Struct SettingItem 

pub struct SettingItem {
    pub key: String,
    pub label: String,
    pub value: String,
    pub description: Option<String>,
    pub setting_type: SettingType,
    pub values: Vec<String>,
    pub has_submenu: bool,
}

A setting item.

Fields

key: String

Setting key.

label: String

Display label.

value: String

Setting value.

description: Option<String>

Description.

setting_type: SettingType

Setting type.

values: Vec<String>

Values cycled through by SettingsList::activate. Empty for submenu triggers and read-only rows.

has_submenu: bool

Whether activating the row should call on_select (open a submenu) rather than cycle values.

Implementations

impl SettingItem

pub fn new(key: &str, label: &str, value: &str) -> Self

Create a new setting item.

pub fn with_description(self, description: &str) -> Self

Add description.

pub fn with_type(self, setting_type: SettingType) -> Self

Set setting type.

pub fn with_values(self, values: &[&str]) -> Self

The cycle order for this row. Activating the row advances to the next value and fires on_change. Empty ⇒ the row is a submenu trigger or a read-only display.

pub fn with_submenu(self) -> Self

Mark the row as a submenu trigger: activating it calls on_select instead of cycling values.

Trait Implementations

impl Clone for SettingItem

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingItem

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

Formats the value using the given formatter.