Struct MouseMsg 

pub struct MouseMsg {
    pub x: u16,
    pub y: u16,
    pub shift: bool,
    pub alt: bool,
    pub ctrl: bool,
    pub action: MouseAction,
    pub button: MouseButton,
}

Mouse event message.

MouseMsg is sent to the program’s update function when mouse activity occurs. Note: Mouse events must be enabled using Program::with_mouse_cell_motion() or Program::with_mouse_all_motion().

Example

use bubbletea::{MouseMsg, MouseButton, MouseAction};

fn handle_mouse(mouse: MouseMsg) {
    if mouse.button == MouseButton::Left && mouse.action == MouseAction::Press {
        println!("Left click at ({}, {})", mouse.x, mouse.y);
    }
}

Fields

x: u16

X coordinate (column), 0-indexed.

y: u16

Y coordinate (row), 0-indexed.

shift: bool

Whether Shift was held.

alt: bool

Whether Alt was held.

ctrl: bool

Whether Ctrl was held.

action: MouseAction

The action that occurred.

button: MouseButton

The button involved.

Implementations

impl MouseMsg

pub fn is_wheel(&self) -> bool

Check if this is a wheel event.

Trait Implementations

impl Clone for MouseMsg

fn clone(&self) -> MouseMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MouseMsg

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

Formats the value using the given formatter.

impl Default for MouseMsg

fn default() -> Self

Returns the “default value” for a type.

impl Display for MouseMsg

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

Formats the value using the given formatter.

impl PartialEq for MouseMsg

fn eq(&self, other: &MouseMsg) -> 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 MouseMsg

impl Eq for MouseMsg

impl StructuralPartialEq for MouseMsg