Struct StateHandlerInput

pub struct StateHandlerInput<'a> {
    pub computed_data: ComputedData,
    pub cursor_position_rel: Option<PxPosition>,
    pub cursor_events: &'a mut Vec<CursorEvent>,
    pub keyboard_events: &'a mut Vec<KeyEvent>,
    pub ime_events: &'a mut Vec<Ime>,
    pub key_modifiers: ModifiersState,
    pub requests: &'a mut WindowRequests,
    pub clipboard: &'a mut Clipboard,
    /* private fields */
}

Input for the state handler function (StateHandlerFn).

Note that you can modify the cursor_events and keyboard_events vectors for exmaple block some keyboard events or cursor events to prevent them from propagating to parent components and older brother components.

Fields

computed_data: ComputedData

The size of the component node, computed during the measure stage.

cursor_position_rel: Option<PxPosition>

The position of the cursor, if available. Relative to the root position of the component.

cursor_events: &'a mut Vec<CursorEvent>

Cursor events from the event loop, if any.

keyboard_events: &'a mut Vec<KeyEvent>

Keyboard events from the event loop, if any.

ime_events: &'a mut Vec<Ime>

IME events from the event loop, if any.

key_modifiers: ModifiersState

The current state of the keyboard modifiers at the time of the event. This allows for implementing keyboard shortcuts (e.g., Ctrl+C).

requests: &'a mut WindowRequests

A context for making requests to the window for the current frame.

clipboard: &'a mut Clipboard

Clipboard

Implementations

impl StateHandlerInput<'_>

pub fn block_cursor(&mut self)

Blocks the cursor to other components.

pub fn block_keyboard(&mut self)

Blocks the keyboard events to other components.

pub fn block_ime(&mut self)

Blocks the IME events to other components.

pub fn block_all(&mut self)

Block all events (cursor, keyboard, IME) to other components.