csInputDefinition Class Reference
This class holds a description of a physical source of input events, such as a keyboard key, mouse or joystick button, or a mouse or joystick axis. More...
#include <csutil/inputdef.h>
Public Member Functions | |
csInputDefinition (uint32 honorModifiers=0, bool useCookedCode=false) | |
Default constructor. | |
csInputDefinition (const csInputDefinition &other) | |
Copy constructor. | |
csInputDefinition (iEvent *event, uint32 honorModifiers=0, bool useCookedCode=false) | |
Construct an input description from an iEvent (usually a button). | |
csInputDefinition (iEvent *event, int axis) | |
Construct an input description from an iEvent (usually an axis). | |
csInputDefinition (const char *string, uint32 honorModifiers=0, bool useCookedCode=false) | |
Construct an input description from a string. | |
csString | ToString (bool distinguishModifiers=true) const |
Gets the string representation of the description. | |
bool | IsValid () const |
Returns a boolean indicating whether the object contains a valid input. | |
int | GetType () const |
Returns the event type of the description (a csev... constant). | |
void | SetType (int t) |
Set the event type of the description (a csev... constant). | |
bool | GetKeyCode (utf32_char &code, bool &isCooked) const |
Gives the key code of the description, assuming it is a keyboard type. | |
bool | SetKeyCode (utf32_char code) |
Sets the key code of the description, assuming it is a keyboard type. | |
int | GetNumber () const |
Returns the numeric value of the description. | |
void | SetNumber (int n) |
Sets the numeric value of the description. | |
const csKeyModifiers & | GetModifiers () const |
Returns the keyboard modifiers of the description. | |
void | SetModifiers (const csKeyModifiers &mods) |
Sets the keyboard modifiers of the description. | |
uint32 | ComputeHash () const |
Generate a hash value from the object. | |
bool | Compare (csInputDefinition const &) const |
Return a boolean indicating whether the two definitions are equal. | |
Static Public Member Functions | |
bool | ParseKey (const char *iStr, utf32_char *oKeyCode, utf32_char *oCookedCode, csKeyModifiers *oModifiers) |
Helper function to parse a string (eg. | |
bool | ParseOther (const char *iStr, int *oType, int *oNumeric, csKeyModifiers *oModifiers) |
Helper function to parse a string (eg. | |
csString | GetKeyString (utf32_char code, const csKeyModifiers *mods, bool distinguishModifiers=true) |
Helper function to return a string (eg. | |
csString | GetOtherString (int type, int num, const csKeyModifiers *mods, bool distinguishModifiers=true) |
Helper function to return a string (eg. | |
unsigned int | ComputeHash (const csInputDefinition &key) |
Allows this class to be used as a csHash key handler. | |
bool | CompareKeys (const csInputDefinition &key1, const csInputDefinition &key2) |
Allows this class to be used as a csHash key handler. | |
Friends | |
class | csInputBinder |
Detailed Description
This class holds a description of a physical source of input events, such as a keyboard key, mouse or joystick button, or a mouse or joystick axis.
Definition at line 40 of file inputdef.h.
Constructor & Destructor Documentation
|
Default constructor.
|
|
Copy constructor.
|
|
Construct an input description from an iEvent (usually a button).
|
|
Construct an input description from an iEvent (usually an axis).
|
|
Construct an input description from a string.
|
Member Function Documentation
|
Return a boolean indicating whether the two definitions are equal.
Referenced by CompareKeys(). |
|
Allows this class to be used as a csHash key handler.
Definition at line 225 of file inputdef.h. References Compare(). |
|
Allows this class to be used as a csHash key handler.
Definition at line 221 of file inputdef.h. References ComputeHash(). |
|
Generate a hash value from the object.
Referenced by ComputeHash(). |
|
Gives the key code of the description, assuming it is a keyboard type.
Definition at line 126 of file inputdef.h. |
|
Helper function to return a string (eg. "Ctrl+A") from values describing a keyboard event.
|
|
Returns the keyboard modifiers of the description.
Definition at line 152 of file inputdef.h. References csKeyModifiers. |
|
Returns the numeric value of the description.
Definition at line 142 of file inputdef.h. |
|
Helper function to return a string (eg. "MouseX", "Alt+Mouse1") from values describing a non-keyboard event.
|
|
Returns the event type of the description (a csev... constant).
Definition at line 115 of file inputdef.h. |
|
Returns a boolean indicating whether the object contains a valid input.
|
|
Helper function to parse a string (eg. "Ctrl+A") into values describing a keyboard event, returning both raw and cooked key codes.
|
|
Helper function to parse a string (eg. "MouseX", "Alt+Mouse1") into values describing a non-keyboard event.
|
|
Sets the key code of the description, assuming it is a keyboard type.
Definition at line 132 of file inputdef.h. |
|
Sets the keyboard modifiers of the description.
Definition at line 155 of file inputdef.h. References csKeyModifiers. |
|
Sets the numeric value of the description.
Definition at line 149 of file inputdef.h. |
|
Set the event type of the description (a csev... constant).
Definition at line 118 of file inputdef.h. |
|
Gets the string representation of the description.
|
The documentation for this class was generated from the following file:
- csutil/inputdef.h
Generated for Crystal Space by doxygen 1.3.9.1