GtkStack

GtkStack — A stacking container

Synopsis

#include <gtk/gtk.h>

struct              GtkStack;
GtkWidget *         gtk_stack_new                       (void);
void                gtk_stack_add_named                 (GtkStack *stack,
                                                         GtkWidget *child,
                                                         const gchar *name);
void                gtk_stack_add_titled                (GtkStack *stack,
                                                         GtkWidget *child,
                                                         const gchar *name,
                                                         const gchar *title);
void                gtk_stack_set_visible_child         (GtkStack *stack,
                                                         GtkWidget *child);
GtkWidget *         gtk_stack_get_visible_child         (GtkStack *stack);
void                gtk_stack_set_visible_child_name    (GtkStack *stack,
                                                         const gchar *name);
const gchar *       gtk_stack_get_visible_child_name    (GtkStack *stack);
void                gtk_stack_set_visible_child_full    (GtkStack *stack,
                                                         const gchar *name,
                                                         GtkStackTransitionType transition);
void                gtk_stack_set_homogeneous           (GtkStack *stack,
                                                         gboolean homogeneous);
gboolean            gtk_stack_get_homogeneous           (GtkStack *stack);
void                gtk_stack_set_transition_duration   (GtkStack *stack,
                                                         guint duration);
guint               gtk_stack_get_transition_duration   (GtkStack *stack);
enum                GtkStackTransitionType;
void                gtk_stack_set_transition_type       (GtkStack *stack,
                                                         GtkStackTransitionType transition);
GtkStackTransitionType gtk_stack_get_transition_type    (GtkStack *stack);

Description

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 GtkStackSwitcher 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-enable-animations" setting.

The GtkStack widget was added in GTK+ 3.10.

Details

struct GtkStack

struct GtkStack {
  GtkContainer parent_instance;
  GtkStackPrivate *priv;
};

gtk_stack_new ()

GtkWidget *         gtk_stack_new                       (void);

Creates a new GtkStack container.

Returns :

a new GtkStack

Since 3.10


gtk_stack_add_named ()

void                gtk_stack_add_named                 (GtkStack *stack,
                                                         GtkWidget *child,
                                                         const gchar *name);

Adds a child to stack. The child is identified by the name.

stack :

a GtkStack

child :

the widget to add

name :

the name for child

Since 3.10


gtk_stack_add_titled ()

void                gtk_stack_add_titled                (GtkStack *stack,
                                                         GtkWidget *child,
                                                         const gchar *name,
                                                         const gchar *title);

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

stack :

a GtkStack

child :

the widget to add

name :

the name for child

title :

a human-readable title for child

Since 3.10


gtk_stack_set_visible_child ()

void                gtk_stack_set_visible_child         (GtkStack *stack,
                                                         GtkWidget *child);

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.

stack :

a GtkStack

child :

a child of stack

Since 3.10


gtk_stack_get_visible_child ()

GtkWidget *         gtk_stack_get_visible_child         (GtkStack *stack);

Gets the currently visible child of stack, or NULL if there are no visible children.

stack :

a GtkStack

Returns :

the visible child of the GtkStack. [transfer none]

Since 3.10


gtk_stack_set_visible_child_name ()

void                gtk_stack_set_visible_child_name    (GtkStack *stack,
                                                         const gchar *name);

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.

stack :

a GtkStack

name :

the name of the child to make visible

Since 3.10


gtk_stack_get_visible_child_name ()

const gchar *       gtk_stack_get_visible_child_name    (GtkStack *stack);

Returns the name of the currently visible child of stack, or NULL if there is no visible child.

stack :

a GtkStack

Returns :

the name of the visible child of the GtkStack. [transfer none]

Since 3.10


gtk_stack_set_visible_child_full ()

void                gtk_stack_set_visible_child_full    (GtkStack *stack,
                                                         const gchar *name,
                                                         GtkStackTransitionType transition);

Makes the child with the given name visible.

stack :

a GtkStack

name :

the name of the child to make visible

transition :

the transition type to use

Since 3.10


gtk_stack_set_homogeneous ()

void                gtk_stack_set_homogeneous           (GtkStack *stack,
                                                         gboolean homogeneous);

Sets the GtkStack to be homogeneous or not. If it is homogeneous, the GtkStack will request the same size for all its children. If it isn't, the stack may change size when a different child becomes visible.

stack :

a GtkStack

homogeneous :

TRUE to make stack homogeneous

Since 3.10


gtk_stack_get_homogeneous ()

gboolean            gtk_stack_get_homogeneous           (GtkStack *stack);

Gets whether stack is homogeneous. See gtk_stack_set_homogeneous().

stack :

a GtkStack

Returns :

whether stack is homogeneous.

Since 3.10


gtk_stack_set_transition_duration ()

void                gtk_stack_set_transition_duration   (GtkStack *stack,
                                                         guint duration);

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

stack :

a GtkStack

duration :

the new duration, in milliseconds

Since 3.10


gtk_stack_get_transition_duration ()

guint               gtk_stack_get_transition_duration   (GtkStack *stack);

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

stack :

a GtkStack

Returns :

the transition duration

Since 3.10


enum GtkStackTransitionType

typedef enum {
  GTK_STACK_TRANSITION_TYPE_NONE,
  GTK_STACK_TRANSITION_TYPE_CROSSFADE,
  GTK_STACK_TRANSITION_TYPE_SLIDE_RIGHT,
  GTK_STACK_TRANSITION_TYPE_SLIDE_LEFT,
  GTK_STACK_TRANSITION_TYPE_SLIDE_UP,
  GTK_STACK_TRANSITION_TYPE_SLIDE_DOWN
} GtkStackTransitionType;

These enumeration values describe the possible transitions between pages in a GtkStack widget.

GTK_STACK_TRANSITION_TYPE_NONE

No transition

GTK_STACK_TRANSITION_TYPE_CROSSFADE

A cross-fade

GTK_STACK_TRANSITION_TYPE_SLIDE_RIGHT

Slide from left to right

GTK_STACK_TRANSITION_TYPE_SLIDE_LEFT

Slide from right to left

GTK_STACK_TRANSITION_TYPE_SLIDE_UP

Slide from bottom up

GTK_STACK_TRANSITION_TYPE_SLIDE_DOWN

Slide from top down

gtk_stack_set_transition_type ()

void                gtk_stack_set_transition_type       (GtkStack *stack,
                                                         GtkStackTransitionType transition);

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.

stack :

a GtkStack

transition :

the new transition type

Since 3.10


gtk_stack_get_transition_type ()

GtkStackTransitionType gtk_stack_get_transition_type    (GtkStack *stack);

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

stack :

a GtkStack

Returns :

the current transition type of stack

Since 3.10

See Also

GtkNotebook, GtkStackSwitcher