Struct ambient_api::prelude::Hotkey

pub struct Hotkey {
    pub hotkey: VirtualKeyCode,
    pub hotkey_modifier: ModifiersState,
    pub on_is_pressed_changed: Option<Arc<CbDebuggable<dyn Fn(bool) + Sync + Send>>>,
    pub on_invoke: Arc<CbDebuggable<dyn Fn(&mut World) + Sync + Send>>,
    pub content: Element,
}

An element that will invoke a callback when a hotkey is pressed.

Fields

hotkey: VirtualKeyCode

The hotkey that will invoke the callback.

hotkey_modifier: ModifiersState

The keyboard modifiers for the hotkey.

on_is_pressed_changed: Option<Arc<CbDebuggable<dyn Fn(bool) + Sync + Send>>>

The callback that is invoked when the current state of the hotkey changes.

on_invoke: Arc<CbDebuggable<dyn Fn(&mut World) + Sync + Send>>

The callback that is invoked when the hotkey is pressed.

content: Element

What to render for this element.

Implementations

impl Hotkey

pub fn new( hotkey: VirtualKeyCode, on_invoke: impl Fn(&mut World) + Sync + Send + 'static, content: Element ) -> Hotkey

Create a new Hotkey with the given content and callback.

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

Set the keyboard modifiers for the hotkey.

Trait Implementations

impl Clone for Hotkey

fn clone(&self) -> Hotkey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hotkey

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

Formats the value using the given formatter.

impl ElementComponent for Hotkey

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

Render the virtual tree for this component.