csEvent Class Reference
This class represents a system event. More...
#include <csutil/csevent.h>
Inheritance diagram for csEvent:

Public Member Functions | |
csEvent () | |
Empty initializer. | |
csEvent (csEvent const &) | |
Cloning constructor. | |
csEvent (csTicks, int type, int x, int y, int button, int modifiers) | |
Create a mouse event object. | |
csEvent (csTicks, int type, int n, int x, int y, int button, int modifiers) | |
Create a joystick event object. | |
csEvent (csTicks, int type, int code, void *info=0) | |
Create a command event object. | |
virtual | ~csEvent () |
Destructor. | |
virtual bool | Add (const char *name, float v) |
Add an attribute to the event. | |
virtual bool | Add (const char *name, double v) |
Add an attribute to the event. | |
virtual bool | Add (const char *name, const char *v) |
Add an attribute to the event. | |
virtual bool | Add (const char *name, const void *v, size_t size) |
Add an attribute to the event. | |
virtual bool | Add (const char *name, bool v) |
Add an attribute to the event. | |
virtual bool | Add (const char *name, iEvent *v) |
Add an attribute to the event. | |
virtual bool | Add (const char *name, iBase *v) |
Add an attribute to the event. | |
virtual csEventError | Retrieve (const char *name, int64 &value) const |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, uint64 &value) const |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, float &v) const |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, double &v) const |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, const char *&v) const |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, const void *&v, size_t &size) const |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, bool &v) const |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, csRef< iEvent > &v) const |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, csRef< iBase > &v) const |
Retrieve an attribute from the event. | |
virtual bool | AttributeExists (const char *name) |
Test whether an attribute exists. | |
virtual csEventAttributeType | GetAttributeType (const char *name) |
Query the type of an attribute. | |
virtual bool | Remove (const char *name) |
Remove a specific attribute. | |
virtual bool | RemoveAll () |
Remove all attributes. | |
virtual csRef< iEventAttributeIterator > | GetAttributeIterator () |
Get an iterator for all attributes. |
Detailed Description
This class represents a system event.Events can be generated by hardware (keyboard, mouse) as well as by software. There are so much constructors of this class as much different types of events exists.
Definition at line 49 of file csevent.h.
Constructor & Destructor Documentation
|
Empty initializer.
|
|
Cloning constructor. Note that for command style events, this performs only a shallow copy of the `Info' attribute. |
|
Create a mouse event object.
|
|
Create a joystick event object.
|
|
Create a command event object.
|
|
Destructor.
|
Member Function Documentation
|
Add an attribute to the event.
Implements iEvent. |
|
Add an attribute to the event.
Implements iEvent. |
|
Add an attribute to the event.
Implements iEvent. |
|
Add an attribute to the event.
Implements iEvent. |
|
Add an attribute to the event.
Implements iEvent. |
|
Add an attribute to the event.
Implements iEvent. |
|
Add an attribute to the event.
Implements iEvent. |
|
Test whether an attribute exists.
Implements iEvent. |
|
Get an iterator for all attributes.
Implements iEvent. |
|
Query the type of an attribute.
Implements iEvent. |
|
Remove a specific attribute.
Implements iEvent. |
|
Remove all attributes.
Implements iEvent. |
|
Retrieve an attribute from the event.
Implements iEvent. |
|
Retrieve an attribute from the event.
Implements iEvent. |
|
Retrieve an attribute from the event.
Implements iEvent. |
|
Retrieve an attribute from the event.
Implements iEvent. |
|
Retrieve an attribute from the event.
Implements iEvent. |
|
Retrieve an attribute from the event.
Implements iEvent. |
|
Retrieve an attribute from the event.
Implements iEvent. |
|
Retrieve an attribute from the event.
Implements iEvent. |
|
Retrieve an attribute from the event.
Implements iEvent. |
The documentation for this class was generated from the following file:
- csutil/csevent.h
Generated for Crystal Space by doxygen 1.3.9.1