Struct iced_native::widget::checkbox::Checkbox

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

A box that can be checked.

Example

pub enum Message {
    CheckboxToggled(bool),
}

let is_checked = true;

Checkbox::new(is_checked, "Toggle me!", Message::CheckboxToggled);

Implementations

impl<'a, Message, Renderer> Checkbox<'a, Message, Renderer> where
    Renderer: Renderer,
    Renderer::Theme: StyleSheet + StyleSheet, 

pub fn new<F>(is_checked: bool, label: impl Into<String>, f: F) -> Self where
    F: 'a + Fn(bool) -> Message, 

Creates a new Checkbox.

It expects:

• a boolean describing whether the Checkbox is checked or not
• the label of the Checkbox
• a function that will be called when the Checkbox is toggled. It will receive the new state of the Checkbox and must produce a Message.

pub fn size(self, size: u16) -> Self

Sets the size of the Checkbox.

pub fn width(self, width: Length) -> Self

Sets the width of the Checkbox.

pub fn spacing(self, spacing: u16) -> Self

Sets the spacing between the Checkbox and the text.

pub fn text_size(self, text_size: u16) -> Self

Sets the text size of the Checkbox.

pub fn font(self, font: Renderer::Font) -> Self

Sets the Font of the text of the Checkbox.

pub fn style(
    self,
    style: impl Into<<Renderer::Theme as StyleSheet>::Style>
) -> Self

Sets the style of the Checkbox.

Trait Implementations

impl<'a, Message, Renderer> From<Checkbox<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
    Message: 'a,
    Renderer: 'a + Renderer,
    Renderer::Theme: StyleSheet + StyleSheet, 

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

Converts to this type from the input type.

impl<'a, Message, Renderer> Widget<Message, Renderer> for Checkbox<'a, Message, Renderer> where
    Renderer: Renderer,
    Renderer::Theme: StyleSheet + StyleSheet, 

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

fn layout(&self, 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_position: Point,
    _renderer: &Renderer,
    _clipboard: &mut dyn Clipboard,
    shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

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

Returns the current mouse::Interaction of the Widget.

fn draw(
    &self,
    _tree: &Tree,
    renderer: &mut Renderer,
    theme: &Renderer::Theme,
    style: &Style,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle
)

Draws the Widget using the associated Renderer.

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

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

Returns the state Tree of the children of the Widget.

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

Reconciliates the Widget with the provided Tree.

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

Applies an Operation to the Widget.

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

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