Class KeyboardManager

Manages the physical keyboard.

Inheritance
System.Object
KeyboardManager
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Cosmos.System
Assembly: Cosmos.System2.dll
Syntax
public static class KeyboardManager

Properties

| Improve this Doc View Source

AltPressed

Whether the Alt key is currently pressed.

Declaration
public static bool AltPressed { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CapsLock

The caps-lock state.

Declaration
public static bool CapsLock { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ControlPressed

Whether the Control (Ctrl) key is currently pressed.

Declaration
public static bool ControlPressed { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

KeyAvailable

Whether a keyboard input is pending to be processed; i.e, whether the queued key-press buffer is not empty.

Declaration
public static bool KeyAvailable { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

NumLock

The num-lock state.

Declaration
public static bool NumLock { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ScrollLock

The scroll-lock state.

Declaration
public static bool ScrollLock { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ShiftPressed

Whether the Shift key is currently pressed.

Declaration
public static bool ShiftPressed { get; set; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

GetKey(Byte, out KeyEvent)

Attempts to convert the given physical key scan-code to a KeyEvent instance.

Declaration
public static bool GetKey(byte scanCode, out KeyEvent keyInfo)
Parameters
Type Name Description
System.Byte scanCode

The scan-code of the physical key.
KeyEvent keyInfo

The resulting KeyEvent.
Returns
Type Description
System.Boolean

true if the operation succeded and keyInfo holds a non-null value; otherwise, false.
| Improve this Doc View Source

GetKeyLayout()

Gets the currently used keyboard layout.

Declaration
public static ScanMapBase GetKeyLayout()
Returns
Type Description
ScanMapBase
| Improve this Doc View Source

ReadKey()

Reads the next key from the pending key-press keyboard buffer, and removes it from said buffer.

Declaration
public static KeyEvent ReadKey()
Returns
Type Description
KeyEvent

The pending key-press.
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the queue is empty.
| Improve this Doc View Source

SetKeyLayout(ScanMapBase)

Sets the currently used keyboard layout.

Declaration
public static void SetKeyLayout(ScanMapBase scanMap)
Parameters
Type Name Description
ScanMapBase scanMap

The keyboard scan map to use.
| Improve this Doc View Source

TryReadKey(out KeyEvent)

If available, reads the next key from the pending key-press keyboard buffer, and removes it from said buffer.

Declaration
public static bool TryReadKey(out KeyEvent key)
Parameters
Type Name Description
KeyEvent key

The pending key-press.
Returns
Type Description
System.Boolean

true if a key-press was pending and has been dequeued to key; otherwise, false.