Struct yew::events::ContextMenuEvent

pub struct ContextMenuEvent(_);

The ContextMenuEvent event is fired when the right button of the mouse is clicked (before the context menu is displayed), or when the context menu key is pressed.

(JavaScript docs)

Trait Implementations

impl IEvent for ContextMenuEvent

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 AsRef<Reference> for ContextMenuEvent

fn as_ref(&self) -> &Reference

Performs the conversion.

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

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Reference> for ContextMenuEvent

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<MouseEvent> for ContextMenuEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(
    value: MouseEvent
) -> Result<ContextMenuEvent, <ContextMenuEvent as TryFrom<MouseEvent>>::Error>

Performs the conversion.

impl TryFrom<Value> for ContextMenuEvent

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Event> for ContextMenuEvent

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UiEvent> for ContextMenuEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(
    value: UiEvent
) -> Result<ContextMenuEvent, <ContextMenuEvent as TryFrom<UiEvent>>::Error>

Performs the conversion.

impl InstanceOf for ContextMenuEvent

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.

impl JsSerialize for ContextMenuEvent

impl IUiEvent for ContextMenuEvent

fn detail(&self) -> i32

Provides the current click count for this event, if applicable.

fn view(&self) -> Option<Window>

Returns the WindowProxy that generated the event.

impl Debug for ContextMenuEvent

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

Formats the value using the given formatter.

impl ConcreteEvent for ContextMenuEvent

const EVENT_TYPE: &'static str

A string representing the event type.

impl IMouseEvent for ContextMenuEvent

fn alt_key(&self) -> bool

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

fn button(&self) -> MouseButton

Indicates the mouse button that fired this event.

fn buttons(&self) -> MouseButtonsState

Indicates which mouse buttons were down when this event was fired.

fn client_x(&self) -> i32

Returns the X position in the application's client area where this event occured.

fn client_y(&self) -> i32

Returns the Y position in the application's client area where this event occured.

fn offset_x(&self) -> f64

Returns the X position on the target element where this event occured.

fn offset_y(&self) -> f64

Returns the Y position on the target element where this event occured.

fn ctrl_key(&self) -> bool

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

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

Returns the current state of the specified modifier key.

fn meta_key(&self) -> bool

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

fn movement_x(&self) -> i32

Returns the change in X coordinate of the pointer between this event and the previous MouseMove event.

fn movement_y(&self) -> i32

Returns the change in Y coordinate of the pointer between this event and the previous MouseMove event.

fn region(&self) -> Option<String>

Returns the ID of the hit region affected by the event.

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

Returns the secondary target of this event, if any.

fn screen_x(&self) -> i32

Returns the X position of the pointer in screen coordinates.

fn screen_y(&self) -> i32

Returns the Y position of the pointer in screen coordinates.

fn shift_key(&self) -> bool

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

impl Clone for ContextMenuEvent

fn clone(&self) -> ContextMenuEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ReferenceType for ContextMenuEvent

unsafe fn from_reference_unchecked(reference: Reference) -> ContextMenuEvent

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

impl Eq for ContextMenuEvent

impl PartialEq<ContextMenuEvent> for ContextMenuEvent

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

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

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

This method tests for !=.