Class MouseEvent

Namespace

Terminal.Gui

Assembly

Terminal.Gui.dll

Low-level construct that conveys the details of mouse events, such as coordinates and button state, from ConsoleDrivers up to Application and Views.

public class MouseEvent

Inheritance

object

MouseEvent

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

The Application class includes the RootMouseEvent Action which takes a MouseEvent argument.

Properties

Flags

Flags indicating the kind of mouse event that is being posted.

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.

OfX

The offset X (column) location for the mouse event.

OfY

The offset Y (column) location for the mouse event.

View

The current view at the location for the mouse event.

X

The X (column) location for the mouse event.

Y

The Y (column) location for the mouse event.

Methods

ToString()

Returns a string that represents the current MouseEvent.