Skip to main content

MouseCaptureState

Struct MouseCaptureState 

Source
pub struct MouseCaptureState { /* private fields */ }
Expand description

State for mouse capture management

Tracks whether mouse capture is enabled and provides methods to toggle it. When mouse capture is disabled, the terminal allows native text selection (copy mode).

Implementations§

Source§

impl MouseCaptureState

Source

pub fn new(enabled: bool) -> Self

Create a new mouse capture state

§Arguments
  • enabled - Initial state (true = capturing mouse events)
Source

pub fn enabled() -> Self

Create a new state with mouse capture enabled

Source

pub fn disabled() -> Self

Create a new state with mouse capture disabled (copy mode)

Source

pub fn is_enabled(&self) -> bool

Check if mouse capture is currently enabled

Source

pub fn is_copy_mode(&self) -> bool

Check if copy mode is active (mouse capture disabled)

When in copy mode, the terminal allows native text selection.

Source

pub fn set_enabled(&mut self, enabled: bool)

Set the mouse capture state

Source

pub fn toggle(&mut self) -> bool

Toggle the mouse capture state and return the new state

Trait Implementations§

Source§

impl Clone for MouseCaptureState

Source§

fn clone(&self) -> MouseCaptureState

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MouseCaptureState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MouseCaptureState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for MouseCaptureState

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for MouseCaptureState

Source§

impl Eq for MouseCaptureState

Source§

impl StructuralPartialEq for MouseCaptureState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.