Adw.ViewStack – libadwaita-1 – Vala Binding Reference

Description:

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

A view container for [class@ViewSwitcher].

`AdwViewStack` is a container which only shows one page at a time. It is typically used to hold an application's main views.

It doesn't provide a way to transition between pages. Instead, a separate widget such as [class@ViewSwitcher], [class@InlineViewSwitcher] or [class@ViewSwitcherSidebar] can be used with `AdwViewStack` to provide this functionality.

`AdwViewStack` pages can have a title, an icon, an attention request, and a numbered badge that [class@ViewSwitcher] will use to let users identify which page is which. Set them using the [property@ViewStackPage:title], [property@ViewStackPage:icon-name], [ property@ViewStackPage:needs-attention], and [property@ViewStackPage:badge-number] properties.

`AdwViewStack` pages can also be grouped into sections, using the [property@ViewStackPage:starts-section] and [ property@ViewStackPage:section-title] properties. Currently, only [class@ViewSwitcherSidebar] displays groups.

Unlike [class@Gtk.Stack], transitions between views can only be animated via a crossfade and size changes are always interpolated. Animations are disabled by default. Use [property@ViewStack:enable-transitions] to enable them.

`AdwViewStack` maintains a [class@ViewStackPage] object for each added child, which holds additional per-child properties. You obtain the [class@ViewStackPage] for a child with [method@ViewStack.get_page] and you can obtain a [iface@Gtk.SelectionModel] containing all the pages with [method@ViewStack.get_pages].

AdwViewStack as GtkBuildable

To set child-specific properties in a .ui file, create [class@ViewStackPage] objects explicitly, and set the child widget as a property on it:

```xml <object class="AdwViewStack" id="stack"> <child> <object class="AdwViewStackPage"> <property name="name" >overview</property> <property name="title">Overview</property> <property name="child"> <object class="AdwStatusPage"> <property name="title">Welcome!</property> </object> </property> </object> </child> </object> ```

CSS nodes

`AdwViewStack` has a single CSS node named `stack`.

Accessibility

`AdwViewStack` uses the [enum@Gtk.AccessibleRole.tab-panel] for the stack pages which are the accessible parent objects of the child widgets.

Namespace: Adw

Content:

Properties:

public bool enable_transitions { get; set; }

Whether the stack uses a crossfade transition between pages.

public bool hhomogeneous { get; set; }

Whether the stack is horizontally homogeneous.

public SelectionModel pages { owned get; }

A selection model with the stack's pages.

public uint transition_duration { get; set; }

The transition animation duration, in milliseconds.

public bool transition_running { get; }

Whether a transition is currently running.

public bool vhomogeneous { get; set; }

Whether the stack is vertically homogeneous.

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 ViewStack ()

Creates a new `AdwViewStack`.

Methods:

public unowned ViewStackPage add (Widget child)

Adds a child to this.

public unowned ViewStackPage add_named (Widget child, string? name)

Adds a child to this.

public unowned ViewStackPage add_titled (Widget child, string? name, string title)

Adds a child to this.

public unowned ViewStackPage add_titled_with_icon (Widget child, string? name, string title, string icon_name)

Adds a child to this.

public unowned Widget? get_child_by_name (string name)

Finds the child with name in this.

public bool get_enable_transitions ()

Gets whether this uses a crossfade transition between pages.

public bool get_hhomogeneous ()

Gets whether this is horizontally homogeneous.

public unowned ViewStackPage get_page (Widget child)

Gets the [class@ViewStackPage] object for child.

public SelectionModel get_pages ()

Returns a [iface@Gio.

public uint get_transition_duration ()

Gets the transition animation duration for this.

public bool get_transition_running ()

Gets whether a transition is currently running for 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_enable_transitions (bool enable_transitions)

Sets whether this uses a crossfade transition between pages.

public void set_hhomogeneous (bool hhomogeneous)

Sets this to be horizontally homogeneous or not.

public void set_transition_duration (uint duration)

Sets the transition animation duration for this.

public void set_vhomogeneous (bool vhomogeneous)

Sets this 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_name (string name)

Makes the child with name visible.

Inherited Members:

ViewStack

Object Hierarchy:

Description:

AdwViewStack as GtkBuildable

CSS nodes

Accessibility

Content:

Properties:

Creation methods:

Methods:

Inherited Members: