Adw.TabBar – libadwaita-1 Reference Manual

Packages

libadwaita-1

Adw

TabBar

TabBar

Object Hierarchy:

Object hierarchy for TabBar

Description:

[ CCode ( type_id = "adw_tab_bar_get_type ()" ) ]
public sealed class TabBar : Widget, Accessible, Buildable, ConstraintTarget

A tab bar for [class@TabView].

<picture> <source srcset="tab-bar-dark.png" media="(prefers-color-scheme: dark)"> <img src="tab-bar.png" alt="tab-bar" > </picture>

The `AdwTabBar` widget is a tab bar that can be used with conjunction with `AdwTabView`. It is typically used as a top bar within [ class@ToolbarView].

`AdwTabBar` can autohide and can optionally contain action widgets on both sides of the tabs.

When there's not enough space to show all the tabs, `AdwTabBar` will scroll them. Pinned tabs always stay visible and aren't a part of the scrollable area.

Drag-and-Drop

`AdwTabBar` tabs can have an additional drop target for arbitrary content.

Use [method@TabBar.setup_extra_drop_target] to set it up, specifying the supported content types and drag actions, then connect to [ signal@TabBar:AdwTabBar:extra-drag-drop] to handle a drop.

In some cases, it may be necessary to determine the used action based on the content. In that case, set [ property@TabBar:extra-drag-preload] to `TRUE` and connect to [signal@TabBar:AdwTabBar:extra-drag-value] signal, then return the action from its handler. To access this action from the [signal@TabBar:AdwTabBar:extra-drag-drop] handler, use the [ property@TabBar:extra-drag-preferred-action] property.

[signal@TabBar:AdwTabBar:extra-drag-value] is also always emitted when starting to hover an item, with a `NULL` value. This happens even when [property@TabBar:extra-drag-preload] is `FALSE`.

CSS nodes

`AdwTabBar` has a single CSS node with name `tabbar`.

Style classes

By default `AdwTabBar` look like a part of an `AdwHeaderBar` and is intended to be used directly attached to one or used as a [ class@ToolbarView] toolbar. The [`.inline`](style-classes.html#inline) style class removes its background, so that it can be used in different contexts instead.

<picture> <source srcset="tab-bar-inline-dark.png" media="(prefers-color-scheme: dark)"> <img src="tab-bar-inline.png" alt="tab-bar-inline"> </picture>

Namespace: Adw

Package: libadwaita-1

Content:

Properties:

public bool autohide { get; set; }
Whether the tabs automatically hide.
public Widget end_action_widget { get; set; }
The widget shown after the tabs.
public bool expand_tabs { get; set; }
Whether tabs expand to full width.
public DragAction extra_drag_preferred_action { get; }
The current drag action during a drop.
public bool extra_drag_preload { get; set; }
Whether the drop data should be preloaded on hover.
public bool inverted { get; set; }
Whether tabs use inverted layout.
public bool is_overflowing { get; }
Whether the tab bar is overflowing.
public Widget start_action_widget { get; set; }
The widget shown before the tabs.
public bool tabs_revealed { get; }
Whether the tabs are currently revealed.
public TabView view { get; set; }
The tab view the tab bar controls.

Creation methods:

public TabBar ()
Creates a new `AdwTabBar`.

Methods:

public bool get_autohide ()
Gets whether the tabs automatically hide.
public unowned Widget? get_end_action_widget ()
Gets the widget shown after the tabs.
public bool get_expand_tabs ()
Gets whether tabs expand to full width.
public DragAction get_extra_drag_preferred_action ()
Gets the current drag action during a drop.
public bool get_extra_drag_preload ()
Gets whether drop data should be preloaded on hover.
public bool get_inverted ()
Gets whether tabs use inverted layout.
public bool get_is_overflowing ()
Gets whether this is overflowing.
public unowned Widget? get_start_action_widget ()
Gets the widget shown before the tabs.
public bool get_tabs_revealed ()
Gets whether the tabs are currently revealed.
public unowned TabView? get_view ()
Gets the tab view this controls.
public void set_autohide (bool autohide)
Sets whether the tabs automatically hide.
public void set_end_action_widget (Widget? widget)
Sets the widget to show after the tabs.
public void set_expand_tabs (bool expand_tabs)
Sets whether tabs expand to full width.
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 tabs tabs use inverted layout.
public void set_start_action_widget (Widget? widget)
Sets the widget to show before the tabs.
public void set_view (TabView? view)
Sets the tab view this controls.
public void setup_extra_drop_target (DragAction actions, Type[]? types)
Sets up an extra drop target on tabs.

Signals:

public signal bool extra_drag_drop (TabPage page, Value value)
Emitted when content is dropped onto a tab.
public signal DragAction extra_drag_value (TabPage page, Value? value)
Emitted when the dropped content is preloaded.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable

Generated by valadoc