Struct cushy::widgets::checkbox::Checkbox

pub struct Checkbox {
    pub state: Dynamic<CheckboxState>,
    pub kind: Option<Value<ButtonKind>>,
    /* private fields */
}

A labeled-widget that supports three states: Checked, Unchecked, and Indeterminant

Fields

state: Dynamic<CheckboxState>

The state (value) of the checkbox.

kind: Option<Value<ButtonKind>>

The button kind to use as the basis for this checkbox. If None, the checkbox indicator will be a standalone, focusable widget.

Implementations

impl Checkbox

pub fn new(state: impl IntoDynamic<CheckboxState>) -> Self

Returns a new checkbox that updates state when clicked.

state can also be a Dynamic<bool> if there is no need to represent an indeterminant state.

pub fn labelled_by(self, label: impl MakeWidget) -> Self

Returns a new checkbox that updates state when clicked. label is drawn next to the checkbox and is also clickable to toggle the checkbox.

state can also be a Dynamic<bool> if there is no need to represent an indeterminant state.

pub fn kind(self, kind: impl IntoValue<ButtonKind>) -> Self

Updates the button kind to use as the basis for this checkbox, and returns self.

This causes the checkbox to become a regular Button, which may be desireable for layout and/or visual consistency purposes.

Trait Implementations

impl MakeWidgetWithTag for Checkbox

fn make_with_tag(self, id: WidgetTag) -> WidgetInstance

Returns a new WidgetInstance whose WidgetId comes from tag.