Search Results for

    Show / Hide Table of Contents

    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
    System.Object
    MouseEvent
    Remarks
    The Application class includes the RootMouseEvent Action which takes a MouseEvent argument.
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Terminal.Gui
    Assembly: Terminal.Gui.dll
    Syntax
    public class MouseEvent

    Properties

    | Improve this Doc 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
    | Improve this Doc 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
    System.Boolean
    | Improve this Doc View Source

    OfX

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

    OfY

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

    View

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

    X

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

    Y

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

    Methods

    | Improve this Doc View Source

    ToString()

    Returns a System.String that represents the current MouseEvent.
    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String A System.String that represents the current MouseEvent.
    Overrides
    System.Object.ToString()
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX