Class MouseEvent

Low-level construct that conveys the details of mouse events, such as coordinates and button state, from ConsoleDrivers up to Application and Views.
Inheritance
object
MouseEvent
Inherited Members
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class MouseEvent
Remarks
The Application class includes the RootMouseEvent Action which takes a MouseEvent argument.

Properties

| Edit this page View Source

Flags

Flags indicating the kind of mouse event that is being posted.
Declaration
public MouseFlags Flags { get; set; }
Property Value
Type Description
MouseFlags
| Edit this page View Source

Handled

Indicates if the current mouse event has already been processed and the driver should stop notifying any other event subscriber. Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
Declaration
public bool Handled { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

OfX

The offset X (column) location for the mouse event.
Declaration
public int OfX { get; set; }
Property Value
Type Description
int
| Edit this page View Source

OfY

The offset Y (column) location for the mouse event.
Declaration
public int OfY { get; set; }
Property Value
Type Description
int
| Edit this page View Source

View

The current view at the location for the mouse event.
Declaration
public View View { get; set; }
Property Value
Type Description
View
| Edit this page View Source

X

The X (column) location for the mouse event.
Declaration
public int X { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Y

The Y (column) location for the mouse event.
Declaration
public int Y { get; set; }
Property Value
Type Description
int

Methods

| Edit this page View Source

ToString()

Returns a string that represents the current MouseEvent.
Declaration
public override string ToString()
Returns
Type Description
string A string that represents the current MouseEvent.
Overrides