Struct Button 

pub struct Button<'a, Message, W = Element<'a, Message, Theme, Renderer<Renderer, Renderer>>, Theme = Theme>
where
    Theme: Catalog,
{ /* private fields */ }

A generic widget that produces a message when pressed.

Example

use iced::widget::button;

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

fn view(state: &State) -> impl Widget<Message> {
    button("Press me!").on_press(Message::ButtonPressed)
}

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

use iced::widget::button;

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

fn view(state: &State) -> impl Widget<Message> {
    button("I am disabled!")
}

Implementations

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

where Theme: Catalog,

pub fn new(content: W) -> Button<'a, Message, W, Theme>

Creates a new Button with the given content.

pub fn width(self, width: impl Into<Length>) -> Button<'a, Message, W, Theme>

Sets the width of the Button.

pub fn height(self, height: impl Into<Length>) -> Button<'a, Message, W, Theme>

Sets the height of the Button.

pub fn padding<P>(self, padding: P) -> Button<'a, Message, W, Theme>

where P: Into<Padding>,

Sets the Padding of the Button.

pub fn on_press(self, on_press: Message) -> Button<'a, Message, W, Theme>

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_with( self, on_press: impl Fn() -> Message + 'a, ) -> Button<'a, Message, W, Theme>

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

This is analogous to Button::on_press, but using a closure to produce the message.

This closure will only be called when the Button is actually pressed and, therefore, this method is useful to reduce overhead if creating the resulting message is slow.

pub fn on_press_maybe( self, on_press: Option<Message>, ) -> Button<'a, Message, W, Theme>

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

If None, the Button will be disabled.

pub fn on_press_maybe_with( self, on_press: Option<impl Fn() -> Message + 'a>, ) -> Button<'a, Message, W, Theme>

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

This is analogous to Button::on_press, but using a closure to produce the message.

This closure will only be called when the Button is actually pressed and, therefore, this method is useful to reduce overhead if creating the resulting message is slow.

If None, the Button will be disabled.

pub fn clip(self, clip: bool) -> Button<'a, Message, W, Theme>

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

pub fn style( self, style: impl Fn(&Theme, Status) -> Style + 'a, ) -> Button<'a, Message, W, Theme>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme, Status) -> Style + 'a>>,

Sets the style of the Button.

pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> Button<'a, Message, W, Theme>

Available on crate feature advanced only.

Sets the style class of the Button.

Trait Implementations

impl<'a, Message, W, Theme> Meta for Button<'a, Message, W, Theme>

where Theme: Catalog,

fn is_void(&self) -> bool

Returns whether the Widget is Void.

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

where Message: 'a + Clone, W: Widget<Message, Theme, Renderer>, Renderer: 'a + Renderer, Theme: Catalog,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn diff(&mut self, tree: &mut Tree)

Reconciles the Widget with the provided Tree.

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

Returns the Size of the Widget in lengths.

fn layout(&mut self, tree: &mut Tree, renderer: &Renderer, limits: &Limits)

Lays out the Widget.

fn operate( &mut self, tree: &mut Tree, layout: Layout, viewport: &Rectangle, renderer: &Renderer, operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn update( &mut self, tree: &mut Tree, event: &Event, layout: Layout, cursor: Cursor, renderer: &Renderer, shell: &mut Shell<'_, Message>, viewport: &Rectangle, )

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, viewport: &Rectangle, translation: Vector, window: Size, ) -> Vec<Element<'b, Message, Theme, Renderer>>

Returns the overlays of the Widget.

fn _map<F, B>(self, f: F) -> Map<Self, F, Message>

where Self: Sized, F: Fn(Message) -> B,

Applies a transformation to the produced message of this Widget, returning a Map.

fn _boxed<'a>(self) -> Element<'a, Message, Theme, Renderer>

where Self: Sized + 'a,

Boxes this Widget, turning it into a generic Element.