The GtkStack widget 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, the Gtk.Stack_Switcher.Gtk_Stack_Switcher widget can be used with GtkStack to provide this functionality.
Transitions between pages can be animated as slides or fades. This can be controlled with Gtk.Stack.Set_Transition_Type. These animations respect the Gtk.Settings.Gtk_Settings:gtk-enable-animations setting.
The GtkStack widget was added in GTK+ 3.10.
# CSS nodes
GtkStack has a single CSS node named stack.
function "+"
(Widget : access Gtk_Stack_Record'Class)
return Gtk.Buildable.Gtk_Buildable
function "-"
(Interf : Gtk.Buildable.Gtk_Buildable)
return Gtk_Stack
procedure Add_Named
(Self : not null access Gtk_Stack_Record;
Child : not null access Gtk.Widget.Gtk_Widget_Record'Class;
Name : UTF8_String)
Adds a child to Stack. The child is identified by the Name. Since: gtk+ 3.10
the widget to add
the name for Child
procedure Add_Titled
(Self : not null access Gtk_Stack_Record;
Child : not null access Gtk.Widget.Gtk_Widget_Record'Class;
Name : UTF8_String;
Title : UTF8_String)
Adds a child to Stack. The child is identified by the Name. The Title will be used by Gtk.Stack_Switcher.Gtk_Stack_Switcher to represent Child in a tab bar, so it should be short. Since: gtk+ 3.10
the widget to add
the name for Child
a human-readable title for Child
function Get_Child_By_Name
(Self : not null access Gtk_Stack_Record;
Name : UTF8_String) return Gtk.Widget.Gtk_Widget
Finds the child of the Gtk.Stack.Gtk_Stack with the name given as the argument. Returns null if there is no child with this name. Since: gtk+ 3.12
the name of the child to find
the requested child of the Gtk.Stack.Gtk_Stack
function Get_Hhomogeneous
(Self : not null access Gtk_Stack_Record) return Boolean
Gets whether Stack is horizontally homogeneous. See Gtk.Stack.Set_Hhomogeneous. Since: gtk+ 3.16
whether Stack is horizontally homogeneous.
function Get_Homogeneous
(Self : not null access Gtk_Stack_Record) return Boolean
Gets whether Stack is homogeneous. See Gtk.Stack.Set_Homogeneous. Since: gtk+ 3.10
whether Stack is homogeneous.
function Get_Interpolate_Size
(Self : not null access Gtk_Stack_Record) return Boolean
Returns wether the Gtk.Stack.Gtk_Stack is set up to interpolate between the sizes of children on page switch. Since: gtk+ 3.18
True if child sizes are interpolated
function Get_Transition_Duration
(Self : not null access Gtk_Stack_Record) return Guint
Returns the amount of time (in milliseconds) that transitions between pages in Stack will take. Since: gtk+ 3.10
the transition duration
function Get_Transition_Running
(Self : not null access Gtk_Stack_Record) return Boolean
Returns whether the Stack is currently in a transition from one page to another. Since: gtk+ 3.12
True if the transition is currently running, False otherwise.
function Get_Transition_Type
(Self : not null access Gtk_Stack_Record)
return Gtk_Stack_Transition_Type
Gets the type of animation that will be used for transitions between pages in Stack. Since: gtk+ 3.10
the current transition type of Stack
function Get_Type return Glib.GType
function Get_Vhomogeneous
(Self : not null access Gtk_Stack_Record) return Boolean
Gets whether Stack is vertically homogeneous. See Gtk.Stack.Set_Vhomogeneous. Since: gtk+ 3.16
whether Stack is vertically homogeneous.
function Get_Visible_Child
(Self : not null access Gtk_Stack_Record) return Gtk.Widget.Gtk_Widget
Gets the currently visible child of Stack, or null if there are no visible children. Since: gtk+ 3.10
the visible child of the Gtk.Stack.Gtk_Stack
function Get_Visible_Child_Name
(Self : not null access Gtk_Stack_Record) return UTF8_String
Returns the name of the currently visible child of Stack, or null if there is no visible child. Since: gtk+ 3.10
the name of the visible child of the Gtk.Stack.Gtk_Stack
procedure Gtk_New (Self : out Gtk_Stack)
Creates a new Gtk.Stack.Gtk_Stack container. Since: gtk+ 3.10 Initialize does nothing if the object was already created with another call to Initialize* or G_New.
type Gtk_Stack is access all Gtk_Stack_Record'Class;
function Gtk_Stack_New return Gtk_Stack
Creates a new Gtk.Stack.Gtk_Stack container. Since: gtk+ 3.10
type Gtk_Stack_Record is new Gtk_Container_Record with null record;
type Gtk_Stack_Transition_Type is (
Stack_Transition_Type_None,
Stack_Transition_Type_Crossfade,
Stack_Transition_Type_Slide_Right,
Stack_Transition_Type_Slide_Left,
Stack_Transition_Type_Slide_Up,
Stack_Transition_Type_Slide_Down,
Stack_Transition_Type_Slide_Left_Right,
Stack_Transition_Type_Slide_Up_Down,
…,
Stack_Transition_Type_Over_Right_Left);
These enumeration values describe the possible transitions between pages in a Gtk.Stack.Gtk_Stack widget.
New values may be added to this enumeration over time.
package Gtk_Stack_Transition_Type_Properties is
new Generic_Internal_Discrete_Property (Gtk_Stack_Transition_Type);
Hhomogeneous_Property : constant Glib.Properties.Property_Boolean;
True if the stack allocates the same width for all children.
Homogeneous_Property : constant Glib.Properties.Property_Boolean;
package Implements_Gtk_Buildable is new Glib.Types.Implements
(Gtk.Buildable.Gtk_Buildable, Gtk_Stack_Record, Gtk_Stack);
procedure Initialize (Self : not null access Gtk_Stack_Record'Class)
Creates a new Gtk.Stack.Gtk_Stack container. Since: gtk+ 3.10 Initialize does nothing if the object was already created with another call to Initialize* or G_New.
Interpolate_Size_Property : constant Glib.Properties.Property_Boolean;
type Property_Gtk_Stack_Transition_Type is new Gtk_Stack_Transition_Type_Properties.Property;
procedure Set_Hhomogeneous
(Self : not null access Gtk_Stack_Record;
Hhomogeneous : Boolean)
Sets the Gtk.Stack.Gtk_Stack to be horizontally homogeneous or not. If it is homogeneous, the Gtk.Stack.Gtk_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. Since: gtk+ 3.16
True to make Stack horizontally homogeneous
procedure Set_Homogeneous
(Self : not null access Gtk_Stack_Record;
Homogeneous : Boolean)
Sets the Gtk.Stack.Gtk_Stack to be homogeneous or not. If it is homogeneous, the Gtk.Stack.Gtk_Stack will request the same size for all its children. If it isn't, the stack may change size when a different child becomes visible. Since 3.16, homogeneity can be controlled separately for horizontal and vertical size, with the Gtk.Stack.Gtk_Stack:hhomogeneous and Gtk.Stack.Gtk_Stack:vhomogeneous. Since: gtk+ 3.10
True to make Stack homogeneous
procedure Set_Interpolate_Size
(Self : not null access Gtk_Stack_Record;
Interpolate_Size : Boolean)
Sets whether or not Stack will interpolate its size when changing the visible child. If the Gtk.Stack.Gtk_Stack:interpolate-size property is set to True, Stack 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. Since: gtk+ 3.18
the new value
procedure Set_Transition_Duration
(Self : not null access Gtk_Stack_Record;
Duration : Guint)
Sets the duration that transitions between pages in Stack will take. Since: gtk+ 3.10
the new duration, in milliseconds
procedure Set_Transition_Type
(Self : not null access Gtk_Stack_Record;
Transition : Gtk_Stack_Transition_Type)
Sets the type of animation that will be used for transitions between pages in Stack. 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. Since: gtk+ 3.10
the new transition type
procedure Set_Vhomogeneous
(Self : not null access Gtk_Stack_Record;
Vhomogeneous : Boolean)
Sets the Gtk.Stack.Gtk_Stack to be vertically homogeneous or not. If it is homogeneous, the Gtk.Stack.Gtk_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. Since: gtk+ 3.16
True to make Stack vertically homogeneous
procedure Set_Visible_Child
(Self : not null access Gtk_Stack_Record;
Child : not null access Gtk.Widget.Gtk_Widget_Record'Class)
Makes Child the visible child of Stack. If Child is different from the currently visible child, the transition between the two will be animated with the current transition type of Stack. Note that the Child widget has to be visible itself (see Gtk.Widget.Show) in order to become the visible child of Stack. Since: gtk+ 3.10
a child of Stack
procedure Set_Visible_Child_Full
(Self : not null access Gtk_Stack_Record;
Name : UTF8_String;
Transition : Gtk_Stack_Transition_Type)
Makes the child with the given name visible. Note that the child widget has to be visible itself (see Gtk.Widget.Show) in order to become the visible child of Stack. Since: gtk+ 3.10
the name of the child to make visible
the transition type to use
procedure Set_Visible_Child_Name
(Self : not null access Gtk_Stack_Record;
Name : UTF8_String)
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 Stack. Note that the child widget has to be visible itself (see Gtk.Widget.Show) in order to become the visible child of Stack. Since: gtk+ 3.10
the name of the child to make visible
Transition_Duration_Property : constant Glib.Properties.Property_Uint;
Transition_Running_Property : constant Glib.Properties.Property_Boolean;
Transition_Type_Property : constant Gtk.Stack.Property_Gtk_Stack_Transition_Type;
Type: Gtk_Stack_Transition_Type
Vhomogeneous_Property : constant Glib.Properties.Property_Boolean;
True if the stack allocates the same height for all children.
Visible_Child_Name_Property : constant Glib.Properties.Property_String;
Visible_Child_Property : constant Glib.Properties.Property_Object;
Type: Gtk.Widget.Gtk_Widget