Struct gtk4::Stack

pub struct Stack(_);

Stack is a container which only shows one of its children at a time.

In contrast to Notebook, Stack does not provide a means for users to change the visible child. Instead, a separate widget such as StackSwitcher or StackSidebar can be used with Stack to provide this functionality.

Transitions between pages can be animated as slides or fades. This can be controlled with set_transition_type(). These animations respect the property::Settings::gtk-enable-animations setting.

Stack maintains a StackPage object for each added child, which holds additional per-child properties. You obtain the StackPage for a child with page() and you can obtain a SelectionModel containing all the pages with pages().

GtkStack as GtkBuildable

To set child-specific properties in a .ui file, create StackPage objects explicitly, and set the child widget as a property on it:

  <object class="GtkStack" id="stack">
    <child>
      <object class="GtkStackPage">
        <property name="name">page1</property>
        <property name="title">In the beginning…</property>
        <property name="child">
          <object class="GtkLabel">
            <property name="label">It was dark</property>
          </object>
        </property>
      </object>
    </child>

CSS nodes

Stack has a single CSS node named stack.

Accessibility

Stack uses the AccessibleRole::TabPanel for the stack pages, which are the accessible parent objects of the child widgets.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Implementations

impl Stack

pub fn new() -> Stack

Creates a new Stack.

Returns

a new Stack

pub fn builder() -> StackBuilder

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

This method returns an instance of StackBuilder which can be used to create Stack objects.

pub fn add_child<P: IsA<Widget>>(&self, child: &P) -> StackPage

Adds a child to self.

child

the widget to add

Returns

the StackPage for child

pub fn add_named<P: IsA<Widget>>(
    &self,
    child: &P,
    name: Option<&str>
) -> StackPage

Adds a child to self.

The child is identified by the name.

child

the widget to add

name

the name for child

Returns

the StackPage for child

pub fn add_titled<P: IsA<Widget>>(
    &self,
    child: &P,
    name: Option<&str>,
    title: &str
) -> StackPage

Adds a child to self.

The child is identified by the name. The title will be used by StackSwitcher to represent child in a tab bar, so it should be short.

child

the widget to add

name

the name for child

title

a human-readable title for child

Returns

the StackPage for child

pub fn child_by_name(&self, name: &str) -> Option<Widget>

Finds the child with the name given as the argument.

Returns None if there is no child with this name.

name

the name of the child to find

Returns

the requested child of the Stack

pub fn is_hhomogeneous(&self) -> bool

Gets whether self is horizontally homogeneous.

Returns

whether self is horizontally homogeneous.

pub fn interpolates_size(&self) -> bool

Returns whether the Stack is set up to interpolate between the sizes of children on page switch.

Returns

true if child sizes are interpolated

pub fn page<P: IsA<Widget>>(&self, child: &P) -> Option<StackPage>

Returns the StackPage object for child.

child

a child of self

Returns

the StackPage for child

pub fn pages(&self) -> SelectionModel

Returns a GListModel that contains the pages of the stack.

This can be used to keep an up-to-date view. The model also implements SelectionModel and can be used to track and modify the visible page.

Returns

a SelectionModel for the stack’s children

pub fn transition_duration(&self) -> u32

Returns the amount of time (in milliseconds) that transitions between pages in self will take.

Returns

the transition duration

pub fn is_transition_running(&self) -> bool

Returns whether the self is currently in a transition from one page to another.

Returns

true if the transition is currently running, false otherwise.

pub fn transition_type(&self) -> StackTransitionType

Gets the type of animation that will be used for transitions between pages in self.

Returns

the current transition type of self

pub fn is_vhomogeneous(&self) -> bool

Gets whether self is vertically homogeneous.

Returns

whether self is vertically homogeneous.

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

Gets the currently visible child of self.

Returns None if there are no visible children.

Returns

the visible child of the Stack

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

Returns the name of the currently visible child of self.

Returns None if there is no visible child.

Returns

the name of the visible child of the Stack

pub fn remove<P: IsA<Widget>>(&self, child: &P)

Removes a child widget from self.

child

the child to remove

pub fn set_hhomogeneous(&self, hhomogeneous: bool)

Sets the Stack to be horizontally homogeneous or not.

If it is homogeneous, the Stack will request the same width for all its children. If it isn’t, the stack may change width when a different child becomes visible.

hhomogeneous

true to make self horizontally homogeneous

pub fn set_interpolate_size(&self, interpolate_size: bool)

Sets whether or not self will interpolate its size when changing the visible child.

If the property::Stack::interpolate-size property is set to true, self will interpolate its size between the current one and the one it’ll take after changing the visible child, according to the set transition duration.

interpolate_size

the new value

pub fn set_transition_duration(&self, duration: u32)

Sets the duration that transitions between pages in self will take.

duration

the new duration, in milliseconds

pub fn set_transition_type(&self, transition: StackTransitionType)

Sets the type of animation that will be used for transitions between pages in self.

Available types include various kinds of fades and slides.

The transition type can be changed without problems at runtime, so it is possible to change the animation based on the page that is about to become current.

transition

the new transition type

pub fn set_vhomogeneous(&self, vhomogeneous: bool)

Sets the Stack to be vertically homogeneous or not.

If it is homogeneous, the Stack will request the same height for all its children. If it isn’t, the stack may change height when a different child becomes visible.

vhomogeneous

true to make self vertically homogeneous

pub fn set_visible_child<P: IsA<Widget>>(&self, child: &P)

Makes child the visible child of self.

If child is different from the currently visible child, the transition between the two will be animated with the current transition type of self.

Note that the child widget has to be visible itself (see WidgetExt::show()) in order to become the visible child of self.

child

a child of self

pub fn set_visible_child_full(
    &self,
    name: &str,
    transition: StackTransitionType
)

Makes the child with the given name visible.

Note that the child widget has to be visible itself (see WidgetExt::show()) in order to become the visible child of self.

name

the name of the child to make visible

transition

the transition type to use

pub fn set_visible_child_name(&self, name: &str)

Makes the child with the given name visible.

If child is different from the currently visible child, the transition between the two will be animated with the current transition type of self.

Note that the child widget has to be visible itself (see WidgetExt::show()) in order to become the visible child of self.

name

the name of the child to make visible

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for Stack

fn clone(&self) -> Stack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stack

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

Formats the value using the given formatter.

impl Default for Stack

fn default() -> Self

Returns the “default value” for a type.

impl Display for Stack

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

Formats the value using the given formatter.

impl Hash for Stack

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Stack

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for Stack

type Parent = Widget

impl<T: ObjectType> PartialEq<T> for Stack

fn eq(&self, other: &T) -> 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 !=.

impl<T: ObjectType> PartialOrd<T> for Stack

fn partial_cmp(&self, other: &T) -> 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 Stack

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Stack

impl IsA<Accessible> for Stack

impl IsA<Buildable> for Stack

impl IsA<ConstraintTarget> for Stack

impl IsA<Widget> for Stack

impl StructuralEq for Stack