Struct yew::prelude::KeyPressEvent

pub struct KeyPressEvent(_);

The KeyPressEvent is fired when a key is pressed down. It’s only fired for keys which produce a character value.

(JavaScript docs)

Trait Implementations

impl AsRef<Reference> for KeyPressEvent

fn as_ref(&self) -> &Reference

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for KeyPressEvent

fn clone(&self) -> KeyPressEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteEvent for KeyPressEvent

const EVENT_TYPE: &'static str = "keypress"

A string representing the event type.

impl Debug for KeyPressEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl IEvent for KeyPressEvent

fn bubbles(&self) -> bool

Indicates whether this event bubbles upward through the DOM.

fn cancel_bubble(&self) -> bool

A historical alias to Event.stopPropagation().

fn set_cancel_bubble(&self, value: bool)

A historical alias to Event.stopPropagation(). Setting this to true before returning from an event handler will stop propagation of the event.

fn cancelable(&self) -> bool

Indicates whether the event is cancelable.

fn current_target(&self) -> Option<EventTarget>

A reference to the currently registered target of this event.

fn default_prevented(&self) -> bool

Indicates whether preventDefault has been called on this event.

fn event_phase(&self) -> EventPhase

Indicates which phase of event flow is currently being evaluated.

fn stop_immediate_propagation(&self)

Prevents any further listeners from being called for this event.

fn stop_propagation(&self)

Stops the propagation of this event to descendants in the DOM.

fn target(&self) -> Option<EventTarget>

Returns a reference to the target to which this event was originally registered.

fn time_stamp(&self) -> Option<f64>

Returns the time in milliseconds at which this event was created.

fn is_trusted(&self) -> bool

Indicates whether the event was generated by a user action.

fn event_type(&self) -> String

Returns a string containing the type of event. It is set when the event is constructed and is the name commonly used to refer to the specific event.

fn prevent_default(&self)

Cancels the event if it is cancelable, without stopping further propagation of the event.

impl IKeyboardEvent for KeyPressEvent

fn alt_key(&self) -> bool

Indicates whether the Alt key was down when this event was fired.

fn code(&self) -> String

Returns a code value that indicates the physical key pressed on the keyboard.

fn ctrl_key(&self) -> bool

Returns whether the Ctrl key was down when this event was fired.

fn get_modifier_state(&self, key: ModifierKey) -> bool

Returns whether a modifier key was down when this event was fired.

fn is_composing(&self) -> bool

Returns whether this event was fired during composition.

fn location(&self) -> KeyboardLocation

Returns the location of the key on the keyboard.

fn key(&self) -> String

Returns the value of a key or keys pressed by the user.

fn meta_key(&self) -> bool

Indicates whether the Meta key was down when this event was fired.

fn repeat(&self) -> bool

Indicates whether the key is held down such that it is repeating.

fn shift_key(&self) -> bool

Indicates whether the Shift key was down when this event was fired.

impl InstanceOf for KeyPressEvent

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.

impl PartialEq<KeyPressEvent> for KeyPressEvent

fn eq(&self, other: &KeyPressEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ReferenceType for KeyPressEvent

unsafe fn from_reference_unchecked(reference: Reference) -> KeyPressEvent

Converts a given reference into a concrete reference-like wrapper. Doesn’t do any type checking; highly unsafe to use!

impl<'_r> TryFrom<&'_r Reference> for KeyPressEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(
    reference: &Reference
) -> Result<KeyPressEvent, <KeyPressEvent as TryFrom<&'_r Reference>>::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Value> for KeyPressEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(
    value: &Value
) -> Result<KeyPressEvent, <KeyPressEvent as TryFrom<&'_r Value>>::Error>

Performs the conversion.

impl TryFrom<Event> for KeyPressEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(
    value: Event
) -> Result<KeyPressEvent, <KeyPressEvent as TryFrom<Event>>::Error>

Performs the conversion.

impl TryFrom<KeyboardEvent> for KeyPressEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(
    value: KeyboardEvent
) -> Result<KeyPressEvent, <KeyPressEvent as TryFrom<KeyboardEvent>>::Error>

Performs the conversion.

impl TryFrom<Reference> for KeyPressEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(
    reference: Reference
) -> Result<KeyPressEvent, <KeyPressEvent as TryFrom<Reference>>::Error>

Performs the conversion.

impl TryFrom<Value> for KeyPressEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(
    value: Value
) -> Result<KeyPressEvent, <KeyPressEvent as TryFrom<Value>>::Error>

Performs the conversion.

impl Eq for KeyPressEvent

impl JsSerialize for KeyPressEvent

impl StructuralEq for KeyPressEvent

impl StructuralPartialEq for KeyPressEvent