Struct Button

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

W A clickable container.

Shorthand

The Button! macro provides a shorthand init that sets the command, Button!(SOME_CMD).

Implementations

impl Button

pub fn widget_new() -> Self

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl Button

pub fn on_click(&self, handler: impl WidgetHandler<ClickArgs>)

P Button click event.

pub fn capture_pointer(&self, mode: impl IntoVar<CaptureMode>)

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

Enabled by default in this widget.

impl Button

pub fn style_fn(&self, style_fn: impl IntoVar<StyleFn>)

P 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.

impl Button

pub fn cmd(&self, cmd: impl IntoVar<Command>)

c 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().

impl Button

pub fn cmd_param<T: VarValue>(&self, cmd_param: impl IntoVar<T>)

P 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.

impl Button

pub fn cmd_child_fn(&self, cmd_child: impl IntoVar<WidgetFn<Command>>)

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

impl Button

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

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

Methods from Deref<Target = FocusableMix<StyleMix<Container>>>

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 Button

type Target = FocusableMix<StyleMix<Container>>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Button

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

Mutably dereferences the value.