crystalspace.jbind.interfaces.iutil.event
Interface iEventCord

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csEventCord

public interface iEventCord

extends iBase

The iEventCord is an interface provided by an event queue to any event handlers wanting to receive some subclasses of events ASAP in a specified priority, bypassing the queue itself. Events may also optionally be sent to the normal event queue itself if none of the event handlers in the cord handle the event.

Author:

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

Method Summary

int	getCategory() Get the category of this cord.
boolean	getPass() Returns true if events are passed on to the owning event queue if all plugins in the cord return false from HandleEvent();.
int	insert(iEventHandler handler, int priority) Insert an event handler into the cord.
void	remove(iEventHandler handler) Remove an event handler from the cord.
void	setPass(boolean pass) Sets whether events are passed along to the owning event queue if all plugins in the cord return false from HandleEvent();.

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

getCategory

public int getCategory()

Get the category of this cord. Implemented in csEventCord.

Returns:

getPass

public boolean getPass()

Returns true if events are passed on to the owning event queue if all plugins in the cord return false from HandleEvent();. Implemented in csEventCord.

Returns:

insert

public int insert(iEventHandler handler,
                  int priority)

Insert an event handler into the cord. The priority defines when it will receive the event with respect to other registered event handlers. Event handlers with the same priority are handled in a first-come first-served fashion. This is significant since returning true from HandleEvent(); will stop further event processing. Implemented in csEventCord.

Parameters:

handler -

priority -

Returns:

remove

public void remove(iEventHandler handler)

Remove an event handler from the cord. Implemented in csEventCord.

Parameters:

handler -

setPass

public void setPass(boolean pass)

Sets whether events are passed along to the owning event queue if all plugins in the cord return false from HandleEvent();. Implemented in csEventCord

Parameters:

pass -