Gondwana.Input.Keyboard Namespace Reference

Classes
interface	IKeyboardAdapter
	Represents an adapter for keyboard input, providing access to the currently pressed keys and active modifier states. More...
class	KeyboardEventPoller
	Cross-platform singleton keyboard handler with throttling and manual input state feeding. More...
class	KeyDownEventArgs
	Provides data for keyboard key events, including information about the key that was pressed, the action performed (pressed, released, or repeated), and the state of modifier keys at the time of the event. This event args class is used with keyboard input polling to deliver comprehensive keyboard event information to event handlers. More...
class	KeyEventConfiguration
	Represents the configuration for keyboard key events, including key identification and timing controls for event throttling. This configuration is used to control how frequently key events are raised and whether event processing is currently paused for a specific key. More...

Enumerations
enum	KeyAction { Pressed , Released , Repeated }
	Represents the type of action performed on a keyboard key, indicating whether the key was pressed, released, or is being held down and generating repeated input events. This enumeration is typically used in keyboard event handling to distinguish between different phases of key interaction. More...
enum	KeyboardModifierState { None = 0 , Shift = 1 , Ctrl = 2 , Alt = 4 }
	Represents the state of keyboard modifier keys (Shift, Ctrl, Alt) that can be pressed simultaneously with other keys to modify their behavior. This is a flags enumeration, allowing multiple modifiers to be combined to represent complex modifier combinations (e.g., Ctrl | Shift for Ctrl+Shift). More...

Enumeration Type Documentation

KeyAction

enum Gondwana.Input.Keyboard.KeyAction

Represents the type of action performed on a keyboard key, indicating whether the key was pressed, released, or is being held down and generating repeated input events. This enumeration is typically used in keyboard event handling to distinguish between different phases of key interaction.

Enumerator
Pressed	The key was initially pressed down. This action occurs once when the user first pushes the key, before any repeat events are generated.
Released	The key was released after being pressed. This action occurs once when the user lifts their finger from the key, marking the end of the key press interaction.
Repeated	The key is being held down and is generating repeated input events. This action occurs continuously at a system-defined or application-defined rate while the user keeps the key pressed, typically used to implement auto-repeat behavior for text input or held actions.

KeyboardModifierState

enum Gondwana.Input.Keyboard.KeyboardModifierState

Represents the state of keyboard modifier keys (Shift, Ctrl, Alt) that can be pressed simultaneously with other keys to modify their behavior. This is a flags enumeration, allowing multiple modifiers to be combined to represent complex modifier combinations (e.g., Ctrl | Shift for Ctrl+Shift).

Enumerator
None	No modifier keys are currently pressed. This represents the default keyboard state when only regular keys (without modifiers) are being pressed or held.
Shift	The Shift modifier key is currently pressed. This typically modifies character input to produce uppercase letters and alternate symbols, and can also modify the behavior of shortcut keys. Can be combined with Ctrl and/or Alt for multi-modifier shortcuts.
Ctrl	The Control (Ctrl) modifier key is currently pressed. This is commonly used for keyboard shortcuts and commands (e.g., Ctrl+C for copy, Ctrl+V for paste). Can be combined with Shift and/or Alt for multi-modifier shortcuts.
Alt	The Alt (Alternate) modifier key is currently pressed. This is used for alternate keyboard shortcuts, menu access keys, and special character input. Can be combined with Shift and/or Ctrl for multi-modifier shortcuts.