Struct crossterm::event::MouseEvent

pub struct MouseEvent {
    pub kind: MouseEventKind,
    pub column: u16,
    pub row: u16,
    pub modifiers: KeyModifiers,
}

Represents a mouse event.

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.

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.

Fields

kind: MouseEventKind

The kind of mouse event that was caused.

column: u16

The column that the event occurred on.

row: u16

The row that the event occurred on.

modifiers: KeyModifiers

The key modifiers active when the event occurred.

Trait Implementations

impl Clone for MouseEvent

fn clone(&self) -> MouseEvent

Returns a copy 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

Formats the value using the given formatter.

impl Hash for MouseEvent

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<MouseEvent> for MouseEvent

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

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

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

This method tests for !=.

impl PartialOrd<MouseEvent> 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

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 MouseEvent

impl Eq for MouseEvent

impl StructuralEq for MouseEvent

impl StructuralPartialEq for MouseEvent