Struct Button

pub struct Button<'a, Message, Theme = Theme, Renderer = Renderer>
where
    Renderer: Renderer,
    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) -> Element<'_, Message> {
    button("Press me!").on_press(Message::ButtonPressed).into()
}

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) -> Element<'_, Message> {
    button("I am disabled!").into()
}

Implementations

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

where Renderer: Renderer, Theme: Catalog,

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

Creates a new Button with the given content.

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

Sets the width of the Button.

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

Sets the height of the Button.

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

where P: Into<Padding>,

Sets the Padding of the Button.

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

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, Theme, Renderer>

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, Theme, Renderer>

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

If None, the Button will be disabled.

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

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, Theme, Renderer>

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, Theme, Renderer>

Sets the style class of the Button.

pub fn id(self, id: Id) -> Button<'a, Message, Theme, Renderer>

Sets the Id of the Button.

pub fn name( self, name: impl Into<Cow<'a, str>>, ) -> Button<'a, Message, Theme, Renderer>

Sets the name of the Button.

pub fn description_widget<T>( self, description: &T, ) -> Button<'a, Message, Theme, Renderer>

where T: Describes,

Sets the description of the Button.

pub fn description( self, description: impl Into<Cow<'a, str>>, ) -> Button<'a, Message, Theme, Renderer>

Sets the description of the Button.

pub fn label(self, label: &dyn Labels) -> Button<'a, Message, Theme, Renderer>

Sets the label of the Button.

Trait Implementations

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

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

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

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, Renderer: 'a + Renderer, Theme: Catalog,

fn a11y_nodes(&self, layout: Layout<'_>, state: &Tree, p: Cursor) -> A11yTree

get the a11y nodes for the widget

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(&mut 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, )

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, renderer_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 id(&self) -> Option<Id>

Returns the id of the widget

fn set_id(&mut self, id: Id)

Sets the id of the widget This may be called while diffing the widget tree

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

Returns a Size hint for laying out the Widget.

fn drag_destinations( &self, _state: &Tree, _layout: Layout<'_>, _renderer: &Renderer, _dnd_rectangles: &mut DndDestinationRectangles, )

Adds the drag destination rectangles of the widget. Runs after the layout phase for each widget in the tree.