Adap.TabOverview – libadapta-1 – Vala Binding Reference

Description:

[ CCode ( type_id = "adap_tab_overview_get_type ()" ) ]
[ Version ( since = "1.3" ) ]
public sealed class TabOverview : Widget, Accessible, Buildable, ConstraintTarget

A tab overview for [class@TabView].

`AdapTabOverview` is a widget that can display tabs from an `AdapTabView` in a grid.

`AdapTabOverview` 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.

`AdapTabOverview` 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:AdapTabOverview: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.

`AdapTabOverview` 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].

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

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

`AdapTabOverview` has a single CSS node with name `taboverview`.

Namespace: Adap

Content:

Properties:

public Widget child { get; set; }

The child widget.

public bool enable_new_tab { get; set; }

Whether to enable new tab button.

public bool enable_search { get; set; }

Whether to enable search in tabs.

public DragAction extra_drag_preferred_action { get; }

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

public bool extra_drag_preload { get; set; }

Whether the drop data should be preloaded on hover.

public bool inverted { get; set; }

Whether thumbnails use inverted layout.

public bool open { get; set; }

Whether the overview is open.

public bool search_active { get; }

Whether search is currently active.

public MenuModel secondary_menu { get; set; }

The secondary menu model.

public bool show_end_title_buttons { get; set; }

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

public bool show_start_title_buttons { get; set; }

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

public TabView view { get; set; }

The tab view the overview controls.

Creation methods:

public TabOverview ()

Creates a new `AdapTabOverview`.

Methods:

public unowned Widget? get_child ()

Gets the child widget of this.

public bool get_enable_new_tab ()

Gets whether to new tab button is enabled for this.

public bool get_enable_search ()

Gets whether search in tabs is enabled for this.

public DragAction get_extra_drag_preferred_action ()

Gets the current action during a drop on the extra_drop_target.

public bool get_extra_drag_preload ()

Gets whether drop data should be preloaded on hover.

public bool get_inverted ()

Gets whether thumbnails use inverted layout.

public bool get_open ()

Gets whether this is open.

public bool get_search_active ()

Gets whether search is currently active for this.

public unowned MenuModel? get_secondary_menu ()

Gets the secondary menu model for this .

public bool get_show_end_title_buttons ()

Gets whether end title buttons are shown in this's header bar.

public bool get_show_start_title_buttons ()

Gets whether start title buttons are shown in this's header bar.

public unowned TabView? get_view ()

Gets the tab view this controls.

public void set_child (Widget? child)

Sets the child widget of this.

public void set_enable_new_tab (bool enable_new_tab)

Sets whether to enable new tab button for this.

public void set_enable_search (bool enable_search)

Sets whether to enable search in tabs for this.

public void set_extra_drag_preload (bool preload)

Sets whether drop data should be preloaded on hover.

public void set_inverted (bool inverted)

Sets whether thumbnails use inverted layout.

public void set_open (bool open)

Sets whether the to open this.

public void set_secondary_menu (MenuModel? secondary_menu)

Sets the secondary menu model for this .

public void set_show_end_title_buttons (bool show_end_title_buttons)

Sets whether to show end title buttons in this's header bar.

public void set_show_start_title_buttons (bool show_start_title_buttons)

Sets whether to show start title buttons in this's header bar.

public void set_view (TabView? view)

Sets the tab view to control.

public void setup_extra_drop_target (DragAction actions, Type[]? types)

Sets the supported types for this drop target.

Signals:

public signal unowned TabPage create_tab ()

Emitted when a tab needs to be created.

public signal bool extra_drag_drop (TabPage page, Value value)

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

public signal DragAction extra_drag_value (TabPage page, Value value)

This signal is emitted when the dropped content is preloaded.

Inherited Members:

TabOverview

Object Hierarchy: