Struct Checkbox

pub struct Checkbox<'a, Message, Theme = Theme, Renderer = Renderer>
where
    Renderer: Renderer,
    Theme: Catalog,
{ /* private fields */ }

A box that can be checked.

Example

use iced::widget::checkbox;

struct State {
   is_checked: bool,
}

enum Message {
    CheckboxToggled(bool),
}

fn view(state: &State) -> Element<'_, Message> {
    checkbox("Toggle me!", state.is_checked)
        .on_toggle(Message::CheckboxToggled)
        .into()
}

fn update(state: &mut State, message: Message) {
    match message {
        Message::CheckboxToggled(is_checked) => {
            state.is_checked = is_checked;
        }
    }
}

Implementations

impl<'a, Message, Theme, Renderer> Checkbox<'a, Message, Theme, Renderer>

where Renderer: Renderer, Theme: Catalog,

pub fn new( label: impl Into<String>, is_checked: bool, ) -> Checkbox<'a, Message, Theme, Renderer>

Creates a new Checkbox.

It expects:

• the label of the Checkbox
• a boolean describing whether the Checkbox is checked or not

pub fn on_toggle<F>(self, f: F) -> Checkbox<'a, Message, Theme, Renderer>

where F: 'a + Fn(bool) -> Message,

Sets the function that will be called when the Checkbox is toggled. It will receive the new state of the Checkbox and must produce a Message.

Unless on_toggle is called, the Checkbox will be disabled.

pub fn on_toggle_maybe<F>( self, f: Option<F>, ) -> Checkbox<'a, Message, Theme, Renderer>

where F: Fn(bool) -> Message + 'a,

Sets the function that will be called when the Checkbox is toggled, if Some.

If None, the checkbox will be disabled.

pub fn size( self, size: impl Into<Pixels>, ) -> Checkbox<'a, Message, Theme, Renderer>

Sets the size of the Checkbox.

pub fn width( self, width: impl Into<Length>, ) -> Checkbox<'a, Message, Theme, Renderer>

Sets the width of the Checkbox.

pub fn spacing( self, spacing: impl Into<Pixels>, ) -> Checkbox<'a, Message, Theme, Renderer>

Sets the spacing between the Checkbox and the text.

pub fn text_size( self, text_size: impl Into<Pixels>, ) -> Checkbox<'a, Message, Theme, Renderer>

Sets the text size of the Checkbox.

pub fn text_line_height( self, line_height: impl Into<LineHeight>, ) -> Checkbox<'a, Message, Theme, Renderer>

Sets the text text::LineHeight of the Checkbox.

pub fn text_shaping( self, shaping: Shaping, ) -> Checkbox<'a, Message, Theme, Renderer>

Sets the text::Shaping strategy of the Checkbox.

pub fn text_wrapping( self, wrapping: Wrapping, ) -> Checkbox<'a, Message, Theme, Renderer>

Sets the text::Wrapping strategy of the Checkbox.

pub fn font( self, font: impl Into<<Renderer as Renderer>::Font>, ) -> Checkbox<'a, Message, Theme, Renderer>

Sets the Renderer::Font of the text of the Checkbox.

pub fn icon( self, icon: Icon<<Renderer as Renderer>::Font>, ) -> Checkbox<'a, Message, Theme, Renderer>

Sets the Icon of the Checkbox.

pub fn style( self, style: impl Fn(&Theme, Status) -> Style + 'a, ) -> Checkbox<'a, Message, Theme, Renderer>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme, Status) -> Style + 'a>>,

Sets the style of the Checkbox.

pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> Checkbox<'a, Message, Theme, Renderer>

Sets the style class of the Checkbox.

pub fn name( self, name: impl Into<Cow<'a, str>>, ) -> Checkbox<'a, Message, Theme, Renderer>

Sets the name of the Checkbox.

pub fn description_widget<T>( self, description: &T, ) -> Checkbox<'a, Message, Theme, Renderer>

where T: Describes,

Sets the description of the Checkbox.

pub fn description( self, description: impl Into<Cow<'a, str>>, ) -> Checkbox<'a, Message, Theme, Renderer>

Sets the description of the Checkbox.

Trait Implementations

impl<'a, Message, Theme, Renderer> From<Checkbox<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>

where Message: 'a, Theme: 'a + Catalog, Renderer: 'a + Renderer,

fn from( checkbox: Checkbox<'a, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Checkbox<'a, Message, Theme, Renderer>

where Renderer: Renderer, Theme: Catalog,

fn a11y_nodes( &self, layout: Layout<'_>, _state: &Tree, cursor: Cursor, ) -> A11yTree

get the a11y nodes for the widget

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

fn layout(&self, tree: &mut Tree, renderer: &Renderer, limits: &Limits) -> Node

Returns the layout::Node of the Widget.

fn on_event( &mut self, _tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, ) -> Status

Processes a runtime Event.

fn mouse_interaction( &self, _tree: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, defaults: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn id(&self) -> Option<Id>

Returns the id of the widget

fn set_id(&mut self, id: Id)

Sets the id of the widget This may be called while diffing the widget tree

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

fn diff(&mut self, _tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

fn operate( &self, _state: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn overlay<'a>( &'a mut self, _state: &'a mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

Returns the overlay of the Widget, if there is any.

fn drag_destinations( &self, _state: &Tree, _layout: Layout<'_>, _renderer: &Renderer, _dnd_rectangles: &mut DndDestinationRectangles, )

Adds the drag destination rectangles of the widget. Runs after the layout phase for each widget in the tree.