InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IFormFieldSuite.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Tim Wright
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 // Comments: Selection suite for Form items
24 //
25 //========================================================================================
26 
27 #ifndef _IFormFieldSuite_
28 #define _IFormFieldSuite_
29 
30 #include "FormFieldID.h"
31 #include "FormFieldTypes.h"
32 
33 //================================================================================================
34 class IGraphicStyleAttributeBossList;
35 class ITextAttributes;
36 class AttributeBossList;
37 class IFormFieldFactory;
38 
44 class IFormFieldSuite : public IPMUnknown
45 {
46 public:
47  enum { kDefaultIID = IID_IFORMFIELDSUITE };
48 
50  virtual bool16 IsFieldSelection() const = 0;
51 
54  virtual bool16 IsFieldSelectionOfType(ClassID inFormFieldType) const = 0;
55 
57  virtual bool16 IsMixedSelection() const = 0;
58 
60  virtual bool16 IsDefaultSelection() const = 0;
61 
66  virtual IFormFieldFactory* QueryFormFieldFactory() const = 0;
67 
69  virtual bool16 CanEditFieldSelection() const = 0;
70 
73  virtual bool16 CanCreateFieldFromSelection(ClassID inFormFieldType) const = 0;
74 
77  virtual ErrorCode CreateFieldFromSelection(ClassID inFormFieldType) = 0;
78 
81  virtual bool16 CanDestroyFieldFromSelection(bool16 &outWarnNonEmptyStates) const = 0;
82 
87  virtual ErrorCode DestroyFieldFromSelection(ClassID formFieldToConvert = kInvalidClass) = 0;
88 
90  virtual bool16 SelectionHasAnyFormFields() const = 0;
91 
93  virtual bool16 SelectionHasAnyFieldsOfType(ClassID inFieldType) const = 0;
94 
97  virtual bool16 GetIsInitiallyHidden(bool16 &isMixed) const = 0;
98 
101  virtual bool16 GetIsPrintable(bool16 &isMixed) const = 0;
102 
105  virtual bool16 GetIsReadOnly(bool16 &isMixed) const = 0;
106 
109  virtual bool16 GetIsRequired(bool16 &isMixed) const = 0;
110 
113  virtual bool16 GetIsSelectedByDefault(bool16 &isMixed) const = 0;
114 
117  virtual bool16 GetIsMultiLineTextField(bool16 &isMixed) const = 0;
118 
121  virtual bool16 GetIsPasswordTextField(bool16 &isMixed) const = 0;
122 
125  virtual bool16 GetIsScrollableTextField(bool16 &isMixed) const = 0;
126 
129  virtual ErrorCode GetFormFieldDescription(PMString &description) const = 0;
130 
133  virtual ErrorCode SetIsInitiallyHidden(bool16 inHidden) const = 0;
134 
137  virtual ErrorCode SetIsPrintable(bool16 isPrintable) const = 0;
138 
141  virtual ErrorCode SetIsReadOnly(bool16 isReadOnly) const = 0;
142 
145  virtual ErrorCode SetIsRequired(bool16 isRequired) const = 0;
146 
149  virtual ErrorCode SetIsSelectedByDefault(bool16 isSelectedByDefault) const = 0;
150 
153  virtual ErrorCode SetIsTextFieldMultiline(bool16 isMultiLine) const = 0;
154 
157  virtual ErrorCode SetIsTextFieldPasswordField(bool16 isPasswordField) const = 0;
158 
161  virtual ErrorCode SetIsTextFieldScrollable(bool16 isScrollable) const = 0;
162 
165  virtual ErrorCode SetFormFieldDescription(const PMString &description) const = 0;
166 
170  virtual ErrorCode GetChoiceList(Form::ChoiceList &choices) const = 0;
171 
174  virtual ErrorCode AddChoice(const PMString &choice) const = 0;
175 
179  virtual ErrorCode RemoveChoice(const PMString &choice) const = 0;
180 
183  virtual ErrorCode SetIsMultipleSelectionEnabled(bool16 isMultipleSelectionEnabled) const = 0;
184 
187  virtual bool16 GetIsMultipleSelectionEnabled(bool16 &isMixed) const = 0;
188 
190  virtual ErrorCode MoveChoice(const PMString &choice, int32 pos) const = 0;
191 
193  virtual ErrorCode SetTextSizeAttribute(const PMReal &FontSize) const = 0;
194 
197  virtual bool16 GetTextSizeAttribute(PMReal &FontSize) const = 0;
198 
201  virtual bool16 GetShouldSortListItems(bool16 &isMixed) const = 0;
202 
205  virtual ErrorCode SetShouldSortListItems(bool16 isSorted) const = 0;
206 
209  virtual bool16 GetIsMERTLEnabled(bool16 &isMixed) const = 0;
210 
213  virtual ErrorCode SetIsMERTLEnabled(bool16 isMERTLEnabled) const = 0;
214 
220  virtual bool16 GetDefaultChoice(PMString &choice, int32 &index) const = 0;
221 
225  virtual ErrorCode SetDefaultChoice(const PMString &choice) const = 0;
226 
229  virtual ErrorCode GetExportValue(PMString &exportValue) const = 0;
230 
233  virtual ErrorCode SetExportValue(const PMString &exportValue) const = 0;
234 
235  virtual ErrorCode SetFontFamilyAttr(const PMString& fontFamilyName) const = 0;
236  virtual bool16 GetFontFamilyAttribute(PMString& fontFamilyName) const = 0;
237  virtual ErrorCode SetFontFamilyUIDAttr(const PMString& fontFamilyName, const PMString& fontStyleName) const = 0;
238  virtual bool16 GetFontFamilyUIDAttr(UID& FontUID) const = 0;
239  virtual ErrorCode SetFontStyleAttribute(const PMString& fontStyleName) const = 0;
240  virtual bool16 GetFontStyleAttribute(PMString& fontStyleName) const = 0;
241 
242 #ifdef DEBUG
243  virtual ErrorCode TraceSelectionGeometry() = 0;
244 #endif
245 };
246 
247 
248 #endif // _IFormFieldSuite_