Enum freya_core::events::event_name::EventName

pub enum EventName {
    Click,
    MiddleClick,
    RightClick,
    MouseUp,
    MouseDown,
    MouseMove,
    MouseEnter,
    MouseLeave,
    Wheel,
    PointerOver,
    PointerDown,
    PointerEnter,
    PointerLeave,
    PointerUp,
    KeyDown,
    KeyUp,
    GlobalKeyDown,
    GlobalKeyUp,
    TouchCancel,
    TouchStart,
    TouchMove,
    TouchEnd,
    GlobalClick,
    GlobalPointerUp,
    GlobalMouseDown,
    GlobalMouseMove,
    GlobalFileHover,
    GlobalFileHoverCancelled,
    FileDrop,
}

Variants

Click

MiddleClick

RightClick

MouseUp

MouseDown

MouseMove

MouseEnter

MouseLeave

Wheel

PointerOver

PointerDown

PointerEnter

PointerLeave

PointerUp

KeyDown

KeyUp

GlobalKeyDown

GlobalKeyUp

TouchCancel

TouchStart

TouchMove

TouchEnd

GlobalClick

GlobalPointerUp

GlobalMouseDown

GlobalMouseMove

GlobalFileHover

GlobalFileHoverCancelled

FileDrop

Implementations

impl EventName

pub fn get_global_event(&self) -> Option<EventName>

Get the equivalent to a global event

pub fn get_collateral_events(&self) -> SmallVec<[EventName; 4]>

Some events might cause other events, like for example: A mousemove might also trigger a mouseenter A mousedown or a touchdown might also trigger a pointerdown

pub fn is_enter(&self) -> bool

Check if the event means that the pointer (e.g. cursor) just entered a Node

pub fn is_pointer(&self) -> bool

Check if it’s one of the Pointer variants

pub fn was_cursor_moved(&self) -> bool

Check if the event means the cursor was moved

pub fn does_bubble(&self) -> bool

pub fn does_go_through_solid(&self) -> bool

Only let events that do not move the mouse, go through solid nodes

pub fn can_change_hover_state(&self) -> bool

Check if this event can change the hover state of a Node.

pub fn can_change_press_state(&self) -> bool

Check if this event can change the press state of a Node.

pub fn was_cursor_pressed_or_released(&self) -> bool

Check if the event means the cursor started or released a click

pub fn is_pressed(&self) -> bool

Check if the event was pressed

Trait Implementations

impl Clone for EventName

fn clone(&self) -> EventName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventName

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

Formats the value using the given formatter.

impl From<EventName> for &str

fn from(event: EventName) -> &str

Converts to this type from the input type.

impl FromStr for EventName

type Err = ()

The associated error which can be returned from parsing.

fn from_str(txt: &str) -> Result<EventName, <EventName as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for EventName

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EventName

fn cmp(&self, other: &EventName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for EventName

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for EventName

fn partial_cmp(&self, other: &EventName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for EventName

impl Eq for EventName

impl StructuralPartialEq for EventName