Enum MouseMode 

#[non_exhaustive]
pub enum MouseMode {
    None,
    Press,
    PressRelease,
    ButtonMotion,
    AnyMotion,
}

Which mouse events the application asked its terminal to report.

Read it from a snapshot via Screen::mouse_mode; Terminal::click and Terminal::scroll consult the same state to encode exactly what the application expects.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

No mouse tracking enabled.

Press

X10 mode (CSI ?9 h): presses only.

PressRelease

VT200 mode (CSI ?1000 h): presses and releases.

ButtonMotion

Button-event tracking (CSI ?1002 h): presses, releases, and motion while a button is held down.

AnyMotion

Any-event tracking (CSI ?1003 h): presses, releases, and all motion.

Trait Implementations

impl Clone for MouseMode

fn clone(&self) -> MouseMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MouseMode

impl Debug for MouseMode

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

Formats the value using the given formatter.

impl Default for MouseMode

fn default() -> MouseMode

Returns the “default value” for a type.

impl Eq for MouseMode

impl Hash for MouseMode

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 MouseMode

fn eq(&self, other: &MouseMode) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MouseMode