Stack

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_stack_get_type ()" ) ]
public sealed class Stack : Widget, Accessible, Buildable, ConstraintTarget

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

In contrast to `GtkNotebook`, `GtkStack` does not provide a means for users to change the visible child. Instead, a separate widget such as [ class@Gtk.StackSwitcher] or [class@Gtk.StackSidebar] can be used with `GtkStack` to provide this functionality.

Transitions between pages can be animated as slides or fades. This can be controlled with [method@Gtk.Stack.set_transition_type]. These animations respect the [property@Gtk.Settings:gtk-enable-animations] setting.

`GtkStack` maintains a [class@Gtk.StackPage] object for each added child, which holds additional per-child properties. You obtain the `GtkStackPage` for a child with [method@Gtk.Stack.get_page] and you can obtain a `GtkSelectionModel` containing all the pages with [ method@Gtk.Stack.get_pages].

GtkStack as GtkBuildable

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

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

`GtkStack` has a single CSS node named stack.

Accessibility

`GtkStack` uses the gtk_accessible_role_tab_panel for the stack pages, which are the accessible parent objects of the child widgets.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public bool hhomogeneous { get; set; }
true if the stack allocates the same width for all children.
public bool interpolate_size { get; set; }
Whether or not the size should smoothly change during the transition.
public SelectionModel pages { owned get; }
A selection model with the stack pages.
public uint transition_duration { get; set; }
The animation duration, in milliseconds.
public bool transition_running { get; }
Whether or not the transition is currently running.
public StackTransitionType transition_type { get; set; }
The type of animation used to transition.
public bool vhomogeneous { get; set; }
true if the stack allocates the same height for all children.
public Widget visible_child { get; set; }
The widget currently visible in the stack.
public string visible_child_name { get; set; }
The name of the widget currently visible in the stack.

Creation methods:

public Stack ()
Creates a new `GtkStack`.

Methods:

public unowned StackPage add_child (Widget child)
Adds a child to this.
public unowned StackPage add_named (Widget child, string? name)
Adds a child to this.
public unowned StackPage add_titled (Widget child, string? name, string title)
Adds a child to this.
public unowned Widget? get_child_by_name (string name)
Finds the child with the name given as the argument.
public bool get_hhomogeneous ()
Gets whether this is horizontally homogeneous.
public bool get_interpolate_size ()
Returns whether the `GtkStack` is set up to interpolate between the sizes of children on page switch.
public unowned StackPage get_page (Widget child)
Returns the `GtkStackPage` object for child.
public SelectionModel get_pages ()
Returns a `GListModel` that contains the pages of the stack.
public uint get_transition_duration ()
Returns the amount of time (in milliseconds) that transitions between pages in this will take.
public bool get_transition_running ()
Returns whether the this is currently in a transition from one page to another.
public StackTransitionType get_transition_type ()
Gets the type of animation that will be used for transitions between pages in this.
public bool get_vhomogeneous ()
Gets whether this is vertically homogeneous.
public unowned Widget? get_visible_child ()
Gets the currently visible child of this.
public unowned string? get_visible_child_name ()
Returns the name of the currently visible child of this.
public void remove (Widget child)
Removes a child widget from this.
public void set_hhomogeneous (bool hhomogeneous)
Sets the `GtkStack` to be horizontally homogeneous or not.
public void set_interpolate_size (bool interpolate_size)
Sets whether or not this will interpolate its size when changing the visible child.
public void set_transition_duration (uint duration)
Sets the duration that transitions between pages in this will take.
public void set_transition_type (StackTransitionType transition)
Sets the type of animation that will be used for transitions between pages in this.
public void set_vhomogeneous (bool vhomogeneous)
Sets the `GtkStack` to be vertically homogeneous or not.
public void set_visible_child (Widget child)
Makes child the visible child of this.
public void set_visible_child_full (string name, StackTransitionType transition)
Makes the child with the given name visible.
public void set_visible_child_name (string name)
Makes the child with the given name visible.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable