InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
BPIScriptProvider Class Reference
Inheritance diagram for BPIScriptProvider:
CScriptProviderCPMUnknown< IScriptProvider >IScriptProviderIPMUnknown

Public Member Functions

 BPIScriptProvider (IPMUnknown *boss)
 
 ~BPIScriptProvider ()
 
virtual ErrorCode HandleMethod (ScriptID methodID, IScriptRequestData *data, IScript *script)
 
virtual ErrorCode AccessProperty (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 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 Attributes inherited from CPMUnknown< IScriptProvider >
HelperInterface fHelperInterface
 

Detailed Description

From SDK sample; Handles scripting of the BasicPersistInterface's data property (p_BPIData) added onto page items in interface IBPIData. See the Provider statement for kBPIScriptProviderBoss in BPI.fr for the list of scripting objects on which the p_BPIData property is available.

Constructor & Destructor Documentation

BPIScriptProvider::BPIScriptProvider (IPMUnknownboss)
inline

Constructor.

Parameters
bossinterface ptr from boss object on which this interface is aggregated.
BPIScriptProvider::~BPIScriptProvider ()
inline

Destructor.

Member Function Documentation

ErrorCode BPIScriptProvider::AccessProperty (ScriptID propID,
IScriptRequestDatadata,
IScriptscript 
)
virtual

Called if a provider can handle a property.

Parameters
propIDidentifies the ID of the property to handle.
dataidentifies an interface pointer used to extract data.
scriptidentifies an interface pointer on the script object representing the parent of the application object.

Reimplemented from CScriptProvider.

ErrorCode BPIScriptProvider::HandleMethod (ScriptID methodID,
IScriptRequestDatadata,
IScriptscript 
)
virtual

Called if a provider can handle a method/event.

Parameters
methodIDidentifies the ID of the method/event to handle.
dataidentifies an interface pointer used to extract data.
scriptidentifies an interface pointer on the script object representing the parent of the application object.

Reimplemented from CScriptProvider.