[][src]Struct sauron::KeyboardEvent

#[repr(transparent)]pub struct KeyboardEvent { /* fields omitted */ }

The KeyboardEvent class.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

Implementations

impl KeyboardEvent[src]

pub const DOM_KEY_LOCATION_STANDARD: u32[src]

The KeyboardEvent.DOM_KEY_LOCATION_STANDARD const.

This API requires the following crate features to be activated: KeyboardEvent

pub const DOM_KEY_LOCATION_LEFT: u32[src]

The KeyboardEvent.DOM_KEY_LOCATION_LEFT const.

This API requires the following crate features to be activated: KeyboardEvent

pub const DOM_KEY_LOCATION_RIGHT: u32[src]

The KeyboardEvent.DOM_KEY_LOCATION_RIGHT const.

This API requires the following crate features to be activated: KeyboardEvent

pub const DOM_KEY_LOCATION_NUMPAD: u32[src]

The KeyboardEvent.DOM_KEY_LOCATION_NUMPAD const.

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn char_code(&self) -> u32[src]

Getter for the charCode field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn key_code(&self) -> u32[src]

Getter for the keyCode field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn alt_key(&self) -> bool[src]

Getter for the altKey field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn ctrl_key(&self) -> bool[src]

Getter for the ctrlKey field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn shift_key(&self) -> bool[src]

Getter for the shiftKey field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn meta_key(&self) -> bool[src]

Getter for the metaKey field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn location(&self) -> u32[src]

Getter for the location field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn repeat(&self) -> bool[src]

Getter for the repeat field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn is_composing(&self) -> bool[src]

Getter for the isComposing field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn key(&self) -> String[src]

Getter for the key field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn code(&self) -> String[src]

Getter for the code field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn new(type_arg: &str) -> Result<KeyboardEvent, JsValue>[src]

The new KeyboardEvent(..) constructor, creating a new instance of KeyboardEvent.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn get_modifier_state(&self, key: &str) -> bool[src]

The getModifierState() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn init_keyboard_event(&self, type_arg: &str) -> Result<(), JsValue>[src]

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn init_keyboard_event_with_bubbles_arg(
    &self,
    type_arg: &str,
    bubbles_arg: bool
) -> Result<(), JsValue>
[src]

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg(
    &self,
    type_arg: &str,
    bubbles_arg: bool,
    cancelable_arg: bool
) -> Result<(), JsValue>
[src]

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent[src]

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg(
    &self,
    type_arg: &str,
    bubbles_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>
) -> Result<(), JsValue>
[src]

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent[src]

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg(
    &self,
    type_arg: &str,
    bubbles_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    key_arg: &str
) -> Result<(), JsValue>
[src]

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent[src]

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg(
    &self,
    type_arg: &str,
    bubbles_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    key_arg: &str,
    location_arg: u32
) -> Result<(), JsValue>
[src]

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent[src]

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg_and_ctrl_key(
    &self,
    type_arg: &str,
    bubbles_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    key_arg: &str,
    location_arg: u32,
    ctrl_key: bool
) -> Result<(), JsValue>
[src]

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent[src]

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg_and_ctrl_key_and_alt_key(
    &self,
    type_arg: &str,
    bubbles_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    key_arg: &str,
    location_arg: u32,
    ctrl_key: bool,
    alt_key: bool
) -> Result<(), JsValue>
[src]

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent[src]

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg_and_ctrl_key_and_alt_key_and_shift_key(
    &self,
    type_arg: &str,
    bubbles_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    key_arg: &str,
    location_arg: u32,
    ctrl_key: bool,
    alt_key: bool,
    shift_key: bool
) -> Result<(), JsValue>
[src]

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent[src]

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg_and_ctrl_key_and_alt_key_and_shift_key_and_meta_key(
    &self,
    type_arg: &str,
    bubbles_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    key_arg: &str,
    location_arg: u32,
    ctrl_key: bool,
    alt_key: bool,
    shift_key: bool,
    meta_key: bool
) -> Result<(), JsValue>
[src]

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

Methods from Deref<Target = UiEvent>

pub fn view(&self) -> Option<Window>[src]

Getter for the view field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent, Window

pub fn detail(&self) -> i32[src]

Getter for the detail field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn layer_x(&self) -> i32[src]

Getter for the layerX field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn layer_y(&self) -> i32[src]

Getter for the layerY field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn page_x(&self) -> i32[src]

Getter for the pageX field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn page_y(&self) -> i32[src]

Getter for the pageY field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn which(&self) -> u32[src]

Getter for the which field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn range_parent(&self) -> Option<Node>[src]

Getter for the rangeParent field of this object.

MDN Documentation

This API requires the following crate features to be activated: Node, UiEvent

pub fn range_offset(&self) -> i32[src]

Getter for the rangeOffset field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn init_ui_event(&self, a_type: &str)[src]

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn init_ui_event_with_a_can_bubble(&self, a_type: &str, a_can_bubble: bool)[src]

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn init_ui_event_with_a_can_bubble_and_a_cancelable(
    &self,
    a_type: &str,
    a_can_bubble: bool,
    a_cancelable: bool
)
[src]

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn init_ui_event_with_a_can_bubble_and_a_cancelable_and_a_view(
    &self,
    a_type: &str,
    a_can_bubble: bool,
    a_cancelable: bool,
    a_view: Option<&Window>
)
[src]

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent, Window

pub fn init_ui_event_with_a_can_bubble_and_a_cancelable_and_a_view_and_a_detail(
    &self,
    a_type: &str,
    a_can_bubble: bool,
    a_cancelable: bool,
    a_view: Option<&Window>,
    a_detail: i32
)
[src]

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent, Window

Methods from Deref<Target = Event>

pub fn type_(&self) -> String[src]

Getter for the type field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn target(&self) -> Option<EventTarget>[src]

Getter for the target field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event, EventTarget

pub fn current_target(&self) -> Option<EventTarget>[src]

Getter for the currentTarget field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event, EventTarget

pub fn event_phase(&self) -> u16[src]

Getter for the eventPhase field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn bubbles(&self) -> bool[src]

Getter for the bubbles field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn cancelable(&self) -> bool[src]

Getter for the cancelable field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn default_prevented(&self) -> bool[src]

Getter for the defaultPrevented field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn composed(&self) -> bool[src]

Getter for the composed field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn is_trusted(&self) -> bool[src]

Getter for the isTrusted field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn time_stamp(&self) -> f64[src]

Getter for the timeStamp field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn cancel_bubble(&self) -> bool[src]

Getter for the cancelBubble field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn set_cancel_bubble(&self, value: bool)[src]

Setter for the cancelBubble field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn composed_path(&self) -> Array[src]

The composedPath() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn init_event(&self, type_: &str)[src]

The initEvent() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn init_event_with_bubbles(&self, type_: &str, bubbles: bool)[src]

The initEvent() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn init_event_with_bubbles_and_cancelable(
    &self,
    type_: &str,
    bubbles: bool,
    cancelable: bool
)
[src]

The initEvent() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn prevent_default(&self)[src]

The preventDefault() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn stop_immediate_propagation(&self)[src]

The stopImmediatePropagation() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn stop_propagation(&self)[src]

The stopPropagation() method.

MDN Documentation

This API requires the following crate features to be activated: Event

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function[src]

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

pub fn has_own_property(&self, property: &JsValue) -> bool[src]

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool[src]

The isPrototypeOf() method checks if an object exists in another object's prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool[src]

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString[src]

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString[src]

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object[src]

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue[src]

pub const UNDEFINED: JsValue[src]

pub const TRUE: JsValue[src]

pub const FALSE: JsValue[src]

pub fn into_serde<T>(&self) -> Result<T, Error> where
    T: for<'a> Deserialize<'a>, 
[src]

Invokes JSON.stringify on this value and then parses the resulting JSON into an arbitrary Rust value.

This function will first call JSON.stringify on the JsValue itself. The resulting string is then passed into Rust which then parses it as JSON into the resulting value.

Usage of this API requires activating the serde-serialize feature of the wasm-bindgen crate.

Errors

Returns any error encountered when parsing the JSON into a T.

pub fn as_f64(&self) -> Option<f64>[src]

Returns the f64 value of this JS value if it's an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool[src]

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>[src]

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it's not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>[src]

Returns the bool value of this JS value if it's an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool[src]

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool[src]

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool[src]

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool[src]

Tests whether typeof self == "object" && self !== null.

pub fn is_function(&self) -> bool[src]

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool[src]

Tests whether the value is "truthy".

pub fn is_falsy(&self) -> bool[src]

Tests whether the value is "falsy".

Trait Implementations

impl AsRef<Event> for KeyboardEvent[src]

impl AsRef<JsValue> for KeyboardEvent[src]

impl AsRef<KeyboardEvent> for KeyboardEvent[src]

impl AsRef<Object> for KeyboardEvent[src]

impl AsRef<UiEvent> for KeyboardEvent[src]

impl Clone for KeyboardEvent[src]

impl Debug for KeyboardEvent[src]

impl Deref for KeyboardEvent[src]

type Target = UiEvent

The resulting type after dereferencing.

impl Eq for KeyboardEvent[src]

impl From<JsValue> for KeyboardEvent[src]

impl From<KeyboardEvent> for JsValue[src]

impl From<KeyboardEvent> for Object[src]

impl From<KeyboardEvent> for UiEvent[src]

impl From<KeyboardEvent> for Event[src]

impl FromWasmAbi for KeyboardEvent[src]

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary. Read more

impl IntoWasmAbi for KeyboardEvent[src]

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary. Read more

impl<'a> IntoWasmAbi for &'a KeyboardEvent[src]

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary. Read more

impl JsCast for KeyboardEvent[src]

impl OptionFromWasmAbi for KeyboardEvent[src]

impl<'a> OptionIntoWasmAbi for &'a KeyboardEvent[src]

impl OptionIntoWasmAbi for KeyboardEvent[src]

impl PartialEq<KeyboardEvent> for KeyboardEvent[src]

impl RefFromWasmAbi for KeyboardEvent[src]

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<KeyboardEvent>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous. Read more

impl StructuralEq for KeyboardEvent[src]

impl StructuralPartialEq for KeyboardEvent[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<Q, K> Equivalent<K> for Q where
    Q: Eq + ?Sized,
    K: Borrow<Q> + ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ReturnWasmAbi for T where
    T: IntoWasmAbi
[src]

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.