Struct coffee::ui::widget::checkbox::Checkbox

pub struct Checkbox<Message> { /* fields omitted */ }

A box that can be checked.

It implements Widget when the core::Renderer implements the checkbox::Renderer trait.

Example

use coffee::graphics::Color;
use coffee::ui::Checkbox;

pub enum Message {
    CheckboxToggled(bool),
}

let is_checked = true;

Checkbox::new(is_checked, "Toggle me!", Message::CheckboxToggled)
    .label_color(Color::BLACK);

Methods

impl<Message> Checkbox<Message>

pub fn new<F>(is_checked: bool, label: &str, 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 receives the new state of the Checkbox and must produce a Message.

pub fn label_color(self, color: Color) -> Self

Sets the Color of the label of the Checkbox.

Trait Implementations

impl<Message> Debug for Checkbox<Message>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

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

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

Performs the conversion.

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

fn node(&self, renderer: &Renderer) -> Node

Returns the [Node] of the [Widget].

fn on_event(
    &mut self,
    event: Event,
    layout: Layout,
    cursor_position: Point,
    messages: &mut Vec<Message>
)

Processes a runtime [Event].

fn draw(
    &self,
    renderer: &mut Renderer,
    layout: Layout,
    cursor_position: Point
) -> MouseCursor

Draws the [Widget] using the associated Renderer.

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

Computes the layout hash of the [Widget].