CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

inpnames.h File Reference

Crystal Space input library. More...

Go to the source code of this file.

Defines

#define CSAXIS_X   -1
 Use in `int button' for csevXXXMove events with the backward compatible funcs. More...

#define CSAXIS_Y   -2
 Use in `int button' for csevXXXMove events with the backward compatible funcs. More...


Functions

bool csParseInputDef (const char *name, iEvent *ev, bool use_shift=true)
 Convert a free-format string into an input event as understood by the csinput library ("Ctrl+a", "alt+shift+mouse1" and so on). More...

bool csParseInputDef (const char *name, csEvent &ev, bool use_shift=true)
bool csParseKeyDef (const char *name, int &key, int &shift, bool use_shift=true)
 Convert a free-format string into an input event as understood by the csinput library ("Ctrl+a", "alt+shift+mouse1" and so on). More...

bool csParseMouseDef (const char *name, int &button, int &shift, bool use_shift=true)
 Convert a free-format string into an input event as understood by the csinput library ("Ctrl+a", "alt+shift+mouse1" and so on). More...

bool csParseJoystickDef (const char *name, int &button, int &shift, bool use_shift=true)
 Convert a free-format string into an input event as understood by the csinput library ("Ctrl+a", "alt+shift+mouse1" and so on). More...

bool csGetInputDesc (iEvent *ev, char *buf, bool use_shift=true)
 Given an event object this routine will copy a string describing the input combination in human-understandable format. More...

bool csGetInputDesc (csEvent &ev, char *buf, bool use_shift=true)
bool csGetKeyDesc (int key, int shift, char *buf, bool use_shift=true)
 Given an event object this routine will copy a string describing the input combination in human-understandable format. More...

bool csGetMouseDesc (int button, int shift, char *buf, bool use_shift=true)
 Given an event object this routine will copy a string describing the input combination in human-understandable format. More...

bool csGetJoyDesc (int button, int shift, char *buf, bool use_shift=true)
 Given an event object this routine will copy a string describing the input combination in human-understandable format. More...


Detailed Description

Crystal Space input library.

Definition in file inpnames.h.


Define Documentation

#define CSAXIS_X   -1
 

Use in `int button' for csevXXXMove events with the backward compatible funcs.

Definition at line 32 of file inpnames.h.

#define CSAXIS_Y   -2
 

Use in `int button' for csevXXXMove events with the backward compatible funcs.

Definition at line 37 of file inpnames.h.


Function Documentation

bool csGetInputDesc csEvent   ev,
char *    buf,
bool    use_shift = true
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool csGetInputDesc iEvent   ev,
char *    buf,
bool    use_shift = true
 

Given an event object this routine will copy a string describing the input combination in human-understandable format.

bool csGetJoyDesc int    button,
int    shift,
char *    buf,
bool    use_shift = true
 

Given an event object this routine will copy a string describing the input combination in human-understandable format.

bool csGetKeyDesc int    key,
int    shift,
char *    buf,
bool    use_shift = true
 

Given an event object this routine will copy a string describing the input combination in human-understandable format.

bool csGetMouseDesc int    button,
int    shift,
char *    buf,
bool    use_shift = true
 

Given an event object this routine will copy a string describing the input combination in human-understandable format.

bool csParseInputDef const char *    name,
csEvent   ev,
bool    use_shift = true
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool csParseInputDef const char *    name,
iEvent   ev,
bool    use_shift = true
 

Convert a free-format string into an input event as understood by the csinput library ("Ctrl+a", "alt+shift+mouse1" and so on).

Handy for supporting user-defined hot-keys, keyboard accelerators and so on.

bool csParseJoystickDef const char *    name,
int &    button,
int &    shift,
bool    use_shift = true
 

Convert a free-format string into an input event as understood by the csinput library ("Ctrl+a", "alt+shift+mouse1" and so on).

Handy for supporting user-defined hot-keys, keyboard accelerators and so on.

bool csParseKeyDef const char *    name,
int &    key,
int &    shift,
bool    use_shift = true
 

Convert a free-format string into an input event as understood by the csinput library ("Ctrl+a", "alt+shift+mouse1" and so on).

Handy for supporting user-defined hot-keys, keyboard accelerators and so on.

bool csParseMouseDef const char *    name,
int &    button,
int &    shift,
bool    use_shift = true
 

Convert a free-format string into an input event as understood by the csinput library ("Ctrl+a", "alt+shift+mouse1" and so on).

Handy for supporting user-defined hot-keys, keyboard accelerators and so on.


Generated for Crystal Space by doxygen 1.2.14