Inheritance diagram for CdlStockScriptProvider:

Public Member Functions
	CdlStockScriptProvider (IPMUnknown *boss)

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

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

Protected Member Functions
virtual int32	GetNumObjects (const IScriptRequestData data, IScript parent)

virtual ErrorCode	AppendNthObject (const IScriptRequestData data, IScript parent, int32 n, ScriptList &objectList)

Protected Member Functions inherited from RepresentScriptProvider
	RepresentScriptProvider (IPMUnknown *boss)

virtual void	GetObject (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectByIndex (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectByName (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectByID (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectByRange (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectPrevious (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectNext (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectFirst (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectLast (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectMiddle (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectAny (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectAll (IScriptRequestData data, IScript parent)

virtual ErrorCode	GetObjectWhose (IScriptRequestData data, IScript parent)

virtual ErrorCode	AppendAllObjects (const IScriptRequestData data, IScript parent, ScriptList &objectList)

virtual ErrorCode	AppendObjectsWhose (const IScriptRequestData data, IScript parent, ScriptID propID, const ScriptData &propData, bool16 bFirstMatchOnly, ScriptList &objectList)

virtual int32	GetObjectIndex (const IScriptRequestData data, IScript parent, IScript *script)

virtual ErrorCode	CountObjects (ScriptID methodID, IScriptRequestData data, IScript parent)

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

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

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

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

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

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

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

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

ErrorCode	GetIndex (const IScriptRequestData data, IScript parent, const ScriptData &accessorData, int32 &index)

Protected Member Functions inherited from CScriptProvider
	CScriptProvider (IPMUnknown *boss)

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	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 }

Protected Types inherited from RepresentScriptProvider
typedef CScriptProvider	Inherited

Protected Attributes inherited from CPMUnknown< IScriptProvider >
HelperInterface	fHelperInterface

Detailed Description

From SDK sample; shows how to implement a script provider for proxy script object, kCdlStockScriptObjectBoss.

See Scripting Resources defined in the plug-in's .fr file.

See Also: kCdlStockScriptObjectBoss - the proxy object boss; kCandleStockObjectScriptElement - the script object defintion; CdlChart.fr

Member Function Documentation

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

virtual

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 from RepresentScriptProvider.

ErrorCode CdlStockScriptProvider::AppendNthObject	(	const IScriptRequestData *	data,
		IScript *	parent,
		int32	n,
		ScriptList &	objectList
	)

protectedvirtual

Append the nth child object, as specified by the data, that is contained in the parent object. All subclasses must override this method.

Parameters

data	is the request data
parent	is the parent object
n	is the index of the child
objectList	- the child object should be appended to this list

Returns: kSuccess or an error code

Implements RepresentScriptProvider.

int32 CdlStockScriptProvider::GetNumObjects	(	const IScriptRequestData *	data,
		IScript *	parent
	)

protectedvirtual

Get the number of child objects, as specified by the data, that are contained in the parent object. All subclasses must override this method.

Parameters

data	is the request data
parent	is the parent object

Returns: the number of child objects

Implements RepresentScriptProvider.

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

virtual

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 from RepresentScriptProvider.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation