crystalspace.jbind.interfaces.iutil.event
Interface iEvent

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csEvent

public interface iEvent

extends iBase

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.

Author:

Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/pubapi/structiEvent.php

Method Summary

byte	Category() Event category (unused by CSWS).
void	Category(byte category) Event category (unused by CSWS).
csEventCommandData	Command() Command data of event.
void	Command(csEventCommandData command) Command data of event.
byte	Flags() Miscelaneous event flags.
void	Flags(byte flags) Miscelaneous event flags.
csEventJoystickData	Joystick() Joystick data of event.
void	Joystick(csEventJoystickData joystick) Joystick data of event.
csEventMouseData	Mouse() Mouse data of event.
void	Mouse(csEventMouseData mouse) Mouse data of event.
csEventNetworkData	Network() Network data of event.
void	Network(csEventNetworkData network) Network data of event.
byte	SubCategory() Even finer granularity.
void	SubCategory(byte subCategory) Even finer granularity.
int	Time() Time when the event occured.
void	Time(int time) Time when the event occured.
byte	Type() Event type (one of csevKeyDown etc.).
void	Type(byte type) Event type (one of csevKeyDown etc.).

Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getName, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Method Detail

Type

public byte Type()

Event type (one of csevKeyDown etc.).

Returns:

Type

public void Type(byte type)

Event type (one of csevKeyDown etc.).

Parameters:

type -

Category

public byte Category()

Event category (unused by CSWS).

Returns:

Category

public void Category(byte category)

Event category (unused by CSWS).

Parameters:

category -

SubCategory

public byte SubCategory()

Even finer granularity.

Returns:

SubCategory

public void SubCategory(byte subCategory)

Even finer granularity.

Parameters:

subCategory -

Flags

public byte Flags()

Miscelaneous event flags.

Returns:

Flags

public void Flags(byte flags)

Miscelaneous event flags.

Parameters:

flags -

Time

public int Time()

Time when the event occured.

Returns:

Time

public void Time(int time)

Time when the event occured.

Parameters:

time -

Command

public csEventCommandData Command()

Command data of event.

Returns:

Command

public void Command(csEventCommandData command)

Command data of event.

Parameters:

command -

Mouse

public csEventMouseData Mouse()

Mouse data of event.

Returns:

Mouse

public void Mouse(csEventMouseData mouse)

Mouse data of event.

Parameters:

mouse -

Joystick

public csEventJoystickData Joystick()

Joystick data of event.

Returns:

Joystick

public void Joystick(csEventJoystickData joystick)

Joystick data of event.

Parameters:

joystick -

Network

public csEventNetworkData Network()

Network data of event.

Returns:

Network

public void Network(csEventNetworkData network)

Network data of event.

Parameters:

network -