Struct zng::config::settings::editor::SettingsEditor

pub struct SettingsEditor(/* private fields */);

W Settings editor widget.

Implementations

impl SettingsEditor

pub fn category_item_fn(&self, wgt_fn: impl IntoVar<WidgetFn<CategoryItemArgs>>)

P Widget function that converts CategoryItemArgs to a category item on a category list.

Sets the CATEGORY_ITEM_FN_VAR.

impl SettingsEditor

pub fn categories_list_fn( &self, wgt_fn: impl IntoVar<WidgetFn<CategoriesListArgs>>, )

P Widget function that converts CategoriesListArgs to a category list.

Sets the CATEGORIES_LIST_FN_VAR.

impl SettingsEditor

pub fn category_header_fn( &self, wgt_fn: impl IntoVar<WidgetFn<CategoryHeaderArgs>>, )

P Widget function that converts CategoryHeaderArgs to a category settings header.

Sets the CATEGORY_HEADER_FN_VAR.

impl SettingsEditor

pub fn setting_fn(&self, wgt_fn: impl IntoVar<WidgetFn<SettingArgs>>)

P Widget function that converts SettingArgs to a setting editor entry on a settings list.

Note that the widget must set setting or some features will not work.

Sets the SETTING_FN_VAR.

impl SettingsEditor

pub fn settings_fn(&self, wgt_fn: impl IntoVar<WidgetFn<SettingsArgs>>)

P Widget function that converts SettingsArgs to a settings list.

Sets the SETTINGS_FN_VAR.

impl SettingsEditor

pub fn settings_search_fn( &self, wgt_fn: impl IntoVar<WidgetFn<SettingsSearchArgs>>, )

P Widget function that converts SettingsSearchArgs to a search box.

Sets the SETTINGS_SEARCH_FN_VAR.

impl SettingsEditor

pub fn panel_fn(&self, wgt_fn: impl IntoVar<WidgetFn<PanelArgs>>)

P Widget that defines the editor layout, bringing together the other component widgets.

impl SettingsEditor

pub fn widget_new() -> SettingsEditor

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl SettingsEditor

pub fn save_state(&self, enabled: impl IntoValue<SaveState>)

P Save and restore settings search and selected category.

This property is enabled by default in the SettingsEditor! widget, without a key. Note that without a config key this feature only actually enables if the settings widget ID has a name.

Methods from Deref<Target = WidgetBase>

pub fn widget_builder(&mut self) -> &mut WidgetBuilder

Returns a mutable reference to the widget builder.

pub fn widget_when(&mut self) -> Option<&mut WhenInfo>

Returns a mutable reference to the when block if called inside a when block.

pub fn widget_take(&mut self) -> WidgetBuilder

Takes the widget builder, finishing the widget macro build.

After this call trying to set a property using self will panic, the returned builder can still be manipulated directly.

pub fn widget_build(&mut self) -> impl UiNode

Build the widget.

After this call trying to set a property will panic.

pub fn widget_importance(&mut self) -> &mut Importance

Returns a mutable reference to the importance of the next property assigns, unsets or when blocks.

Note that during the widget_intrinsic call this is Importance::WIDGET and after it is Importance::INSTANCE.

pub fn start_when_block( &mut self, inputs: Box<[WhenInput]>, state: Box<dyn VarBoxed<bool>>, expr: &'static str, location: SourceLocation, )

Start building a when block, all properties set after this call are pushed in the when block.

pub fn end_when_block(&mut self)

End the current when block, all properties set after this call are pushed in the widget.

pub fn id(&self, id: impl IntoValue<WidgetId>)

c Unique ID of the widget instance.

Note that the id can convert from a &'static str unique name.

Trait Implementations

impl Deref for SettingsEditor

type Target = WidgetBase

The resulting type after dereferencing.

fn deref(&self) -> &<SettingsEditor as Deref>::Target

Dereferences the value.

impl DerefMut for SettingsEditor

fn deref_mut(&mut self) -> &mut <SettingsEditor as Deref>::Target

Mutably dereferences the value.