![]() |
Public API Reference |
This class represents a system event. More...
#include <csutil/csevent.h>
Public Member Functions | |
| 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 bool | Add (const char *name, void *v) |
| Add an attribute to the event. | |
| virtual bool | AttributeExists (const char *name) |
| Test whether an attribute exists. | |
| csEvent () | |
| Empty initializer. | |
| csEvent (csEvent const &) | |
| Cloning constructor. | |
| csEvent (csTicks iTime, csEventID iName, bool iBroadcast) | |
| Basic constructor. | |
| virtual csRef < iEventAttributeIterator > | GetAttributeIterator () |
| Get an iterator for all attributes. | |
| virtual csEventAttributeType | GetAttributeType (const char *name) |
| Query the type of an attribute. | |
| const csEventID | GetName () |
| Return the event's name. | |
| virtual bool | Remove (const char *name) |
| Remove a specific attribute. | |
| virtual bool | RemoveAll () |
| Remove all attributes. | |
| 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 csEventError | Retrieve (const char *name, void *&v) const |
| Retrieve an attribute from the event. | |
| virtual | ~csEvent () |
| Destructor. | |
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.
| csEvent::csEvent | ( | ) |
Empty initializer.
| csEvent::csEvent | ( | csEvent const & | ) |
Cloning constructor.
Note that for command style events, this performs only a shallow copy of the `Info' attribute.
| csEvent::csEvent | ( | csTicks | iTime, |
| csEventID | iName, | ||
| bool | iBroadcast | ||
| ) |
Basic constructor.
| virtual csEvent::~csEvent | ( | ) | [virtual] |
Destructor.
| virtual bool csEvent::Add | ( | const char * | name, |
| float | v | ||
| ) | [virtual] |
Add an attribute to the event.
Implements iEvent.
| virtual bool csEvent::Add | ( | const char * | name, |
| double | v | ||
| ) | [virtual] |
Add an attribute to the event.
Implements iEvent.
| virtual bool csEvent::Add | ( | const char * | name, |
| const char * | v | ||
| ) | [virtual] |
Add an attribute to the event.
Implements iEvent.
| virtual bool csEvent::Add | ( | const char * | name, |
| const void * | v, | ||
| size_t | size | ||
| ) | [virtual] |
Add an attribute to the event.
Implements iEvent.
| virtual bool csEvent::Add | ( | const char * | name, |
| bool | v | ||
| ) | [virtual] |
Add an attribute to the event.
Implements iEvent.
| virtual bool csEvent::Add | ( | const char * | name, |
| iEvent * | v | ||
| ) | [virtual] |
Add an attribute to the event.
Implements iEvent.
| virtual bool csEvent::Add | ( | const char * | name, |
| iBase * | v | ||
| ) | [virtual] |
Add an attribute to the event.
Implements iEvent.
| virtual bool csEvent::Add | ( | const char * | name, |
| void * | v | ||
| ) | [virtual] |
Add an attribute to the event.
Implements iEvent.
| virtual bool csEvent::AttributeExists | ( | const char * | name | ) | [virtual] |
Test whether an attribute exists.
Implements iEvent.
| virtual csRef<iEventAttributeIterator> csEvent::GetAttributeIterator | ( | ) | [virtual] |
Get an iterator for all attributes.
Implements iEvent.
| virtual csEventAttributeType csEvent::GetAttributeType | ( | const char * | name | ) | [virtual] |
Query the type of an attribute.
Implements iEvent.
| const csEventID csEvent::GetName | ( | ) | [virtual] |
Return the event's name.
Implements iEvent.
| virtual bool csEvent::Remove | ( | const char * | name | ) | [virtual] |
Remove a specific attribute.
Implements iEvent.
| virtual bool csEvent::RemoveAll | ( | ) | [virtual] |
Remove all attributes.
Implements iEvent.
| virtual csEventError csEvent::Retrieve | ( | const char * | name, |
| int64 & | v | ||
| ) | const [inline, virtual] |
| virtual csEventError csEvent::Retrieve | ( | const char * | name, |
| uint64 & | v | ||
| ) | const [inline, virtual] |
| virtual csEventError csEvent::Retrieve | ( | const char * | name, |
| float & | v | ||
| ) | const [virtual] |
Retrieve an attribute from the event.
Implements iEvent.
| virtual csEventError csEvent::Retrieve | ( | const char * | name, |
| double & | v | ||
| ) | const [virtual] |
Retrieve an attribute from the event.
Implements iEvent.
| virtual csEventError csEvent::Retrieve | ( | const char * | name, |
| const char *& | v | ||
| ) | const [virtual] |
Retrieve an attribute from the event.
Implements iEvent.
| virtual csEventError csEvent::Retrieve | ( | const char * | name, |
| const void *& | v, | ||
| size_t & | size | ||
| ) | const [virtual] |
Retrieve an attribute from the event.
Implements iEvent.
| virtual csEventError csEvent::Retrieve | ( | const char * | name, |
| bool & | v | ||
| ) | const [virtual] |
Retrieve an attribute from the event.
Implements iEvent.
| virtual csEventError csEvent::Retrieve | ( | const char * | name, |
| csRef< iEvent > & | v | ||
| ) | const [virtual] |
Retrieve an attribute from the event.
Implements iEvent.
| virtual csEventError csEvent::Retrieve | ( | const char * | name, |
| csRef< iBase > & | v | ||
| ) | const [virtual] |
Retrieve an attribute from the event.
Implements iEvent.
| virtual csEventError csEvent::Retrieve | ( | const char * | name, |
| void *& | v | ||
| ) | const [virtual] |
Retrieve an attribute from the event.
Implements iEvent.