Enum Terminal.KittyKeyboardMode

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Disambiguate
      Disambiguate escape codes: all keys get unambiguous CSI ? u encoding.
      ReportAllKeys
      Report all keys as escape sequences, including plain text keys that would normally be sent as literal characters.
      ReportAlternates
      Report alternate keys: includes shifted and base-layout key codes in addition to the primary key code.
      ReportEvents
      Report event types: distinguishes key press, repeat, and release events.
      ReportText
      Report associated text: includes the generated text as Unicode codepoints alongside the key event.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Terminal.KittyKeyboardMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Terminal.KittyKeyboardMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • 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 Detail

      • values

        public static Terminal.KittyKeyboardMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (Terminal.KittyKeyboardMode c : Terminal.KittyKeyboardMode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Terminal.KittyKeyboardMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null