Skip to main content

DispatchKeyEventParamsBuilder

Struct DispatchKeyEventParamsBuilder 

Source
pub struct DispatchKeyEventParamsBuilder<'a> { /* private fields */ }

Implementations§

Source§

impl<'a> DispatchKeyEventParamsBuilder<'a>

Source

pub fn modifiers(self, modifiers: i64) -> Self

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

Source

pub fn timestamp(self, timestamp: TimeSinceEpoch) -> Self

Time at which the event occurred.

Source

pub fn text(self, text: impl Into<Cow<'a, str>>) -> Self

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

Source

pub fn unmodified_text(self, unmodified_text: impl Into<Cow<'a, str>>) -> 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: “”).

Source

pub fn key_identifier(self, key_identifier: impl Into<Cow<'a, str>>) -> Self

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

Source

pub fn code(self, code: impl Into<Cow<'a, str>>) -> Self

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

Source

pub fn key(self, key: impl Into<Cow<'a, str>>) -> 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: “”).

Source

pub fn windows_virtual_key_code(self, windows_virtual_key_code: i64) -> Self

Windows virtual key code (default: 0).

Source

pub fn native_virtual_key_code(self, native_virtual_key_code: i64) -> Self

Native virtual key code (default: 0).

Source

pub fn auto_repeat(self, auto_repeat: bool) -> Self

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

Source

pub fn is_keypad(self, is_keypad: bool) -> Self

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

Source

pub fn is_system_key(self, is_system_key: bool) -> Self

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

Source

pub fn location(self, location: i64) -> Self

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

Source

pub fn commands(self, commands: Vec<Cow<'a, str>>) -> 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.

Source

pub fn build(self) -> DispatchKeyEventParams<'a>

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.