Struct orbtk_api::application::KeyboardState

pub struct KeyboardState { /* fields omitted */ }

Contains the state information for the keyboard.

This currently tracks which keys are currently pressed.

The key state is stored in a lazy-loaded HashMap.

There are several convenience methods to check common modifiers (ctrl, shift, alt, etc). This is useful if you don't care which shift key is down.

Implementations

impl KeyboardState

pub fn set_key_state(&mut self, key: Key, pressed: bool)

Sets whether or not the given key is currently pressed

pub fn is_key_down(&self, key: Key) -> bool

Returns whether or not the requested key is pressed

pub fn is_shift_down(&self) -> bool

Returns whether or not any shift key is down.

pub fn is_alt_down(&self) -> bool

Returns whether or not any alt key is down.

pub fn is_ctrl_down(&self) -> bool

Returns whether or not any control key is down.

pub fn is_home_down(&self) -> bool

Returns whether or not any home key is down.

Trait Implementations

impl Clone for KeyboardState

fn clone(&self) -> KeyboardState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardState

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

Formats the value using the given formatter.

impl Default for KeyboardState

fn default() -> KeyboardState

Returns the "default value" for a type.

impl PartialEq<KeyboardState> for KeyboardState

fn eq(&self, other: &KeyboardState) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &KeyboardState) -> bool

This method tests for !=.

impl StructuralPartialEq for KeyboardState