csKeyEventHelper Class Reference
[Event handling]
Helper class to conveniently deal with keyboard events.
More...
#include <csutil/event.h>
Static Public Member Functions | |
utf32_char | GetRawCode (const iEvent *event) |
Retrieve the key's raw code. | |
utf32_char | GetCookedCode (const iEvent *event) |
Retrieve the key's cooked code. | |
void | GetModifiers (const iEvent *event, csKeyModifiers &modifiers) |
Retrieve the key's raw code. | |
csKeyEventType | GetEventType (const iEvent *event) |
Retrieve the event type (key up or down.). | |
bool | GetAutoRepeat (const iEvent *event) |
Retrieve whether a keyboard down event was caused by the initial press (not auto-repeat) or by having it held for a period of time (auto-repeat.). | |
csKeyCharType | GetCharacterType (const iEvent *event) |
Retrieve the character type (dead or normal.). | |
bool | GetEventData (const iEvent *event, csKeyEventData &data) |
Get all the information in one compact struct. | |
uint32 | GetModifiersBits (const csKeyModifiers &modifiers) |
Get a bitmask corresponding to the pressed modifier keys from the keyboard modifiers struct. | |
uint32 | GetModifiersBits (const iEvent *event) |
Get a bitmask corresponding to the pressed modifier keys from the event. | |
void | GetModifiers (uint32 mask, csKeyModifiers &modifiers) |
Convert a bitmask returned by GetModifiersBits back to a csKeyModifiers struct. |
Detailed Description
Helper class to conveniently deal with keyboard events.
Definition at line 39 of file event.h.
Member Function Documentation
|
Retrieve whether a keyboard down event was caused by the initial press (not auto-repeat) or by having it held for a period of time (auto-repeat.).
|
|
Retrieve the character type (dead or normal.).
|
|
Retrieve the key's cooked code.
|
|
Get all the information in one compact struct.
|
|
Retrieve the event type (key up or down.).
|
|
Convert a bitmask returned by GetModifiersBits back to a csKeyModifiers struct. Also works for the Modifiers members of the csEventMouseData and csEventJoystickData structs, if you cast them to uint32. |
|
Retrieve the key's raw code.
|
|
Get a bitmask corresponding to the pressed modifier keys from the event.
|
|
Get a bitmask corresponding to the pressed modifier keys from the keyboard modifiers struct.
|
|
Retrieve the key's raw code.
|
The documentation for this class was generated from the following file:
- csutil/event.h
Generated for Crystal Space by doxygen 1.3.9.1