CrystalSpace

Public API Reference

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

csEvent Class Reference

This class represents a system event. More...

#include <csevent.h>

Inheritance diagram for csEvent:

iEvent iBase csPoolEvent List of all members.

Public Methods

 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, int8 v)
 Add a named event with a given parameter.

virtual bool Find (const char *name, int8 &v, int index=0) const
 Find a named event for a given type.


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 56 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,
int8    v
[virtual]
 

Add a named event with a given parameter.

Implements iEvent.

virtual bool csEvent::Find const char *    name,
int8   v,
int    index = 0
const [virtual]
 

Find a named event for a given type.

Implements iEvent.


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