CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

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>

List of all members.

Public Member Functions

int Compare (csInputDefinition const &) const
 Returns a number indicating the relation of the two definitions.
uint32 ComputeHash () const
 Generate a hash value from the object.
 csInputDefinition (const char *string, uint32 honorModifiers=0, bool useCookedCode=false)
 Construct an input description from a string.
 csInputDefinition (iEvent *event, uint8 axis)
 Construct an input description from an iEvent (usually an axis).
 csInputDefinition (iEvent *event, uint32 honorModifiers=0, bool useCookedCode=false)
 Construct an input description from an iEvent (usually a button).
 csInputDefinition (const csInputDefinition &other)
 Copy constructor.
 csInputDefinition (uint32 honorModifiers=0, bool useCookedCode=false)
 Default constructor.
bool GetKeyCode (utf32_char &code, bool &isCooked) const
 Gives the key code of the description, assuming it is a keyboard type.
const csKeyModifiersGetModifiers () const
 Returns the keyboard modifiers of the description.
int GetNumber () const
 Returns the numeric value of the description.
int GetType () const
 Returns the event type of the description (a csev... constant).
bool IsValid () const
 Returns a boolean indicating whether the object contains a valid input.
bool SetKeyCode (utf32_char code)
 Sets the key code of the description, assuming it is a keyboard type.
void SetModifiers (const csKeyModifiers &mods)
 Sets the keyboard modifiers of the description.
void SetNumber (int n)
 Sets the numeric value of the description.
void SetType (int t)
 Set the event type of the description (a csev... constant).
csString ToString (bool distinguishModifiers=true) const
 Gets the string representation of the description.

Static Public Member Functions

static csString GetKeyString (utf32_char code, const csKeyModifiers *mods, bool distinguishModifiers=true)
 Helper function to return a string (eg.
static csString GetOtherString (int type, int num, const csKeyModifiers *mods, bool distinguishModifiers=true)
 Helper function to return a string (eg.
static bool ParseKey (const char *iStr, utf32_char *oKeyCode, utf32_char *oCookedCode, csKeyModifiers *oModifiers)
 Helper function to parse a string (eg.
static bool ParseOther (const char *iStr, int *oType, int *oNumeric, csKeyModifiers *oModifiers)
 Helper function to parse a string (eg.

Protected Attributes

int containedType
csKeyModifiers modifiers
uint32 modifiersHonored
utf32_char code
bool isCooked
int joystickAxis
int joystickButton
int mouseAxis
int mouseButton

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 44 of file inputdef.h.


Constructor & Destructor Documentation

csInputDefinition::csInputDefinition uint32  honorModifiers = 0,
bool  useCookedCode = false
 

Default constructor.

Parameters:
honorModifiers A bitmask of modifier keys that will be recognised.
useCookedCode If true, will use the cooked key code instead of raw.

csInputDefinition::csInputDefinition const csInputDefinition other  ) 
 

Copy constructor.

csInputDefinition::csInputDefinition iEvent event,
uint32  honorModifiers = 0,
bool  useCookedCode = false
 

Construct an input description from an iEvent (usually a button).

Parameters:
event The event to analyse for input data.
honorModifiers A bitmask of modifier keys that will be recognised.
useCookedCode If true, will use the cooked key code instead of raw.

csInputDefinition::csInputDefinition iEvent event,
uint8  axis
 

Construct an input description from an iEvent (usually an axis).

Parameters:
event The event to analyse for input data.
axis Events include all axes, so choose: 0 = x, 1 = y.

csInputDefinition::csInputDefinition const char *  string,
uint32  honorModifiers = 0,
bool  useCookedCode = false
 

Construct an input description from a string.

Parameters:
string The string to parse, e.g. "mouse1", "shift+a".
honorModifiers A bitmask of modifier keys that will be recognised.
useCookedCode If true, will use the cooked key code instead of raw.


Member Function Documentation

int csInputDefinition::Compare csInputDefinition const &   )  const
 

Returns a number indicating the relation of the two definitions.

Referenced by csComparator< csInputDefinition, csInputDefinition >::Compare().

uint32 csInputDefinition::ComputeHash  )  const
 

Generate a hash value from the object.

Referenced by csHashComputer< csInputDefinition >::ComputeHash().

bool csInputDefinition::GetKeyCode utf32_char code,
bool &  isCooked
const [inline]
 

Gives the key code of the description, assuming it is a keyboard type.

Parameters:
code Will be set to the key code.
isCooked Will be set to true if the code is cooked, false if raw.
Returns:
False if the description is not a keyboard type.

Definition at line 130 of file inputdef.h.

References csevKeyboard.

static csString csInputDefinition::GetKeyString utf32_char  code,
const csKeyModifiers mods,
bool  distinguishModifiers = true
[static]
 

Helper function to return a string (eg.

"Ctrl+A") from values describing a keyboard event.

Parameters:
code The key code, treated as a raw code although raw vs. cooked doesn't matter here.
mods The keyboard modifiers. Will be ignored if 0.
distinguishModifiers Whether to output distinguished modifiers (eg. "LCtrl" as opposed to just "Ctrl").
Returns:
The description string.

const csKeyModifiers& csInputDefinition::GetModifiers  )  const [inline]
 

Returns the keyboard modifiers of the description.

Definition at line 156 of file inputdef.h.

int csInputDefinition::GetNumber  )  const [inline]
 

Returns the numeric value of the description.

Returns:
If non-keyboard button event, the button number. If axis event, the axis number (0 = x, 1 = y).

Definition at line 146 of file inputdef.h.

static csString csInputDefinition::GetOtherString int  type,
int  num,
const csKeyModifiers mods,
bool  distinguishModifiers = true
[static]
 

Helper function to return a string (eg.

"MouseX", "Alt+Mouse1") from values describing a non-keyboard event.

Parameters:
type The event type of the description (a csev... constant).
num For button events, the button number. For axis events, the axis number (0 = x, 1 = y).
mods The keyboard modifiers. Will be ignored if 0.
distinguishModifiers Whether to output distinguished modifiers (eg. "LCtrl" as opposed to just "Ctrl").
Returns:
The description string.

int csInputDefinition::GetType  )  const [inline]
 

Returns the event type of the description (a csev... constant).

Definition at line 119 of file inputdef.h.

bool csInputDefinition::IsValid  )  const
 

Returns a boolean indicating whether the object contains a valid input.

static bool csInputDefinition::ParseKey const char *  iStr,
utf32_char oKeyCode,
utf32_char oCookedCode,
csKeyModifiers oModifiers
[static]
 

Helper function to parse a string (eg.

"Ctrl+A") into values describing a keyboard event, returning both raw and cooked key codes.

Parameters:
iStr The string to parse.
oKeyCode Will be set to the raw code of the parsed description.
oCookedCode Will be set to the cooked code of the description.
oModifiers The modifiers of the description.
Returns:
Whether the string could be successfully parsed.
Remarks:
Any of the output parameters may be null, in which case they are ignored.

static bool csInputDefinition::ParseOther const char *  iStr,
int *  oType,
int *  oNumeric,
csKeyModifiers oModifiers
[static]
 

Helper function to parse a string (eg.

"MouseX", "Alt+Mouse1") into values describing a non-keyboard event.

Parameters:
iStr The string to parse.
oType Will be set to the event type of the description (a csev... constant).
oNumeric For button events, will be set to the button number. For axis events, will be set to the axis number (0 = x, 1 = y).
oModifiers Will be populated with the modifiers of the description.
Returns:
Whether the string could be successfully parsed.
Remarks:
Any of the output parameters may be null, in which case they are ignored.

bool csInputDefinition::SetKeyCode utf32_char  code  )  [inline]
 

Sets the key code of the description, assuming it is a keyboard type.

Definition at line 136 of file inputdef.h.

References csevKeyboard.

void csInputDefinition::SetModifiers const csKeyModifiers mods  )  [inline]
 

Sets the keyboard modifiers of the description.

Definition at line 159 of file inputdef.h.

void csInputDefinition::SetNumber int  n  )  [inline]
 

Sets the numeric value of the description.

Parameters:
n If non-keyboard button event, the button number. If axis event, the axis number (0 = x, 1 = y).

Definition at line 153 of file inputdef.h.

void csInputDefinition::SetType int  t  )  [inline]
 

Set the event type of the description (a csev... constant).

Definition at line 122 of file inputdef.h.

csString csInputDefinition::ToString bool  distinguishModifiers = true  )  const
 

Gets the string representation of the description.

Parameters:
distinguishModifiers If false, left and right modifiers will be output as plain-old modifiers (e.g. "LAlt" and "RAlt" become just "Alt").
Returns:
The string representation of the description (e.g. "mouse1", "shift+a").


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.4.4