CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | 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

virtual bool AttributeExists (const char *name)
 Test whether an attribute exists.
 csEvent (csTicks, int type, uint code, intptr_t info=0)
 Create a command event object.
 csEvent (csTicks, int type, uint n, const int32 *axes, uint8 numAxes, uint32 axesChanged, uint8 button, uint32 modifiers)
 Create an enumerated pointer (mouse/joystick) event object (newer interface).
 csEvent (csTicks, int type, uint n, int x, int y, uint32 axesChanged, uint button, uint32 modifiers)
 Create a joystick event object (old interface).
 csEvent (csTicks, int type, int x, int y, uint button, uint32 modifiers)
 Create a mouse event object (old interface).
 csEvent (csEvent const &)
 Cloning constructor.
 csEvent ()
 Empty initializer.
virtual csRef< iEventAttributeIteratorGetAttributeIterator ()
 Get an iterator for all attributes.
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 csEventError Retrieve (const char *name, uint64 &value) const
virtual csEventError Retrieve (const char *name, int64 &value) const
virtual ~csEvent ()
 Destructor.

Public Attributes

 SCF_DECLARE_IBASE

Friends

class csEventAttributeIterator

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 48 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,
uint  button,
uint32  modifiers
 

Create a mouse event object (old interface).

csEvent::csEvent csTicks  ,
int  type,
uint  n,
int  x,
int  y,
uint32  axesChanged,
uint  button,
uint32  modifiers
 

Create a joystick event object (old interface).

csEvent::csEvent csTicks  ,
int  type,
uint  n,
const int32 axes,
uint8  numAxes,
uint32  axesChanged,
uint8  button,
uint32  modifiers
 

Create an enumerated pointer (mouse/joystick) event object (newer interface).

csEvent::csEvent csTicks  ,
int  type,
uint  code,
intptr_t  info = 0
 

Create a command event object.

virtual csEvent::~csEvent  )  [virtual]
 

Destructor.


Member Function Documentation

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.


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