Adw.ViewStack – libadwaita-1 Reference Manual

ViewStack

Object Hierarchy:

Description:

[ CCode ( type_id = "adw_view_stack_get_type ()" ) ]
[ Version ( since = "1.0" ) ]
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] 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.

Unlike [[email protected]], transitions between views are not animated.

`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 [[email protected]_page] and you can obtain a [[email protected]] containing all the pages with [[email protected]_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`.

Namespace: Adw

Package: libadwaita-1

Content:

Properties:

public bool hhomogeneous { get; set; }
Whether the stack allocates the same width for all children.
public SelectionModel pages { owned get; }
A selection model with the stack's pages.
public bool vhomogeneous { get; set; }
Whether 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 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_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 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 this to be horizontally homogeneous or not.
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:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref

All known members inherited from interface Gtk.Accessible

accessible_role
get_accessible_role
reset_property
reset_relation

reset_state
update_property
update_property_value
update_relation

update_relation_value
update_state
update_state_value

All known members inherited from interface Gtk.Buildable

add_child
custom_finished
custom_tag_end
custom_tag_start

get_buildable_id
get_id
get_internal_child

parser_finished
set_buildable_property
set_id

2022 vala-language.org