Struct libadwaita::TabBar

pub struct TabBar { /* private fields */ }

A tab bar for TabView.

The TabBar widget is a tab bar that can be used with conjunction with TabView. It is typically used as a top bar within ToolbarView.

TabBar 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, TabBar will scroll them. Pinned tabs always stay visible and aren’t a part of the scrollable area.

CSS nodes

TabBar has a single CSS node with name tabbar.

Properties

autohide

Whether the tabs automatically hide.

If set to TRUE, the tab bar disappears when view has 0 or 1 tab, no pinned tabs, and no tab is being transferred.

See tabs-revealed.

Readable | Writeable

end-action-widget

The widget shown after the tabs.

Readable | Writeable

expand-tabs

Whether tabs expand to full width.

If set to TRUE, the tabs will always vary width filling the whole width when possible, otherwise tabs will always have the minimum possible size.

Readable | Writeable

extra-drag-preferred-action

The unique action on the current-drop of the extra-drag-drop.

This property should only be used during a extra-drag-drop and is always a subset of what was originally passed to TabBar::setup_extra_drop_target().

Readable

extra-drag-preload

Whether the drop data should be preloaded on hover.

See [preload][struct@crate::Gtk::DropTarget#preload].

Readable | Writeable

inverted

Whether tabs use inverted layout.

If set to TRUE, non-pinned tabs will have the close button at the beginning and the indicator at the end rather than the opposite.

Readable | Writeable

is-overflowing

Whether the tab bar is overflowing.

If TRUE, all tabs cannot be displayed at once and require scrolling.

Readable

start-action-widget

The widget shown before the tabs.

Readable | Writeable

tabs-revealed

Whether the tabs are currently revealed.

See autohide.

Readable

view

The tab view the tab bar controls.

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The gtk::Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Gtk::Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Gtk::Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given gtk::Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Signals

extra-drag-drop

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

The content must be of one of the types set up via TabBar::setup_extra_drop_target().

See [drop][struct@crate::Gtk::DropTarget#drop].

extra-drag-value

This signal is emitted when the dropped content is preloaded.

In order for data to be preloaded, extra-drag-preload must be set to TRUE.

The content must be of one of the types set up via TabBar::setup_extra_drop_target().

See [value][struct@crate::Gtk::DropTarget#value].

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See [WidgetExtManual::keynav_failed()][crate::gtk::prelude::WidgetExtManual::keynav_failed()] for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

query-tooltip

Emitted when the widget’s tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a GdkSurface.

This means that [WidgetExtManual::realize()][crate::gtk::prelude::WidgetExtManual::realize()] has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See [WidgetExtManual::state_flags()][crate::gtk::prelude::WidgetExtManual::state_flags()].

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the GdkSurface associated with @widget is destroyed.

This means that [WidgetExtManual::unrealize()][crate::gtk::prelude::WidgetExtManual::unrealize()] has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

gtk::prelude::WidgetExt, [trait@glib::ObjectExt], gtk::prelude::AccessibleExt, gtk::prelude::BuildableExt, gtk::prelude::ConstraintTargetExt

Implementations

impl TabBar

pub fn new() -> TabBar

Creates a new TabBar.

Returns

the newly created TabBar

pub fn builder() -> TabBarBuilder

Creates a new builder-pattern struct instance to construct TabBar objects.

This method returns an instance of TabBarBuilder which can be used to create TabBar objects.

pub fn is_autohide(&self) -> bool

Gets whether the tabs automatically hide.

Returns

whether the tabs automatically hide

pub fn end_action_widget(&self) -> Option<Widget>

Gets the widget shown after the tabs.

Returns

the widget shown after the tabs

pub fn expands_tabs(&self) -> bool

Gets whether tabs expand to full width.

Returns

whether tabs expand to full width.

pub fn extra_drag_preferred_action(&self) -> DragAction

Available on crate feature v1_4 only.

Gets the current action during a drop on the extra_drop_target.

Returns

the drag action of the current drop.

pub fn is_extra_drag_preload(&self) -> bool

Available on crate feature v1_3 only.

Gets whether drop data should be preloaded on hover.

Returns

whether drop data should be preloaded on hover

pub fn is_inverted(&self) -> bool

Gets whether tabs use inverted layout.

Returns

whether tabs use inverted layout

pub fn is_overflowing(&self) -> bool

Gets whether @self is overflowing.

If TRUE, all tabs cannot be displayed at once and require scrolling.

Returns

whether @self is overflowing

pub fn start_action_widget(&self) -> Option<Widget>

Gets the widget shown before the tabs.

Returns

the widget shown before the tabs

pub fn is_tabs_revealed(&self) -> bool

Gets whether the tabs are currently revealed.

See autohide.

Returns

whether the tabs are currently revealed

pub fn view(&self) -> Option<TabView>

Gets the tab view @self controls.

Returns

the view @self controls

pub fn set_autohide(&self, autohide: bool)

Sets whether the tabs automatically hide.

If set to TRUE, the tab bar disappears when view has 0 or 1 tab, no pinned tabs, and no tab is being transferred.

See tabs-revealed.

autohide

whether the tabs automatically hide

pub fn set_end_action_widget(&self, widget: Option<&impl IsA<Widget>>)

Sets the widget to show after the tabs.

widget

the widget to show after the tabs

pub fn set_expand_tabs(&self, expand_tabs: bool)

Sets whether tabs expand to full width.

If set to TRUE, the tabs will always vary width filling the whole width when possible, otherwise tabs will always have the minimum possible size.

expand_tabs

whether to expand tabs

pub fn set_extra_drag_preload(&self, preload: bool)

Available on crate feature v1_3 only.

Sets whether drop data should be preloaded on hover.

See [preload][struct@crate::Gtk::DropTarget#preload].

preload

whether to preload drop data

pub fn set_inverted(&self, inverted: bool)

Sets whether tabs tabs use inverted layout.

If set to TRUE, non-pinned tabs will have the close button at the beginning and the indicator at the end rather than the opposite.

inverted

whether tabs use inverted layout

pub fn set_start_action_widget(&self, widget: Option<&impl IsA<Widget>>)

Sets the widget to show before the tabs.

widget

the widget to show before the tabs

pub fn set_view(&self, view: Option<&TabView>)

Sets the tab view @self controls.

view

a tab view

pub fn connect_extra_drag_drop<F: Fn(&Self, &TabPage, &Value) -> bool + 'static>( &self, f: F ) -> SignalHandlerId

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

The content must be of one of the types set up via setup_extra_drop_target().

See [drop][struct@crate::Gtk::DropTarget#drop].

page

the page matching the tab the content was dropped onto

value

the GValue being dropped

Returns

whether the drop was accepted for @page

pub fn connect_extra_drag_value<F: Fn(&Self, &TabPage, &Value) -> DragAction + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v1_3 only.

This signal is emitted when the dropped content is preloaded.

In order for data to be preloaded, extra-drag-preload must be set to TRUE.

The content must be of one of the types set up via setup_extra_drop_target().

See [value][struct@crate::Gtk::DropTarget#value].

page

the page matching the tab the content was dropped onto

value

the GValue being dropped

Returns

the preferred action for the drop on @page

pub fn connect_autohide_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_end_action_widget_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_expand_tabs_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_extra_drag_preferred_action_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v1_4 only.

pub fn connect_extra_drag_preload_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v1_3 only.

pub fn connect_inverted_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_is_overflowing_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_start_action_widget_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_tabs_revealed_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_view_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

impl TabBar

pub fn setup_extra_drop_target(&self, actions: DragAction, types: &[Type])

Sets the supported types for this drop target.

Sets up an extra drop target on tabs.

This allows to drag arbitrary content onto tabs, for example URLs in a web browser.

If a tab is hovered for a certain period of time while dragging the content, it will be automatically selected.

The extra-drag-drop signal can be used to handle the drop.

actions

the supported actions

types

all supported GTypes that can be dropped

Trait Implementations

impl Clone for TabBar

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TabBar

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TabBar

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for TabBar

type ParamSpec = ParamSpecObject

type SetValue = TabBar

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, TabBar>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TabBar

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TabBar

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for TabBar

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for TabBar

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for TabBar

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for TabBar

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TabBar

impl IsA<Accessible> for TabBar

impl IsA<Buildable> for TabBar

impl IsA<ConstraintTarget> for TabBar

impl IsA<Widget> for TabBar