MouseMode

public enum MouseMode

Represents the mouse operation mode that the terminal is currently using and higher level implementations should use the functions in this enumeration to determine what events to send

  • off

    No mouse events are reported

    Declaration

    Swift

    case off
  • x10

    X10 Compatibility mode - only sends events in button press

    Declaration

    Swift

    case x10

  • VT200, also known as Normal Tracking Mode - sends both press and release events

    Declaration

    Swift

    case vt200

  • ButtonEventTracking - In addition to sending button press and release events, it sends motion events when the button is pressed

    Declaration

    Swift

    case buttonEventTracking

  • Sends button presses, button releases, and motion events regardless of the button state

    Declaration

    Swift

    case anyEvent

  • Returns true if you should send a motion event, regardless of button state

    Declaration

    Swift

    public func sendMotionEvent() -> Bool

  • Returns true if the modifiers should be encoded

    Declaration

    Swift

    public func sendsModifiers() -> Bool