Struct web_sys::KeyboardEventInit
source · pub struct KeyboardEventInit { /* private fields */ }
Expand description
The KeyboardEventInit
dictionary.
This API requires the following crate features to be activated: KeyboardEventInit
Implementations§
source§impl KeyboardEventInit
impl KeyboardEventInit
sourcepub fn new() -> Self
pub fn new() -> Self
Construct a new KeyboardEventInit
.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn bubbles(&mut self, val: bool) -> &mut Self
pub fn bubbles(&mut self, val: bool) -> &mut Self
Change the bubbles
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn cancelable(&mut self, val: bool) -> &mut Self
pub fn cancelable(&mut self, val: bool) -> &mut Self
Change the cancelable
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn composed(&mut self, val: bool) -> &mut Self
pub fn composed(&mut self, val: bool) -> &mut Self
Change the composed
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn detail(&mut self, val: i32) -> &mut Self
pub fn detail(&mut self, val: i32) -> &mut Self
Change the detail
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn view(&mut self, val: Option<&Window>) -> &mut Self
pub fn view(&mut self, val: Option<&Window>) -> &mut Self
Change the view
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
, Window
sourcepub fn alt_key(&mut self, val: bool) -> &mut Self
pub fn alt_key(&mut self, val: bool) -> &mut Self
Change the altKey
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn ctrl_key(&mut self, val: bool) -> &mut Self
pub fn ctrl_key(&mut self, val: bool) -> &mut Self
Change the ctrlKey
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn meta_key(&mut self, val: bool) -> &mut Self
pub fn meta_key(&mut self, val: bool) -> &mut Self
Change the metaKey
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn modifier_alt_graph(&mut self, val: bool) -> &mut Self
pub fn modifier_alt_graph(&mut self, val: bool) -> &mut Self
Change the modifierAltGraph
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn modifier_caps_lock(&mut self, val: bool) -> &mut Self
pub fn modifier_caps_lock(&mut self, val: bool) -> &mut Self
Change the modifierCapsLock
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn modifier_fn(&mut self, val: bool) -> &mut Self
pub fn modifier_fn(&mut self, val: bool) -> &mut Self
Change the modifierFn
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn modifier_fn_lock(&mut self, val: bool) -> &mut Self
pub fn modifier_fn_lock(&mut self, val: bool) -> &mut Self
Change the modifierFnLock
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn modifier_num_lock(&mut self, val: bool) -> &mut Self
pub fn modifier_num_lock(&mut self, val: bool) -> &mut Self
Change the modifierNumLock
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn modifier_os(&mut self, val: bool) -> &mut Self
pub fn modifier_os(&mut self, val: bool) -> &mut Self
Change the modifierOS
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn modifier_scroll_lock(&mut self, val: bool) -> &mut Self
pub fn modifier_scroll_lock(&mut self, val: bool) -> &mut Self
Change the modifierScrollLock
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn modifier_symbol(&mut self, val: bool) -> &mut Self
pub fn modifier_symbol(&mut self, val: bool) -> &mut Self
Change the modifierSymbol
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn modifier_symbol_lock(&mut self, val: bool) -> &mut Self
pub fn modifier_symbol_lock(&mut self, val: bool) -> &mut Self
Change the modifierSymbolLock
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn shift_key(&mut self, val: bool) -> &mut Self
pub fn shift_key(&mut self, val: bool) -> &mut Self
Change the shiftKey
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn char_code(&mut self, val: u32) -> &mut Self
pub fn char_code(&mut self, val: u32) -> &mut Self
Change the charCode
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn code(&mut self, val: &str) -> &mut Self
pub fn code(&mut self, val: &str) -> &mut Self
Change the code
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn is_composing(&mut self, val: bool) -> &mut Self
pub fn is_composing(&mut self, val: bool) -> &mut Self
Change the isComposing
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn key(&mut self, val: &str) -> &mut Self
pub fn key(&mut self, val: &str) -> &mut Self
Change the key
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn key_code(&mut self, val: u32) -> &mut Self
pub fn key_code(&mut self, val: u32) -> &mut Self
Change the keyCode
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
sourcepub fn location(&mut self, val: u32) -> &mut Self
pub fn location(&mut self, val: u32) -> &mut Self
Change the location
field of this object.
This API requires the following crate features to be activated: KeyboardEventInit
Methods from Deref<Target = Object>§
sourcepub fn constructor(&self) -> Function
pub fn constructor(&self) -> Function
The constructor property returns a reference to the Object
constructor
function that created the instance object.
sourcepub fn has_own_property(&self, property: &JsValue) -> bool
pub fn has_own_property(&self, property: &JsValue) -> bool
The hasOwnProperty()
method returns a boolean indicating whether the
object has the specified property as its own property (as opposed to
inheriting it).
sourcepub fn is_prototype_of(&self, value: &JsValue) -> bool
pub fn is_prototype_of(&self, value: &JsValue) -> bool
The isPrototypeOf()
method checks if an object exists in another
object’s prototype chain.
sourcepub fn property_is_enumerable(&self, property: &JsValue) -> bool
pub fn property_is_enumerable(&self, property: &JsValue) -> bool
The propertyIsEnumerable()
method returns a Boolean indicating
whether the specified property is enumerable.
sourcepub fn to_locale_string(&self) -> JsString
pub fn to_locale_string(&self) -> JsString
The toLocaleString()
method returns a string representing the object.
This method is meant to be overridden by derived objects for
locale-specific purposes.
sourcepub fn to_string(&self) -> JsString
pub fn to_string(&self) -> JsString
The toString()
method returns a string representing the object.
Methods from Deref<Target = JsValue>§
pub const NULL: JsValue = _
pub const UNDEFINED: JsValue = _
pub const TRUE: JsValue = _
pub const FALSE: JsValue = _
sourcepub fn as_f64(&self) -> Option<f64>
pub fn as_f64(&self) -> Option<f64>
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
.
sourcepub fn as_string(&self) -> Option<String>
pub fn as_string(&self) -> Option<String>
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.
sourcepub fn as_bool(&self) -> Option<bool>
pub fn as_bool(&self) -> Option<bool>
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
.
sourcepub fn is_undefined(&self) -> bool
pub fn is_undefined(&self) -> bool
Tests whether this JS value is undefined
sourcepub fn is_function(&self) -> bool
pub fn is_function(&self) -> bool
Tests whether the type of this JS value is function
.
sourcepub fn js_in(&self, obj: &JsValue) -> bool
pub fn js_in(&self, obj: &JsValue) -> bool
Applies the binary in
JS operator on the two JsValue
s.
sourcepub fn loose_eq(&self, other: &JsValue) -> bool
pub fn loose_eq(&self, other: &JsValue) -> bool
Compare two JsValue
s for equality, using the ==
operator in JS.
sourcepub fn unsigned_shr(&self, rhs: &JsValue) -> u32
pub fn unsigned_shr(&self, rhs: &JsValue) -> u32
Applies the binary >>>
JS operator on the two JsValue
s.
sourcepub fn checked_div(&self, rhs: &JsValue) -> JsValue
pub fn checked_div(&self, rhs: &JsValue) -> JsValue
Applies the binary /
JS operator on two JsValue
s, catching and returning any RangeError
thrown.
sourcepub fn pow(&self, rhs: &JsValue) -> JsValue
pub fn pow(&self, rhs: &JsValue) -> JsValue
Applies the binary **
JS operator on the two JsValue
s.
sourcepub fn lt(&self, other: &JsValue) -> bool
pub fn lt(&self, other: &JsValue) -> bool
Applies the binary <
JS operator on the two JsValue
s.
sourcepub fn le(&self, other: &JsValue) -> bool
pub fn le(&self, other: &JsValue) -> bool
Applies the binary <=
JS operator on the two JsValue
s.
sourcepub fn ge(&self, other: &JsValue) -> bool
pub fn ge(&self, other: &JsValue) -> bool
Applies the binary >=
JS operator on the two JsValue
s.
sourcepub fn gt(&self, other: &JsValue) -> bool
pub fn gt(&self, other: &JsValue) -> bool
Applies the binary >
JS operator on the two JsValue
s.
sourcepub fn unchecked_into_f64(&self) -> f64
pub fn unchecked_into_f64(&self) -> f64
Applies the unary +
JS operator on a JsValue
. Can throw.
Trait Implementations§
source§impl AsRef<JsValue> for KeyboardEventInit
impl AsRef<JsValue> for KeyboardEventInit
source§impl AsRef<KeyboardEventInit> for KeyboardEventInit
impl AsRef<KeyboardEventInit> for KeyboardEventInit
source§fn as_ref(&self) -> &KeyboardEventInit
fn as_ref(&self) -> &KeyboardEventInit
source§impl AsRef<Object> for KeyboardEventInit
impl AsRef<Object> for KeyboardEventInit
source§impl Clone for KeyboardEventInit
impl Clone for KeyboardEventInit
source§fn clone(&self) -> KeyboardEventInit
fn clone(&self) -> KeyboardEventInit
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for KeyboardEventInit
impl Debug for KeyboardEventInit
source§impl Default for KeyboardEventInit
impl Default for KeyboardEventInit
source§impl Deref for KeyboardEventInit
impl Deref for KeyboardEventInit
source§impl From<JsValue> for KeyboardEventInit
impl From<JsValue> for KeyboardEventInit
source§fn from(obj: JsValue) -> KeyboardEventInit
fn from(obj: JsValue) -> KeyboardEventInit
source§impl From<KeyboardEventInit> for JsValue
impl From<KeyboardEventInit> for JsValue
source§fn from(obj: KeyboardEventInit) -> JsValue
fn from(obj: KeyboardEventInit) -> JsValue
source§impl From<KeyboardEventInit> for Object
impl From<KeyboardEventInit> for Object
source§fn from(obj: KeyboardEventInit) -> Object
fn from(obj: KeyboardEventInit) -> Object
source§impl FromWasmAbi for KeyboardEventInit
impl FromWasmAbi for KeyboardEventInit
source§impl<'a> IntoWasmAbi for &'a KeyboardEventInit
impl<'a> IntoWasmAbi for &'a KeyboardEventInit
source§impl IntoWasmAbi for KeyboardEventInit
impl IntoWasmAbi for KeyboardEventInit
source§impl JsCast for KeyboardEventInit
impl JsCast for KeyboardEventInit
source§fn instanceof(val: &JsValue) -> bool
fn instanceof(val: &JsValue) -> bool
instanceof
check to see whether the JsValue
provided is an instance of this type. Read moresource§fn unchecked_from_js(val: JsValue) -> Self
fn unchecked_from_js(val: JsValue) -> Self
source§fn unchecked_from_js_ref(val: &JsValue) -> &Self
fn unchecked_from_js_ref(val: &JsValue) -> &Self
source§fn has_type<T>(&self) -> boolwhere
T: JsCast,
fn has_type<T>(&self) -> boolwhere T: JsCast,
T
. Read moresource§fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
fn dyn_into<T>(self) -> Result<T, Self>where T: JsCast,
T
. Read moresource§fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
fn dyn_ref<T>(&self) -> Option<&T>where T: JsCast,
T
. Read moresource§fn unchecked_into<T>(self) -> Twhere
T: JsCast,
fn unchecked_into<T>(self) -> Twhere T: JsCast,
source§fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
fn unchecked_ref<T>(&self) -> &Twhere T: JsCast,
source§impl LongRefFromWasmAbi for KeyboardEventInit
impl LongRefFromWasmAbi for KeyboardEventInit
§type Abi = <JsValue as LongRefFromWasmAbi>::Abi
type Abi = <JsValue as LongRefFromWasmAbi>::Abi
RefFromWasmAbi::Abi
§type Anchor = KeyboardEventInit
type Anchor = KeyboardEventInit
RefFromWasmAbi::Anchor
source§unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
RefFromWasmAbi::ref_from_abi
source§impl<'a> OptionIntoWasmAbi for &'a KeyboardEventInit
impl<'a> OptionIntoWasmAbi for &'a KeyboardEventInit
source§impl PartialEq for KeyboardEventInit
impl PartialEq for KeyboardEventInit
source§fn eq(&self, other: &KeyboardEventInit) -> bool
fn eq(&self, other: &KeyboardEventInit) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl RefFromWasmAbi for KeyboardEventInit
impl RefFromWasmAbi for KeyboardEventInit
§type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
Self
are recovered from.§type Anchor = ManuallyDrop<KeyboardEventInit>
type Anchor = ManuallyDrop<KeyboardEventInit>
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.impl Eq for KeyboardEventInit
impl StructuralEq for KeyboardEventInit
impl StructuralPartialEq for KeyboardEventInit
Auto Trait Implementations§
impl RefUnwindSafe for KeyboardEventInit
impl !Send for KeyboardEventInit
impl !Sync for KeyboardEventInit
impl Unpin for KeyboardEventInit
impl UnwindSafe for KeyboardEventInit
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
impl<T> ReturnWasmAbi for Twhere T: IntoWasmAbi,
§type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
IntoWasmAbi::Abi
source§fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
.