ModifierKey enum

An enum describing the type of modifier key that is being pressed.

This enum is deprecated and will be removed. There is no direct substitute planned, since this enum will no longer be necessary once RawKeyEvent and associated APIs are removed.

See also:

Inheritance
Available extensions
Annotations
  • @Deprecated('No longer supported. ' 'This feature was deprecated after v3.18.0-2.0.pre.')

Values

controlModifier → const ModifierKey

The CTRL modifier key.

Typically, there are two of these.

shiftModifier → const ModifierKey

The SHIFT modifier key.

Typically, there are two of these.

altModifier → const ModifierKey

The ALT modifier key.

Typically, there are two of these.

metaModifier → const ModifierKey

The META modifier key.

Typically, there are two of these. This is, for example, the Windows key on Windows (⊞), the Command (⌘) key on macOS and iOS, and the Search (🔍) key on Android.

capsLockModifier → const ModifierKey

The CAPS LOCK modifier key.

Typically, there is one of these. Only shown as "pressed" when the caps lock is on, so on a key up when the mode is turned on, on each key press when it's enabled, and on a key down when it is turned off.

numLockModifier → const ModifierKey

The NUM LOCK modifier key.

Typically, there is one of these. Only shown as "pressed" when the num lock is on, so on a key up when the mode is turned on, on each key press when it's enabled, and on a key down when it is turned off.

scrollLockModifier → const ModifierKey

The SCROLL LOCK modifier key.

Typically, there is one of these. Only shown as "pressed" when the scroll lock is on, so on a key up when the mode is turned on, on each key press when it's enabled, and on a key down when it is turned off.

functionModifier → const ModifierKey

The FUNCTION (Fn) modifier key.

Typically, there is one of these.

symbolModifier → const ModifierKey

The SYMBOL modifier key.

Typically, there is one of these.

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
name String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

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

values → const List<ModifierKey>
A constant List of the values in this enum, in order of their declaration.