CrystalSpace

Public API Reference

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

iEvent Struct Reference
[Event handling]

This interface describes any system event. More...

#include <event.h>

Inheritance diagram for iEvent:

iBase csEvent csPoolEvent List of all members.

Public Attributes

uint8 Type
 Event type.
See also:
csEventType.


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


Member Data Documentation

uint8 iEvent::Category
 

Event category (unused by CSWS).

Definition at line 181 of file event.h.

csEventCommandData iEvent::Command
 

Command data of event.

Definition at line 195 of file event.h.

uint8 iEvent::Flags
 

Miscelaneous event flags.

Definition at line 185 of file event.h.

csEventJoystickData iEvent::Joystick
 

Joystick data of event.

Definition at line 193 of file event.h.

csEventMouseData iEvent::Mouse
 

Mouse data of event.

Definition at line 191 of file event.h.

uint8 iEvent::SubCategory
 

Even finer granularity.

Definition at line 183 of file event.h.

csTicks iEvent::Time
 

Time when the event occured.

Definition at line 187 of file event.h.

uint8 iEvent::Type
 

Event type.

See also:
csEventType.

Definition at line 179 of file event.h.


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