Enum MouseButton 

pub enum MouseButton {
    Left,
    Middle,
    Right,
    WheelUp,
    WheelDown,
    WheelLeft,
    WheelRight,
    Button4,
    Button5,
    Button6,
    Button7,
    Button8,
    Button9,
    Button10,
    Button11,
    None,
}

Mouse button or wheel direction associated with a Mouse event.

Button names describe the decoded terminal bitfield, not a physical device guarantee. Some terminals cannot identify the released button and report MouseButton::None instead.

Variants

Left

Primary (left) mouse button.

Middle

Middle mouse button, often the wheel button.

Right

Secondary (right) mouse button.

WheelUp

Vertical wheel scrolled up.

WheelDown

Vertical wheel scrolled down.

WheelLeft

Horizontal wheel scrolled left.

WheelRight

Horizontal wheel scrolled right.

Button4

Additional mouse button 4 when encoded by a terminal extension.

Button5

Additional mouse button 5 when encoded by a terminal extension.

Button6

Additional mouse button 6 when encoded by a terminal extension.

Button7

Additional mouse button 7 when encoded by a terminal extension.

Button8

Additional mouse button 8 when encoded by a terminal extension.

Button9

Additional mouse button 9 when encoded by a terminal extension.

Button10

Additional mouse button 10 when encoded by a terminal extension.

Button11

Additional mouse button 11 when encoded by a terminal extension.

None

No button was reported.

This appears for legacy release records and hover-style motion where the protocol does not attach a specific held button.

Trait Implementations

impl Clone for MouseButton

fn clone(&self) -> MouseButton

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MouseButton

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

Formats the value using the given formatter.

impl Hash for MouseButton

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MouseButton

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

impl Eq for MouseButton

impl StructuralPartialEq for MouseButton