Stack

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 #GtkSettings:gtk-enable-animations setting.

The GtkStack widget was added in GTK+ 3.10.

CSS nodes

GtkStack has a single CSS node named stack.

class Stack : Container {

protected

GtkStack* gtkStack;

GtkStack* getStackStruct(bool transferOwnership);

void* getStruct();

void setStruct(GObject* obj);

this(GtkStack* gtkStack, bool ownedRef);

static GType getType();

this();

void addNamed(Widget child, string name);

void addTitled(Widget child, string name, string title);

Widget getChildByName(string name);

bool getHhomogeneous();

bool getHomogeneous();

bool getInterpolateSize();

uint getTransitionDuration();

bool getTransitionRunning();

GtkStackTransitionType getTransitionType();

bool getVhomogeneous();

Widget getVisibleChild();

string getVisibleChildName();

void setHhomogeneous(bool hhomogeneous);

void setHomogeneous(bool homogeneous);

void setInterpolateSize(bool interpolateSize);

void setTransitionDuration(uint duration);

void setTransitionType(GtkStackTransitionType transition);

void setVhomogeneous(bool vhomogeneous);

void setVisibleChild(Widget child);

void setVisibleChildFull(string name, GtkStackTransitionType transition);

void setVisibleChildName(string name);

}

Constructors

this this(GtkStack* gtkStack, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new #GtkStack container.

Members

Functions

addNamed void addNamed(Widget child, string name): Adds a child to @stack. The child is identified by the @name.
addTitled void addTitled(Widget child, string name, string 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.
getChildByName Widget getChildByName(string name): Finds the child of the #GtkStack with the name given as the argument. Returns %NULL if there is no child with this name.
getHhomogeneous bool getHhomogeneous(): Gets whether @stack is horizontally homogeneous. See gtk_stack_set_hhomogeneous().
getHomogeneous bool getHomogeneous(): Gets whether @stack is homogeneous. See gtk_stack_set_homogeneous().
getInterpolateSize bool getInterpolateSize(): Returns wether the #GtkStack is set up to interpolate between the sizes of children on page switch.
getStackStruct GtkStack* getStackStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getTransitionDuration uint getTransitionDuration(): Returns the amount of time (in milliseconds) that transitions between pages in @stack will take.
getTransitionRunning bool getTransitionRunning(): Returns whether the @stack is currently in a transition from one page to another.
getTransitionType GtkStackTransitionType getTransitionType(): Gets the type of animation that will be used for transitions between pages in @stack.
getVhomogeneous bool getVhomogeneous(): Gets whether @stack is vertically homogeneous. See gtk_stack_set_vhomogeneous().
getVisibleChild Widget getVisibleChild(): Gets the currently visible child of @stack, or %NULL if there are no visible children.
getVisibleChildName string getVisibleChildName(): Returns the name of the currently visible child of @stack, or %NULL if there is no visible child.
setHhomogeneous void setHhomogeneous(bool hhomogeneous): Sets the #GtkStack to be horizontally homogeneous or not. If it is homogeneous, the #GtkStack will request the same width for all its children. If it isn't, the stack may change width when a different child becomes visible.
setHomogeneous void setHomogeneous(bool 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.
setInterpolateSize void setInterpolateSize(bool interpolateSize): Sets whether or not @stack will interpolate its size when changing the visible child. If the #GtkStack: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.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
setTransitionDuration void setTransitionDuration(uint duration): Sets the duration that transitions between pages in @stack will take.
setTransitionType void setTransitionType(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.
setVhomogeneous void setVhomogeneous(bool vhomogeneous): Sets the #GtkStack to be vertically homogeneous or not. If it is homogeneous, the #GtkStack will request the same height for all its children. If it isn't, the stack may change height when a different child becomes visible.
setVisibleChild void setVisibleChild(Widget child): Makes @child the visible child of @stack.
setVisibleChildFull void setVisibleChildFull(string name, GtkStackTransitionType transition): Makes the child with the given name visible.
setVisibleChildName void setVisibleChildName(string name): Makes the child with the given name visible.

Static functions

getType GType getType()

Variables

gtkStack GtkStack* gtkStack;: the main Gtk struct

Inherited Members

From Container

gtkContainer GtkContainer* gtkContainer;: the main Gtk struct
getContainerStruct GtkContainer* getContainerStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
removeAll void removeAll(): Removes all widgets from the container
getType GType getType()
add void add(Widget widget): Adds @widget to @container. Typically used for simple containers such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated layout containers such as #GtkBox or #GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk_box_pack_start() and gtk_grid_attach() as an alternative to gtk_container_add() in those cases. A widget may be added to only one container at a time; you can’t place the same widget inside two different containers.
checkResize void checkResize()
childGetProperty void childGetProperty(Widget child, string propertyName, Value value): Gets the value of a child property for @child and @container.
childGetValist void childGetValist(Widget child, string firstPropertyName, void* varArgs): Gets the values of one or more child properties for @child and @container.
childNotify void childNotify(Widget child, string childProperty): Emits a #GtkWidget::child-notify signal for the [child property][child-properties] @child_property on the child.
childNotifyByPspec void childNotifyByPspec(Widget child, ParamSpec pspec): Emits a #GtkWidget::child-notify signal for the [child property][child-properties] specified by @pspec on the child.
childSetProperty void childSetProperty(Widget child, string propertyName, Value value): Sets a child property for @child and @container.
childSetValist void childSetValist(Widget child, string firstPropertyName, void* varArgs): Sets one or more child properties for @child and @container.
childType GType childType(): Returns the type of the children supported by the container.
forall void forall(GtkCallback callback, void* callbackData): Invokes @callback on each direct child of @container, including children that are considered “internal” (implementation details of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself.
foreac void foreac(GtkCallback callback, void* callbackData): Invokes @callback on each non-internal child of @container. See gtk_container_forall() for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.
getBorderWidth uint getBorderWidth(): Retrieves the border width of the container. See gtk_container_set_border_width().
getChildren ListG getChildren(): Returns the container’s non-internal children. See gtk_container_forall() for details on what constitutes an "internal" child.
getFocusChain bool getFocusChain(ListG focusableWidgets): Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores %NULL in @focusable_widgets and returns %FALSE.
getFocusChild Widget getFocusChild(): Returns the current focus child widget inside @container. This is not the currently focused widget. That can be obtained by calling gtk_window_get_focus().
getFocusHadjustment Adjustment getFocusHadjustment(): Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().
getFocusVadjustment Adjustment getFocusVadjustment(): Retrieves the vertical focus adjustment for the container. See gtk_container_set_focus_vadjustment().
getPathForChild WidgetPath getPathForChild(Widget child): Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including @child.
getResizeMode GtkResizeMode getResizeMode(): Returns the resize mode for the container. See gtk_container_set_resize_mode ().
propagateDraw void propagateDraw(Widget child, Context cr): When a container receives a call to the draw function, it must send synthetic #GtkWidget::draw calls to all children that don’t have their own #GdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its #GtkWidget::draw function, calls gtk_container_propagate_draw() once for each child, passing in the @cr the container received.
remove void remove(Widget widget): Removes @widget from @container. @widget must be inside @container. Note that @container will own a reference to @widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use @widget again, you need to add a reference to it before removing it from a container, using g_object_ref(). If you don’t want to use @widget again it’s usually more efficient to simply destroy it directly using gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles.
resizeChildren void resizeChildren()
setBorderWidth void setBorderWidth(uint borderWidth): Sets the border width of the container.
setFocusChain void setFocusChain(ListG focusableWidgets): Sets a focus chain, overriding the one computed automatically by GTK+.
setFocusChild void setFocusChild(Widget child): Sets, or unsets if @child is %NULL, the focused child of @container.
setFocusHadjustment void setFocusHadjustment(Adjustment adjustment): Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting the vertical adjustment.
setFocusVadjustment void setFocusVadjustment(Adjustment adjustment): Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting the horizontal adjustment.
setReallocateRedraws void setReallocateRedraws(bool needsRedraws): Sets the @reallocate_redraws flag of the container to the given value.
setResizeMode void setResizeMode(GtkResizeMode resizeMode): Sets the resize mode for the container.
unsetFocusChain void unsetFocusChain(): Removes a focus chain explicitly set with gtk_container_set_focus_chain().
OnAddDelegateWrapper class OnAddDelegateWrapper: Undocumented in source.
onAddListeners OnAddDelegateWrapper[] onAddListeners;: Undocumented in source.
addOnAdd gulong addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackAdd void callBackAdd(GtkContainer* containerStruct, GtkWidget* object, OnAddDelegateWrapper wrapper): Undocumented in source. Be warned that the author may not have intended to support it.
callBackAddDestroy void callBackAddDestroy(OnAddDelegateWrapper wrapper, GClosure* closure): Undocumented in source. Be warned that the author may not have intended to support it.
OnCheckResizeDelegateWrapper class OnCheckResizeDelegateWrapper: Undocumented in source.
onCheckResizeListeners OnCheckResizeDelegateWrapper[] onCheckResizeListeners;: Undocumented in source.
addOnCheckResize gulong addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
callBackCheckResize void callBackCheckResize(GtkContainer* containerStruct, OnCheckResizeDelegateWrapper wrapper): Undocumented in source. Be warned that the author may not have intended to support it.
callBackCheckResizeDestroy void callBackCheckResizeDestroy(OnCheckResizeDelegateWrapper wrapper, GClosure* closure): Undocumented in source. Be warned that the author may not have intended to support it.
OnRemoveDelegateWrapper class OnRemoveDelegateWrapper: Undocumented in source.
onRemoveListeners OnRemoveDelegateWrapper[] onRemoveListeners;: Undocumented in source.
addOnRemove gulong addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackRemove void callBackRemove(GtkContainer* containerStruct, GtkWidget* object, OnRemoveDelegateWrapper wrapper): Undocumented in source. Be warned that the author may not have intended to support it.
callBackRemoveDestroy void callBackRemoveDestroy(OnRemoveDelegateWrapper wrapper, GClosure* closure): Undocumented in source. Be warned that the author may not have intended to support it.
OnSetFocusChildDelegateWrapper class OnSetFocusChildDelegateWrapper: Undocumented in source.
onSetFocusChildListeners OnSetFocusChildDelegateWrapper[] onSetFocusChildListeners;: Undocumented in source.
addOnSetFocusChild gulong addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackSetFocusChild void callBackSetFocusChild(GtkContainer* containerStruct, GtkWidget* object, OnSetFocusChildDelegateWrapper wrapper): Undocumented in source. Be warned that the author may not have intended to support it.
callBackSetFocusChildDestroy void callBackSetFocusChildDestroy(OnSetFocusChildDelegateWrapper wrapper, GClosure* closure): Undocumented in source. Be warned that the author may not have intended to support it.