Class Mouse

Namespace: Terminal.Gui.Input

Assembly: Terminal.Gui.dll

Provides an abstraction for common mouse operations and state. Represents a mouse event, including position, button state, and other flags.

public class Mouse : EventArgs

Inheritance: object

EventArgs

Mouse

Inherited Members: EventArgs.Empty

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

The MouseEvent event uses this class.

Constructors

Mouse(): Initializes a new instance of the Mouse class.

Properties

Flags: Flags indicating the state of the mouse buttons and the type of event that occurred.

Handled: Gets or sets a value indicating whether the mouse event was handled.

IsDoubleClicked: Gets a value indicating whether a double-click mouse event occurred.

IsPressed: Gets a value indicating whether a mouse button was pressed.

IsReleased: Gets a value indicating whether a mouse button was released.

IsSingleClicked: Gets a value indicating whether a single-click mouse event occurred.

IsSingleDoubleOrTripleClicked: Gets a value indicating whether a single, double, or triple-click mouse event occurred.

IsTripleClicked: Gets a value indicating whether a triple-click mouse event occurred.

IsWheel: Gets a value indicating whether a mouse wheel event occurred.

Position: The position of the mouse in View's viewport-relative coordinates.

ScreenPosition: The screen-relative mouse position, in columns and rows.

Timestamp: The timestamp when this mouse event was created. Used for multi-click detection timing.

View: The view that is the target of the mouse event.

Methods

ToString(): Returns a string that represents the current mouse event.

Edit this page