Struct gtk4::Stack

#[repr(transparent)]
pub struct Stack { /* private fields */ }

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

Properties

hhomogeneous

true if the stack allocates the same width for all children.

Readable | Writeable

interpolate-size

Whether or not the size should smoothly change during the transition.

Readable | Writeable

pages

A selection model with the stack pages.

Readable

transition-duration

The animation duration, in milliseconds.

Readable | Writeable

transition-running

Whether or not the transition is currently running.

Readable

transition-type

The type of animation used to transition.

Readable | Writeable

vhomogeneous

true if the stack allocates the same height for all children.

Readable | Writeable

visible-child

The widget currently visible in the stack.

Readable | Writeable

visible-child-name

The name of the widget currently visible in the stack.

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 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 WidgetExt::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 WidgetExt::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 WidgetExt::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 WidgetExt::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 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 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 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 Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

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(&self, child: &impl IsA<Widget>) -> StackPage

Adds a child to @self.

child

the widget to add

Returns

the StackPage for @child

pub fn add_named( &self, child: &impl IsA<Widget>, 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( &self, child: &impl IsA<Widget>, 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(&self, child: &impl IsA<Widget>) -> 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(&self, child: &impl IsA<Widget>)

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 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(&self, child: &impl IsA<Widget>)

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) -> Self

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 HasParamSpec for Stack

type ParamSpec = ParamSpecObject

type SetValue = Stack

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Stack

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 Stack

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Stack

type Parent = Widget

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

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 Stack

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