Class
AdwSidebar
unstable since: 1.9
Description [src]
final class Adw.Sidebar : Gtk.Widget
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
/* No available fields */
}Adaptive sidebar widget.
AdwSidebar contains AdwSidebarSection objects, which in turn contain
AdwSidebarItem objects.
To add sections, use adw_sidebar_append(), adw_sidebar_prepend() or
adw_sidebar_insert().
To remove sections, use adw_sidebar_remove() or
adw_sidebar_remove_all().
To inspect the items, use adw_sidebar_get_item() or
AdwSidebar:items.
To inspect sections themselves, use adw_sidebar_get_section() or
AdwSidebar:sections.
Selection and activation
AdwSidebar has zero or one selected items. The index of the item can be
accessed and changed via AdwSidebar:selected. Set it to
GTK_INVALID_LIST_POSITION to remove selection.
Selection cannot be permanently disabled.
AdwSidebar:selected-item can be used to access the selected item.
Connect to the AdwSidebar::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.
See also: AdwViewSwitcherSidebar.
Modes
AdwSidebar is adaptive and can act as either a regular sidebar, or a page
of boxed lists.
Use the AdwSidebar:mode to determine its look and behavior.
A typical use case involves using AdwSidebar inside the sidebar pane of a
AdwNavigationSplitView, and switching mode to page whenever it’s
collapsed, as follows:
<object class="AdwWindow">
<property name="default-width">800</property>
<property name="default-height">600</property>
<child>
<object class="AdwBreakpoint">
<condition>max-width: 400sp</condition>
<setter object="split_view" property="collapsed">True</setter>
<setter object="sidebar" property="mode">page</setter>
</object>
</child>
<property name="content">
<object class="AdwNavigationSplitView" id="split_view">
<property name="sidebar">
<object class="AdwNavigationPage">
<property name="title" translatable="yes">Sidebar</property>
<property name="child">
<object class="AdwToolbarView">
<child type="top">
<object class="AdwHeaderBar"/>
</child>
<property name="content">
<object class="AdwSidebar" id="sidebar">
<!-- Calls adw_navigation_split_view_set_show_content (split_view, TRUE); -->
<signal name="activated" handler="sidebar_activated_cb"/>
<!-- ... -->
</object>
</property>
</object>
</property>
</object>
</property>
<property name="content">
<object class="AdwNavigationPage">
<property name="title" translatable="yes">Content</property>
<property name="child">
<!-- ... -->
</property>
</object>
</property>
</object>
</property>
</object>
When used with AdwOverlaySplitView, the sidebar should stay in sidebar
mode, as the sidebar pane is still a sidebar when collapsed.
Search
AdwSidebar supports filtering items via the AdwSidebar:filter property.
Use AdwSidebar: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.
Context Menu
To create a context menu for the sidebar items, use the
AdwSidebar:menu-model property to provide a menu model, and the
AdwSidebar::setup-menu signal to set up actions for the given item.
To set or override the menu for just one section, use
AdwSidebarSection:menu-model instead.
Drag-and-Drop
AdwSidebar items can have a drop target for arbitrary content.
Use adw_sidebar_setup_drop_target() to set it up, specifying the
supported content types and drag actions, then connect to
AdwSidebar::drop to handle drops.
In some cases, it may be necessary to determine the used action based on the dragged content, or the hovered item.
To determine it based on the sidebar item, connect to the
AdwSidebar::drop-enter signal and return the action from its handler.
To determine it based on the content, set AdwSidebar:drop-preload to
TRUE, then connect to AdwSidebar::drop-value-loaded signal and return
the action from its handler.
In both cases the action will be passed as a parameter to the
AdwSidebar::drop signal.
Regardless of whether a drop target was set up, dragging content over sidebar
items activates them after a timeout. To disable this behavior for specific
items, set AdwSidebarItem:drag-motion-activate to FALSE on them.
AdwSidebar as GtkBuildable
AdwSidebar allows adding sections as children.
Example of an AdwSidebar UI definition:
<object class="AdwSidebar">
<child>
<object class="AdwSidebarSection">
<child>
<object class="AdwSidebarItem">
<property name="title" translatable="yes">Recent</property>
<property name="icon-name">document-open-recent-symbolic</property>
</object>
</child>
<child>
<object class="AdwSidebarItem">
<property name="title" translatable="yes">Starred</property>
<property name="icon-name">starred-symbolic</property>
</object>
</child>
</object>
</child>
<child>
<object class="AdwSidebarSection">
<property name="title" translatable="yes">Places</property>
<child>
<object class="AdwSidebarItem">
<property name="title" translatable="yes">Music</property>
<property name="icon-name">folder-music-symbolic</property>
</object>
</child>
<child>
<object class="AdwSidebarItem">
<property name="title" translatable="yes">Pictures</property>
<property name="icon-name">folder-pictures-symbolic</property>
</object>
</child>
<child>
<object class="AdwSidebarItem">
<property name="title" translatable="yes">Videos</property>
<property name="icon-name">folder-videos-symbolic</property>
</object>
</child>
</object>
</child>
<child>
<object class="AdwSidebarSection">
<child>
<object class="AdwSidebarItem">
<property name="title" translatable="yes">Trash</property>
<property name="icon-name">user-trash-symbolic</property>
</object>
</child>
</object>
</child>
</object>
CSS nodes
AdwSidebar has a main CSS node with the name sidebar.
Internally, it’s using a GtkListBox with the
.navigation-sidebar style class in sidebar
mode, or an AdwPreferencesPage in page mode.
Accessibility
AdwSidebar uses the GTK_ACCESSIBLE_ROLE_GENERIC role.
Available since: 1.9
Instance methods
adw_sidebar_get_drop_preload
Gets whether drop data should be preloaded on hover.
unstable since: 1.9
adw_sidebar_set_drop_preload
Sets whether drop data should be preloaded on hover.
unstable since: 1.9
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
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.Sidebar::drop-value-loaded
Emitted when the dropped content is preloaded for the item at index.
unstable 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.