Class

AdwTabOverview

Description [src]

final class Adw.TabOverview : Gtk.Widget {
  /* No available fields */
}

A tab overview for AdwTabView.

tab-overview

AdwTabOverview is a widget that can display tabs from an AdwTabView in a grid.

AdwTabOverview 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 AdwTabPage:live-thumbnail to TRUE, or refreshed with adw_tab_page_invalidate_thumbnail() or adw_tab_view_invalidate_thumbnails() otherwise.

If the pages are too tall or too wide, the thumbnails will be cropped; use AdwTabPage:thumbnail-xalign and AdwTabPage: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 AdwTabBar, they still have titles, as well as an unpin button.

AdwTabOverview provides search in open tabs. It searches in tab titles and tooltips, as well as AdwTabPage:keyword.

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

AdwTabOverview: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.

AdwTabOverview is intended to be used as the direct child of the window, with the rest of the window contents set as the AdwTabOverview:child. The child is expected to contain an AdwTabView.

AdwTabOverview shows window buttons by default. They can be disabled by setting AdwTabOverview:show-start-title-buttons and/or AdwTabOverview:show-start-title-buttons and/or AdwTabOverview: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

AdwTabOverview defines the overview.open and overview.close actions for opening and closing itself. They can be convenient when used together with AdwTabButton.

CSS nodes

AdwTabOverview has a single CSS node with name taboverview.

Available since:1.3

Ancestors

  • GtkWidget
  • GInitiallyUnowned
  • GObject

Implements

  • GtkAccessible
  • GtkBuildable
  • GtkConstraintTarget

Constructors

adw_tab_overview_new

Creates a new AdwTabOverview.

Available since: 1.3

Instance methods

adw_tab_overview_get_child

Gets the child widget of self.

Available since: 1.3

adw_tab_overview_get_enable_new_tab

Gets whether to new tab button is enabled for self.

Available since: 1.3

adw_tab_overview_get_enable_search

Gets whether search in tabs is enabled for self.

Available since: 1.3

adw_tab_overview_get_extra_drag_preferred_action

Gets the current action during a drop on the extra_drop_target.

Available since: 1.4

adw_tab_overview_get_extra_drag_preload

Gets whether drop data should be preloaded on hover.

Available since: 1.3

adw_tab_overview_get_inverted

Gets whether thumbnails use inverted layout.

Available since: 1.3

adw_tab_overview_get_open

Gets whether self is open.

Available since: 1.3

adw_tab_overview_get_search_active

Gets whether search is currently active for self.

Available since: 1.3

adw_tab_overview_get_secondary_menu

Gets the secondary menu model for self.

Available since: 1.3

adw_tab_overview_get_show_end_title_buttons

Gets whether end title buttons are shown in selfs header bar.

Available since: 1.3

adw_tab_overview_get_show_start_title_buttons

Gets whether start title buttons are shown in selfs header bar.

Available since: 1.3

adw_tab_overview_get_view

Gets the tab view self controls.

Available since: 1.3

adw_tab_overview_set_child

Sets the child widget of self.

Available since: 1.3

adw_tab_overview_set_enable_new_tab

Sets whether to enable new tab button for self.

Available since: 1.3

adw_tab_overview_set_enable_search

Sets whether to enable search in tabs for self.

Available since: 1.3

adw_tab_overview_set_extra_drag_preload

Sets whether drop data should be preloaded on hover.

Available since: 1.3

adw_tab_overview_set_inverted

Sets whether thumbnails use inverted layout.

Available since: 1.3

adw_tab_overview_set_open

Sets whether the to open self.

Available since: 1.3

adw_tab_overview_set_secondary_menu

Sets the secondary menu model for self.

Available since: 1.3

adw_tab_overview_set_show_end_title_buttons

Sets whether to show end title buttons in selfs header bar.

Available since: 1.3

adw_tab_overview_set_show_start_title_buttons

Sets whether to show start title buttons in selfs header bar.

Available since: 1.3

adw_tab_overview_set_view

Sets the tab view to control.

Available since: 1.3

adw_tab_overview_setup_extra_drop_target

Sets the supported types for this drop target.

Available since: 1.3

Properties

Adw.TabOverview:child

The child widget.

Available since: 1.3

Adw.TabOverview:enable-new-tab

Whether to enable new tab button.

Available since: 1.3

Adw.TabOverview:enable-search

Whether to enable search in tabs.

Available since: 1.3

Adw.TabOverview:extra-drag-preferred-action

The unique action on the current-drop of the AdwTabOverview::extra-drag-drop.

Available since: 1.4

Adw.TabOverview:extra-drag-preload

Whether the drop data should be preloaded on hover.

Available since: 1.3

Adw.TabOverview:inverted

Whether thumbnails use inverted layout.

Available since: 1.3

Adw.TabOverview:open

Whether the overview is open.

Available since: 1.3

Adw.TabOverview:search-active

Whether search is currently active.

Available since: 1.3

Adw.TabOverview:secondary-menu

The secondary menu model.

Available since: 1.3

Adw.TabOverview:show-end-title-buttons

Whether to show end title buttons in the overview’s header bar.

Available since: 1.3

Adw.TabOverview:show-start-title-buttons

Whether to show start title buttons in the overview’s header bar.

Available since: 1.3

Adw.TabOverview:view

The tab view the overview controls.

Available since: 1.3

Signals

Adw.TabOverview::create-tab

Emitted when a tab needs to be created;

Available since: 1.3

Adw.TabOverview::extra-drag-drop

This signal is emitted when content is dropped onto a tab.

Available since: 1.3

Adw.TabOverview::extra-drag-value

This signal is emitted when the dropped content is preloaded.

Available since: 1.3

Class structure

struct AdwTabOverviewClass {
  GtkWidgetClass parent_class;
  
}
Class members
parent_class
GtkWidgetClass
  No description available.