InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IScriptRequestHandler Class Referenceabstract

#include <IScriptRequestHandler.h>

Inheritance diagram for IScriptRequestHandler:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISCRIPTREQUESTHANDLER }
 

Public Member Functions

virtual ErrorCode DoGetObject (IScript *parent, const ScriptID &objectType, SpecifierForm accessorForm, const ScriptData &accessorData, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoHandleMethod (IScript *script, const ScriptID &methodID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoHandleMethod (IScript *script, const ScriptElementID &methodID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoHandleMethod (const ScriptList &scriptList, const ScriptID &methodID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoHandleMethod (const ScriptList &scriptList, const ScriptElementID &methodID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoHandleCollectionMethod (IScript *parent, const ScriptID &childType, const ScriptID &methodID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoHandleCollectionMethod (IScript *parent, const ScriptID &childType, const ScriptElementID &methodID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoHandleCollectionMethod (const ScriptList &parentList, const ScriptID &childType, const ScriptID &methodID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoHandleCollectionMethod (const ScriptList &parentList, const ScriptID &childType, const ScriptElementID &methodID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoSetProperty (IScript *script, const ScriptID &propertyID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoSetProperty (IScript *script, const ScriptElementID &propertyID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoSetProperty (const ScriptList &scriptList, const ScriptID &propertyID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoSetProperty (const ScriptList &scriptList, const ScriptElementID &propertyID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoGetProperty (IScript *script, const ScriptID &propertyID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoGetProperty (IScript *script, const ScriptElementID &propertyID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoGetProperty (const ScriptList &scriptList, const ScriptID &propertyID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode DoGetProperty (const ScriptList &scriptList, const ScriptElementID &propertyID, IScriptRequestData *scriptRequestData) const =0
 
virtual const
ScriptInfo::ObjectScriptElement * 		FindCollectionInfo (IScript *script, const ScriptID &collectionID, IScriptRequestData *scriptRequestData) const =0
 
virtual const
ScriptInfo::ObjectScriptElement * 		FindCollectionInfo (IScript *script, const ScriptElementID &collectionID, IScriptRequestData *scriptRequestData) const =0
 
virtual ErrorCode SetProperties (IScript *script, IScriptRequestData *data) const =0
 
virtual ErrorCode GetProperties (IScript *script, IScriptRequestData *data) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Matches requests from clients to the appropriate script provider.

Member Function Documentation

virtual ErrorCode IScriptRequestHandler::DoGetObject (IScript * parent,
const ScriptID & objectType,
SpecifierForm accessorForm,
const ScriptData & accessorData,
IScriptRequestData * scriptRequestData 
) const
pure virtual

Get a script object

Parameters
parent- the parent script object
objectType- the type of the desired script object
accessorForm- the form of the get request
accessorData- the data for the get request
scriptRequestData- the request context
Returns
kSuccess if the specified object was found, kInvalidCollectionItemError if the specified object wasn't found, or another error code if getting the specified object failed
virtual ErrorCode IScriptRequestHandler::DoGetProperty (IScript * script,
const ScriptID & propertyID,
IScriptRequestData * scriptRequestData 
) const
pure virtual

Handle a get property request

Parameters
script- the script object
objectType- the type of object
propertyID- the property
scriptRequestData- the request context
Returns
kSuccess if the property was accessed successfully, kRequestNotHandledError if the property wasn't accessed at all, or another error code if the property access failed
virtual ErrorCode IScriptRequestHandler::DoHandleCollectionMethod (IScript * parent,
const ScriptID & childType,
const ScriptID & methodID,
IScriptRequestData * scriptRequestData 
) const
pure virtual

Handle a collection method request

Parameters
parent- the parent script object
objectType- the type of child object
methodID- the method's ID
scriptRequestData- the request context
Returns
kSuccess if the method was handled successfully, kRequestNotHandledError if the method wasn't handled at all, or another error code if the method failed
virtual ErrorCode IScriptRequestHandler::DoHandleMethod (IScript * script,
const ScriptID & methodID,
IScriptRequestData * scriptRequestData 
) const
pure virtual

Handle a method request

Parameters
script- the script object
objectType- the type of object
methodID- the method's ID
scriptRequestData- the request context
Returns
kSuccess if the method was handled successfully, kRequestNotHandledError if the method wasn't handled at all, or another error code if the method failed
virtual ErrorCode IScriptRequestHandler::DoSetProperty (IScript * script,
const ScriptID & propertyID,
IScriptRequestData * scriptRequestData 
) const
pure virtual

Handle a set property request

Parameters
script- the script object
objectType- the type of object
propertyID- the property
scriptRequestData- the request context
Returns
kSuccess if the property was accessed successfully, kRequestNotHandledError if the property wasn't accessed at all, or another error code if the property access failed
virtual const ScriptInfo::ObjectScriptElement* IScriptRequestHandler::FindCollectionInfo (IScript * script,
const ScriptID & collectionID,
IScriptRequestData * scriptRequestData 
) const
pure virtual

Get a script object collection

Parameters
script- the parent script object
collectionID- the type of the object for which a collection is desired
scriptRequestData- the request context
Returns
a pointer to the specified collection's object info, or nil if the specified collection wasn't found
virtual ErrorCode IScriptRequestHandler::GetProperties (IScript * script,
IScriptRequestData * data 
) const
pure virtual

Get all properties of an object

virtual ErrorCode IScriptRequestHandler::SetProperties (IScript * script,
IScriptRequestData * data 
) const
pure virtual

Set multiple properties of an object