Adw.ViewSwitcherSidebar

Adw.ViewSwitcherSidebar
since: 1.9
Description
[src]
final class Adw.ViewSwitcherSidebar : Gtk.Widget
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
/* No available fields */
An adaptive sidebar that controls an
AdwViewStack
AdwViewSwitcherSidebar
is a view switcher implemented using a
AdwSidebar
, in a similar fashion to
GtkStackSidebar
AdwViewSwitcherSidebar
items have an icon, a label, as well as an unread
dot or a badge.
Unlike other switchers,
AdwViewSwitcherSidebar
supports grouping pages into
sections, using the
AdwViewStackPage:starts-section
and
AdwViewStackPage:section-title
properties.
Like
AdwSidebar
AdwViewSwitcherSidebar
is adaptive and can behave as
a sidebar or a page, via the
AdwViewSwitcherSidebar:mode
property.
Connect to the
AdwViewSwitcherSidebar::activated
signal to run code when
an item has been activated. This can be used to toggle the visible pane when
used in a split view.
Like
AdwSidebar
AdwViewSwitcherSidebar
supports filtering items via the
AdwViewSwitcherSidebar:filter
property.
Use
AdwViewSwitcherSidebar:placeholder
to provide an empty state
widget. It will be shown when all items have been filtered out, or the
sidebar has no items otherwise.
Like
AdwSidebar
AdwViewSwitcherSidebar
supports prefix and suffix
widgets via the
AdwSidebar:prefix
and
AdwSidebar:suffix
properties.
CSS nodes
AdwViewSwitcherSidebar
has a single
CSS
node with name
view-switcher-sidebar
See also:
AdwViewSwitcher
AdwViewSwitcherBar
AdwInlineViewSwitcher
Available since: 1.9
Hierarchy
Ancestors
GtkWidget
GInitiallyUnowned
GObject
Implements
GtkAccessible
GtkBuildable
GtkConstraintTarget
Constructors
adw_view_switcher_sidebar_new
Creates a new
AdwViewSwitcherSidebar
since: 1.9
Instance methods
adw_view_switcher_sidebar_get_filter
Gets the item filter for
self
since: 1.9
adw_view_switcher_sidebar_get_mode
Gets
self
s look and behavior.
since: 1.9
adw_view_switcher_sidebar_get_placeholder
Gets the placeholder widget for
self
since: 1.9
adw_view_switcher_sidebar_get_prefix
Gets the widget displayed before the sidebar items.
unstable
since: 1.10
adw_view_switcher_sidebar_get_stack
Gets the stack
self
controls.
since: 1.9
adw_view_switcher_sidebar_get_suffix
Gets the widget displayed after sidebar items.
unstable
since: 1.10
adw_view_switcher_sidebar_set_filter
Sets the item filter for
self
since: 1.9
adw_view_switcher_sidebar_set_mode
Sets
self
s look and behavior.
since: 1.9
adw_view_switcher_sidebar_set_placeholder
Sets the placeholder widget for
self
since: 1.9
adw_view_switcher_sidebar_set_prefix
Sets the widget to be displayed before the sidebar items.
unstable
since: 1.10
adw_view_switcher_sidebar_set_stack
Sets the stack to control.
since: 1.9
adw_view_switcher_sidebar_set_suffix
Sets the widget to be displayed after the sidebar items.
unstable
since: 1.10
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.ViewSwitcherSidebar:filter
The item filter.
since: 1.9
Adw.ViewSwitcherSidebar:mode
Determines the sidebar’s look and behavior.
since: 1.9
Adw.ViewSwitcherSidebar:placeholder
The placeholder widget.
since: 1.9
Adw.ViewSwitcherSidebar:prefix
A widget to be displayed before the sidebar items.
unstable
since: 1.10
Adw.ViewSwitcherSidebar:stack
The stack the sidebar controls.
since: 1.9
Adw.ViewSwitcherSidebar:suffix
A widget to be displayed after the sidebar items.
unstable
since: 1.10
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
Adw.ViewSwitcherSidebar::activated
Emitted when an item has been activated.
since: 1.9
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 AdwViewSwitcherSidebarClass {
GtkWidgetClass parent_class;

No description available.
Class members
parent_class: GtkWidgetClass
No description available.