Struct TerminalMouseEvent 

pub struct TerminalMouseEvent {
    pub event_type: MouseEventType,
    pub col: u16,
    pub row: u16,
    /* private fields */
}

Mouse event data with terminal cell coordinates.

Represents a mouse event translated from pixel coordinates to terminal grid coordinates, including modifier key states.col and row are 0-based terminal grid coordinates

Fields

event_type: MouseEventType

Type of mouse event (down, up, or move).

col: u16

Column in the terminal grid (0-based).

row: u16

Row in the terminal grid (0-based).

Implementations

impl TerminalMouseEvent

pub fn button(&self) -> i16

Returns the mouse button pressed during the event.

pub fn ctrl_key(&self) -> bool

Returns whether the Ctrl key was pressed during the event.

pub fn shift_key(&self) -> bool

Returns whether the Shift key was pressed during the event.

pub fn alt_key(&self) -> bool

Returns whether the Alt key was pressed during the event.

pub fn meta_key(&self) -> bool

Returns whether the Meta key was pressed during the event.

This is the Command key on macOS or the Windows key on Windows.

pub fn has_exact_modifiers(&self, mods: ModifierKeys) -> bool

Returns whether the pressed modifiers exactly match the specified set.

Returns true only if the modifier keys pressed during the event are exactly equal to mods—no more, no less.

Trait Implementations

impl Clone for TerminalMouseEvent

fn clone(&self) -> TerminalMouseEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalMouseEvent

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

Formats the value using the given formatter.

impl From<TerminalMouseEvent> for MouseEvent

fn from(event: TerminalMouseEvent) -> Self

Converts to this type from the input type.

impl Copy for TerminalMouseEvent