Adw.ViewStack
Description
[src]
final class Adw.ViewStack : Gtk.Widget
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
/* No available fields */
A view container for
AdwViewSwitcher
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
AdwViewSwitcher
AdwInlineViewSwitcher
or
AdwViewSwitcherSidebar
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
AdwViewSwitcher
will use to let users identify which
page is which. Set them using the
AdwViewStackPage:title
AdwViewStackPage:icon-name
AdwViewStackPage:needs-attention
, and
AdwViewStackPage:badge-number
properties.
AdwViewStack
pages can also be grouped into sections, using the
AdwViewStackPage:starts-section
and
AdwViewStackPage:section-title
properties. Currently, only
AdwViewSwitcherSidebar
displays groups.
Unlike
GtkStack
, transitions between views can only be animated via
a crossfade and size changes are always interpolated. Animations are disabled
by default. Use
AdwViewStack:enable-transitions
to enable them.
AdwViewStack
maintains a
AdwViewStackPage
object for each added child,
which holds additional per-child properties. You obtain the
AdwViewStackPage
for a child with
adw_view_stack_get_page()
and you
can obtain a
GtkSelectionModel
containing all the pages with
adw_view_stack_get_pages()
AdwViewStack as GtkBuildable
To set child-specific properties in a .ui file, create
AdwViewStackPage
objects explicitly, and set the child widget as a
property on it:
"AdwViewStack"
id=
"stack"
"AdwViewStackPage"
"name"
overview
"title"
Overview
"child"
"AdwStatusPage"
"title"
Welcome!
CSS nodes
AdwViewStack
has a single
CSS
node named
stack
AdwViewStack
uses the
GTK_ACCESSIBLE_ROLE_TAB_PANEL
for the stack
pages which are the accessible parent objects of the child widgets.
Hierarchy
Ancestors
GtkWidget
GInitiallyUnowned
GObject
Implements
GtkAccessible
GtkBuildable
GtkConstraintTarget
Constructors
adw_view_stack_new
Creates a new
AdwViewStack
Instance methods
adw_view_stack_add
Adds a child to
self
adw_view_stack_add_named
Adds a child to
self
adw_view_stack_add_titled
Adds a child to
self
adw_view_stack_add_titled_with_icon
Adds a child to
self
since: 1.2
adw_view_stack_get_child_by_name
Finds the child with
name
in
self
adw_view_stack_get_enable_transitions
Gets whether
self
uses a crossfade transition between pages.
since: 1.7
adw_view_stack_get_hhomogeneous
Gets whether
self
is horizontally homogeneous.
adw_view_stack_get_page
Gets the
AdwViewStackPage
object for
child
adw_view_stack_get_pages
Returns a
GListModel
that contains the pages of the stack.
adw_view_stack_get_transition_duration
Gets the transition animation duration for
self
since: 1.7
adw_view_stack_get_transition_running
Gets whether a transition is currently running for
self
since: 1.7
adw_view_stack_get_vhomogeneous
Gets whether
self
is vertically homogeneous.
adw_view_stack_get_visible_child
Gets the currently visible child of
self
adw_view_stack_get_visible_child_name
Returns the name of the currently visible child of
self
adw_view_stack_remove
Removes a child widget from
self
adw_view_stack_set_enable_transitions
Sets whether
self
uses a crossfade transition between pages.
since: 1.7
adw_view_stack_set_hhomogeneous
Sets
self
to be horizontally homogeneous or not.
adw_view_stack_set_transition_duration
Sets the transition animation duration for
self
since: 1.7
adw_view_stack_set_vhomogeneous
Sets
self
to be vertically homogeneous or not.
adw_view_stack_set_visible_child
Makes
child
the visible child of
self
adw_view_stack_set_visible_child_name
Makes the child with
name
visible.
Methods inherited from
GtkWidget
(164)
Please see
GtkWidget
for a full list of methods.
Methods inherited from
GObject
(43)
Please see
GObject
for a full list of methods.
Methods inherited from
GtkAccessible
(21)
gtk_accessible_announce
Requests the user’s screen reader to announce the given message.
gtk_accessible_get_accessible_id
Retrieves the accessible identifier for the accessible object.
gtk_accessible_get_accessible_parent
Retrieves the accessible parent for an accessible object.
gtk_accessible_get_accessible_role
Retrieves the accessible role of an accessible object.
gtk_accessible_get_at_context
Retrieves the implementation for the given accessible object.
gtk_accessible_get_bounds
Queries the coordinates and dimensions of this accessible.
gtk_accessible_get_first_accessible_child
Retrieves the first accessible child of an accessible object.
gtk_accessible_get_next_accessible_sibling
Retrieves the next accessible sibling of an accessible object.
gtk_accessible_get_platform_state
Queries a platform state, such as focus.
gtk_accessible_reset_property
Resets the accessible property to its default value.
gtk_accessible_reset_relation
Resets the accessible relation to its default value.
gtk_accessible_reset_state
Resets the accessible state to its default value.
gtk_accessible_set_accessible_parent
Sets the parent and sibling of an accessible object.
gtk_accessible_update_next_accessible_sibling
Updates the next accessible sibling.
gtk_accessible_update_platform_state
Informs ATs that the platform state has changed.
gtk_accessible_update_property
Updates a list of accessible properties.
gtk_accessible_update_property_value
Updates an array of accessible properties.
gtk_accessible_update_relation
Updates a list of accessible relations.
gtk_accessible_update_relation_value
Updates an array of accessible relations.
gtk_accessible_update_state
Updates a list of accessible states.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from
GtkBuildable
(1)
gtk_buildable_get_buildable_id
Gets the
ID
of the
buildable
object.
Properties
Adw.ViewStack:enable-transitions
Whether the stack uses a crossfade transition between pages.
since: 1.7
Adw.ViewStack:hhomogeneous
Whether the stack is horizontally homogeneous.
Adw.ViewStack:pages
A selection model with the stack’s pages.
Adw.ViewStack:transition-duration
The transition animation duration, in milliseconds.
since: 1.7
Adw.ViewStack:transition-running
Whether a transition is currently running.
since: 1.7
Adw.ViewStack:vhomogeneous
Whether the stack is vertically homogeneous.
Adw.ViewStack:visible-child
The widget currently visible in the stack.
Adw.ViewStack:visible-child-name
The name of the widget currently visible in the stack.
Properties inherited from
GtkWidget
(35)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept
the input focus.
Gtk.Widget:can-target
Whether the widget can receive pointer events.
Gtk.Widget:css-classes
A list of css classes applied to this widget.
Gtk.Widget:css-name
The name of this widget in the
CSS
tree.
Gtk.Widget:cursor
The cursor used by
widget
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
Gtk.Widget:has-default
Whether the widget is the default widget.
Gtk.Widget:has-focus
Whether the widget has the input focus.
Gtk.Widget:has-tooltip
Enables or disables the emission of the
GtkWidget::query-tooltip
signal on
widget
Gtk.Widget:height-request
Overrides for height request of the widget.
Gtk.Widget:hexpand
Whether to expand horizontally.
Gtk.Widget:hexpand-set
Whether to use the
hexpand
property.
Gtk.Widget:layout-manager
The
GtkLayoutManager
instance to use to compute
the preferred size of the widget, and allocate its children.
Gtk.Widget:limit-events
Makes this widget act like a modal dialog, with respect to
event delivery.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
The name of the widget.
Gtk.Widget:opacity
The requested opacity of the widget.
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
Gtk.Widget:parent
The parent widget of this widget.
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
Gtk.Widget:root
The
GtkRoot
widget of the widget tree containing this widget.
Gtk.Widget:scale-factor
The scale factor of the widget.
Gtk.Widget:sensitive
Whether the widget responds to input.
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up
with Pango markup.
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
Gtk.Widget:vexpand
Whether to expand vertically.
Gtk.Widget:vexpand-set
Whether to use the
vexpand
property.
Gtk.Widget:visible
Whether the widget is visible.
Gtk.Widget:width-request
Overrides for width request of the widget.
Properties inherited from
GtkAccessible
(1)
Gtk.Accessible:accessible-role
The accessible role of the given
GtkAccessible
implementation.
Signals
Signals inherited from
GtkWidget
(13)
GtkWidget::destroy
Signals that all holders of a reference to the widget should release
the reference that they hold.
GtkWidget::direction-changed
Emitted when the text direction of a widget changes.
GtkWidget::hide
Emitted when
widget
is hidden.
GtkWidget::keynav-failed
Emitted if keyboard navigation fails.
GtkWidget::map
Emitted when
widget
is going to be mapped.
GtkWidget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
GtkWidget::move-focus
Emitted when the focus is moved.
GtkWidget::query-tooltip
Emitted when the widget’s tooltip is about to be shown.
GtkWidget::realize
Emitted when
widget
is associated with a
GdkSurface
GtkWidget::show
Emitted when
widget
is shown.
GtkWidget::state-flags-changed
Emitted when the widget state changes.
GtkWidget::unmap
Emitted when
widget
is going to be unmapped.
GtkWidget::unrealize
Emitted when the
GdkSurface
associated with
widget
is destroyed.
Signals inherited from
GObject
(1)
GObject::notify
The notify signal is emitted on an object when one of its properties has
its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct AdwViewStackClass {
GtkWidgetClass parent_class;
No description available.
Class members
parent_class: GtkWidgetClass
No description available.