Struct widgetry::widgets::button::Button

pub struct Button {
    pub action: String,
    draw_normal: Drawable,
    draw_hovered: Drawable,
    draw_disabled: Drawable,
    pub(crate) hotkey: Option<MultiKey>,
    tooltip: Text,
    hitbox: Polygon,
    pub(crate) hovering: bool,
    is_disabled: bool,
    pub(crate) top_left: ScreenPt,
    pub(crate) dims: ScreenDims,
}

Fields

action: String

When a button is clicked, Outcome::Clicked with this string is produced.

draw_normal: Drawable

draw_hovered: Drawable

draw_disabled: Drawable

hotkey: Option<MultiKey>

tooltip: Text

hitbox: Polygon

hovering: bool

is_disabled: bool

top_left: ScreenPt

dims: ScreenDims

Implementations

impl Button

fn widget(
    ctx: &EventCtx<'_>,
    normal: GeomBatch,
    hovered: GeomBatch,
    disabled: GeomBatch,
    hotkey: Option<MultiKey>,
    action: &str,
    maybe_tooltip: Option<Text>,
    hitbox: Polygon,
    is_disabled: bool
) -> Widget

fn new(
    ctx: &EventCtx<'_>,
    normal: GeomBatch,
    hovered: GeomBatch,
    disabled: GeomBatch,
    hotkey: Option<MultiKey>,
    action: &str,
    maybe_tooltip: Option<Text>,
    hitbox: Polygon,
    is_disabled: bool
) -> Button

Trait Implementations

impl WidgetImpl for Button

fn get_dims(&self) -> ScreenDims

What width and height does the widget occupy? If this changes, be sure to set redo_layout to true in event.

fn set_pos(&mut self, top_left: ScreenPt)

Your widget's top left corner should be here. Handle mouse events and draw appropriately.

fn event(&mut self, ctx: &mut EventCtx<'_>, output: &mut WidgetOutput)

Your chance to react to an event. Any side effects outside of this widget are communicated through the output.

fn draw(&self, g: &mut GfxCtx<'_>)

Draw the widget. Be sure to draw relative to the top-left specified by set_pos.

fn can_restore(&self) -> bool

If a new Panel is being created to replace an older one, all widgets have the chance to preserve state from the previous version.

fn restore(&mut self, _: &mut EventCtx<'_>, _prev: &Box<dyn WidgetImpl>)

Restore state from the previous version of this widget, with the same ID. Implementors must downcast.