BscTAScriptProvider Class Reference

Inheritance diagram for BscTAScriptProvider:

Public Member Functions
	BscTAScriptProvider (IPMUnknown *boss)
	~BscTAScriptProvider ()
virtual ErrorCode	HandleMethod (ScriptID methodID, IScriptRequestData *data, IScript *script)
virtual ErrorCode	PreAccessProperty (ScriptID propID, IScriptRequestData *data, IScript *script)
virtual ErrorCode	AccessProperty (ScriptID propID, IScriptRequestData *data, IScript *script)
virtual ErrorCode	PostAccessProperty (ScriptID propID, IScriptRequestData *data, IScript *script)

Additional Inherited Members
Public Types inherited from IScriptProvider
enum	{ kDefaultIID = IID_ISCRIPTPROVIDER }
Protected Types inherited from CScriptProvider
typedef CPMUnknown < IScriptProvider >	Inherited
Protected Member Functions inherited from CScriptProvider
	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	PreAccessProperties (IScriptRequestData *data, IScript *script)
virtual ErrorCode	PostAccessProperties (IScriptRequestData *data, IScript *script)
virtual ErrorCode	AccessParent (ScriptID propID, IScriptRequestData *data, IScript *script)
Protected Attributes inherited from CPMUnknown< IScriptProvider >
HelperInterface	fHelperInterface

Detailed Description

From SDK sample; Handles scripting of the BasicTextAdornment's text attribute property (p_BscTAShade). See the Provider statement for kBscTAScriptProviderBoss in BscTA.fr for the list of scripting objects on which the p_BscTAShade property is available.

Constructor & Destructor Documentation

BscTAScriptProvider::BscTAScriptProvider ( IPMUnknown *  boss )

inline

Constructor.

Parameters

boss	interface ptr from boss object on which this interface is aggregated.

BscTAScriptProvider::~BscTAScriptProvider ( )

inline

Destructor.

Member Function Documentation

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

virtual

Called if a provider can handle a property.

Parameters

propID	identifies the ID of the property 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 CScriptProvider.

ErrorCode BscTAScriptProvider::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 CScriptProvider.

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

virtual

PostAccessProperty is called after AccessPropery. This method in this class calls ApplyScriptCmd on tasu, if it's a put, and resets tasu to nil.

Parameters

propID	identifies the ID of the property 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 CScriptProvider.

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

virtual

PreAccessProperty is called before AccessPropery. This method in this class resets tasu with a pointer to a new instnace of TextAttributeScriptUtility.

Parameters

propID	identifies the ID of the property 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 CScriptProvider.