Enum MouseEvent 

pub enum MouseEvent {
    Down(MouseButton, u16, u16, KeyModifiers),
    Up(MouseButton, u16, u16, KeyModifiers),
    Drag(MouseButton, u16, u16, KeyModifiers),
    ScrollDown(u16, u16, KeyModifiers),
    ScrollUp(u16, u16, KeyModifiers),
}

Represents a mouse event.

Platform-specific Notes

Mouse Buttons

Some platforms/terminals do not report mouse button for the MouseEvent::Up and MouseEvent::Drag events. MouseButton::Left is returned if we don’t know which button was used.

Key Modifiers

Some platforms/terminals does not report all key modifiers combinations for all mouse event types. For example - macOS reports Ctrl + left mouse button click as a right mouse button click.

Variants

Down(MouseButton, u16, u16, KeyModifiers)

Pressed mouse button.

Contains mouse button, pressed pointer location (column, row), and additional key modifiers.

Up(MouseButton, u16, u16, KeyModifiers)

Released mouse button.

Contains mouse button, released pointer location (column, row), and additional key modifiers.

Drag(MouseButton, u16, u16, KeyModifiers)

Moved mouse pointer while pressing a mouse button.

Contains the pressed mouse button, released pointer location (column, row), and additional key modifiers.

ScrollDown(u16, u16, KeyModifiers)

Scrolled mouse wheel downwards (towards the user).

Contains the scroll location (column, row), and additional key modifiers.

ScrollUp(u16, u16, KeyModifiers)

Scrolled mouse wheel upwards (away from the user).

Contains the scroll location (column, row), and additional key modifiers.

Trait Implementations

impl Clone for MouseEvent

fn clone(&self) -> MouseEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MouseEvent

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

Formats the value using the given formatter.

impl Hash for MouseEvent

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 PartialEq for MouseEvent

fn eq(&self, other: &MouseEvent) -> 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 MouseEvent

fn partial_cmp(&self, other: &MouseEvent) -> 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 MouseEvent

impl Eq for MouseEvent

impl StructuralPartialEq for MouseEvent