VtKeyEvent class final

Mutable key event used with VtKeyEncoder.

Configure the event's action, key, mods, and utf8Text properties, then pass it to VtKeyEncoder.encode to produce terminal escape bytes.

final event = VtKeyEvent();
event
  ..action = GhosttyKeyAction.GHOSTTY_KEY_ACTION_PRESS
  ..key = GhosttyKey.GHOSTTY_KEY_ENTER
  ..mods = 0;
// ... encode with VtKeyEncoder ...
event.close();

Constructors

VtKeyEvent()

Properties

action GhosttyKeyAction
getter/setter pair
composing bool
getter/setter pair
consumedMods int
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
key GhosttyKey
getter/setter pair
mods int
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
unshiftedCodepoint int
getter/setter pair
utf8Text String
getter/setter pair

Methods

close() → void
Releases key event resources.
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