Class

AdwTabView

Description [src]

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

A dynamic tabbed container.

AdwTabView is a container which shows one child at a time. While it provides keyboard shortcuts for switching between pages, it does not provide a visible tab switcher and relies on external widgets for that, such as AdwTabBar, AdwTabOverview and AdwTabButton.

AdwTabView maintains a AdwTabPage object for each page, which holds additional per-page properties. You can obtain the AdwTabPage for a page with adw_tab_view_get_page(), and as the return value for adw_tab_view_append() and other functions for adding children.

AdwTabView only aims to be useful for dynamic tabs in multi-window document-based applications, such as web browsers, file managers, text editors or terminals. It does not aim to replace GtkNotebook for use cases such as tabbed dialogs.

As such, it does not support disabling page reordering or detaching.

AdwTabView adds a number of global page switching and reordering shortcuts. The AdwTabView:shortcuts property can be used to manage them.

See AdwTabViewShortcuts for the list of the available shortcuts. All of the shortcuts are enabled by default.

adw_tab_view_add_shortcuts() and adw_tab_view_remove_shortcuts() can be used to manage shortcuts in a convenient way, for example:

adw_tab_view_remove_shortcuts (view, ADW_TAB_VIEW_SHORTCUT_CONTROL_HOME |
                                     ADW_TAB_VIEW_SHORTCUT_CONTROL_END);

CSS nodes

AdwTabView has a main CSS node with the name tabview.

Accessibility

AdwTabView uses the GTK_ACCESSIBLE_ROLE_TAB_PANEL for the tab pages which are the accessible parent objects of the child widgets.

Ancestors

  • GtkWidget
  • GInitiallyUnowned
  • GObject

Implements

  • GtkAccessible
  • GtkBuildable
  • GtkConstraintTarget

Constructors

adw_tab_view_new

Creates a new AdwTabView.

Instance methods

adw_tab_view_add_page

Adds child to self with parent as the parent.

adw_tab_view_add_shortcuts

Adds shortcuts for self.

Available since: 1.2

adw_tab_view_append

Inserts child as the last non-pinned page.

adw_tab_view_append_pinned

Inserts child as the last pinned page.

adw_tab_view_close_other_pages

Requests to close all pages other than page.

adw_tab_view_close_page

Requests to close page.

adw_tab_view_close_page_finish

Completes a adw_tab_view_close_page() call for page.

adw_tab_view_close_pages_after

Requests to close all pages after page.

adw_tab_view_close_pages_before

Requests to close all pages before page.

adw_tab_view_get_default_icon

Gets the default icon of self.

adw_tab_view_get_is_transferring_page

Whether a page is being transferred.

adw_tab_view_get_menu_model

Gets the tab context menu model for self.

adw_tab_view_get_n_pages

Gets the number of pages in self.

adw_tab_view_get_n_pinned_pages

Gets the number of pinned pages in self.

adw_tab_view_get_nth_page

Gets the AdwTabPage representing the child at position.

adw_tab_view_get_page

Gets the AdwTabPage object representing child.

adw_tab_view_get_page_position

Finds the position of page in self, starting from 0.

adw_tab_view_get_pages

Returns a GListModel that contains the pages of self.

adw_tab_view_get_selected_page

Gets the currently selected page in self.

adw_tab_view_get_shortcuts

Gets the enabled shortcuts for self.

Available since: 1.2

adw_tab_view_insert

Inserts a non-pinned page at position.

adw_tab_view_insert_pinned

Inserts a pinned page at position.

adw_tab_view_invalidate_thumbnails

Invalidates thumbnails for all pages in self.

Available since: 1.3

adw_tab_view_prepend

Inserts child as the first non-pinned page.

adw_tab_view_prepend_pinned

Inserts child as the first pinned page.

adw_tab_view_remove_shortcuts

Removes shortcuts from self.

Available since: 1.2

adw_tab_view_reorder_backward

Reorders page to before its previous page if possible.

adw_tab_view_reorder_first

Reorders page to the first possible position.

adw_tab_view_reorder_forward

Reorders page to after its next page if possible.

adw_tab_view_reorder_last

Reorders page to the last possible position.

adw_tab_view_reorder_page

Reorders page to position.

adw_tab_view_select_next_page

Selects the page after the currently selected page.

adw_tab_view_select_previous_page

Selects the page before the currently selected page.

adw_tab_view_set_default_icon

Sets the default page icon for self.

adw_tab_view_set_menu_model

Sets the tab context menu model for self.

adw_tab_view_set_page_pinned

Pins or unpins page.

adw_tab_view_set_selected_page

Sets the currently selected page in self.

adw_tab_view_set_shortcuts

Sets the enabled shortcuts for self.

Available since: 1.2

adw_tab_view_transfer_page

Transfers page from self to other_view.

Properties

Adw.TabView:default-icon

Default page icon.

Adw.TabView:is-transferring-page

Whether a page is being transferred.

Adw.TabView:menu-model

Tab context menu model.

Adw.TabView:n-pages

The number of pages in the tab view.

Adw.TabView:n-pinned-pages

The number of pinned pages in the tab view.

Adw.TabView:pages

A selection model with the tab view’s pages.

Adw.TabView:selected-page

The currently selected page.

Adw.TabView:shortcuts

The enabled shortcuts.

Available since: 1.2

Signals

Adw.TabView::close-page

Emitted after adw_tab_view_close_page() has been called for page.

Adw.TabView::create-window

Emitted when a tab should be transferred into a new window.

Adw.TabView::indicator-activated

Emitted after the indicator icon on page has been activated.

Adw.TabView::page-attached

Emitted when a page has been created or transferred to self.

Adw.TabView::page-detached

Emitted when a page has been removed or transferred to another view.

Adw.TabView::page-reordered

Emitted after page has been reordered to position.

Adw.TabView::setup-menu

Emitted when a context menu is opened or closed for page.

Class structure

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