Class GrabMouseEventArgs

Namespace

Terminal.Gui.Input

Assembly

Terminal.Gui.dll

Provides data for mouse grab-related events (GrabbingMouse and UnGrabbingMouse).

public class GrabMouseEventArgs : EventArgs

Inheritance

object

EventArgs

GrabMouseEventArgs

Inherited Members

EventArgs.Empty

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This class is used with the Cancellable Work Pattern (CWP). Handlers can set Cancel to true to prevent the grab or ungrab operation from proceeding.

Use Cases for Cancellation:

• Prevent Grab Theft: Cancel GrabbingMouse when another view tries to grab the mouse during an active drag operation.
• Prevent Premature Release: Cancel UnGrabbingMouse when a drag operation must complete before the grab can be released.

Constructors

GrabMouseEventArgs(View)

Initializes a new instance of the GrabMouseEventArgs class.

Properties

Cancel

Gets or sets a value indicating whether the grab or ungrab operation should be cancelled.

View

Gets the view that is requesting or releasing the mouse grab.

See Also

IMouseGrabHandler

GrabbingMouse

UnGrabbingMouse