Struct libadwaita::TabPage

pub struct TabPage { /* private fields */ }

An auxiliary class used by TabView.

Properties

child

The child of the page.

Readable | Writeable | Construct Only

icon

The icon of the page.

TabBar and TabOverview display the icon next to the title, unless loading is set to TRUE.

TabBar also won’t show the icon if the page is pinned and [propertyTabPage:indicator-icon] is set.

Readable | Writeable

indicator-activatable

Whether the indicator icon is activatable.

If set to TRUE, indicator-activated will be emitted when the indicator icon is clicked.

If indicator-icon is not set, does nothing.

Readable | Writeable

indicator-icon

An indicator icon for the page.

A common use case is an audio or camera indicator in a web browser.

TabBar will show it at the beginning of the tab, alongside icon representing icon or loading spinner.

If the page is pinned, the indicator will be shown instead of icon or spinner.

TabOverview will show it at the at the top part of the thumbnail.

indicator-tooltip can be used to set the tooltip on the indicator icon.

If indicator-activatable is set to TRUE, the indicator icon can act as a button.

Readable | Writeable

indicator-tooltip

The tooltip of the indicator icon.

The tooltip can be marked up with the Pango text markup language.

See indicator-icon.

Readable | Writeable

keyword

The search keyboard of the page.

TabOverview can search pages by their keywords in addition to their titles and tooltips.

Keywords allow to include e.g. page URLs into tab search in a web browser.

Readable | Writeable

live-thumbnail

Whether to enable live thumbnail for this page.

When set to TRUE, the page’s thumbnail in TabOverview will update immediately when the page is redrawn or resized.

If it’s set to FALSE, the thumbnail will only be live when the page is selected, and otherwise it will be static and will only update when TabPage::invalidate_thumbnail() or TabView::invalidate_thumbnails() is called.

Readable | Writeable

loading

Whether the page is loading.

If set to TRUE, TabBar and TabOverview will display a spinner in place of icon.

If the page is pinned and indicator-icon is set, loading status will not be visible with TabBar.

Readable | Writeable

needs-attention

Whether the page needs attention.

TabBar will display a line under the tab representing the page if set to TRUE. If the tab is not visible, the corresponding edge of the tab bar will be highlighted.

TabOverview will display a dot in the corner of the thumbnail if set to TRUE.

TabButton will display a dot if any of the pages that aren’t selected have this property set to TRUE.

Readable | Writeable

parent

The parent page of the page.

See TabView::add_page() and TabView::close_page().

Readable | Writeable | Construct Only

pinned

Whether the page is pinned.

See TabView::set_page_pinned().

Readable

selected

Whether the page is selected.

Readable

thumbnail-xalign

The horizontal alignment of the page thumbnail.

If the page is so wide that TabOverview can’t display it completely and has to crop it, horizontal alignment will determine which part of the page will be visible.

For example, 0.5 means the center of the page will be visible, 0 means the start edge will be visible and 1 means the end edge will be visible.

The default horizontal alignment is 0.

Readable | Writeable

thumbnail-yalign

The vertical alignment of the page thumbnail.

If the page is so tall that TabOverview can’t display it completely and has to crop it, vertical alignment will determine which part of the page will be visible.

For example, 0.5 means the center of the page will be visible, 0 means the top edge will be visible and 1 means the bottom edge will be visible.

The default vertical alignment is 0.

Readable | Writeable

title

The title of the page.

TabBar will display it in the center of the tab unless it’s pinned, and will use it as a tooltip unless tooltip is set.

TabOverview will display it below the thumbnail unless it’s pinned, or inside the card otherwise, and will use it as a tooltip unless tooltip is set.

Readable | Writeable

tooltip

The tooltip of the page.

The tooltip can be marked up with the Pango text markup language.

If not set, TabBar and TabOverview will use title as a tooltip instead.

Readable | Writeable

Accessible

accessible-role

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

The accessible role cannot be changed once set.

Readable | Writeable

Implements

[trait@glib::ObjectExt], gtk::prelude::AccessibleExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl TabPage

pub fn child(&self) -> Widget

Gets the child of @self.

Returns

the child of @self

pub fn icon(&self) -> Option<Icon>

Gets the icon of @self.

Returns

the icon of @self

pub fn is_indicator_activatable(&self) -> bool

Gets whether the indicator of @self is activatable.

Returns

whether the indicator is activatable

pub fn indicator_icon(&self) -> Option<Icon>

Gets the indicator icon of @self.

Returns

the indicator icon of @self

pub fn indicator_tooltip(&self) -> GString

Available on crate feature v1_2 only.

Gets the tooltip of the indicator icon of @self.

Returns

the indicator tooltip of @self

pub fn keyword(&self) -> Option<GString>

Available on crate feature v1_3 only.

Gets the search keyword of @self.

Returns

the search keyword of @self

pub fn is_live_thumbnail(&self) -> bool

Available on crate feature v1_3 only.

Gets whether to live thumbnail is enabled @self.

Returns

whether live thumbnail is enabled

pub fn is_loading(&self) -> bool

Gets whether @self is loading.

Returns

whether @self is loading

pub fn needs_attention(&self) -> bool

Gets whether @self needs attention.

Returns

whether @self needs attention

pub fn parent(&self) -> Option<TabPage>

Gets the parent page of @self.

See TabView::add_page() and TabView::close_page().

Returns

the parent page

pub fn is_pinned(&self) -> bool

Gets whether @self is pinned.

See TabView::set_page_pinned().

Returns

whether @self is pinned

pub fn is_selected(&self) -> bool

Gets whether @self is selected.

Returns

whether @self is selected

pub fn thumbnail_xalign(&self) -> f32

Available on crate feature v1_3 only.

Gets the horizontal alignment of the thumbnail for @self.

Returns

the horizontal alignment

pub fn thumbnail_yalign(&self) -> f32

Available on crate feature v1_3 only.

Gets the vertical alignment of the thumbnail for @self.

Returns

the vertical alignment

pub fn title(&self) -> GString

Gets the title of @self.

Returns

the title of @self

pub fn tooltip(&self) -> Option<GString>

Gets the tooltip of @self.

Returns

the tooltip of @self

pub fn invalidate_thumbnail(&self)

Available on crate feature v1_3 only.

Invalidates thumbnail for @self.

If an TabOverview is open, the thumbnail representing @self will be immediately updated. Otherwise it will be update when opening the overview.

Does nothing if live-thumbnail is set to TRUE.

See also TabView::invalidate_thumbnails().

pub fn set_icon(&self, icon: Option<&impl IsA<Icon>>)

Sets the icon of @self.

TabBar and TabOverview display the icon next to the title, unless loading is set to TRUE.

TabBar also won’t show the icon if the page is pinned and [propertyTabPage:indicator-icon] is set.

icon

the icon of @self

pub fn set_indicator_activatable(&self, activatable: bool)

Sets whether the indicator of @self is activatable.

If set to TRUE, indicator-activated will be emitted when the indicator icon is clicked.

If indicator-icon is not set, does nothing.

activatable

whether the indicator is activatable

pub fn set_indicator_icon(&self, indicator_icon: Option<&impl IsA<Icon>>)

Sets the indicator icon of @self.

A common use case is an audio or camera indicator in a web browser.

TabBar will show it at the beginning of the tab, alongside icon representing icon or loading spinner.

If the page is pinned, the indicator will be shown instead of icon or spinner.

TabOverview will show it at the at the top part of the thumbnail.

indicator-tooltip can be used to set the tooltip on the indicator icon.

If indicator-activatable is set to TRUE, the indicator icon can act as a button.

indicator_icon

the indicator icon of @self

pub fn set_indicator_tooltip(&self, tooltip: &str)

Available on crate feature v1_2 only.

Sets the tooltip of the indicator icon of @self.

The tooltip can be marked up with the Pango text markup language.

See indicator-icon.

tooltip

the indicator tooltip of @self

pub fn set_keyword(&self, keyword: &str)

Available on crate feature v1_3 only.

Sets the search keyword for @self.

TabOverview can search pages by their keywords in addition to their titles and tooltips.

Keywords allow to include e.g. page URLs into tab search in a web browser.

keyword

the search keyword

pub fn set_live_thumbnail(&self, live_thumbnail: bool)

Available on crate feature v1_3 only.

Sets whether to enable live thumbnail for @self.

When set to TRUE, @self’s thumbnail in TabOverview will update immediately when @self is redrawn or resized.

If it’s set to FALSE, the thumbnail will only be live when the @self is selected, and otherwise it will be static and will only update when invalidate_thumbnail() or TabView::invalidate_thumbnails() is called.

live_thumbnail

whether to enable live thumbnail

pub fn set_loading(&self, loading: bool)

Sets whether @self is loading.

If set to TRUE, TabBar and TabOverview will display a spinner in place of icon.

If the page is pinned and indicator-icon is set, loading status will not be visible with TabBar.

loading

whether @self is loading

pub fn set_needs_attention(&self, needs_attention: bool)

Sets whether @self needs attention.

TabBar will display a line under the tab representing the page if set to TRUE. If the tab is not visible, the corresponding edge of the tab bar will be highlighted.

TabOverview will display a dot in the corner of the thumbnail if set to TRUE.

TabButton will display a dot if any of the pages that aren’t selected have needs-attention set to TRUE.

needs_attention

whether @self needs attention

pub fn set_thumbnail_xalign(&self, xalign: f32)

Available on crate feature v1_3 only.

Sets the horizontal alignment of the thumbnail for @self.

If the page is so wide that TabOverview can’t display it completely and has to crop it, horizontal alignment will determine which part of the page will be visible.

For example, 0.5 means the center of the page will be visible, 0 means the start edge will be visible and 1 means the end edge will be visible.

The default horizontal alignment is 0.

xalign

the new value

pub fn set_thumbnail_yalign(&self, yalign: f32)

Available on crate feature v1_3 only.

Sets the vertical alignment of the thumbnail for @self.

If the page is so tall that TabOverview can’t display it completely and has to crop it, vertical alignment will determine which part of the page will be visible.

For example, 0.5 means the center of the page will be visible, 0 means the top edge will be visible and 1 means the bottom edge will be visible.

The default vertical alignment is 0.

yalign

the new value

pub fn set_title(&self, title: &str)

TabBar will display it in the center of the tab unless it’s pinned, and will use it as a tooltip unless tooltip is set.

TabOverview will display it below the thumbnail unless it’s pinned, or inside the card otherwise, and will use it as a tooltip unless tooltip is set.

Sets the title of @self.

title

the title of @self

pub fn set_tooltip(&self, tooltip: &str)

Sets the tooltip of @self.

The tooltip can be marked up with the Pango text markup language.

If not set, TabBar and TabOverview will use title as a tooltip instead.

tooltip

the tooltip of @self

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

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

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

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

Available on crate feature v1_2 only.

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

Available on crate feature v1_3 only.

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

Available on crate feature v1_3 only.

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

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

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

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

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

Available on crate feature v1_3 only.

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

Available on crate feature v1_3 only.

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

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

Trait Implementations

impl Clone for TabPage

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for TabPage

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

Formats the value using the given formatter.

impl HasParamSpec for TabPage

type ParamSpec = ParamSpecObject

type SetValue = TabPage

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TabPage

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

where H: Hasher,

Hashes the memory address of this object.

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 TabPage

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 TabPage

type Parent = Object

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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 TabPage

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 TabPage

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TabPage

impl IsA<Accessible> for TabPage