Struct direct_gui::controls::Button

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

A button widget that can be rendered in multiple ways: Flat: using a simpel pixel rectangle algorithm. Image: using a spritesheet divided into 3 parts for rendering its state.

Methods

impl<S> Button<S>

fn pos(&self) -> (i32, i32)

Retrieve the position.

fn with_pos(self, x: i32, y: i32) -> Self

Map a position.

fn set_pos(&mut self, x: i32, y: i32)

Change the position.

fn pressed(&self) -> bool

Get if the button is currently pressed.

fn with_callback(self, func: fn(_: &mut Button<S>, _: ButtonState)) -> Self

Set the event to a closure which will be called if the button state changes.

impl Button<Flat>

fn new(size: (i32, i32), color: Color) -> Self

Create a new colored button without text.

impl Button<Image>

fn new_with_sprite(sprite_ref: SpriteRef) -> Self

Create a new button with a sprite without text.

The button image needs to be 3 buttons divided vertically: 1. normal state 2. mouse hover state 3. mouse pressed state

+-------+
|Normal |
+-------+
| Hover |
+-------+
|Pressed|
+-------+

Trait Implementations

impl Control for Button<Flat>

fn update(&mut self, args: &ControlState, _res: &Resources)

Update the control.

fn draw(&self, buffer: &mut Vec<u32>, buffer_width: usize, _res: &Resources)

Draw the control on the output buffer.

fn control_type(&self) -> ControlType

Retrieve what type of control this is.

fn as_any(&self) -> &Any

For downcasting.

fn as_any_mut(&mut self) -> &mut Any

For downcasting.

impl Control for Button<Image>

fn update(&mut self, args: &ControlState, res: &Resources)

Update the control.

fn draw(&self, buffer: &mut Vec<u32>, buffer_width: usize, res: &Resources)

Draw the control on the output buffer.

fn control_type(&self) -> ControlType

Retrieve what type of control this is.

fn as_any(&self) -> &Any

For downcasting.

fn as_any_mut(&mut self) -> &mut Any

For downcasting.