adwaita/org.gtkkn.bindings.adw/TabOverview

TabOverview

class TabOverview(val adwTabOverviewPointer: <Error class: unknown class><<Error class: unknown class>>)(source)

A tab overview for class@TabView.

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 property@TabPage:live-thumbnail to TRUE, or refreshed with method@TabPage.invalidate_thumbnail or method@TabView.invalidate_thumbnails 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.

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

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

AdwTabOverview 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

AdwTabOverview 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

AdwTabOverview has a single CSS node with name taboverview.

Skipped during bindings generation

parameter types: Array parameter of type GType is not supported

Since

1.3

Constructors

TabOverview

constructor()

Creates a new AdwTabOverview.

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

Types

Companion

object Companion

Properties

adwTabOverviewPointer

val adwTabOverviewPointer: <Error class: unknown class><<Error class: unknown class>>

child

var child: <Error class: unknown class>?

The child widget.

enableNewTab

var enableNewTab: Boolean

Whether to enable new tab button.

enableSearch

var enableSearch: Boolean

Whether to enable search in tabs.

extraDragPreferredAction

val extraDragPreferredAction: <Error class: unknown class>

The unique action on the current-drop of the signal@TabOverview::extra-drag-drop.

extraDragPreload

var extraDragPreload: Boolean

Whether the drop data should be preloaded on hover.

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

inverted

var inverted: Boolean

Whether thumbnails use inverted layout.

open

var open: Boolean

Whether the overview is open.

searchActive

val searchActive: Boolean

Whether search is currently active.

secondaryMenu

var secondaryMenu: <Error class: unknown class>?

The secondary menu model.

showEndTitleButtons

var showEndTitleButtons: Boolean

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

showStartTitleButtons

var showStartTitleButtons: Boolean

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

view

var view: TabView?

The tab view the overview controls.

Functions

onCreateTab

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

Emitted when a tab needs to be created;

onExtraDragDrop

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

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

onExtraDragValue

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

This signal is emitted when the dropped content is preloaded.