SidebarItem

Object Hierarchy:

Description:

[ CCode ( type_id = "adw_sidebar_item_get_type ()" ) ]
[ Version ( since = "1.9" ) ]
public class SidebarItem : Object

An item within [class@SidebarSection].

Sidebar items must have a title, set via [property@SidebarItem:title].

Sidebar items should, but are not required to, have an icon. Icons can be set from an icon name, via [property@SidebarItem:icon-name], or a [iface@Gdk.Paintable], via [property@SidebarItem:icon-paintable].

Items can also have subtitles, set with the [property@SidebarItem:subtitle] property. Subtitles should be used sparingly.

To add a tooltip, use [property@SidebarItem:tooltip]. Tooltips always use Pango markup.

Items can have an arbitrary suffix widget, set with the [property@SidebarItem:suffix] properties. It will be displayed at the end of its row, or before the arrow in the [enum@Adw.SidebarMode.page] mode.

To hide or disable the item, use the [property@SidebarItem:visible] and [property@SidebarItem:enabled] properties respectively.

To access the items's section, use [property@SidebarItem:section].

It's also possible to access the index of the item in both the section and the sidebar, using [method@SidebarItem.get_section_index] and [method@SidebarItem.get_index] respectively.

Dragging content over sidebar items activates them by default. To disable this behavior, set [property@SidebarItem:drag-motion-activate] to `FALSE`.

`AdwSidebarItem` is derivable, and applications that need to associate each page with data can store it in the items themselves this way.

Namespace: Adw

Package: libadwaita-1

Content:

Properties:

public bool drag_motion_activate { get; set; }
Whether to activate the item on pointer motion during Drag-and-Drop.
public bool enabled { get; set; }
Whether the item is enabled.
public string icon_name { get; set; }
The icon name for this item.
public Paintable icon_paintable { get; set; }
The paintable to use as the icon for this item.
public SidebarSection section { get; }
The section the item is in.
public string subtitle { get; set; }
Subtitle of the item.
public Widget suffix { get; set; }
The suffix widget for this item.
public string title { get; set; }
Title of the item.
public string tooltip { get; set; }
The tooltip of the item.
public bool use_underline { get; set; }
Whether an underline in the title indicates a mnemonic.
public bool visible { get; set; }
Whether the item is visible.

Creation methods:

public SidebarItem (string title)
Creates a new `AdwSidebarItem` with title as its title.

Methods:

public bool get_drag_motion_activate ()
Gets whether this will be activated on pointer motion during Drag-and-Drop.
public bool get_enabled ()
Gets whether this is enabled.
public unowned string? get_icon_name ()
Gets the icon name for item.
public unowned Paintable? get_icon_paintable ()
Gets the paintable used as the icon for item.
public uint get_index ()
Gets index of this within its [ class@Sidebar].
public unowned SidebarSection? get_section ()
Gets the section this is in.
public uint get_section_index ()
Gets index of this within its [ class@SidebarSection].
public unowned string? get_subtitle ()
Gets the subtitle of this.
public unowned Widget? get_suffix ()
Gets the suffix widget for this.
public unowned string? get_title ()
Gets the title of this.
public unowned string? get_tooltip ()
Gets the tooltip of this.
public bool get_use_underline ()
Gets whether an underline in the title indicates a mnemonic.
public bool get_visible ()
Gets whether this is visible.
public void set_drag_motion_activate (bool drag_motion_activate)
Sets whether to activate this on pointer motion during Drag-and-Drop.
public void set_enabled (bool enabled)
Sets whether this is enabled.
public void set_icon_name (string? icon_name)
Sets the icon name for item.
public void set_icon_paintable (Paintable? paintable)
Sets the paintable to use as the icon for item.
public void set_subtitle (string? subtitle)
Sets the subtitle of this.
public void set_suffix (Widget? suffix)
Sets the suffix widget for this.
public void set_title (string? title)
Sets the title of this.
public void set_tooltip (string? tooltip)
Sets the tooltip of this.
public void set_use_underline (bool use_underline)
Sets whether an underline in the title indicates a mnemonic.
public void set_visible (bool visible)
Sets whether this is visible.

Inherited Members:

All known members inherited from class GLib.Object