Struct crossterm::event::MouseEvent [−][src]
pub struct MouseEvent { pub kind: MouseEventKind, pub column: u16, pub row: u16, pub modifiers: KeyModifiers, }
Expand description
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
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl RefUnwindSafe for MouseEvent
impl Send for MouseEvent
impl Sync for MouseEvent
impl Unpin for MouseEvent
impl UnwindSafe for MouseEvent
Blanket Implementations
Mutably borrows from an owned value. Read more