Struct druid::widget::Button

pub struct Button<T> { /* fields omitted */ }

A button with a text label.

Implementations

impl<T: Data> Button<T>

pub fn new(text: impl Into<LabelText<T>>) -> Button<T>

Create a new button with a text label.

Use the .on_click method to provide a closure to be called when the button is clicked.

Examples

use druid::widget::Button;

let button = Button::new("Increment").on_click(|_ctx, data: &mut u32, _env| {
    *data += 1;
});

pub fn from_label(label: Label<T>) -> Button<T>

Create a new button with the provided Label.

Use the .on_click method to provide a closure to be called when the button is clicked.

Examples

use druid::Color;
use druid::widget::{Button, Label};

let button = Button::from_label(Label::new("Increment").with_text_color(Color::grey(0.5))).on_click(|_ctx, data: &mut u32, _env| {
    *data += 1;
});

pub fn dynamic(text: impl Fn(&T, &Env) -> String + 'static) -> Self

Construct a new dynamic button.

The contents of this button are generated from the data using a closure.

This is provided as a convenience; a closure can also be passed to new, but due to limitations of the implementation of that method, the types in the closure need to be annotated, which is not true for this method.

Examples

The following are equivalent.

use druid::Env;
use druid::widget::Button;
let button1: Button<u32> = Button::new(|data: &u32, _: &Env| format!("total is {}", data));
let button2: Button<u32> = Button::dynamic(|data, _| format!("total is {}", data));

pub fn on_click(
    self,
    f: impl Fn(&mut EventCtx<'_, '_>, &mut T, &Env) + 'static
) -> ControllerHost<Self, Click<T>>

Provide a closure to be called when this button is clicked.

Trait Implementations

impl<T: Data> Widget<T> for Button<T>

pub fn event(
    &mut self,
    ctx: &mut EventCtx<'_, '_>,
    event: &Event,
    _data: &mut T,
    _env: &Env
)

Handle an event.

pub fn lifecycle(
    &mut self,
    ctx: &mut LifeCycleCtx<'_, '_>,
    event: &LifeCycle,
    data: &T,
    env: &Env
)

Handle a life cycle notification.

pub fn update(
    &mut self,
    ctx: &mut UpdateCtx<'_, '_>,
    old_data: &T,
    data: &T,
    env: &Env
)

Update the widget's appearance in response to a change in the app's Data or Env.

pub fn layout(
    &mut self,
    ctx: &mut LayoutCtx<'_, '_>,
    bc: &BoxConstraints,
    data: &T,
    env: &Env
) -> Size

Compute layout.

pub fn paint(&mut self, ctx: &mut PaintCtx<'_, '_, '_>, data: &T, env: &Env)

Paint the widget appearance.