Struct Checkbox 

pub struct Checkbox<Msg> { /* private fields */ }

A box that is checked or not, with an optional label.

The default box is two cells of solid colour that blend from the empty tone to the filled tone over the theme’s motion.step times three when it changes; with reduced motion the change is immediate. A partly checked box (a parent of some checked items) fills its left cell. CheckboxStyle::Check draws the older three-cell box with a check or a dash. Enter, Space or a click on the box or the label toggles it. The application owns the state.

Style keys: checkbox (bg, fg) with states hover, focus, checked, disabled and variant partial (check style); checkbox-label (fg, bold) with the same states.

Implementations

impl<Msg> Checkbox<Msg>

pub fn new(checked: bool) -> Self

A checkbox showing checked.

pub fn label(self, label: impl Into<String>) -> Self

Text after the box; clicking it toggles too.

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

Shows the box partly checked. Toggling a partly checked box asks for true.

pub fn style(self, style: CheckboxStyle) -> Self

Chooses how the box looks.

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

Greys the checkbox out; it cannot be focused or toggled.

pub fn on_toggle(self, message: impl Fn(bool) -> Msg + 'static) -> Self

Message for the new state when the checkbox is toggled.

Trait Implementations

impl<Msg: 'static> Widget<Msg> for Checkbox<Msg>

fn measure(&self, _cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.