Struct DispatchKeyEventBuilder 

pub struct DispatchKeyEventBuilder { /* private fields */ }

Builder for DispatchKeyEvent.

Implementations

impl DispatchKeyEventBuilder

pub fn type<VALUE: Into<DispatchKeyEventTypeOption>>( &mut self, value: VALUE, ) -> &mut Self

Type of the key event.

pub fn modifiers<VALUE: Into<JsUInt>>(&mut self, value: VALUE) -> &mut Self

Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).

pub fn timestamp<VALUE: Into<TimeSinceEpoch>>( &mut self, value: VALUE, ) -> &mut Self

Time at which the event occurred.

pub fn text<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Text as generated by processing a virtual key code with a keyboard layout. Not needed for for keyUp and rawKeyDown events (default: “”)

pub fn unmodified_text<VALUE: Into<String>>( &mut self, value: VALUE, ) -> &mut Self

Text that would have been generated by the keyboard if no modifiers were pressed (except for shift). Useful for shortcut (accelerator) key handling (default: “”).

pub fn key_identifier<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Unique key identifier (e.g., ‘U+0041’) (default: “”).

pub fn code<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Unique DOM defined string value for each physical key (e.g., ‘KeyA’) (default: “”).

pub fn key<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Unique DOM defined string value describing the meaning of the key in the context of active modifiers, keyboard layout, etc (e.g., ‘AltGr’) (default: “”).

pub fn windows_virtual_key_code<VALUE: Into<JsUInt>>( &mut self, value: VALUE, ) -> &mut Self

Windows virtual key code (default: 0).

pub fn native_virtual_key_code<VALUE: Into<JsUInt>>( &mut self, value: VALUE, ) -> &mut Self

Native virtual key code (default: 0).

pub fn auto_repeat<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Whether the event was generated from auto repeat (default: false).

pub fn is_keypad<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Whether the event was generated from the keypad (default: false).

pub fn is_system_key<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Whether the event was a system key event (default: false).

pub fn location<VALUE: Into<JsUInt>>(&mut self, value: VALUE) -> &mut Self

Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default: 0).

pub fn commands<VALUE: Into<Vec<String>>>(&mut self, value: VALUE) -> &mut Self

Editing commands to send with the key event (e.g., ‘selectAll’) (default: []). These are related to but not equal the command names used in document.execCommand and NSStandardKeyBindingResponding. See https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.

pub fn build(&self) -> Result<DispatchKeyEvent, DispatchKeyEventBuilderError>

Builds a new DispatchKeyEvent.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for DispatchKeyEventBuilder

fn clone(&self) -> DispatchKeyEventBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for DispatchKeyEventBuilder

fn default() -> Self

Returns the “default value” for a type.