Struct iced_native::widget::checkbox::Checkbox

pub struct Checkbox<Message, Renderer: Renderer + Renderer> { /* fields omitted */ }

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<Message, Renderer: Renderer + Renderer> Checkbox<Message, Renderer>

pub fn new<F>(is_checked: bool, label: impl Into<String>, f: F) -> Self where
    F: 'static + 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::Style>) -> Self

Sets the style of the Checkbox.

Trait Implementations

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

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

Performs the conversion.

impl<Message, Renderer> Widget<Message, Renderer> for Checkbox<Message, Renderer> where
    Renderer: Renderer + Renderer + Renderer, 

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 [Node] of the [Widget].

fn on_event(
    &mut self,
    event: Event,
    layout: Layout<'_>,
    cursor_position: Point,
    messages: &mut Vec<Message>,
    _renderer: &Renderer,
    _clipboard: Option<&dyn Clipboard>
)

Processes a runtime [Event].

fn draw(
    &self,
    renderer: &mut Renderer,
    defaults: &Renderer::Defaults,
    layout: Layout<'_>,
    cursor_position: Point
) -> Renderer::Output

Draws the [Widget] using the associated Renderer.

fn hash_layout(&self, state: &mut Hasher)

Computes the layout hash of the [Widget].

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

Returns the overlay of the [Element], if there is any.