Struct gtk4::Stack[][src]

pub struct Stack(_);
Expand description

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

Creates a new Stack.

Returns

a new Stack

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.

Adds a child to self.

child

the widget to add

Returns

the StackPage for child

Adds a child to self.

The child is identified by the name.

child

the widget to add

name

the name for child or None

Returns

the StackPage for child

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

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

Gets whether self is horizontally homogeneous.

Returns

whether self is horizontally homogeneous.

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

Returns

true if child sizes are interpolated

Returns the StackPage object for child.

child

a child of self

Returns

the StackPage for child

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

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

Returns

the transition duration

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

Returns

true if the transition is currently running, false otherwise.

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

Returns

the current transition type of self

Gets whether self is vertically homogeneous.

Returns

whether self is vertically homogeneous.

Gets the currently visible child of self.

Returns None if there are no visible children.

Returns

the visible child of the Stack

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

Removes a child widget from self.

child

the child to remove

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

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

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

duration

the new duration, in milliseconds

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

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

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

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

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

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

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

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

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

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

Returns the type identifier of Self.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Upcasts an object to a superclass or interface T. Read more

Upcasts an object to a reference of its superclass or interface T. Read more

Tries to downcast to a subclass or interface implementor T. Read more

Tries to downcast to a reference of its subclass or interface implementor T. Read more

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Casts to T unconditionally. Read more

Casts to &T unconditionally. Read more

Performs the conversion.

Performs the conversion.

Returns true if the object is an instance of (can be cast to) T.

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Same as connect but takes a SignalId instead of a signal name.

Same as connect_local but takes a SignalId instead of a signal name.

Same as connect_unsafe but takes a SignalId instead of a signal name.

Emit signal by signal id.

Same as emit but takes Value for the arguments.

Emit signal by its name.

Same as emit_by_name but takes Value for the arguments.

Emit signal with details by signal id.

Same as emit_with_details but takes Value for the arguments.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

Returns a SendValue clone of self.

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.