Table of Contents

Field CSI_EnableMouseEvents

Namespace
Terminal.Gui.Drivers
Assembly
Terminal.Gui.dll

Control sequence for enabling comprehensive mouse event tracking.

public static readonly string CSI_EnableMouseEvents

Returns

string
Control sequence for enabling comprehensive mouse event tracking.

Remarks

Enables three mouse tracking modes simultaneously:

  1. Mode 1003 (any-event) - Reports all mouse events including motion with/without buttons
  2. Mode 1015 (URXVT) - UTF-8 coordinate encoding (fallback for older terminals)
  3. Mode 1006 (SGR) - Modern decimal format with unlimited coordinates (preferred)

When multiple format modes are enabled, modern terminals typically use the most capable format (SGR), while older terminals fall back to URXVT or traditional encoding. This ensures broad terminal compatibility.

Note: The ANSI specification does NOT provide auto-repeat of button press events while held stationary. You receive one press event, optional motion events (if mode 1003 is enabled), and one release event.

Edit this page