adwaita/org.gtkkn.bindings.adw/TabView

TabView

class TabView(pointer: <Error class: unknown class><<Error class: unknown class>>)

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 class@TabBar, class@TabOverview and class@TabButton.

AdwTabView maintains a class@TabPage object for each page, which holds additional per-page properties. You can obtain the AdwTabPage for a page with method@TabView.get_page, and as the return value for method@TabView.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 class@Gtk.Notebook 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 property@TabView:shortcuts property can be used to manage them.

See flags@TabViewShortcuts for the list of the available shortcuts. All of the shortcuts are enabled by default.

method@TabView.add_shortcuts and method@TabView.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.

Skipped during bindings generation

method selected-page: Property TypeInfo of getter and setter do not match

Constructors

TabView

constructor()

Creates a new AdwTabView.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

adwTabViewPointer

val adwTabViewPointer: <Error class: unknown class><<Error class: unknown class>>

defaultIcon

var defaultIcon: <Error class: unknown class>

Default page icon.

gtkAccessiblePointer

open val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkConstraintTargetPointer

open val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>

isTransferringPage

val isTransferringPage: Boolean

Whether a page is being transferred.

menuModel

var menuModel: <Error class: unknown class>?

Tab context menu model.

nPages

val nPages: Int

The number of pages in the tab view.

nPinnedPages

val nPinnedPages: Int

The number of pinned pages in the tab view.

pages

val pages: <Error class: unknown class>

A selection model with the tab view's pages.

shortcuts

var shortcuts: TabViewShortcuts

The enabled shortcuts.

Functions

addPage

fun addPage(child: <Error class: unknown class>, parent: TabPage? = null): TabPage

Adds @child to @self with @parent as the parent.

addShortcuts

fun addShortcuts(shortcuts: TabViewShortcuts)

Adds @shortcuts for @self.

append

fun append(child: <Error class: unknown class>): TabPage

Inserts @child as the last non-pinned page.

appendPinned

fun appendPinned(child: <Error class: unknown class>): TabPage

Inserts @child as the last pinned page.

closeOtherPages

fun closeOtherPages(page: TabPage)

Requests to close all pages other than @page.

closePage

fun closePage(page: TabPage)

Requests to close @page.

closePageFinish

fun closePageFinish(page: TabPage, confirm: Boolean)

Completes a method@TabView.close_page call for @page.

closePagesAfter

fun closePagesAfter(page: TabPage)

Requests to close all pages after @page.

closePagesBefore

fun closePagesBefore(page: TabPage)

Requests to close all pages before @page.

connectClosePage

fun connectClosePage(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (page: TabPage) -> Boolean): <Error class: unknown class>

Emitted after method@TabView.close_page has been called for @page.

connectCreateWindow

fun connectCreateWindow(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> TabView?): <Error class: unknown class>

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

connectIndicatorActivated

fun connectIndicatorActivated(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (page: TabPage) -> Unit): <Error class: unknown class>

Emitted after the indicator icon on @page has been activated.

connectPageAttached

fun connectPageAttached(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (page: TabPage, position: Int) -> Unit): <Error class: unknown class>

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

connectPageDetached

fun connectPageDetached(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (page: TabPage, position: Int) -> Unit): <Error class: unknown class>

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

connectPageReordered

fun connectPageReordered(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (page: TabPage, position: Int) -> Unit): <Error class: unknown class>

Emitted after @page has been reordered to @position.

connectSetupMenu