iEvent Struct Reference
[Event handling]
This interface describes any system event.
More...
#include <iutil/event.h>
Inheritance diagram for iEvent:

Public Member Functions | |
virtual bool | AttributeExists (const char *name)=0 |
Test whether an attribute exists. | |
virtual csEventAttributeType | GetAttributeType (const char *name)=0 |
Query the type of an attribute. | |
virtual bool | Remove (const char *name)=0 |
Remove a specific attribute. | |
virtual bool | RemoveAll ()=0 |
Remove all attributes. | |
virtual csRef< iEventAttributeIterator > | GetAttributeIterator ()=0 |
Get an iterator for all attributes. | |
virtual bool | Add (const char *name, int8 v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, uint8 v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, int16 v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, uint16 v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, int32 v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, uint32 v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, int64 v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, uint64 v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, float v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, double v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, const char *v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, const void *v, size_t size)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, bool v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, iEvent *v)=0 |
Add an attribute to the event. | |
virtual bool | Add (const char *name, iBase *v)=0 |
Add an attribute to the event. | |
virtual csEventError | Retrieve (const char *name, int8 &v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, uint8 &v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, int16 &v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, uint16 &v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, int32 &v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, uint32 &v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, int64 &v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, uint64 &v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, float &v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, double &v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, const char *&v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, const void *&v, size_t &size) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, bool &v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, csRef< iEvent > &v) const =0 |
Retrieve an attribute from the event. | |
virtual csEventError | Retrieve (const char *name, csRef< iBase > &v) const =0 |
Retrieve an attribute from the event. | |
Public Attributes | |
uint8 | Type |
Event type. | |
uint8 | Category |
Event category (unused by CSWS). | |
uint8 | SubCategory |
Even finer granularity. | |
uint8 | Flags |
Miscelaneous event flags. | |
csTicks | Time |
Time when the event occured. | |
csEventMouseData | Mouse |
Mouse data of event. | |
csEventJoystickData | Joystick |
Joystick data of event. | |
csEventCommandData | Command |
Command data of event. |
Detailed Description
This interface describes any system event.Events can be generated by hardware (keyboard, mouse) as well as by software (commands and broadcasts). Not all events neccessarily pass through the system event queue; you may organize point-to-point event flows between some plugins and so on.
The events can be generated by the event outlet (see the CreateEvent method in iEventOutlet) if you don't want to create your own implementations of this interface. On the other hand, if you want to provide extra functionality you may subclass iEvent interface and add another interface (say iExtEvent) then you may query that interface using normal SCF QueryInterface method.
Definition at line 261 of file event.h.
Member Function Documentation
|
Add an attribute to the event.
Implemented in csEvent. |
|
Add an attribute to the event.
Implemented in csEvent. |
|
Add an attribute to the event.
Implemented in csEvent. |
|
Add an attribute to the event.
Implemented in csEvent. |
|
Add an attribute to the event.
Implemented in csEvent. |
|
Add an attribute to the event.
Implemented in csEvent. |
|
Add an attribute to the event.
Implemented in csEvent. |
|
Add an attribute to the event.
|
|
Add an attribute to the event.
|
|
Add an attribute to the event.
|
|
Add an attribute to the event.
|
|
Add an attribute to the event.
|
|
Add an attribute to the event.
|
|
Add an attribute to the event.
|
|
Add an attribute to the event.
|
|
Test whether an attribute exists.
Implemented in csEvent. |
|
Get an iterator for all attributes.
Implemented in csEvent. |
|
Query the type of an attribute.
Implemented in csEvent. |
|
Remove a specific attribute.
Implemented in csEvent. |
|
Remove all attributes.
Implemented in csEvent. |
|
Retrieve an attribute from the event.
Implemented in csEvent. |
|
Retrieve an attribute from the event.
Implemented in csEvent. |
|
Retrieve an attribute from the event.
Implemented in csEvent. |
|
Retrieve an attribute from the event.
Implemented in csEvent. |
|
Retrieve an attribute from the event.
Implemented in csEvent. |
|
Retrieve an attribute from the event.
Implemented in csEvent. |
|
Retrieve an attribute from the event.
Implemented in csEvent. |
|
Retrieve an attribute from the event.
Implemented in csEvent. |
|
Retrieve an attribute from the event.
Implemented in csEvent. |
|
Retrieve an attribute from the event.
|
|
Retrieve an attribute from the event.
|
|
Retrieve an attribute from the event.
|
|
Retrieve an attribute from the event.
|
|
Retrieve an attribute from the event.
|
|
Retrieve an attribute from the event.
|
Member Data Documentation
|
Event category (unused by CSWS).
|
|
Command data of event.
|
|
Miscelaneous event flags.
|
|
Joystick data of event.
|
|
Mouse data of event.
|
|
Even finer granularity.
|
|
Time when the event occured.
|
|
Event type.
|
The documentation for this struct was generated from the following file:
- iutil/event.h
Generated for Crystal Space by doxygen 1.3.9.1