Struct MouseEvent 

#[non_exhaustive]
pub struct MouseEvent {
    pub kind: MouseKind,
    pub x: u32,
    pub y: u32,
    pub modifiers: KeyModifiers,
    pub pixel_x: Option<u16>,
    pub pixel_y: Option<u16>,
}

A mouse event with position and kind.

Coordinates are zero-based terminal columns (x) and rows (y). pixel_x and pixel_y are reserved for future sub-cell precision (e.g. Kitty pixel mouse protocol, WASM backend); they are currently always None with the crossterm backend, since SGR 1006 only reports cell coordinates and crossterm 0.28 has no pixel mouse fields. Mouse events are only produced when mouse: true is set in crate::RunConfig.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: MouseKind

The type of mouse action that occurred.

x: u32

Column (horizontal position), zero-based.

y: u32

Row (vertical position), zero-based.

modifiers: KeyModifiers

Modifier keys held at the time of the event.

pixel_x: Option<u16>

Pixel-level x coordinate (reserved).

Currently always None with the crossterm backend; populated only when a Kitty-capable or WASM backend provides sub-cell precision.

pixel_y: Option<u16>

Pixel-level y coordinate (reserved).

Currently always None with the crossterm backend; populated only when a Kitty-capable or WASM backend provides sub-cell precision.

Implementations

impl MouseEvent

pub fn new( kind: MouseKind, x: u32, y: u32, modifiers: KeyModifiers, pixel_x: Option<u16>, pixel_y: Option<u16>, ) -> Self

Create a new MouseEvent with all fields.

pub fn is_scroll(&self) -> bool

Returns true if this is a scroll event.

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

Formats the value using the given formatter.

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

impl StructuralPartialEq for MouseEvent