adw.tab_overview

Module for [TabOverview] class

class TabOverview TabOverviewGidBuilder TabOverviewGidBuilderImpl

Types 3

A tab overview for class@TabView.

[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 property@TabPage:live-thumbnail 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 property@TabPage:thumbnail-xalign and property@TabPage:thumbnail-yalign 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 class@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 property@TabPage:keyword.

If property@TabOverview:enable-new-tab is set to TRUE, a new tab button will be shown. Connect to the signal@TabOverview::create-tab signal to use it.

property@TabOverview:secondary-menu 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 property@TabOverview:child. The child is expected to contain an class@TabView.

[adw.tab_overview.TabOverview] shows window buttons by default. They can be disabled by setting property@TabOverview:show-start-title-buttons and/or property@TabOverview:show-start-title-buttons and/or property@TabOverview:show-end-title-buttons 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 class@TabButton.

CSS nodes

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

Methods

GType _getGType()

GType _gType() @property

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

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

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

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

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

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

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

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

gdk.types.DragAction extraDragPreferredAction() @propertyGet `extraDragPreferredAction` property. Returns: The unique action on the `current-drop` of the `signal@TabOverview::extra-drag-drop`.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void setupExtraDropTarget(gdk.types.DragAction actions, gobject.types.GType[] types = null)Sets 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)

Connect 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)

Connect 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)

Connect to `ExtraDragValue` signal.

Constructors

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

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

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

Methods

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

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

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

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

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

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

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

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

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

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

classTabOverviewGidBuilder : TabOverviewGidBuilderImpl!TabOverviewGidBuilder

Fluent builder for [adw.tab_overview.TabOverview]

Methods

TabOverview build()