KeyboardEnhancementFlagsEvent class final

Returns information terminal keyboard support

See sw.kovidgoyal.net/kitty/keyboard-protocol/#progressive-enhancement for more information.

Inheritance
Annotations
  • @immutable

Constructors

KeyboardEnhancementFlagsEvent(int flags, [int mode = 1])
const
KeyboardEnhancementFlagsEvent.empty()
Returns an empty KeyboardEnhancementFlagsEvent.
factory

Properties

flags int
final
hashCode int
The hash code for this object.
no setterinherited
mode int
final
props List<Object>
The list of properties that will be used to determine whether two instances are equal.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stringify bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited

Methods

add(int flag) KeyboardEnhancementFlagsEvent
Add a flag to the current KeyboardEnhancementFlagsEvent and returns a new object.
has(int flag) bool
Check if a flag is present in the current KeyboardEnhancementFlagsEvent.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

disambiguateEscapeCodes → const int
Represent Escape and modified keys using CSI-u sequences, so they can be unambiguously read.
reportAllKeysAsEscapeCodes → const int
Represent all keyboard events as CSI-u sequences. This is required to get repeat/release events for plain-text keys.
reportAlternateKeys → const int
Send alternate keycodes in addition to the base keycode. The alternate keycode overrides the base keycode in resulting KeyEvents.
reportAssociatedText → const int
Send the Unicode codepoint as well as the keycode.
reportEventTypes → const int
Add extra events with KeyEventType set to KeyEventType.keyRepeat or KeyEventType.keyRelease when keys are auto repeated or released.