Inheritance diagram for BscShpScriptProvider:

Public Member Functions
	BscShpScriptProvider (IPMUnknown *boss)

virtual	~BscShpScriptProvider ()

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)

virtual ErrorCode	AppendAllObjects (const IScriptRequestData data, IScript parent, 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	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 a custom page item, kBscShpPageItemBoss.

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

See Also: kBscShpPageItemBoss - the scriptable boss; kBasicShapeObjectScriptElement - the script object that exposes kBscShpPageItemBoss in the Scripting DOM; BscShp.fr; IPageItemScriptUtils

Constructor & Destructor Documentation

BscShpScriptProvider::BscShpScriptProvider ( IPMUnknown * boss )

Constructor

Parameters

boss	the boss object this interface is aggregated onto

BscShpScriptProvider::~BscShpScriptProvider ( )

virtual

Destructor.

Member Function Documentation

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

virtual

Called if a provider can access a property.

Parameters

propID	identifies the property ID.
data	identifies an interface pointer used to extract data.
script	identifies an interface pointer on the script object representing.

Reimplemented from RepresentScriptProvider.

ErrorCode BscShpScriptProvider::AppendAllObjects	(	const IScriptRequestData *	data,
		IScript *	parent,
		ScriptList &	objectList
	)

protectedvirtual

Append all child objects in a collection on the given parent. n is a 0-based index.

Parameters

data	IN identifies the type of child object.
parent	IN references the owner of the collection.
objectList	OUT the objects in the collection.

Returns: kSuccess on success, other ErrorCode otherwise.

Reimplemented from RepresentScriptProvider.

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

protectedvirtual

Append the nth child object from a collection on the given parent.

Parameters

data	IN identifies the type of child object.
parent	IN references the owner of the collection.
n	IN the index (0-based) of the desired child object in the collection.
objectList	OUT the nth child gets added to this list

Returns: kSuccess on success, other ErrorCode otherwise.

Implements RepresentScriptProvider.

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

protectedvirtual

Get the number of child objects in a collection on the given parent.

Parameters

data	IN identifies the type of child object.
parent	IN references the owner of the collection.

Returns: the number of child objects.

Implements RepresentScriptProvider.

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

virtual

Called if a provider can handle a method/event.

Parameters

methodID	identifies the ID of the method/event to handle.
data	identifies an interface pointer used to extract data.
script	identifies an interface pointer on the script object representing the parent of the application object.

Reimplemented from RepresentScriptProvider.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation