CScriptEngine Class Reference

#include <CScriptEngine.h>

Inheritance diagram for CScriptEngine:

Public Member Functions
	CScriptEngine (IPMUnknown *boss, ClassID requestDataBoss=kCScriptRequestDataBoss)
virtual	~CScriptEngine ()
virtual ErrorCode	Install ()
virtual ErrorCode	UnInstall ()
virtual EngineContext	GetRequestContext () const
virtual IScriptManager *	QueryScriptManager () const
virtual IScriptRequestData *	CreateScriptRequestData ()
virtual PMString	GetName () const
virtual bool16	IsScriptActive () const
virtual void	IncrementActiveScriptCount ()
virtual void	DecrementActiveScriptCount ()
virtual bool16	GetShowAlerts () const
virtual bool16	GetShowDialogs () const
Public Member Functions inherited from CPMUnknown< IScriptEngine >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Protected Member Functions
virtual void	ResetScriptRequestData (IScriptRequestData *scriptRequestData) const
Protected Member Functions inherited from CPMUnknown< IScriptEngine >
	CPMUnknown (IPMUnknown *boss)

Additional Inherited Members
Public Types inherited from IScriptEngine
enum	{ kDefaultIID = IID_ISCRIPTENGINE }
Protected Attributes inherited from CPMUnknown< IScriptEngine >
HelperInterface	fHelperInterface

Detailed Description

Base implementation for IScriptEngine. May be used as is for most clients with a single engine aggregated onto their IScriptManager boss. Clients with multiple engines will need a separate boss, and will need to override at least QueryScriptManager() and GetName().

See Also

IScriptEngine

Constructor & Destructor Documentation

CScriptEngine::CScriptEngine	(	IPMUnknown *	boss,
		ClassID	requestDataBoss = kCScriptRequestDataBoss
	)

Constructor. Clients with a custom IScriptRequestData boss will need to subclass this implementation and pass the ClassID of their IScriptRequestData boss to this base class.

Parameters

requestDataBoss

is the ClassID of the IScriptRequestData boss used to handle requests for this client

virtual CScriptEngine::~CScriptEngine ( )

inlinevirtual

Destructor

Member Function Documentation

virtual IScriptRequestData* CScriptEngine::CreateScriptRequestData ( )

virtual

Returns

a script event data boss

Implements IScriptEngine.

virtual void CScriptEngine::DecrementActiveScriptCount ( )

virtual

Decrement the number of active scripts in this engine

Implements IScriptEngine.

virtual PMString CScriptEngine::GetName ( ) const

virtual

Returns

this engine's name. Clients with multiple engines will want to override this method.

Implements IScriptEngine.

virtual EngineContext CScriptEngine::GetRequestContext ( ) const

virtual

Returns

this engine's current request context for processing a script

Implements IScriptEngine.

virtual bool16 CScriptEngine::GetShowAlerts ( ) const

virtual

Returns

whether alerts should be displayed when this engine is processing requests

Implements IScriptEngine.

virtual bool16 CScriptEngine::GetShowDialogs ( ) const

virtual

Returns

whether dialogs should be displayed when this engine is processing requests

Implements IScriptEngine.

virtual void CScriptEngine::IncrementActiveScriptCount ( )

virtual

Increment the number of active scripts in this engine

Implements IScriptEngine.

virtual ErrorCode CScriptEngine::Install ( )

virtual

Tells the script engine to install

Implements IScriptEngine.

virtual bool16 CScriptEngine::IsScriptActive ( ) const

virtual

Returns

whether a script is running in this engine

Implements IScriptEngine.

virtual IScriptManager* CScriptEngine::QueryScriptManager ( ) const

virtual

Returns

the script manager for this engine. Clients with multiple engines must override this method.

Implements IScriptEngine.

virtual void CScriptEngine::ResetScriptRequestData ( IScriptRequestData *  scriptRequestData ) const

protectedvirtual

Called by CreateScriptRequestData() to initialize this script event data with default policies for this engine. Most clients will not need to override this method.

Parameters

scriptRequestData

is the script event data interface to initialize

virtual ErrorCode CScriptEngine::UnInstall ( )

virtual

Tells the script engine to uninstall

Implements IScriptEngine.