InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITextVariableTable.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner:
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 __ICalcTextVarTable__
25 #define __ICalcTextVarTable__
26 
27 #include "IPMUnknown.h"
28 #include "TextID.h"
29 
30 class ITextVariable;
31 class WideString;
32 class VariableTypeInfo;
33 class AddVariableInfo;
34 class ChangeVariableInfo;
35 
39 class ITextVariableTable : public IPMUnknown // ##rk: this can go to private..
40 {
41 public:
42  enum { kDefaultIID = IID_ITEXTVARIABLETABLE };
43  static const int32 kInvalidIndex = -1;
44 
47  virtual UID LookupVariableUID(const WideString& varName) = 0;
48 
52  virtual bool16 GetBaseTypeInfo(ClassID variableClassID, VariableTypeInfo* varInfo) const = 0;
53 
56  virtual int32 GetNumVariables() const = 0;
57 
61  virtual ITextVariable* QueryNthVariable(int32 n) const = 0;
62 
65  virtual ITextVariable* QueryVariable(const WideString& varName) const = 0;
66 
69  virtual bool16 AddVariable(const AddVariableInfo& newInfo) = 0;
70 
73  virtual bool16 AddVariable(UID newUID) = 0;
74 
77  virtual bool16 RemoveVariable(const WideString& varName) = 0;
78 
81  virtual bool16 ChangeVariable(const WideString& varName, const ChangeVariableInfo& chgInfo) = 0;
85  virtual bool16 GetNthVariableObsolete(int32 n, AddVariableInfo* varInfo) const = 0;
86 };
87 
88 #endif // __ICalcTextVarTable__