Enum crossterm::event::MouseEventKind

pub enum MouseEventKind {
    Down(MouseButton),
    Up(MouseButton),
    Drag(MouseButton),
    Moved,
    ScrollDown,
    ScrollUp,
    ScrollLeft,
    ScrollRight,
}

A mouse event kind.

Platform-specific Notes

Mouse Buttons

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

Variants

Down(MouseButton)

Pressed mouse button. Contains the button that was pressed.

Up(MouseButton)

Released mouse button. Contains the button that was released.

Drag(MouseButton)

Moved the mouse cursor while pressing the contained mouse button.

Moved

Moved the mouse cursor while not pressing a mouse button.

ScrollDown

Scrolled mouse wheel downwards (towards the user).

ScrollUp

Scrolled mouse wheel upwards (away from the user).

ScrollLeft

Scrolled mouse wheel left (mostly on a laptop touchpad).

ScrollRight

Scrolled mouse wheel right (mostly on a laptop touchpad).

Trait Implementations

impl Clone for MouseEventKind

fn clone(&self) -> MouseEventKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseEventKind

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

Formats the value using the given formatter.

impl Hash for MouseEventKind

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

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 MouseEventKind

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for MouseEventKind

impl Eq for MouseEventKind

impl StructuralPartialEq for MouseEventKind