Struct iced_native::widget::button::Button

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

A generic widget that produces a message when pressed.

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

let button = Button::new("Press me!").on_press(Message::ButtonPressed);

If a Button::on_press handler is not set, the resulting Button will be disabled:

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

fn disabled_button<'a>() -> Button<'a, Message> {
    Button::new("I'm disabled!")
}

fn enabled_button<'a>() -> Button<'a, Message> {
    disabled_button().on_press(Message::ButtonPressed)
}

Implementations

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

pub fn new(content: impl Into<Element<'a, Message, Renderer>>) -> Self

Creates a new Button with 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 padding<P: Into<Padding>>(self, padding: P) -> 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.

Unless on_press is called, the Button will be disabled.

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

Sets the style variant of this Button.

Trait Implementations

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

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

Converts to this type from the input type.

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

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 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 operate(
    &self,
    tree: &mut Tree,
    layout: Layout<'_>,
    renderer: &Renderer,
    operation: &mut dyn Operation<Message>
)

Applies an Operation to 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 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 mouse_interaction(
    &self,
    _tree: &Tree,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle,
    _renderer: &Renderer
) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn overlay<'b>(
    &'b mut self,
    tree: &'b mut Tree,
    layout: Layout<'_>,
    renderer: &Renderer
) -> Option<Element<'b, Message, Renderer>>

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