Adw.ViewSwitcherSidebar – libadwaita-1

Description:

[ CCode ( type_id = "adw_view_switcher_sidebar_get_type ()" ) ]
[ Version ( since = "1.9" ) ]
public sealed class ViewSwitcherSidebar : Widget, Accessible, Buildable, ConstraintTarget

An adaptive sidebar that controls an [class@ViewStack].

`AdwViewSwitcherSidebar` is a view switcher implemented using a [class@Sidebar], in a similar fashion to [class@Gtk.StackSidebar].

`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 [property@ViewStackPage:starts-section] and [property@ViewStackPage:section-title] properties.

Like [class@Sidebar], `AdwViewSwitcherSidebar` is adaptive and can behave as a sidebar or a page, via the [ property@ViewSwitcherSidebar:mode] property.

Connect to the [signal@ViewSwitcherSidebar: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 [property@ViewSwitcherSidebar:filter] property.

Use [property@ViewSwitcherSidebar: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 [property@Sidebar:prefix] and [ property@Sidebar:suffix] properties.

CSS nodes

`AdwViewSwitcherSidebar` has a single CSS node with name `view-switcher-sidebar`.

See also: [class@ViewSwitcher], [class@ViewSwitcherBar], [class@InlineViewSwitcher].

Namespace: Adw

Content:

Properties:

public Filter filter { get; set; }

The item filter.

public SidebarMode mode { get; set; }

Determines the sidebar's look and behavior.

public Widget placeholder { get; set; }

The placeholder widget.

public Widget prefix { get; set; }

A widget to be displayed before the sidebar items.

public ViewStack stack { get; set; }

The stack the sidebar controls.

public Widget suffix { get; set; }

A widget to be displayed after the sidebar items.

Creation methods:

public ViewSwitcherSidebar ()

Creates a new `AdwViewSwitcherSidebar`.

Methods:

public unowned Filter? get_filter ()

Gets the item filter for this.

public SidebarMode get_mode ()

Gets this's look and behavior.

public unowned Widget? get_placeholder ()

Gets the placeholder widget for this .

public unowned Widget? get_prefix ()

Gets the widget displayed before the sidebar items.

public unowned ViewStack? get_stack ()

Gets the stack this controls.

public unowned Widget? get_suffix ()

Gets the widget displayed after sidebar items.

public void set_filter (Filter? filter)

Sets the item filter for this.

public void set_mode (SidebarMode mode)

Sets this's look and behavior.

public void set_placeholder (Widget? placeholder)

Sets the placeholder widget for this .

public void set_prefix (Widget? prefix)

Sets the widget to be displayed before the sidebar items.

public void set_stack (ViewStack? stack)

Sets the stack to control.

public void set_suffix (Widget? suffix)

Sets the widget to be displayed after the sidebar items.

Signals:

public signal void activated ()

Emitted when an item has been activated.

Inherited Members:

ViewSwitcherSidebar

Object Hierarchy: