- java.lang.Object
-
- java.lang.Enum<Terminal.KittyKeyboardMode>
-
- org.jline.terminal.Terminal.KittyKeyboardMode
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<Terminal.KittyKeyboardMode>
- Enclosing interface:
- Terminal
public static enum Terminal.KittyKeyboardMode extends java.lang.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.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DisambiguateDisambiguate escape codes: all keys get unambiguousCSI ? uencoding.ReportAllKeysReport all keys as escape sequences, including plain text keys that would normally be sent as literal characters.ReportAlternatesReport alternate keys: includes shifted and base-layout key codes in addition to the primary key code.ReportEventsReport event types: distinguishes key press, repeat, and release events.ReportTextReport 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.KittyKeyboardModevalueOf(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.
-
-
-
Enum Constant Detail
-
Disambiguate
public static final Terminal.KittyKeyboardMode Disambiguate
Disambiguate escape codes: all keys get unambiguousCSI ? uencoding. 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 namejava.lang.NullPointerException- if the argument is null
-
-