Struct Toggle

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

W A toggle button that flips a bool or Option<bool> variable on click, or selects a value.

This widget has three primary properties, checked, checked_opt and value, setting one of the checked properties to a read-write variable enables the widget and it will set the variables on click, setting value turns the toggle in a selection item that is inserted/removed in a contextual selector.

Properties

pub style_fn(style_fn: impl IntoVar<StyleFn>);

Extends or replaces the widget style.

Properties and when conditions in the style are applied to the widget. Style instances extend the contextual style by default, you can set replace on a style to true to fully replace.

pub checked(checked: impl IntoVar<bool>);

Toggle cycles between true and false, updating the variable.

Note that you can read the checked state of the widget using is_checked.

pub checked_opt(checked: impl IntoVar<Option<bool>>);

Toggle cycles between Some(true) and Some(false) and accepts None, if the widget is tristate also sets to None in the toggle cycle.

pub tristate(enabled: impl IntoVar<bool>);

Enables None as an input value.

Note that None is always accepted in checked_opt, this property controls if None is one of the values in the toggle cycle. If the widget is bound to the checked property this config is ignored.

This is not enabled by default.

pub is_checked(state: impl IntoVar<bool>);

If the toggle is checked from any of the three primary properties.

Note to read the tristate directly use IS_CHECKED_VAR directly.

pub value<T: VarValue>(value: impl IntoVar<T>);

Values that is selected in the contextual selector.

The widget is_checked when the value is selected, on click and on value update, the selection is updated according to the behavior defined in the contextual selector. If no contextual selector is the widget is never checked.

Note that the value can be any type, but must be one of the types accepted by the contextual selector, type validation happens in run-time, an error is logged if the type is not compatible. Because any type can be used in this property type inference cannot resolve the type automatically and a type annotation is required: value<T> = t;.

This property interacts with the contextual selector, when the widget is clicked or the value variable changes the contextual Selector is used to implement the behavior.

pub scroll_on_select(enabled: impl IntoVar<bool>);

If the scrolls into view when the value selected.

This is enabled by default.

pub selector(selector: impl IntoValue<Selector>);

Sets the contextual selector that all inner widgets will target from the value property.

All value properties declared in widgets inside child will use the Selector to manipulate the selection.

Selection in a context can be blocked by setting the selector to Selector::nil(), this is also the default selector so the value property only works if a contextual selector is present.

This property sets the SELECTOR context and handles cmd::SelectOp requests. It also sets the widget access role to AccessRole::RadioGroup.

pub select_on_init(enabled: impl IntoVar<bool>);

If value is selected when the widget that has the value is inited.

pub deselect_on_deinit(enabled: impl IntoVar<bool>);

If value is deselected when the widget that has the value is deinited and the value was selected.

pub select_on_new(enabled: impl IntoVar<bool>);

If value selects the new value when the variable changes and the previous value was selected.

pub deselect_on_new(enabled: impl IntoVar<bool>);

If value deselects the previously selected value when the variable changes.

pub checked_popup(popup: impl IntoVar<WidgetFn<()>>);

Popup open when the toggle button is checked.

This property can be used together with the ComboStyle! to implement a combo-box flyout widget.

The popup can be any widget, that will be open using POPUP, a Popup! or derived widget is recommended.

Note that if the checked property is not set the toggle will never be checked, to implement a drop-down menu set checked = var(false);.

Properties from Button

pub on_click(handler: impl WidgetHandler<ClickArgs>);

Button click event.

pub capture_pointer(mode: impl IntoVar<CaptureMode>);

If pointer interaction with other widgets is blocked while the button is pressed.

Enabled by default in this widget.

pub cmd(cmd: impl IntoVar<Command>);

Sets the Command the button represents.

When this is set the button widget sets these properties if they are not set:

• child: Set to a widget produced by cmd_child_fn, by default is Text!(cmd.name()).
• tooltip_fn: Set to a widget function provided by cmd_tooltip_fn, by default it shows the command info and first shortcut.
• enabled: Set to cmd.is_enabled().
• visibility: Set to cmd.has_handlers().into().
• on_click: Set to a handler that notifies the command if cmd.is_enabled().
• on_disabled_click: Set to a handler that notifies the command if !cmd.is_enabled().

pub cmd_param<T>(cmd_param: impl IntoVar<T>)

where T: VarValue,

;

Optional command parameter for the button to use when notifying cmd.

If T is Option<CommandParam> the param can be dynamically unset, otherwise the value is the param.

pub cmd_child_fn(cmd_child: impl IntoVar<WidgetFn<Command>>);

Sets the widget function used to produce the button child when cmd is set and child is not.

pub cmd_tooltip_fn( &self, cmd_tooltip: impl IntoVar<WidgetFn<CmdTooltipArgs>>, );

Sets the widget function used to produce the button tooltip when cmd is set and tooltip is not.

Properties from Container

pub clip_to_bounds(clip: impl IntoVar<bool>);

Content overflow clipping.

pub child(child: impl UiNode);

The widget’s child.

Can be any type that implements UiNode, any widget.

In Container! derived widgets or similar this property is captured and used as the actual child, in other widgets this property is an alias for child_under.

pub padding(padding: impl IntoVar<SideOffsets>);

Margin space around the content of a widget.

This property is margin with nest group CHILD_LAYOUT.

pub child_align(alignment: impl IntoVar<Align>);

Aligns the widget content within the available space.

This property is align with nest group CHILD_LAYOUT.

pub child_insert( &self, placement: impl IntoVar<ChildInsert>, node: impl UiNode, spacing: impl IntoVar<Length>, );

Insert node in the placement relative to the widget’s child.

This property disables inline layout for the widget.

pub child_out_insert( &self, placement: impl IntoVar<ChildInsert>, node: impl UiNode, spacing: impl IntoVar<Length>, );

Insert node in the placement relative to the widget’s child, outside of the child layout.

This is still inside the parent widget, but outside of properties like padding.

This property disables inline layout for the widget.

pub child_left(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the left of the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

pub child_right(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the right of the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

pub child_top(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node above the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

pub child_bottom(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node below the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

pub child_start(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the left of the widget’s child in LTR contexts or to the right in RTL contexts.

This property disables inline layout for the widget. See child_insert for more details.

pub child_end(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the right of the widget’s child in LTR contexts or to the right of the widget’s child in RTL contexts.

This property disables inline layout for the widget. See child_insert for more details.

pub child_over(node: impl UiNode);

Insert node over the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

pub child_under(node: impl UiNode);

Insert node under the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

pub child_out_left(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the left of the widget’s child, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_right(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the right of the widget’s child, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_top(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node above the widget’s child, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_bottom(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node below the widget’s child, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_start(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the left of the widget’s child in LTR contexts or to the right in RTL contexts, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_end(node: impl UiNode, spacing: impl IntoVar<Length>);

Insert node to the right of the widget’s child in LTR contexts or to the right of the widget’s child in RTL contexts, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_over(node: impl UiNode);

Insert node over the widget’s child, not affected by child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

pub child_out_under(node: impl UiNode);

Insert node under the widget’s child, not affected by child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

Properties from WidgetBase

pub id(id: impl IntoValue<WidgetId>);

Unique ID of the widget instance.

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

Implementations

impl Toggle

pub fn widget_new() -> Self

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

Loading...

pub fn focusable(&self, focusable: impl IntoVar<bool>)

P Makes the widget focusable when set to true.

pub fn is_focused(&self, state: impl IntoVar<bool>)

P If the widget has keyboard focus.

This is only true if the widget itself is focused. Use is_focus_within to include focused widgets inside this one.

Highlighting

This property is always true when the widget has focus, independent of what device moved the focus, usually when the keyboard is used a special visual indicator is rendered, a dotted line border is common, this state is called highlighting and is tracked by the focus manager. To implement such a visual you can use the is_focused_hgl property.

Return Focus

Usually widgets that have a visual state for this property also have one for is_return_focus, a common example is the text-input widget that shows an emphasized border and blinking cursor when focused and still shows the emphasized border without cursor when a menu is open and it is only the return focus.

pub fn is_focus_within(&self, state: impl IntoVar<bool>)

P If the widget or one of its descendants has keyboard focus.

To check if only the widget has keyboard focus use is_focused.

To track highlighted focus within use is_focus_within_hgl property.

pub fn is_focused_hgl(&self, state: impl IntoVar<bool>)

P If the widget has keyboard focus and the user is using the keyboard to navigate.

This is only true if the widget itself is focused and the focus was acquired by keyboard navigation. You can use is_focus_within_hgl to include widgets inside this one.

Highlighting

Usually when the keyboard is used to move the focus a special visual indicator is rendered, a dotted line border is common, this state is called highlighting and is tracked by the focus manager, this property is only true.

pub fn is_focus_within_hgl(&self, state: impl IntoVar<bool>)

P If the widget or one of its descendants has keyboard focus and the user is using the keyboard to navigate.

To check if only the widget has keyboard focus use is_focused_hgl.

Also see is_focus_within to check if the widget has focus within regardless of highlighting.

pub fn is_return_focus(&self, state: impl IntoVar<bool>)

P If the widget will be focused when a parent scope is focused.

Focus scopes can remember the last focused widget inside, the focus returns to this widget when the scope receives focus. Alt scopes also remember the widget from which the alt focus happened and can also return focus back to that widget.

Usually input widgets that have a visual state for is_focused also have a visual for this, a common example is the text-input widget that shows an emphasized border and blinking cursor when focused and still shows the emphasized border without cursor when a menu is open and it is only the return focus.

Note that a widget can be is_focused and is_return_focus, this property is true if any focus scope considers the widget its return focus, you probably want to declare the widget visual states in such a order that is_focused overrides the state of this property.

pub fn is_return_focus_within(&self, state: impl IntoVar<bool>)

P If the widget or one of its descendants will be focused when a focus scope is focused.

To check if only the widget is the return focus use is_return_focus.

pub fn focus_on_init(&self, enabled: impl IntoVar<bool>)

P If the widget is focused on info init.

When the widget is inited and present in the info tree a FOCUS.focus_widget_or_related request is made for the widget.

pub fn return_focus_on_deinit(&self, enabled: impl IntoVar<bool>)

P If the widget return focus to the previous focus when it inited.

This can be used with the modal property to declare modal dialogs that return the focus to the widget that opens the dialog.

Consider using focus_click_behavior if the widget is also an ALT focus scope.

pub fn focus_highlight( &self, offsets: impl IntoVar<SideOffsets>, widths: impl IntoVar<SideOffsets>, sides: impl IntoVar<BorderSides>, )

P Sets the foreground highlight values used when the widget is focused and highlighted.

Trait Implementations

impl Deref for Toggle

type Target = Button

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Toggle

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.