Struct coffee::ui::widget::button::Button

pub struct Button<'a, Message> { /* fields omitted */ }

A generic widget that produces a message when clicked.

It implements Widget when the associated core::Renderer implements the button::Renderer trait.

Example

use coffee::ui::{button, Button};

pub enum Message {
    ButtonClicked,
}

let state = &mut button::State::new();

Button::new(state, "Click me!")
    .on_press(Message::ButtonClicked);

Methods

impl<'a, Message> Button<'a, Message>

pub fn new(state: &'a mut State, label: &str) -> Self

Creates a new Button with some local State and the given label.

The default Class of a new Button is Class::Primary.

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

Sets the width of the Button in pixels.

pub fn fill_width(self) -> Self

Makes the Button fill the horizontal space of its container.

pub fn align_self(self, align: Align) -> Self

Sets the alignment of the Button itself.

This is useful if you want to override the default alignment given by the parent container.

pub fn class(self, class: Class) -> Self

Sets the Class of the Button.

pub fn on_press(self, msg: Message) -> Self

Sets the message that will be produced when the Button is pressed.

Trait Implementations

impl<'a, Message> Debug for Button<'a, Message> where
    Message: Debug, 

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

Formats the value using the given formatter.

impl<'a, Message, Renderer> From<Button<'a, Message>> for Element<'a, Message, Renderer> where
    Renderer: Renderer,
    Message: 'static + Copy + Debug, 

fn from(button: Button<'a, Message>) -> Element<'a, Message, Renderer>

Performs the conversion.

impl<'a, Message, Renderer> Widget<Message, Renderer> for Button<'a, Message> where
    Renderer: Renderer,
    Message: Copy + Debug, 

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].