#include <CScriptProvider.h>

Inheritance diagram for CScriptProvider:

Protected Types
typedef CPMUnknown < IScriptProvider >	Inherited

Protected Member Functions
	CScriptProvider (IPMUnknown *boss)

virtual void	GetObject (IScriptRequestData data, IScript parent)

virtual void	HandleMethodOnObjects (ScriptID methodID, IScriptRequestData *data, const ScriptList &scriptList)

virtual void	AccessPropertyOnObjects (ScriptID propID, IScriptRequestData *data, const ScriptList &scriptList)

virtual void	AccessProperties (IScriptRequestData data, IScript script)

virtual ErrorCode	HandleMethod (ScriptID methodID, IScriptRequestData data, IScript script)

virtual ErrorCode	AccessProperty (ScriptID propID, IScriptRequestData data, IScript script)

virtual ErrorCode	PreAccessProperty (ScriptID propID, IScriptRequestData data, IScript script)

virtual ErrorCode	PostAccessProperty (ScriptID propID, IScriptRequestData data, IScript script)

virtual ErrorCode	PreAccessProperties (IScriptRequestData data, IScript script)

virtual ErrorCode	PostAccessProperties (IScriptRequestData data, IScript script)

virtual ErrorCode	AccessParent (ScriptID propID, IScriptRequestData data, IScript script)

Protected Member Functions inherited from CPMUnknown< IScriptProvider >
	CPMUnknown (IPMUnknown *boss)

Additional Inherited Members
Public Types inherited from IScriptProvider
enum	{ kDefaultIID = IID_ISCRIPTPROVIDER }

Public Member Functions inherited from CPMUnknown< IScriptProvider >
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 Attributes inherited from CPMUnknown< IScriptProvider >
HelperInterface	fHelperInterface

Detailed Description

A base class for script providers that add support for methods and properties.

Member Function Documentation

virtual ErrorCode CScriptProvider::AccessParent	(	ScriptID	propID,
		IScriptRequestData *	data,
		IScript *	script
	)

protectedvirtual

Access the parent property using the provided data for the target object. Most subclasses will not need to override this method.

Parameters

propID	is the request ID
data	is the request data. If the return value is kSuccess, the implementation must call AppendReturnData before returning. If the return value is not kSuccess, the implementation should not call AppendReturnData.
script	is the target object

Returns: kSuccess or an error code

virtual void CScriptProvider::AccessProperties	(	IScriptRequestData *	data,
		IScript *	script
	)

protectedvirtual

Access multiple properties using the provided data for the target object. Most subclasses will not need to override this method.

Parameters

data	is the request data. The implementation must call AppendReturnData before returning.
script	is the target object

Implements IScriptProvider.

virtual ErrorCode CScriptProvider::AccessProperty	(	ScriptID	propID,
		IScriptRequestData *	data,
		IScript *	script
	)

protectedvirtual

Access the specified property using the provided data for the target object. Most subclasses will override this method.

Parameters

propID	is the request ID
data	is the request data. If the return value is kSuccess, the implementation must call AppendReturnData before returning. If the return value is not kSuccess, the implementation should not call AppendReturnData.
script	is the target object

Returns: kSuccess or an error code

Reimplemented in RepresentScriptProvider, PrefsScriptProvider, BscMEScriptProvider, SnipRunScriptProvider, CusDtLnkScriptProvider, BscShpScriptProvider, BscTAScriptProvider, FrmLblScriptProvider, FrmLblPrefsScriptProvider, CdlChartScriptProvider, BPIScriptProvider, PstLstScriptProvider, SCScriptProvider, SnapPrefsScriptProvider, INXErrLogScriptProvider, SingletonScriptProvider, SnpRunnableScriptProvider, BPIPrefsScriptProvider, PrnSelScriptProvider, TranFxScriptProvider, PnlTrvScriptProvider, XDocBkPrefsScriptProvider, CusCondTxtScriptProvider, CdlStockScriptProvider, IDHAScriptProvider, HypScriptProvider, and CusDtLnkOptionScriptProvider.

virtual void CScriptProvider::AccessPropertyOnObjects	(	ScriptID	propID,
		IScriptRequestData *	data,
		const ScriptList &	scriptList
	)

protectedvirtual

Access the specified property using the provided data for the target objects. Most subclasses will not need to override this method.

Parameters

propID	is the request ID
data	is the request data. The implementation must call AppendReturnData before returning.
scriptList	is the target objects

Implements IScriptProvider.

virtual void CScriptProvider::GetObject	(	IScriptRequestData *	data,
		IScript *	parent
	)

protectedvirtual

Obtain a list of child objects, as specified by the data, that are contained in the parent object. This method is only relevant for subclasses of RepresentScriptProvider.

Implements IScriptProvider.

Reimplemented in RepresentScriptProvider, and SingletonScriptProvider.

virtual ErrorCode CScriptProvider::HandleMethod	(	ScriptID	methodID,
		IScriptRequestData *	data,
		IScript *	script
	)

protectedvirtual

Handle the specified method using the provided data for the target object. Most subclasses will override this method.

Parameters

methodID	is the request ID
data	is the request data. If the return value is kSuccess, the implementation must call AppendReturnData before returning. If the return value is not kSuccess, the implementation should not call AppendReturnData.
script	is the target object

Returns: kSuccess or an error code

Reimplemented in RepresentScriptProvider, BscMEScriptProvider, CusDtLnkScriptProvider, SnipRunScriptProvider, BscShpScriptProvider, FrmLblScriptProvider, FrmLblPrefsScriptProvider, CdlChartScriptProvider, BscTAScriptProvider, BPIScriptProvider, PstLstScriptProvider, SCScriptProvider, INXErrLogScriptProvider, SnpRunnableScriptProvider, and CdlStockScriptProvider.

virtual void CScriptProvider::HandleMethodOnObjects	(	ScriptID	methodID,
		IScriptRequestData *	data,
		const ScriptList &	scriptList
	)

protectedvirtual

Handle the specified method using the provided data for the target objects. Most subclasses will not need to override this method.

Parameters

methodID	is the request ID
data	is the request data. The implementation must call AppendReturnData before returning.
scriptList	is the target objects

Implements IScriptProvider.

virtual ErrorCode CScriptProvider::PostAccessProperties	(	IScriptRequestData *	data,
		IScript *	script
	)

protectedvirtual

Called by AccessProperties after processing multiple properties on an object. Some subclasses may want to override this method.

virtual ErrorCode CScriptProvider::PostAccessProperty	(	ScriptID	propID,
		IScriptRequestData *	data,
		IScript *	script
	)

protectedvirtual

Called by AccessProperty after processing a single property on an object. Some subclasses may want to override this method.

Reimplemented in BscTAScriptProvider.

virtual ErrorCode CScriptProvider::PreAccessProperties	(	IScriptRequestData *	data,
		IScript *	script
	)

protectedvirtual

Called by AccessProperties before processing multiple properties on an object. Some subclasses may want to override this method.

virtual ErrorCode CScriptProvider::PreAccessProperty	(	ScriptID	propID,
		IScriptRequestData *	data,
		IScript *	script
	)

protectedvirtual

Called by AccessProperty before processing a single property on an object. Some subclasses may want to override this method.

Reimplemented in BscTAScriptProvider.

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation