Struct UseKeyboard 

pub struct UseKeyboard {
    pub pressed: Signal<String>,
    /* private fields */
}

Reactive state for the keyboard.

The handle carries the key that is currently held down and the teardown that removes the window listeners.

The key is a Signal<String>: a render closure that reads it re-renders when a key goes down or comes up, and nothing else in the tree is disturbed.

Fields

pressed: Signal<String>

The key currently held down, empty when no key is down.

Implementations

impl UseKeyboard

Inherent implementation of UseKeyboard.

pub fn current_key(&self) -> String

Returns the key currently held down as a snapshot.

Returns

• String - The key, or an empty string when no key is down.

pub fn is_pressed(&self, key: &str) -> bool

Reports whether key is the key currently held down.

Arguments

• &str - The key to test.

Returns

• bool - true when that key is down.

impl UseKeyboard

pub fn get_pressed(&self) -> Signal<String>

pub fn get_mut_pressed(&mut self) -> &mut Signal<String>

pub fn set_pressed(&mut self, val: Signal<String>) -> &mut Self

pub fn get_mut_teardown(&mut self) -> &mut Rc<RefCell<Option<Box<dyn Fn()>>>>

pub fn set_teardown( &mut self, val: Rc<RefCell<Option<Box<dyn Fn()>>>>, ) -> &mut Self

Trait Implementations

impl Clone for UseKeyboard

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UseKeyboard

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

Formats the struct fields as a debug struct, skipping excluded fields.

Arguments

• &mut std::fmt::Formatter<'_> - The formatter to write the representation into.

Returns

• std::fmt::Result - Success or failure of the formatting operation.