Struct MouseEvent 

pub struct MouseEvent {
    pub kind: MouseEventKind,
    pub x: u16,
    pub y: u16,
    pub modifiers: Modifiers,
}

A mouse event.

Fields

kind: MouseEventKind

The type of mouse event.

x: u16

X coordinate (0-indexed, leftmost column is 0).

y: u16

Y coordinate (0-indexed, topmost row is 0).

modifiers: Modifiers

Modifier keys held during the event.

Implementations

impl MouseEvent

pub const fn new(kind: MouseEventKind, x: u16, y: u16) -> Self

Create a new mouse event.

pub const fn with_modifiers(self, modifiers: Modifiers) -> Self

Create a mouse event with modifiers.

pub const fn position(&self) -> (u16, u16)

Get the position as a tuple.

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

impl Eq for MouseEvent

impl StructuralPartialEq for MouseEvent