IScriptEventListener Class Reference

#include <IScriptEventListener.h>

Inheritance diagram for IScriptEventListener:

Public Types
enum	{ kDefaultIID = IID_ISCRIPTEVENTLISTENER }
enum	State { kNew, kAlive, kDead }

Public Member Functions
virtual void	Init (const PMString &eventType, const ScriptData &handler)=0
virtual int32	GetID () const =0
virtual const PMString &	GetEventType () const =0
virtual const ScriptData &	GetHandler () const =0
virtual State	GetState () const =0
virtual void	SetState (State state)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Represents an event handler for scripting events.

Member Enumeration Documentation

enum IScriptEventListener::State

State of a listener

Enumerator
kNew	Listener exists but is not yet active
kAlive	Listener exists and should be called
kDead	Listener exists but is no longer active

Member Function Documentation

virtual const PMString& IScriptEventListener::GetEventType ( ) const

pure virtual

The name of the event to handle

virtual const ScriptData& IScriptEventListener::GetHandler ( ) const

pure virtual

The handler for the event

virtual int32 IScriptEventListener::GetID ( ) const

pure virtual

The unique id of this event listener

virtual State IScriptEventListener::GetState ( ) const

pure virtual

The current state of the listener

virtual void IScriptEventListener::Init ( const PMString &  eventType, const ScriptData &  handler  )

pure virtual

Initialize this ScriptEventListener.

Parameters

eventType	the event name
handler	is the script to execute in response to an event

virtual void IScriptEventListener::SetState ( State  state )

pure virtual

Set the state of the listener