CrystalSpace

Public API Reference

iEvent Struct Reference
[Event handling]

This interface describes any system event. More...

#include <iutil/event.h>

Inheritance diagram for iEvent:

List of all members.

Public Member Functions

virtual bool AttributeExists (const char *name)=0
 Test whether an attribute exists.
virtual csRef
< iEventAttributeIterator
GetAttributeIterator ()=0
 Get an iterator for all attributes.
virtual csEventAttributeType GetAttributeType (const char *name)=0
 Query the type of an attribute.
virtual const csEventID GetName ()=0
 Return event name.
virtual bool Remove (const char *name)=0
 Remove a specific attribute.
virtual bool RemoveAll ()=0
 Remove all attributes.



virtual bool Add (const char *name, void *v)=0
 Add an attribute to the event.
virtual bool Add (const char *name, iBase *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, bool 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, const char *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, float 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, int64 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, int32 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, int16 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, int8 v)=0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, void *&v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, csRef< iBase > &v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, csRef< iEvent > &v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, bool &v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, const void *&v, size_t &size) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, const char *&v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, double &v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, float &v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, uint64 &v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, int64 &v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, uint32 &v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, int32 &v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, uint16 &v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, int16 &v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, uint8 &v) const =0
 Add an attribute to the event.
virtual csEventError Retrieve (const char *name, int8 &v) const =0
 Retrieve an attribute from the event.

Public Attributes

bool Broadcast
 Ignore "true" returned by HandleEvent.
csEventID Name
 Event name.
csTicks Time
 Time when the event occured.

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 279 of file event.h.


Member Function Documentation

virtual bool iEvent::Add ( const char *  name,
void *  v 
) [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual bool iEvent::Add ( const char *  name,
iBase v 
) [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual bool iEvent::Add ( const char *  name,
iEvent v 
) [pure virtual]

Add an attribute to the event.

virtual bool iEvent::Add ( const char *  name,
bool  v 
) [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual bool iEvent::Add ( const char *  name,
const void *  v,
size_t  size 
) [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual bool iEvent::Add ( const char *  name,
const char *  v 
) [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual bool iEvent::Add ( const char *  name,
double  v 
) [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual bool iEvent::Add ( const char *  name,
float  v 
) [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual bool iEvent::Add ( const char *  name,
uint64  v 
) [pure virtual]

Add an attribute to the event.

virtual bool iEvent::Add ( const char *  name,
int64  v 
) [pure virtual]

Add an attribute to the event.

virtual bool iEvent::Add ( const char *  name,
uint32  v 
) [pure virtual]

Add an attribute to the event.

virtual bool iEvent::Add ( const char *  name,
int32  v 
) [pure virtual]

Add an attribute to the event.

virtual bool iEvent::Add ( const char *  name,
uint16  v 
) [pure virtual]

Add an attribute to the event.

virtual bool iEvent::Add ( const char *  name,
int16  v 
) [pure virtual]

Add an attribute to the event.

virtual bool iEvent::Add ( const char *  name,
uint8  v 
) [pure virtual]

Add an attribute to the event.

virtual bool iEvent::Add ( const char *  name,
int8  v 
) [pure virtual]

Add an attribute to the event.

virtual bool iEvent::AttributeExists ( const char *  name  )  [pure virtual]

Test whether an attribute exists.

Implemented in csEvent.

virtual csRef<iEventAttributeIterator> iEvent::GetAttributeIterator (  )  [pure virtual]

Get an iterator for all attributes.

Implemented in csEvent.

virtual csEventAttributeType iEvent::GetAttributeType ( const char *  name  )  [pure virtual]

Query the type of an attribute.

Implemented in csEvent.

virtual const csEventID iEvent::GetName (  )  [pure virtual]

Return event name.

Implemented in csEvent.

virtual bool iEvent::Remove ( const char *  name  )  [pure virtual]

Remove a specific attribute.

Implemented in csEvent.

virtual bool iEvent::RemoveAll (  )  [pure virtual]

Remove all attributes.

Implemented in csEvent.

virtual csEventError iEvent::Retrieve ( const char *  name,
void *&  v 
) const [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual csEventError iEvent::Retrieve ( const char *  name,
csRef< iBase > &  v 
) const [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual csEventError iEvent::Retrieve ( const char *  name,
csRef< iEvent > &  v 
) const [pure virtual]

Add an attribute to the event.

virtual csEventError iEvent::Retrieve ( const char *  name,
bool &  v 
) const [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual csEventError iEvent::Retrieve ( const char *  name,
const void *&  v,
size_t &  size 
) const [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual csEventError iEvent::Retrieve ( const char *  name,
const char *&  v 
) const [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual csEventError iEvent::Retrieve ( const char *  name,
double &  v 
) const [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual csEventError iEvent::Retrieve ( const char *  name,
float &  v 
) const [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual csEventError iEvent::Retrieve ( const char *  name,
uint64 &  v 
) const [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual csEventError iEvent::Retrieve ( const char *  name,
int64 &  v 
) const [pure virtual]

Add an attribute to the event.

Implemented in csEvent.

virtual csEventError iEvent::Retrieve ( const char *  name,
uint32 &  v 
) const [pure virtual]

Add an attribute to the event.

virtual csEventError iEvent::Retrieve ( const char *  name,
int32 &  v 
) const [pure virtual]

Add an attribute to the event.

virtual csEventError iEvent::Retrieve ( const char *  name,
uint16 &  v 
) const [pure virtual]

Add an attribute to the event.

virtual csEventError iEvent::Retrieve ( const char *  name,
int16 &  v 
) const [pure virtual]

Add an attribute to the event.

virtual csEventError iEvent::Retrieve ( const char *  name,
uint8 &  v 
) const [pure virtual]

Add an attribute to the event.

virtual csEventError iEvent::Retrieve ( const char *  name,
int8 &  v 
) const [pure virtual]

Retrieve an attribute from the event.


Member Data Documentation

Ignore "true" returned by HandleEvent.

Definition at line 289 of file event.h.

Event name.

Definition at line 283 of file event.h.

Time when the event occured.

Definition at line 287 of file event.h.


The documentation for this struct was generated from the following file:

Generated for Crystal Space 2.1 by doxygen 1.6.1