RawKeyEventDataWindows class Null safety

Platform-specific key event data for Windows.

This object contains information about key events obtained from Windows's win32 API.

See also:

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

Constructors

RawKeyEventDataWindows({int keyCode = 0, int scanCode = 0, int characterCodePoint = 0, int modifiers = 0})
Creates a key event data structure specific for Windows.
const

Properties

characterCodePoint int
The Unicode code point represented by the key event, if any.
final
hashCode int
The hash code for this object.
read-only, override
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-only, inherited
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-only, inherited
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-only, inherited
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-only, inherited
keyCode int
The hardware key code corresponding to this key event.
final
keyLabel String
Returns the Unicode string representing the label on this key.
read-only, override
logicalKey LogicalKeyboardKey
Returns an object representing the logical key that was pressed.
read-only, override
modifiers int
A mask of the current modifiers. The modifier values must be in sync with the ones defined in https://github.com/flutter/engine/blob/master/shell/platform/windows/key_event_handler.cc
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-only, inherited
physicalKey PhysicalKeyboardKey
Returns an object representing the physical location of this key on a QWERTY keyboard.
read-only, override
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
scanCode int
The hardware scan code id corresponding to this key event.
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.
override
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

Constants

modifierAlt → const int
This mask is used to check the modifiers field to test whether one of the ALT modifier keys is pressed.
1 << 6
modifierCaps → const int
This mask is used to check the modifiers field to test whether the CAPS LOCK key is pressed.
1 << 11
modifierControl → const int
This mask is used to check the modifiers field to test whether one of the CTRL modifier keys is pressed.
1 << 3
modifierLeftAlt → const int
This mask is used to check the modifiers field to test whether the left ALT modifier key is pressed.
1 << 7
modifierLeftControl → const int
This mask is used to check the modifiers field to test whether the left CTRL modifier key is pressed.
1 << 4
modifierLeftMeta → const int
This mask is used to check the modifiers field to test whether the left WIN modifier keys is pressed.
1 << 9
modifierLeftShift → const int
This mask is used to check the modifiers field to test whether the left SHIFT modifier key is pressed.
1 << 1
modifierNumLock → const int
This mask is used to check the modifiers field to test whether the NUM LOCK key is pressed.
1 << 12
modifierRightAlt → const int
This mask is used to check the modifiers field to test whether the right ALT modifier key is pressed.
1 << 8
modifierRightControl → const int
This mask is used to check the modifiers field to test whether the right CTRL modifier key is pressed.
1 << 5
modifierRightMeta → const int
This mask is used to check the modifiers field to test whether the right WIN modifier keys is pressed.
1 << 10
modifierRightShift → const int
This mask is used to check the modifiers field to test whether the right SHIFT modifier key is pressed.
1 << 2
modifierScrollLock → const int
This mask is used to check the modifiers field to test whether the SCROLL LOCK key is pressed.
1 << 13
modifierShift → const int
This mask is used to check the modifiers field to test whether one of the SHIFT modifier keys is pressed.
1 << 0