Struct iced_widget::button::Button

pub struct Button<'a, Message, Theme = Theme, Renderer = Renderer>
where
    Theme: StyleSheet,
    Renderer: Renderer,
{ /* 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, Theme, Renderer> Button<'a, Message, Theme, Renderer>

where Theme: StyleSheet, Renderer: Renderer,

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

Creates a new Button with the given content.

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

Sets the width of the Button.

pub fn height(self, height: impl Into<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, on_press: 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 on_press_maybe(self, on_press: Option<Message>) -> Self

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

If None, the Button will be disabled.

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

Sets the style variant of this Button.

pub fn clip(self, clip: bool) -> Self

Sets whether the contents of the Button should be clipped on overflow.

Trait Implementations

impl<'a, Message, Theme, Renderer> From<Button<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>

where Message: Clone + 'a, Theme: StyleSheet + 'a, Renderer: Renderer + 'a,

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

Converts to this type from the input type.

impl<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Button<'a, Message, Theme, Renderer>

where Message: 'a + Clone, Theme: StyleSheet, Renderer: 'a + Renderer,

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 size(&self) -> Size<Length>

Returns the [Size] of the [Widget] in lengths.

fn layout(&self, tree: &mut Tree, 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: Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, viewport: &Rectangle ) -> Status

Processes a runtime [Event].

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, _style: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle )

Draws the [Widget] using the associated Renderer.

fn mouse_interaction( &self, _tree: &Tree, layout: Layout<'_>, cursor: Cursor, _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, translation: Vector ) -> Option<Element<'b, Message, Theme, Renderer>>

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

fn size_hint(&self) -> Size<Length>

Returns a [Size] hint for laying out the [Widget].