Struct KeyboardState 

pub struct KeyboardState {
    pub enabled: bool,
    pub text_input_focused: bool,
    pub slide: Tween,
    pub current_layer: Layer,
    pub last_painted_keys: Vec<PaintedKey>,
    pub last_panel_height: Option<f64>,
    pub pressed_key_index: Option<usize>,
    pub captured_pointer: bool,
    pub caps_lock: bool,
    pub last_shift_tap: Option<Instant>,
    pub key_repeat: Option<KeyRepeatState>,
    pub dismiss_requested: bool,
}

All mutable state owned by the keyboard module.

Kept private to the module so callers can’t accidentally diverge from the controlled-mutation rules (e.g. retargeting the tween also requires request_draw to wake the event loop).

Fields

enabled: bool

Host opted in via super::set_enabled. Defaults to false so desktop apps that never call it see no keyboard.

text_input_focused: bool

Set by super::set_text_input_focused when the focused widget reports accepts_text_input.

slide: Tween

Slide animation. Value in [0.0, 1.0] interprets as “fraction of the keyboard panel visible from the bottom”.

current_layer: Layer

Active layer (lowercase letters / shifted letters / numbers / symbols).

last_painted_keys: Vec<PaintedKey>

Painted keys from the most recent paint pass. Used for tap hit-testing. Coordinates are in the same Y-up viewport space the paint pass uses.

last_panel_height: Option<f64>

Height of the most recently painted panel in logical pixels. None until first paint. Used by super::occluded_height to report how much screen real estate the keyboard is consuming.

pressed_key_index: Option<usize>

Index into last_painted_keys of the key currently held down, if any. Cleared when the pointer is released or moves off the panel.

captured_pointer: bool

true between MouseDown and MouseUp on the panel — used by the move/up handlers to know they should keep consuming events.

caps_lock: bool

true if the user has toggled caps lock on (via double-tap shift). Holds the keyboard in the Shifted layer until shift is tapped again.

last_shift_tap: Option<Instant>

Most recent shift-key tap, used to detect double-tap → caps lock. Cleared after a non-shift key press or after the double-tap window expires.

key_repeat: Option<KeyRepeatState>

State machine for the held key (currently only Backspace). When set we keep firing the key every repeat_period after an initial delay, until the pointer releases / leaves.

dismiss_requested: bool

Set by super::dismiss when the user taps the keyboard’s close key. Drained once per event-loop iteration by the App (see App::drain_keyboard_events), which calls set_focus(None) so the previously-focused text field gets a FocusLost and the keyboard-aware lift retargets back to 0 — otherwise the keyboard panel slides down but the tree stays lifted, leaving an empty band where the keyboard used to be.

Implementations

impl KeyboardState

pub fn visible_fraction(&self) -> f64

Current eased visible fraction. Wraps Tween::value so callers outside the module don’t need a mutable borrow just to peek.

Trait Implementations

impl Default for KeyboardState

fn default() -> Self

Returns the “default value” for a type.