Struct libhandy::TabPage

pub struct TabPage { /* private fields */ }

Available on crate feature v1_2 only.

An auxiliary class used by TabView.

Properties

child

The child of the page.

Readable | Writeable | Construct Only

icon

The icon of the page.

TabBar displays the icon next to the title.

It will not show the icon if loading is set to TRUE, or 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.

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

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

Readable | Writeable

loading

Whether the page is loading.

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

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

Readable | Writeable

needs-attention

Whether the page needs attention.

TabBar will display a glow 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.

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

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.

Readable | Writeable

tooltip

The tooltip of the page.

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

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

Readable | Writeable

Implements

glib::ObjectExt

Implementations

impl TabPage

pub fn builder() -> TabPageBuilder

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

This method returns an instance of TabPageBuilder which can be used to create TabPage objects.

pub fn child(&self) -> Option<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 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.

Returns

the parent page of @self

pub fn is_pinned(&self) -> bool

Gets whether @self is pinned.

Returns

whether @self is pinned

pub fn is_selected(&self) -> bool

Gets whether @self is selected.

Returns

whether @self is selected

pub fn title(&self) -> Option<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 set_icon(&self, icon: Option<&impl IsA<Icon>>)

Sets the icon of @self.

icon

the icon of @self

pub fn set_indicator_activatable(&self, activatable: bool)

Sets whether the indicator of @self is activatable.

activatable

whether the indicator is activatable

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

Sets the indicator icon of @self.

indicator_icon

the indicator icon of @self

pub fn set_loading(&self, loading: bool)

Sets wether @self is loading.

loading

whether @self is loading

pub fn set_needs_attention(&self, needs_attention: bool)

Sets whether @self needs attention.

needs_attention

whether @self needs attention

pub fn set_title(&self, title: Option<&str>)

Sets the title of @self.

title

the title of @self

pub fn set_tooltip(&self, tooltip: Option<&str>)

Sets the tooltip of @self.

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

Returns a copy of the value.

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

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 TabPage

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 TabPage

type Parent = Object

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

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 TabPage

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 TabPage

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TabPage