Struct SidebarItem 

pub struct SidebarItem { /* private fields */ }

Available on crate feature v1_9 only.

An item within SidebarSection.

Sidebar items must have a title, set via title.

Sidebar items should, but are not required to, have an icon. Icons can be set from an icon name, via icon-name, or a gdk::Paintable, via icon-paintable.

Items can also have subtitles, set with the subtitle property. Subtitles should be used sparingly.

To add a tooltip, use tooltip. Tooltips always use Pango markup.

Items can have an arbitrary suffix widget, set with the 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 visible and enabled properties respectively.

To access the items’s section, use section.

It’s also possible to access the index of the item in both the section and the sidebar, using SidebarItemExt::section_index() and SidebarItemExt::index() respectively.

Dragging content over sidebar items activates them by default. To disable this behavior, set drag-motion-activate to FALSE.

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

Properties

drag-motion-activate

Whether to activate the item on pointer motion during Drag-and-Drop.

This is needed to be able to drag content into the page the item represents, when the sidebar is used as a page switcher. However, it may be unwanted when dropping content onto the item itself, so it can be disabled.

Readable | Writeable

enabled

Whether the item is enabled.

See sensitive.

Readable | Writeable

icon-name

The icon name for this item.

Mutually exclusive with icon-paintable.

Readable | Writeable

icon-paintable

The paintable to use as the icon for this item.

Mutually exclusive with icon-name.

Readable | Writeable

section

The section the item is in.

Readable

subtitle

Subtitle of the item.

Readable | Writeable

suffix

The suffix widget for this item.

Suffix will be shown at the end of the item’s row, or before the arrow in the [enum@Adw.SidebarMode.PAGE] mode.

Readable | Writeable

title

Title of the item.

Readable | Writeable

tooltip

The tooltip of the item.

The tooltip can be marked up with the Pango text markup language.

Readable | Writeable

use-underline

Whether an underline in the title indicates a mnemonic.

The mnemonic can be used to activate the item.

Readable | Writeable

visible

Whether the item is visible.

Readable | Writeable

Implements

SidebarItemExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl SidebarItem

pub const NONE: Option<&'static SidebarItem> = None

pub fn new(title: &str) -> SidebarItem

Creates a new SidebarItem with @title as its title.

title

the item title

Returns

the newly created SidebarItem

pub fn builder() -> SidebarItemBuilder

Creates a new builder-pattern struct instance to construct SidebarItem objects.

This method returns an instance of SidebarItemBuilder which can be used to create SidebarItem objects.

Trait Implementations

impl Clone for SidebarItem

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SidebarItem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SidebarItem

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SidebarItem

type ParamSpec = ParamSpecObject

type SetValue = SidebarItem

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, SidebarItem>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SidebarItem

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: SidebarItemImpl> IsSubclassable<T> for SidebarItem

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for SidebarItem

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for SidebarItem

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for SidebarItem

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for SidebarItem

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SidebarItem

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SidebarItem