Struct Checkbox

pub struct Checkbox { /* private fields */ }

A checkbox widget. Changes state when it’s clicked.

See the checkbox example for how to use it in practice.

Theming

Styling the checkbox require following properties:

• color_unchecked - The color of the checkbox, when it’s not checked (inner value is false).
• color_checked - The color of the checkbox, when it’s checked (inner value is true).

Implementations

impl Checkbox

pub fn new(value: impl Into<MaybeSignal<bool>>) -> Self

Create a new checkbox with the given value.

The value should be a signal, so it’s mutable.

pub fn with_value(self, value: impl Into<MaybeSignal<bool>>) -> Self

Sets the value of the checkbox and returns itself.

pub fn with_on_change(self, on_change: impl Into<MaybeSignal<Update>>) -> Self

Sets the update value to apply on changes.

Trait Implementations

impl Widget for Checkbox

fn render( &mut self, scene: &mut Scene, theme: &mut dyn Theme, layout_node: &LayoutNode, _: &AppInfo, _: AppContext, )

Render the widget to the canvas.

fn layout_style(&self) -> StyleNode

Return the layout style node for layout computation.

fn update( &mut self, layout: &LayoutNode, _: AppContext, info: &AppInfo, ) -> Update

Update the widget state with given info and layout. Returns if the app should be updated.

fn widget_id(&self) -> WidgetId

Return the widget id.

impl WidgetLayoutExt for Checkbox

fn set_layout_style( &mut self, layout_style: impl Into<MaybeSignal<LayoutStyle>>, )

Sets the layout style of the widget.

fn with_layout_style( self, layout_style: impl Into<MaybeSignal<LayoutStyle>>, ) -> Self

where Self: Sized,

Sets the layout style of the widget and returns self.