Enum Class Terminal.KittyKeyboardMode

java.lang.Object
java.lang.Enum<Terminal.KittyKeyboardMode>
org.jline.terminal.Terminal.KittyKeyboardMode
All Implemented Interfaces:
Serializable, Comparable<Terminal.KittyKeyboardMode>, Constable
Enclosing interface:
Terminal

public static enum Terminal.KittyKeyboardMode extends Enum<Terminal.KittyKeyboardMode>
Enhancement modes for the Kitty Keyboard Protocol.

These modes control which keyboard enhancements the terminal should enable. The protocol uses a flags-based push/pop stack model. Applications push a set of enhancement modes when entering an interactive mode and pop them when leaving.

See Also:
  • Enum Constant Details

    • Disambiguate

      public static final Terminal.KittyKeyboardMode Disambiguate
      Disambiguate escape codes: all keys get unambiguous CSI ? u encoding. This is the primary mode used by JLine's line reader.
    • ReportEvents

      public static final Terminal.KittyKeyboardMode ReportEvents
      Report event types: distinguishes key press, repeat, and release events.
    • ReportAlternates

      public static final Terminal.KittyKeyboardMode ReportAlternates
      Report alternate keys: includes shifted and base-layout key codes in addition to the primary key code.
    • ReportAllKeys

      public static final Terminal.KittyKeyboardMode ReportAllKeys
      Report all keys as escape sequences, including plain text keys that would normally be sent as literal characters.
    • ReportText

      public static final Terminal.KittyKeyboardMode ReportText
      Report associated text: includes the generated text as Unicode codepoints alongside the key event.
  • Method Details

    • values

      public static Terminal.KittyKeyboardMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static Terminal.KittyKeyboardMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null