CrystalSpace

Public API Reference

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

csEvent Class Reference

This class represents a system event. More...

#include <csutil/csevent.h>

Inheritance diagram for csEvent:

iEvent iBase csPoolEvent List of all members.

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< iEventAttributeIteratorGetAttributeIterator ()
 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

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  ,
int  type,
int  x,
int  y,
int  button,
int  modifiers
 

Create a mouse event object.

csEvent::csEvent csTicks  ,
int  type,
int  n,
int  x,
int  y,
int  button,
int  modifiers
 

Create a joystick event object.

csEvent::csEvent csTicks  ,
int  type,
int  code,
void *  info = 0
 

Create a command event object.

virtual csEvent::~csEvent  )  [virtual]
 

Destructor.


Member Function Documentation

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,
iEvent v
[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,
const void *  v,
size_t  size
[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,
double  v
[virtual]
 

Add an attribute to the event.

Implements iEvent.

virtual bool csEvent::Add const char *  name,
float  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.

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,
csRef< iBase > &  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,
bool &  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,
const char *&  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,
float &  v
const [virtual]
 

Retrieve an attribute from the event.

Implements iEvent.

virtual csEventError csEvent::Retrieve const char *  name,
uint64 value
const [inline, virtual]
 

Retrieve an attribute from the event.

Implements iEvent.

Definition at line 248 of file csevent.h.

virtual csEventError csEvent::Retrieve const char *  name,
int64 value
const [inline, virtual]
 

Retrieve an attribute from the event.

Implements iEvent.

Definition at line 226 of file csevent.h.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.3.9.1