Struct Mouse 

pub struct Mouse;

Mouse-reporting options. MO.1 (2026-08-21): ui.mouse, the single switch that decides whether the editor asks the terminal for mouse events at all.

It is its own group rather than a field of Modeline because the modeline is only the first consumer — terminal mouse passthrough (T4.2) and editor-body click/drag want the same switch, and a user reading :customize mouse is asking one question about the whole editor, not about a status row.

Trait Implementations

impl OptionGroup for Mouse

const NAME: &'static str = "mouse"

Public display name. Used as the boundary string for :customize <name> and as the prefix-match key for option group queries. Cannot end in -mode.

const DOC: &'static str = "Mouse reporting: whether the editor captures mouse events from the terminal."

Doc string. Shown in :describe-group <name> and the :customize group picker.

fn type_id() -> TypeId

where Self: Sized,

TypeId for type-driven group lookups.