Enum crossterm::event::MouseEventKind

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

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).

Trait Implementations

impl Clone for MouseEventKind

pub fn clone(&self) -> MouseEventKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MouseEventKind

impl Debug for MouseEventKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MouseEventKind

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for MouseEventKind

impl Hash for MouseEventKind

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<MouseEventKind> for MouseEventKind

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

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

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

This method tests for !=.

impl PartialOrd<MouseEventKind> for MouseEventKind

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

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

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

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

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

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

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

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

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

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

impl Serialize for MouseEventKind

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for MouseEventKind

impl StructuralPartialEq for MouseEventKind