Struct iced_native::widget::button::Button

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

A generic widget that produces a message when pressed.

#[derive(Clone)]
enum Message {
    ButtonPressed,
}

let mut state = button::State::new();
let button = Button::new(&mut state, Text::new("Press me!"))
    .on_press(Message::ButtonPressed);

Implementations

impl<'a, Message, Renderer> Button<'a, Message, Renderer> where
    Message: Clone,
    Renderer: Renderer, 

pub fn new<E>(state: &'a mut State, content: E) -> Self where
    E: Into<Element<'a, Message, Renderer>>, 

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

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

Sets the width of the Button.

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

Sets the height of the Button.

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

Sets the minimum width of the Button.

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

Sets the minimum height of the Button.

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

Sets the padding of the Button.

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

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

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

Sets the style of the Button.

Trait Implementations

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

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

Performs the conversion.

impl<'a, Message, Renderer> Widget<Message, Renderer> for Button<'a, Message, Renderer> where
    Message: Clone,
    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,
    renderer: &Renderer,
    clipboard: &mut dyn Clipboard,
    messages: &mut Vec<Message>
) -> Status

Processes a runtime Event.

fn draw(
    &self,
    renderer: &mut Renderer,
    defaults: &Renderer::Defaults,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle
) -> 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 Widget, if there is any.