Struct ambient_api::prelude::Button

pub struct Button {
    pub content: Element,
    pub disabled: bool,
    pub toggled: bool,
    pub style: ButtonStyle,
    pub hotkey: Option<VirtualKeyCode>,
    pub hotkey_modifier: ModifiersState,
    pub tooltip: Option<Element>,
    pub on_invoked: ButtonCb,
    pub on_is_pressed_changed: Option<Arc<CbDebuggable<dyn Fn(&mut World, bool) + Send + Sync>>>,
}

A button UI element.

Fields

content: Element

The content of the button; typically text, as provided by one of the constructor functions.

disabled: bool

Whether or not the button is disabled.

toggled: bool

Whether or not the button can be toggled.

style: ButtonStyle

The style of the button.

hotkey: Option<VirtualKeyCode>

The hotkey for the button.

hotkey_modifier: ModifiersState

The hotkey input modifiers for the button.

tooltip: Option<Element>

The tooltip for the button.

on_invoked: ButtonCb

The callback to invoke when the button is pressed.

on_is_pressed_changed: Option<Arc<CbDebuggable<dyn Fn(&mut World, bool) + Send + Sync>>>

The callback to invoke when the current pressed state changes.

Implementations

impl Button

pub fn el( content: Element, disabled: bool, toggled: bool, style: ButtonStyle, hotkey: Option<VirtualKeyCode>, hotkey_modifier: ModifiersState, tooltip: Option<Element>, on_invoked: ButtonCb, on_is_pressed_changed: Option<Arc<CbDebuggable<dyn Fn(&mut World, bool) + Send + Sync>>> ) -> Element

Create an Element from this component.

impl Button

pub fn new<T>( content: T, on_invoked: impl Fn(&mut World) + Sync + Send + 'static ) -> Buttonwhere T: Into<UIElement>,

Create a new Button with the given content and callback.

pub fn new_inner<T>( content: T, on_invoked: Arc<CbDebuggable<dyn Fn(&mut World) + Send + Sync>> ) -> Buttonwhere T: Into<UIElement>,

Create a new Button with the given content and callback as a Cb.

pub fn new_once<T>( content: T, on_invoked: impl FnOnce(&mut World) + Sync + Send + 'static ) -> Buttonwhere T: Into<UIElement>,

Create a new one-shot Button with the given content and a callback that is only invoked once.

pub fn new_async<F, T>( content: T, on_invoked: impl Fn() -> F + Sync + Send + 'static ) -> Buttonwhere F: Future<Output = ()> + Send + 'static, T: Into<UIElement>,

Create a new Button with the given content and a callback that returns a Future (i.e. is async).

pub fn new_async_once<F, T>( content: T, on_invoked: impl FnOnce() -> F + Sync + Send + 'static ) -> Buttonwhere F: Future + Send + 'static, T: Into<UIElement>,

Create a new one-shot Button with the given content and a callback that returns a Future (i.e. is async) and is only invoked once.

pub fn new_value<T, V>( content: T, value: V, set_value: Arc<CbDebuggable<dyn Fn(V) + Send + Sync>>, desired_value: V ) -> Buttonwhere T: Into<UIElement>, V: PartialEq + Copy + Send + Sync + 'static,

Create a new Button with the given content that sets the given value to the given desired value when clicked.

pub fn disabled(self, disabled: bool) -> Button

Set whether or not the button is disabled.

pub fn style(self, style: ButtonStyle) -> Button

Set the style of the button.

pub fn hotkey(self, hotkey: VirtualKeyCode) -> Button

Set the hotkey of the button.

pub fn hotkey_modifier(self, hotkey_modifier: ModifiersState) -> Button

Set the modifiers for the hotkey of the button.

pub fn tooltip(self, tooltip: impl Into<UIElement>) -> Button

Set the tooltip of the button.

pub fn toggled(self, toggled: bool) -> Button

Set whether or not the button can be toggled.

pub fn on_is_pressed_changed( self, handle: impl Fn(&mut World, bool) + Sync + Send + 'static ) -> Button

Set the callback that is invoked when the current pressed state of the button changes.

Trait Implementations

impl Clone for Button

fn clone(&self) -> Button

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Button

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl ElementComponent for Button

fn render(self: Box<Button>, hooks: &mut Hooks<'_>) -> Element

Render the virtual tree for this component.