InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CScriptProvider.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 __CScriptProvider__
25 #define __CScriptProvider__
26 
27 #include "CPMUnknown.h"
28 #include "ICommand.h"
29 #include "IScript.h"
30 #include "IScriptErrorUtils.h"
31 #include "IScriptRequestData.h"
32 #include "IScriptProvider.h"
33 #include "IScriptUtils.h"
34 
35 
39 class CScriptProvider : public CPMUnknown<IScriptProvider>
40 {
41 protected:
42  typedef CPMUnknown<IScriptProvider> Inherited ;
43 
44  CScriptProvider(IPMUnknown *boss);
45  virtual ~CScriptProvider();
46 
49  virtual void GetObject( IScriptRequestData* data, IScript* parent ) ;
50 
57  virtual void HandleMethodOnObjects( ScriptID methodID, IScriptRequestData* data, const ScriptList& scriptList ) ;
58 
65  virtual void AccessPropertyOnObjects( ScriptID propID, IScriptRequestData* data, const ScriptList& scriptList ) ;
66 
72  virtual void AccessProperties( IScriptRequestData* data, IScript* script ) ;
73 
82  virtual ErrorCode HandleMethod( ScriptID methodID, IScriptRequestData* data, IScript* script ) ;
83 
92  virtual ErrorCode AccessProperty( ScriptID propID, IScriptRequestData* data, IScript* script ) ;
93 
96  virtual ErrorCode PreAccessProperty( ScriptID propID, IScriptRequestData* data, IScript* script ) ;
97 
100  virtual ErrorCode PostAccessProperty( ScriptID propID, IScriptRequestData* data, IScript* script ) ;
101 
104  virtual ErrorCode PreAccessProperties( IScriptRequestData* data, IScript* script ) ;
105 
108  virtual ErrorCode PostAccessProperties( IScriptRequestData* data, IScript* script ) ;
109 
118  virtual ErrorCode AccessParent( ScriptID propID, IScriptRequestData* data, IScript* script ) ;
119 };
120 
124 class RepresentScriptProvider : public CScriptProvider
125 {
126 protected:
127  typedef CScriptProvider Inherited ;
128 
129  RepresentScriptProvider( IPMUnknown* boss ) ;
130  virtual ~RepresentScriptProvider() ;
131 
137  virtual void GetObject( IScriptRequestData* data, IScript* parent ) ;
138 
146  virtual ErrorCode GetObjectByIndex( IScriptRequestData* data, IScript* parent ) ;
147  virtual ErrorCode GetObjectByName( IScriptRequestData* data, IScript* parent ) ;
148  virtual ErrorCode GetObjectByID( IScriptRequestData* data, IScript* parent ) ;
149  virtual ErrorCode GetObjectByRange( IScriptRequestData* data, IScript* parent ) ;
150  virtual ErrorCode GetObjectPrevious( IScriptRequestData* data, IScript* parent ) ;
151  virtual ErrorCode GetObjectNext( IScriptRequestData* data, IScript* parent ) ;
152  virtual ErrorCode GetObjectFirst( IScriptRequestData* data, IScript* parent ) ;
153  virtual ErrorCode GetObjectLast( IScriptRequestData* data, IScript* parent ) ;
154  virtual ErrorCode GetObjectMiddle( IScriptRequestData* data, IScript* parent ) ;
155  virtual ErrorCode GetObjectAny( IScriptRequestData* data, IScript* parent ) ;
156  virtual ErrorCode GetObjectAll( IScriptRequestData* data, IScript* parent ) ;
157  virtual ErrorCode GetObjectWhose( IScriptRequestData* data, IScript* parent ) ;
158 
167  virtual ErrorCode HandleMethod( ScriptID methodID, IScriptRequestData* data, IScript* script ) ;
168 
177  virtual ErrorCode AccessProperty( ScriptID propID, IScriptRequestData* data, IScript* script ) ;
178 
185  virtual int32 GetNumObjects( const IScriptRequestData* data, IScript* parent ) = 0 ;
186 
195  virtual ErrorCode AppendNthObject( const IScriptRequestData* data, IScript* parent, int32 n, ScriptList& objectList ) = 0 ; //0-based index
196 
206  virtual ErrorCode AppendAllObjects( const IScriptRequestData* data, IScript* parent, ScriptList& objectList ) ;
207 
220  virtual ErrorCode AppendObjectsWhose( const IScriptRequestData* data, IScript* parent, ScriptID propID, const ScriptData& propData, bool16 bFirstMatchOnly, ScriptList& objectList ) ;
221 
229  virtual int32 GetObjectIndex( const IScriptRequestData* data, IScript* parent, IScript* script ) ; //0-based index
230 
239  virtual ErrorCode CountObjects( ScriptID methodID, IScriptRequestData* data, IScript* parent ) ;
240 
249  virtual ErrorCode AccessObject( ScriptID propID, IScriptRequestData* data, IScript* script ) ;
250  virtual ErrorCode AccessID( ScriptID propID, IScriptRequestData* data, IScript* script ) ;
251  virtual ErrorCode AccessIndex( ScriptID propID, IScriptRequestData* data, IScript* script ) ;
252  virtual ErrorCode AccessLabel( ScriptID propID, IScriptRequestData* data, IScript* script ) ;
253  virtual ErrorCode AccessClass( ScriptID propID, IScriptRequestData* data, IScript* script ) ;
254  virtual ErrorCode AccessPropertiesProperty( ScriptID propID, IScriptRequestData* data, IScript* script ) ;
255 
264  virtual ErrorCode ExtractLabel( ScriptID methodID, IScriptRequestData* data, IScript* script ) ;
272  virtual ErrorCode InsertLabel( ScriptID methodID, IScriptRequestData* data, IScript* script ) ;
273 
281  ErrorCode GetIndex( const IScriptRequestData* data, IScript* parent, const ScriptData& accessorData, int32& index ) ;
282 };
283 
284 
285 #endif