SidebarSection

Object Hierarchy:

Description:

[ CCode ( type_id = "adw_sidebar_section_get_type ()" ) ]
[ Version ( since = "1.9" ) ]
public sealed class SidebarSection : Object, Buildable

A section within [class@Sidebar].

`AdwSidebarSection` contains [class@SidebarItem] objects.

Section can optionally have a title, set with the [property@SidebarSection:title] property. If a title is not set, the section will have a separator in front of it, or just spacing in the [enum@Adw.SidebarMode.page] mode.

To add items, use [method@SidebarSection.append], [method@SidebarSection.prepend] or [method@SidebarSection.insert].

To remove items, use [method@SidebarSection.remove] or [method@SidebarSection.remove_all].

To inspect the items, use [method@SidebarSection.get_item] or [property@SidebarSection:items].

To get the sidebar the section is in, use[property@SidebarSection:sidebar].

Binding models

`AdwSidebarSection` can show items from a provided [iface@Gio.ListModel], using [method@SidebarSection.bind_model]. It works the same way as [method@Gtk.ListBox.bind_model], except the provided function creates an [class@SidebarItem] rather than a [class@Gtk.ListBoxRow].

While a model is bound, adding or removing items manually is not allowed. Inspecting them is still allowed, but discouraged.

`AdwSidebarSection` as `GtkBuildable`

`AdwSidebarSection` allows adding items as children.

Example of an `AdwSidebarSection` UI definition:

```xml <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> ```

Result:

Namespace: Adw

Package: libadwaita-1

Content:

Properties:

public ListModel items { owned get; }
A list model with the section's items.
public MenuModel menu_model { get; set; }
Context menu model for the section items.
public Sidebar sidebar { get; }
The sidebar the section is in.
public string title { get; set; }
Title of the section.

Creation methods:

public SidebarSection ()
Creates a new `AdwSidebarSection`.

Methods:

public void append (owned SidebarItem item)
Appends item to this.
public void bind_model (ListModel? model, owned SidebarSectionCreateItemFunc? create_item_func)
Binds model to this.
public unowned SidebarItem? get_item (uint index)
Gets the item at index within this.
public ListModel get_items ()
Gets a list model with this's items.
public unowned MenuModel? get_menu_model ()
Gets the context menu model for this 's items.
public unowned Sidebar? get_sidebar ()
Gets the sidebar this is in.
public unowned string? get_title ()
Gets the title of this.
public void insert (owned SidebarItem item, int position)
Inserts item at position to this.
public void prepend (owned SidebarItem item)
Prepends item to this.
public void remove (SidebarItem item)
Removes item from this.
public void remove_all ()
Removes all items from this.
public void set_menu_model (MenuModel? menu_model)
Sets the context menu model for this 's items.
public void set_title (string? title)
Sets the title of this.

Inherited Members:

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Buildable