Struct tuix::Button

pub struct Button {
    pub text: Option<String>,
    // some fields omitted
}

A basic button widget with an optional label.

A Widget that can be pressed and released and may emit an event on_press and on_release. The button can also be triggered with a keyboard key (default space bar).

Example

Create a button which closes the window when pressed:

Button::new()
    .on_press(|_, state, button| {
        button.emit(state, WindowEvent::CloseWindow);
    })
   .build(state, parent, |builder| builder);

Fields

text: Option<String>

Implementations

impl Button

pub fn new() -> Button

Create a new button widget with no callbacks.

Example

Button::new().build(state, parent, |builder| builder);

pub fn with_label(text: &str) -> Button

Create a new button widget with a specified text label.

Example

Button::with_label("A Button").build(state, parent, |builder| builder);

pub fn on_press<F>(self, callback: F) -> Button where
    F: 'static + Fn(&mut Button, &mut State, Entity), 

Set the callback triggered when the button is pressed.

Example

Creates a button which closes the window when pressed:

Button::new()
    .on_press(|_, state, button| {
        button.emit(state, WindowEvent::CloseWindow);
    })
   .build(state, parent, |builder| builder);

pub fn on_release<F>(self, callback: F) -> Button where
    F: 'static + Fn(&mut Button, &mut State, Entity), 

Set the callback triggered when the button is released.

Example

Create a button which closes the window when released:

Button::new()
    .on_release(|_, state, button| {
        button.emit(state, WindowEvent::CloseWindow);
    })
   .build(state, parent, |builder| builder);

pub fn with_key(self, key: Code) -> Button

Set the keyboard key which triggers the button.

Example

Triggers the button’s on_press callback when the Enter key is pressed and the button has focus.

Button::new()
    .with_key(Code::Enter)
   .build(state, parent, |builder| builder);

Trait Implementations

impl Default for Button

pub fn default() -> Button

Returns the “default value” for a type.

impl Widget for Button

type Ret = Entity

type Data = ()

pub fn widget_name(&self) -> String

pub fn on_build(
    &mut self,
    state: &mut State,
    entity: Entity
) -> <Button as Widget>::Ret

pub fn on_event(&mut self, state: &mut State, entity: Entity, event: &mut Event)

fn build<F>(
    self,
    state: &mut State,
    parent: impl AsEntity,
    builder: F
) -> Self::Ret where
    Self: 'static,
    F: FnMut(Builder<'_, Self>) -> Builder<'_, Self>, 

Adds the widget into state and returns the associated type Ret - an entity id or a tuple of entity ids

fn bind<L, F>(self, lens: L, converter: F) -> Wrapper<L, Self> where
    L: Lens,
    F: 'static + Fn(&<L as Lens>::Target) -> Self::Data, 

fn bind2<L>(self, lens: L) -> LensWrap<L, Self> where
    L: Lens, 

fn on_update(&mut self, state: &mut State, entity: Entity, data: &Self::Data)

fn on_style(
    &mut self,
    state: &mut State,
    entity: Entity,
    property: (String, PropType)
)

fn on_draw(
    &mut self,
    state: &mut State,
    entity: Entity,
    canvas: &mut Canvas<OpenGl>
)