IScriptEngine Class Reference

#include <IScriptEngine.h>

Inheritance diagram for IScriptEngine:

Public Types
enum	{ kDefaultIID = IID_ISCRIPTENGINE }

Public Member Functions
virtual ErrorCode	Install ()=0
virtual ErrorCode	UnInstall ()=0
virtual EngineContext	GetRequestContext () const =0
virtual IScriptManager *	QueryScriptManager () const =0
virtual IScriptRequestData *	CreateScriptRequestData ()=0
virtual PMString	GetName () const =0
virtual bool16	IsScriptActive () const =0
virtual void	IncrementActiveScriptCount ()=0
virtual void	DecrementActiveScriptCount ()=0
virtual bool16	GetShowAlerts () const =0
virtual bool16	GetShowDialogs () const =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

Every scripting client must implement this interface to provide basic information about support for its scripting engine.

Clients with a single engine may aggregate onto their IScriptManager boss. Clients with multiple engines will need a separate boss.

Member Function Documentation

virtual IScriptRequestData* IScriptEngine::CreateScriptRequestData ( )

pure virtual

Returns

a script event data boss

Implemented in CScriptEngine.

virtual void IScriptEngine::DecrementActiveScriptCount ( )

pure virtual

Decrement the number of active scripts in this engine

Implemented in CScriptEngine.

virtual PMString IScriptEngine::GetName ( ) const

pure virtual

Returns

this engine's name

Implemented in CScriptEngine.

virtual EngineContext IScriptEngine::GetRequestContext ( ) const

pure virtual

Returns

this engine's current request context for processing a script

Implemented in CScriptEngine.

virtual bool16 IScriptEngine::GetShowAlerts ( ) const

pure virtual

Returns

whether alerts should be displayed when this engine is processing requests

Implemented in CScriptEngine.

virtual bool16 IScriptEngine::GetShowDialogs ( ) const

pure virtual

Returns

whether dialogs should be displayed when this engine is processing requests

Implemented in CScriptEngine.

virtual void IScriptEngine::IncrementActiveScriptCount ( )

pure virtual

Increment the number of active scripts in this engine

Implemented in CScriptEngine.

virtual ErrorCode IScriptEngine::Install ( )

pure virtual

Tells the script engine to install

Implemented in CScriptEngine.

virtual bool16 IScriptEngine::IsScriptActive ( ) const

pure virtual

Returns

whether a script is running in this engine

Implemented in CScriptEngine.

virtual IScriptManager* IScriptEngine::QueryScriptManager ( ) const

pure virtual

Returns

the script manager for this engine

Implemented in CScriptEngine.

virtual ErrorCode IScriptEngine::UnInstall ( )

pure virtual

Tells the script engine to uninstall

Implemented in CScriptEngine.