Enum SettingItem 

pub enum SettingItem {
    Item {
        title: SharedString,
        description: Option<Text>,
        keywords: Vec<SharedString>,
        layout: Axis,
        disabled: bool,
        field: Rc<dyn AnySettingField>,
    },
    Element {
        disabled: bool,
        keywords: Vec<SharedString>,
        reset_handler: Option<(Rc<dyn Fn(&App) -> bool>, Rc<dyn Fn(&mut Window, &mut App)>)>,
        render: Rc<dyn Fn(&RenderOptions, &mut Window, &mut App) -> AnyElement + 'static>,
    },
}

Setting item.

Variants

Item

A normal setting item with a title, description, and field.

Fields

title: SharedString

description: Option<Text>

keywords: Vec<SharedString>

layout: Axis

disabled: bool

field: Rc<dyn AnySettingField>

Element

A full custom element to render.

Fields

disabled: bool

keywords: Vec<SharedString>

reset_handler: Option<(Rc<dyn Fn(&App) -> bool>, Rc<dyn Fn(&mut Window, &mut App)>)>

Optional custom reset behavior. The first closure reports whether the item is “dirty” (controls reset button visibility), the second performs the reset.

render: Rc<dyn Fn(&RenderOptions, &mut Window, &mut App) -> AnyElement + 'static>

Implementations

impl SettingItem

pub fn new<F>(title: impl Into<SharedString>, field: F) -> Self

where F: AnySettingField + 'static,

Create a new setting item.

pub fn render<R, E>(render: R) -> Self

where E: IntoElement, R: Fn(&RenderOptions, &mut Window, &mut App) -> E + 'static,

Create a new custom element setting item with a render closure.

pub fn on_reset<D, R>(self, is_dirty: D, reset: R) -> Self

where D: Fn(&App) -> bool + 'static, R: Fn(&mut Window, &mut App) + 'static,

Provide custom reset behavior for a custom element item.

Only applies to SettingItem::Element (created via SettingItem::render). When set, the page-level reset button will appear while is_dirty returns true, and clicking it invokes reset.

• is_dirty reports whether the item differs from its default state.
• reset performs the reset.

pub fn keywords<I, S>(self, keywords: I) -> Self

where I: IntoIterator<Item = S>, S: Into<SharedString>,

Set additional keywords used only for search matching (not rendered).

For example, an item titled “Enable Two-factor auth” can be made searchable via “MFA”. This is also useful for custom elements that have no title/description but should still show up in search results.

pub fn disabled(self, disabled: bool) -> Self

Set whether the setting item is disabled, default is false.

A disabled item is rendered with reduced opacity. For SettingItem::Item the underlying field is also rendered in a non-interactive state. For SettingItem::Element the disabled flag is forwarded via RenderOptions::disabled so the custom renderer can disable its interactive controls.

pub fn description(self, description: impl Into<Text>) -> Self

Set the description of the setting item.

Only applies to SettingItem::Item.

pub fn layout(self, layout: Axis) -> Self

Set the layout of the setting item.

Only applies to SettingItem::Item.

Trait Implementations

impl Clone for SettingItem

fn clone(&self) -> SettingItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.