InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IScriptRequestHandler.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Jonathan W. Brown
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //========================================================================================
23 
24 #ifndef __IScriptRequestHandler__
25 #define __IScriptRequestHandler__
26 
27 #include "IPMUnknown.h"
28 
29 #include "IScriptRequestData.h"
30 
31 class IScript ;
32 
33 namespace ScriptInfo
34 {
35 class ObjectScriptElement ;
36 }
37 
41 class IScriptRequestHandler : public IPMUnknown
42 {
43 public:
44  enum { kDefaultIID = IID_ISCRIPTREQUESTHANDLER };
45 
46  // Handling Script Requests ---------------------------------------------------------------------------------------------
47 
59  virtual ErrorCode DoGetObject( IScript* parent, const ScriptID& objectType, SpecifierForm accessorForm, const ScriptData& accessorData, IScriptRequestData* scriptRequestData ) const = 0 ;
60 
71  virtual ErrorCode DoHandleMethod( IScript* script, const ScriptID& methodID, IScriptRequestData* scriptRequestData ) const = 0 ;
72  virtual ErrorCode DoHandleMethod( IScript* script, const ScriptElementID& methodID, IScriptRequestData* scriptRequestData ) const = 0 ;
73  virtual ErrorCode DoHandleMethod( const ScriptList& scriptList, const ScriptID& methodID, IScriptRequestData* scriptRequestData ) const = 0 ;
74  virtual ErrorCode DoHandleMethod( const ScriptList& scriptList, const ScriptElementID& methodID, IScriptRequestData* scriptRequestData ) const = 0 ;
75 
86  virtual ErrorCode DoHandleCollectionMethod( IScript* parent, const ScriptID& childType, const ScriptID& methodID, IScriptRequestData* scriptRequestData ) const = 0 ;
87  virtual ErrorCode DoHandleCollectionMethod( IScript* parent, const ScriptID& childType, const ScriptElementID& methodID, IScriptRequestData* scriptRequestData ) const = 0 ;
88  virtual ErrorCode DoHandleCollectionMethod( const ScriptList& parentList, const ScriptID& childType, const ScriptID& methodID, IScriptRequestData* scriptRequestData ) const = 0 ;
89  virtual ErrorCode DoHandleCollectionMethod( const ScriptList& parentList, const ScriptID& childType, const ScriptElementID& methodID, IScriptRequestData* scriptRequestData ) const = 0 ;
90 
101  virtual ErrorCode DoSetProperty( IScript* script, const ScriptID& propertyID, IScriptRequestData* scriptRequestData ) const = 0 ;
102  virtual ErrorCode DoSetProperty( IScript* script, const ScriptElementID& propertyID, IScriptRequestData* scriptRequestData ) const = 0 ;
103  virtual ErrorCode DoSetProperty( const ScriptList& scriptList, const ScriptID& propertyID, IScriptRequestData* scriptRequestData ) const = 0 ;
104  virtual ErrorCode DoSetProperty( const ScriptList& scriptList, const ScriptElementID& propertyID, IScriptRequestData* scriptRequestData ) const = 0 ;
105 
116  virtual ErrorCode DoGetProperty( IScript* script, const ScriptID& propertyID, IScriptRequestData* scriptRequestData ) const = 0 ;
117  virtual ErrorCode DoGetProperty( IScript* script, const ScriptElementID& propertyID, IScriptRequestData* scriptRequestData ) const = 0 ;
118  virtual ErrorCode DoGetProperty( const ScriptList& scriptList, const ScriptID& propertyID, IScriptRequestData* scriptRequestData ) const = 0 ;
119  virtual ErrorCode DoGetProperty( const ScriptList& scriptList, const ScriptElementID& propertyID, IScriptRequestData* scriptRequestData ) const = 0 ;
120 
129  virtual const ScriptInfo::ObjectScriptElement* FindCollectionInfo( IScript* script, const ScriptID& collectionID, IScriptRequestData* scriptRequestData ) const = 0 ;
130  virtual const ScriptInfo::ObjectScriptElement* FindCollectionInfo( IScript* script, const ScriptElementID& collectionID, IScriptRequestData* scriptRequestData ) const = 0 ;
131 
135  virtual ErrorCode SetProperties( IScript* script, IScriptRequestData* data ) const = 0 ;
139  virtual ErrorCode GetProperties( IScript* script, IScriptRequestData* data ) const = 0 ;
140 } ;
141 
142 #endif // __IScriptRequestHandler__