Enum MouseCapturePolicy 

pub enum MouseCapturePolicy {
    Auto,
    On,
    Off,
}

Policy controlling when terminal mouse capture is enabled.

Mouse capture can steal normal scrollback interaction in inline mode. Auto keeps inline mode scrollback-safe while still enabling mouse in alt-screen mode.

Variants

Auto

Enable in alt-screen mode, disable in inline modes.

On

Always enable mouse capture.

Off

Always disable mouse capture.

Implementations

impl MouseCapturePolicy

pub const fn resolve(self, screen_mode: ScreenMode) -> bool

Resolve the policy to a concrete mouse-capture toggle.

Trait Implementations

impl Clone for MouseCapturePolicy

fn clone(&self) -> MouseCapturePolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MouseCapturePolicy

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

Formats the value using the given formatter.

impl Default for MouseCapturePolicy

fn default() -> MouseCapturePolicy

Returns the “default value” for a type.

impl PartialEq for MouseCapturePolicy

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

impl Eq for MouseCapturePolicy

impl StructuralPartialEq for MouseCapturePolicy