Enum MouseState

Namespace

Terminal.Gui.ViewBase

Assembly

Terminal.Gui.dll

Used to describe the state of the mouse in relation to a View (MouseState) and to specify visual effects, such as highlighting a button when the mouse is over it or changing the appearance of a view when the mouse is pressed (HighlightStates).

[JsonConverter(typeof(JsonStringEnumConverter<MouseState>))]
[Flags]
public enum MouseState

Fields

In = 1

The mouse is in the Viewport (but not pressed). Set between the MouseEnter and MouseLeave events.

None = 0

No mouse interaction with the view is occurring.

Pressed = 2

The mouse is in the Viewport and is pressed.

PressedOutside = 4

The mouse is outside the Viewport and is pressed. If WantContinuousButtonPressed is true, this flag is ignored so that the view remains in the pressed state until the mouse is released.

See Also

MouseState

HighlightStates