Class

AdwTabOverview

since: 1.3

Description [src] 

final class Adw.TabOverview : Gtk.Widget
  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
  /* 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

Hierarchy

hierarchy this AdwTabOverview implements_0 GtkAccessible this--implements_0 implements_1 GtkBuildable this--implements_1 implements_2 GtkConstraintTarget this--implements_2 ancestor_0 GtkWidget ancestor_0--this ancestor_1 GInitiallyUnowned ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

Ancestors

Implements

Constructors

adw_tab_overview_new

Creates a new AdwTabOverview.

since: 1.3

Instance methods

adw_tab_overview_get_child

Gets the child widget of self.

since: 1.3

adw_tab_overview_get_enable_new_tab

Gets whether to new tab button is enabled for self.

since: 1.3

adw_tab_overview_get_enable_search

Gets whether search in tabs is enabled for self.

since: 1.3

adw_tab_overview_get_extra_drag_preferred_action

Gets the current action during a drop on the extra_drop_target.

since: 1.4

adw_tab_overview_get_extra_drag_preload

Gets whether drop data should be preloaded on hover.

since: 1.3

adw_tab_overview_get_inverted

Gets whether thumbnails use inverted layout.

since: 1.3

adw_tab_overview_get_open

Gets whether self is open.

since: 1.3

adw_tab_overview_get_search_active

Gets whether search is currently active for self.

since: 1.3

adw_tab_overview_get_secondary_menu

Gets the secondary menu model for self.

since: 1.3

adw_tab_overview_get_show_end_title_buttons

Gets whether end title buttons are shown in self‘s header bar.

since: 1.3

adw_tab_overview_get_show_start_title_buttons

Gets whether start title buttons are shown in self‘s header bar.

since: 1.3

adw_tab_overview_get_view

Gets the tab view self controls.

since: 1.3

adw_tab_overview_set_child

Sets the child widget of self.

since: 1.3

adw_tab_overview_set_enable_new_tab

Sets whether to enable new tab button for self.

since: 1.3

adw_tab_overview_set_enable_search

Sets whether to enable search in tabs for self.

since: 1.3

adw_tab_overview_set_extra_drag_preload

Sets whether drop data should be preloaded on hover.

since: 1.3

adw_tab_overview_set_inverted

Sets whether thumbnails use inverted layout.

since: 1.3

adw_tab_overview_set_open

Sets whether the to open self.

since: 1.3

adw_tab_overview_set_secondary_menu

Sets the secondary menu model for self.

since: 1.3

adw_tab_overview_set_show_end_title_buttons

Sets whether to show end title buttons in self‘s header bar.

since: 1.3

adw_tab_overview_set_show_start_title_buttons

Sets whether to show start title buttons in self‘s header bar.

since: 1.3

adw_tab_overview_set_view

Sets the tab view to control.

since: 1.3

adw_tab_overview_setup_extra_drop_target

Sets the supported types for this drop target.

since: 1.3

Methods inherited from GtkWidget (162)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkAccessible (18)
gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

unstable since: 4.10

gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

unstable since: 4.0

gtk_accessible_get_at_context

Retrieves the accessible implementation for the given GtkAccessible.

unstable since: 4.10

gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

unstable since: 4.10

gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

unstable since: 4.10

gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

unstable since: 4.10

gtk_accessible_get_platform_state

Query a platform state, such as focus.

unstable since: 4.10

gtk_accessible_reset_property

Resets the accessible property to its default value.

unstable since: 4.0

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

unstable since: 4.0

gtk_accessible_reset_state

Resets the accessible state to its default value.

unstable since: 4.0

gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

unstable since: 4.10

gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of self.

unstable since: 4.10

gtk_accessible_update_property

Updates a list of accessible properties.

unstable since: 4.0

gtk_accessible_update_property_value

Updates an array of accessible properties.

unstable since: 4.0

gtk_accessible_update_relation

Updates a list of accessible relations.

unstable since: 4.0

gtk_accessible_update_relation_value

Updates an array of accessible relations.

unstable since: 4.0

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

unstable since: 4.0

gtk_accessible_update_state_value

Updates an array of accessible states.

unstable since: 4.0

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

unstable since: 4.0

Properties

Adw.TabOverview:child

The child widget.

since: 1.3

Adw.TabOverview:enable-new-tab

Whether to enable new tab button.

since: 1.3

Adw.TabOverview:enable-search

Whether to enable search in tabs.

since: 1.3

Adw.TabOverview:extra-drag-preferred-action

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

since: 1.4

Adw.TabOverview:extra-drag-preload

Whether the drop data should be preloaded on hover.

since: 1.3

Adw.TabOverview:inverted

Whether thumbnails use inverted layout.

since: 1.3

Adw.TabOverview:open

Whether the overview is open.

since: 1.3

Adw.TabOverview:search-active

Whether search is currently active.

since: 1.3

Adw.TabOverview:secondary-menu

The secondary menu model.

since: 1.3

Adw.TabOverview:show-end-title-buttons

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

since: 1.3

Adw.TabOverview:show-start-title-buttons

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

since: 1.3

Adw.TabOverview:view

The tab view the overview controls.

since: 1.3

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

unstable since: 4.0

Gtk.Widget:can-target

Whether the widget can receive pointer events.

unstable since: 4.0

Gtk.Widget:css-classes

A list of css classes applied to this widget.

unstable since: 4.0

Gtk.Widget:css-name

The name of this widget in the CSS tree.

unstable since: 4.0

Gtk.Widget:cursor

The cursor used by widget.

unstable since: 4.0

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

unstable since: 4.0

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

unstable since: 4.0

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

unstable since: 4.0

Gtk.Widget:has-default

Whether the widget is the default widget.

unstable since: 4.0

Gtk.Widget:has-focus

Whether the widget has the input focus.

unstable since: 4.0

Gtk.Widget:has-tooltip

Enables or disables the emission of the ::query-tooltip signal on widget.

unstable since: 4.0

Gtk.Widget:height-request

Override for height request of the widget.

unstable since: 4.0

Gtk.Widget:hexpand

Whether to expand horizontally.

unstable since: 4.0

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

unstable since: 4.0

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

unstable since: 4.0

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

unstable since: 4.0

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

unstable since: 4.0

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

unstable since: 4.0

Gtk.Widget:margin-top

Margin on top side of widget.

unstable since: 4.0

Gtk.Widget:name

The name of the widget.

unstable since: 4.0

Gtk.Widget:opacity

The requested opacity of the widget.

unstable since: 4.0

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

unstable since: 4.0

Gtk.Widget:parent

The parent widget of this widget.

unstable since: 4.0

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

unstable since: 4.0

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

unstable since: 4.0

Gtk.Widget:scale-factor

The scale factor of the widget.

unstable since: 4.0

Gtk.Widget:sensitive

Whether the widget responds to input.

unstable since: 4.0

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

unstable since: 4.0

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

unstable since: 4.0

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

unstable since: 4.0

Gtk.Widget:vexpand

Whether to expand vertically.

unstable since: 4.0

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

unstable since: 4.0

Gtk.Widget:visible

Whether the widget is visible.

unstable since: 4.0

Gtk.Widget:width-request

Override for width request of the widget.

unstable since: 4.0

Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

unstable since: 4.0

Signals

Adw.TabOverview::create-tab

Emitted when a tab needs to be created;

since: 1.3

Adw.TabOverview::extra-drag-drop

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

since: 1.3

Adw.TabOverview::extra-drag-value

This signal is emitted when the dropped content is preloaded.

since: 1.3

Signals inherited from GtkWidget (13)
GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

unstable since: 4.0

GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

unstable since: 4.0

GtkWidget::hide

Emitted when widget is hidden.

unstable since: 4.0

GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

unstable since: 4.0

GtkWidget::map

Emitted when widget is going to be mapped.

unstable since: 4.0

GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

unstable since: 4.0

GtkWidget::move-focus

Emitted when the focus is moved.

unstable since: 4.0

GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

unstable since: 4.0

GtkWidget::realize

Emitted when widget is associated with a GdkSurface.

unstable since: 4.0

GtkWidget::show

Emitted when widget is shown.

unstable since: 4.0

GtkWidget::state-flags-changed

Emitted when the widget state changes.

unstable since: 4.0

GtkWidget::unmap

Emitted when widget is going to be unmapped.

unstable since: 4.0

GtkWidget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

unstable since: 4.0

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

unstable since: 2.0

Class structure 

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