KeyboardLockMode enum

Represents a lock mode of a keyboard, such as KeyboardLockMode.capsLock.

A lock mode locks some of a keyboard's keys into a distinct mode of operation, depending on the lock settings selected. The status of the mode is toggled with each key down of its corresponding logical key. A KeyboardLockMode object is used to query whether this mode is enabled on the keyboard.

Only a limited number of modes are supported, which are enumerated as static members of this class. Manual constructing of this class is prohibited.



numLock → const KeyboardLockMode

Represents the number lock mode on the keyboard.

On supporting systems, enabling number lock mode usually allows key presses of the number pad to input numbers, instead of acting as up, down, left, right, page up, end, etc.

const KeyboardLockMode._(LogicalKeyboardKey.numLock)
scrollLock → const KeyboardLockMode

Represents the scrolling lock mode on the keyboard.

On supporting systems and applications (such as a spreadsheet), enabling scrolling lock mode usually allows key presses of the cursor keys to scroll the document instead of the cursor.

const KeyboardLockMode._(LogicalKeyboardKey.scrollLock)
capsLock → const KeyboardLockMode

Represents the capital letters lock mode on the keyboard.

On supporting systems, enabling capital lock mode allows key presses of the letter keys to input uppercase letters instead of lowercase.

const KeyboardLockMode._(LogicalKeyboardKey.capsLock)


hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
logicalKey LogicalKeyboardKey
The logical key that triggers this lock mode.
runtimeType Type
A representation of the runtime type of the object.
no setterinherited


noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
toString() String
A string representation of this object.


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

Static Methods

findLockByLogicalKey(LogicalKeyboardKey logicalKey) KeyboardLockMode?
Returns the KeyboardLockMode constant from the logical key, or null, if not found.


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