adw.tab_overview

Module for [TabOverview] class

class TabOverview TabOverviewGidBuilder TabOverviewGidBuilderImpl

Types 3

A tab overview for adw.tab_view.TabView.

tab-overview

adw.tab_overview.TabOverview is a widget that can display tabs from an adw.tab_view.TabView in a grid.

adw.tab_overview.TabOverview shows a thumbnail for each tab. By default thumbnails are static for all pages except the selected one. They can be made always live by setting adw.tab_page.TabPage.liveThumbnail to TRUE, or refreshed with adw.tab_page.TabPage.invalidateThumbnail or adw.tab_view.TabView.invalidateThumbnails otherwise.

If the pages are too tall or too wide, the thumbnails will be cropped; use adw.tab_page.TabPage.thumbnailXalign and adw.tab_page.TabPage.thumbnailYalign to control which part of the page should be visible in this case.

Pinned tabs are shown as smaller cards without thumbnails above the other tabs. Unlike in adw.tab_bar.TabBar, they still have titles, as well as an unpin button.

adw.tab_overview.TabOverview provides search in open tabs. It searches in tab titles and tooltips, as well as adw.tab_page.TabPage.keyword.

If adw.tab_overview.TabOverview.enableNewTab is set to TRUE, a new tab button will be shown. Connect to the adw.tab_overview.TabOverview.createTab signal to use it.

adw.tab_overview.TabOverview.secondaryMenu can be used to provide a secondary menu for the overview. Use it to add extra actions, e.g. to open a new window or undo closed tab.

adw.tab_overview.TabOverview is intended to be used as the direct child of the window, with the rest of the window contents set as the adw.tab_overview.TabOverview.child. The child is expected to contain an adw.tab_view.TabView.

adw.tab_overview.TabOverview shows window buttons by default. They can be disabled by setting adw.tab_overview.TabOverview.showStartTitleButtons and/or adw.tab_overview.TabOverview.showStartTitleButtons and/or adw.tab_overview.TabOverview.showEndTitleButtons to FALSE.

If search and window buttons are disabled, and secondary menu is not set, the header bar will be hidden.

Actions

adw.tab_overview.TabOverview defines the overview.open and overview.close actions for opening and closing itself. They can be convenient when used together with adw.tab_button.TabButton.

CSS nodes

adw.tab_overview.TabOverview has a single CSS node with name taboverview.

Methods

GType _getGType() static nothrow

GType _gType() @property nothrow

TabOverview self() nothrowReturns `this`, for use in `with` statements.

TabOverviewGidBuilder builder() static nothrowGet builder for [adw.tab_overview.TabOverview] Returns: New builder object

gtk.widget.Widget child() @property nothrowGet `child` property. Returns: The child widget.

void child(gtk.widget.Widget propval) @property nothrowSet `child` property. Params: propval = The child widget.

bool enableNewTab() @property nothrowGet `enableNewTab` property. Returns: Whether to enable new tab button.

void enableNewTab(bool propval) @property nothrowSet `enableNewTab` property. Params: propval = Whether to enable new tab button.

bool enableSearch() @property nothrowGet `enableSearch` property. Returns: Whether to enable search in tabs.

void enableSearch(bool propval) @property nothrowSet `enableSearch` property. Params: propval = Whether to enable search in tabs.

gdk.types.DragAction extraDragPreferredAction() @property nothrowGet `extraDragPreferredAction` property. Returns: The unique action on the `current-drop` of the [adw.tab_overview.TabOverview.extraDragDrop].

bool extraDragPreload() @property nothrowGet `extraDragPreload` property. Returns: Whether the drop data should be preloaded on hover.

void extraDragPreload(bool propval) @property nothrowSet `extraDragPreload` property. Params: propval = Whether the drop data should be preloaded on hover.

bool inverted() @property nothrowGet `inverted` property. Returns: Whether thumbnails use inverted layout.

void inverted(bool propval) @property nothrowSet `inverted` property. Params: propval = Whether thumbnails use inverted layout.

bool open() @property nothrowGet `open` property. Returns: Whether the overview is open.

void open(bool propval) @property nothrowSet `open` property. Params: propval = Whether the overview is open.

bool searchActive() @property nothrowGet `searchActive` property. Returns: Whether search is currently active.

gio.menu_model.MenuModel secondaryMenu() @property nothrowGet `secondaryMenu` property. Returns: The secondary menu model.

void secondaryMenu(gio.menu_model.MenuModel propval) @property nothrowSet `secondaryMenu` property. Params: propval = The secondary menu model.

bool showEndTitleButtons() @property nothrowGet `showEndTitleButtons` property. Returns: Whether to show end title buttons in the overview's header bar.

void showEndTitleButtons(bool propval) @property nothrowSet `showEndTitleButtons` property. Params: propval = Whether to show end title buttons in the overview's header bar.

bool showStartTitleButtons() @property nothrowGet `showStartTitleButtons` property. Returns: Whether to show start title buttons in the overview's header bar.

void showStartTitleButtons(bool propval) @property nothrowSet `showStartTitleButtons` property. Params: propval = Whether to show start title buttons in the overview's header bar.

adw.tab_view.TabView view() @property nothrowGet `view` property. Returns: The tab view the overview controls.

void view(adw.tab_view.TabView propval) @property nothrowSet `view` property. Params: propval = The tab view the overview controls.

gtk.widget.Widget getChild() nothrowGets the child widget of self. Returns: the child widget of self

bool getEnableNewTab() nothrowGets whether to new tab button is enabled for self. Returns: whether new tab button is enabled

bool getEnableSearch() nothrowGets whether search in tabs is enabled for self. Returns: whether search is enabled

gdk.types.DragAction getExtraDragPreferredAction() nothrowGets the current action during a drop on the extra_drop_target. Returns: the drag action of the current drop.

bool getExtraDragPreload() nothrowGets whether drop data should be preloaded on hover. Returns: whether drop data should be preloaded on hover

bool getInverted() nothrowGets whether thumbnails use inverted layout. Returns: whether thumbnails use inverted layout

bool getOpen() nothrowGets whether self is open. Returns: whether the overview is open

bool getSearchActive() nothrowGets whether search is currently active for self.

gio.menu_model.MenuModel getSecondaryMenu() nothrowGets the secondary menu model for self. Returns: the secondary menu model

bool getShowEndTitleButtons() nothrowGets whether end title buttons are shown in self's header bar. Returns: whether end title buttons are shown

bool getShowStartTitleButtons() nothrowGets whether start title buttons are shown in self's header bar. Returns: whether start title buttons are shown

adw.tab_view.TabView getView() nothrowGets the tab view self controls. Returns: the tab view

void setChild(gtk.widget.Widget child = null) nothrowSets the child widget of self.

void setEnableNewTab(bool enableNewTab) nothrowSets whether to enable new tab button for self.

void setEnableSearch(bool enableSearch) nothrowSets whether to enable search in tabs for self.

void setExtraDragPreload(bool preload) nothrowSets whether drop data should be preloaded on hover.

void setInverted(bool inverted) nothrowSets whether thumbnails use inverted layout.

void setOpen(bool open) nothrowSets whether the to open self.

void setSecondaryMenu(gio.menu_model.MenuModel secondaryMenu = null) nothrowSets the secondary menu model for self.

void setShowEndTitleButtons(bool showEndTitleButtons) nothrowSets whether to show end title buttons in self's header bar.

void setShowStartTitleButtons(bool showStartTitleButtons) nothrowSets whether to show start title buttons in self's header bar.

void setView(adw.tab_view.TabView view = null) nothrowSets the tab view to control.

void setupExtraDropTarget(gdk.types.DragAction actions, gobject.types.GType[] types = null) nothrowSets the supported types for this drop target.

gulong connectCreateTab(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T :  adw.tab_page.TabPage)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  adw.tab_overview.TabOverview)))
   &&  Parameters!T.length <  2)

nothrowConnect to `CreateTab` signal.

gulong connectExtraDragDrop(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  bool)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  adw.tab_page.TabPage)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  gobject.value.Value)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  adw.tab_overview.TabOverview)))
   &&  Parameters!T.length <  4)

nothrowConnect to `ExtraDragDrop` signal.

gulong connectExtraDragValue(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  gdk.types.DragAction)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  adw.tab_page.TabPage)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  gobject.value.Value)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  adw.tab_overview.TabOverview)))
   &&  Parameters!T.length <  4)

nothrowConnect to `ExtraDragValue` signal.

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new [adw.tab_overview.TabOverview]. Returns: the newly created [adw.tab_overview.TabOverview]

classTabOverviewGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T

Fluent builder implementation template for adw.tab_overview.TabOverview

Methods

T child(gtk.widget.Widget propval) nothrowSet `child` property. Params: propval = The child widget. Returns: Builder instance for fluent chaining

T enableNewTab(bool propval) nothrowSet `enableNewTab` property. Params: propval = Whether to enable new tab button.

T enableSearch(bool propval) nothrowSet `enableSearch` property. Params: propval = Whether to enable search in tabs.

T extraDragPreload(bool propval) nothrowSet `extraDragPreload` property. Params: propval = Whether the drop data should be preloaded on hover.

T inverted(bool propval) nothrowSet `inverted` property. Params: propval = Whether thumbnails use inverted layout.

T open(bool propval) nothrowSet `open` property. Params: propval = Whether the overview is open. Returns: Builder instance for fluent chaining

T secondaryMenu(gio.menu_model.MenuModel propval) nothrowSet `secondaryMenu` property. Params: propval = The secondary menu model.

T showEndTitleButtons(bool propval) nothrowSet `showEndTitleButtons` property. Params: propval = Whether to show end title buttons in the overview's header bar.

T showStartTitleButtons(bool propval) nothrowSet `showStartTitleButtons` property. Params: propval = Whether to show start title buttons in the overview's header bar.

T view(adw.tab_view.TabView propval) nothrowSet `view` property. Params: propval = The tab view the overview controls.

classTabOverviewGidBuilder : TabOverviewGidBuilderImpl!TabOverviewGidBuilder

Fluent builder for adw.tab_overview.TabOverview

Methods

TabOverview build() nothrowCreate object from builder. Returns: New object