RawKeyEventDataLinux class Null safety

Platform-specific key event data for Linux.

Different window toolkit implementations can map to different key codes. This class will use the correct mapping depending on the keyHelper provided.

See also:

  • RawKeyboard, which uses this interface to expose key data.
Inheritance

Constructors

RawKeyEventDataLinux({required KeyHelper keyHelper, int unicodeScalarValues = 0, int scanCode = 0, int keyCode = 0, int modifiers = 0, required bool isDown, int? specifiedLogicalKey})
Creates a key event data structure specific for Linux.
const

Properties

hashCode int
The hash code for this object.
read-onlyoverride
isAltPressed bool
Returns true if a ALT modifier key was pressed at the time of this event, regardless of which side of the keyboard it is on.
read-onlyinherited
isControlPressed bool
Returns true if a CTRL modifier key was pressed at the time of this event, regardless of which side of the keyboard it is on.
read-onlyinherited
isDown bool
Whether or not this key event is a key down (true) or key up (false).
final
isMetaPressed bool
Returns true if a META modifier key was pressed at the time of this event, regardless of which side of the keyboard it is on.
read-onlyinherited
isShiftPressed bool
Returns true if a SHIFT modifier key was pressed at the time of this event, regardless of which side of the keyboard it is on.
read-onlyinherited
keyCode int
The hardware key code corresponding to this key event.
final
keyHelper KeyHelper
A helper class that abstracts the fetching of the toolkit-specific mappings.
final
keyLabel String
Returns the Unicode string representing the label on this key.
read-onlyoverride
logicalKey LogicalKeyboardKey
Returns an object representing the logical key that was pressed.
read-onlyoverride
modifiers int
A mask of the current modifiers using the values in Modifier Flags. This value may be different depending on the window toolkit used. See KeyHelper.
final
modifiersPressed Map<ModifierKey, KeyboardSide>
Returns a map of modifier keys that were pressed at the time of this event, and the keyboard side or sides that the key was on.
read-onlyinherited
physicalKey PhysicalKeyboardKey
Returns an object representing the physical location of this key on a QWERTY keyboard.
read-onlyoverride
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
scanCode int
The hardware scan code id corresponding to this key event.
final
specifiedLogicalKey int?
A logical key specified by the embedding that should be used instead of deriving from raw data.
final
unicodeScalarValues int
An int with up to two Unicode scalar values generated by a single keystroke. An assertion will fire if more than two values are encoded in a single keystroke.
final

Methods

debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
override
getModifierSide(ModifierKey key) KeyboardSide
Returns a KeyboardSide enum value that describes which side or sides of the given keyboard modifier key were pressed at the time of this event.
override
isModifierPressed(ModifierKey key, {KeyboardSide side = KeyboardSide.any}) bool
Returns true if the given ModifierKey was pressed at the time of this event.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
shouldDispatchEvent() bool
Whether a key down event, and likewise its accompanying key up event, should be dispatched.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringShort() String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

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