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

Public Member Functions

 PstLstScriptProvider (IPMUnknown *boss)
 
virtual ~PstLstScriptProvider ()
 
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

Provides scripting support by means of handling events and property accesses that are delegated by the script manager.

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * PstLstScriptProvider::PstLstScriptProvider (IPMUnknownboss)

Constructor

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

Destructor.

Member Function Documentation

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

Processes a property access. This call further delegates to private methods.

See Also
IScriptProvider::AccessProperty

Reimplemented from RepresentScriptProvider.

ErrorCode PstLstScriptProvider::AppendNthObject (const IScriptRequestDatadata,
IScriptparent,
int32 n,
ScriptList & objectList 
)
protectedvirtual

Append the nth child object, as specified by the data, that is contained in the given object. All subclasses must override this method. n is a 0-based index. NOTE: This method has been modified in InDesign CS2.

Implements RepresentScriptProvider.

int32 PstLstScriptProvider::GetNumObjects (const IScriptRequestDatadata,
IScriptparent 
)
protectedvirtual

Get the number of child objects, as specified by the data, that are contained in the given object. All subclasses must override this method. NOTE: This method has been modified in InDesign CS2.

Implements RepresentScriptProvider.

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

Handles an event. This call further delegates to private methods.

See Also
IScriptProvider::HandleMethod

Reimplemented from RepresentScriptProvider.