Struct KEYBOARD

pub struct KEYBOARD;

Keyboard service.

Provider

This service is provided by the KeyboardManager extension.

Implementations

impl KEYBOARD

pub fn modifiers(&self) -> ReadOnlyArcVar<ModifiersState>

Returns a read-only variable that tracks the currently pressed modifier keys.

pub fn codes(&self) -> ReadOnlyArcVar<Vec<KeyCode>>

Returns a read-only variable that tracks the KeyCode of the keys currently pressed.

pub fn keys(&self) -> ReadOnlyArcVar<Vec<Key>>

Returns a read-only variable that tracks the Key identifier of the keys currently pressed.

pub fn repeat_config( &self, ) -> ArcCowVar<KeyRepeatConfig, ArcVar<KeyRepeatConfig>>

Returns a variable that defines key press repeat start delay and repeat speed on the app.

This delay is roughly the time the user must hold a key pressed to start repeating. When a second key press happens without any other keyboard event and within twice this value it increments the repeat_count by the KeyboardManager.

The value is the same as sys_repeat_config, if set the variable disconnects from system config.

pub fn sys_repeat_config(&self) -> ReadOnlyArcVar<KeyRepeatConfig>

Returns a read-only variable that tracks the operating system key press repeat start delay and repeat speed.

The variable updates every time the system config changes and on view-process (re)init.

pub fn caret_animation_config( &self, ) -> ArcCowVar<(Duration, Duration), ArcVar<(Duration, Duration)>>

Returns a variable that defines the system config for the caret blink speed and timeout for the app.

The first value defines the blink speed interval, the caret is visible for the duration, then not visible for the duration. The second value defines the animation total duration, the caret stops animating and sticks to visible after this timeout is reached.

You can use the caret_animation method to generate a new animation.

The value is the same as sys_repeat_config, if set the variable disconnects from system config.

pub fn sys_caret_animation_config(&self) -> ReadOnlyArcVar<(Duration, Duration)>

Returns a read-only variable that tracks the operating system caret blink speed and timeout.

The variable updates every time the system config changes and on view-process (re)init.

pub fn caret_animation(&self) -> ReadOnlyArcVar<Factor>

Returns a new read-only variable that animates the caret opacity.

A new animation must be started after each key press. The value is always 1 or 0, no easing is used by default, it can be added using the Var::easing method.