InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IFramePrefsCmdData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Kevin Van Wiel
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 __IFramePrefsCmdData__
25 #define __IFramePrefsCmdData__
26 
27 #include "IPMUnknown.h"
28 #include "ICompositionStyle.h"
29 #include "IReferencePointData.h"
30 #include "UIDRef.h"
31 #include "PMReal.h"
32 #include "CTextEnum.h"
33 #include "TextID.h"
34 
35 class IDataBase;
36 
41 class IFramePrefsCmdData : public IPMUnknown
42 {
43 public:
44  enum { kDefaultIID = IID_IFRAMEPREFSCMDDATA };
45 
84  virtual void Set(
85  bool16 useFixedWidth,
86  bool16 useVerticalAlign,
87  bool16 ignoreTextWrap,
88  int32 numColumns,
89  PMReal gutter,
90  PMReal columnWidth,
91  PMReal leftInset,
92  PMReal topInset,
93  PMReal rightInset,
94  PMReal bottomInset,
95  Text::FirstLineOffsetMetric firstLineOffsetMetric,
96  PMReal minFirstLineOffset,
97  Text::VerticalJustification vj,
98  PMReal maxVJInterParaSpace,
99  bool16 vjBalanceColumns,
100  bool16 useFlexibleWidth,
101  PMReal maxColumnWidth,
102  Text::AutoSizeDimension asDimension,
103  IReferencePointData::ReferencePointPosition refPoint,
104  bool16 useMinHeight,
105  PMReal minHeightValue,
106  bool16 useMinWidth,
107  PMReal minWidthValue,
108  bool16 noLineBreak,
109  bool16 useVerticalRule,
110  PMReal verticalRuleOffset,
111  PMReal verticalRuleTopInset,
112  bool16 verticalRuleInsetChain,
113  PMReal verticalRuleBottomInset,
114  PMReal verticalRuleStrokeWidth,
115  UID verticalRuleStrokeColor,
116  ICompositionStyle::StrokeType verticalRuleStrokeType,
117  PMReal verticalRuleTint,
118  bool16 verticalRuleOverprint,
119  const UIDRef& doc /* which document to affect */
120  ) = 0;
121 
126  virtual bool16 GetUseFixedWidth() = 0;
127 
132  virtual bool16 GetUseVerticalAlignment() = 0;
133 
138  virtual bool16 GetIgnoreTextWrap() = 0;
139 
144  virtual int32 GetNumColumns() = 0;
145 
150  virtual PMReal GetGutter() = 0;
151 
156  virtual PMReal GetFixedColumnWidth() = 0;
157 
166  virtual const void GetInsets(PMReal& left, PMReal& top, PMReal& right, PMReal& bottom) = 0;
167 
172  virtual Text::FirstLineOffsetMetric GetFirstLineOffsetMetric() = 0;
173 
178  virtual PMReal GetMinFirstLineOffset() = 0;
179 
184  virtual const UIDRef& GetDocument() = 0;
185 
190  virtual Text::VerticalJustification GetVerticalJustification() const = 0;
191 
196  virtual PMReal GetMaxVJInterParaSpace() const = 0;
197 
202  virtual bool16 GetVJBalanceColumns() const = 0;
203 
208  virtual bool16 GetUseFlexibleWidth() = 0;
209 
214  virtual PMReal GetMinColumnWidth() = 0;
215 
220  virtual PMReal GetMaxColumnWidth() = 0;
221 
226  virtual Text::AutoSizeDimension GetAutoSizeDimension() = 0;
227 
232  virtual IReferencePointData::ReferencePointPosition GetAutoSizeRefPoint() = 0;
233 
238  virtual bool16 GetAutoSizeHasMinHeight() = 0;
239 
244  virtual PMReal GetAutoSizeMinHeightValue() = 0;
245 
250  virtual bool16 GetAutoSizeHasMinWidth() = 0;
251 
256  virtual PMReal GetAutoSizeMinWidthValue() = 0;
257 
262  virtual bool16 GetAutoSizeNoLineBreak() = 0;
263 
268  virtual bool16 GetUseVerticalRule() = 0;
269 
274  virtual PMReal GetVerticalRuleOffset() = 0;
275 
280  virtual PMReal GetVerticalRuleTopInset() = 0;
281 
286  virtual bool16 GetVerticalRuleInsetChain() = 0;
287 
292  virtual PMReal GetVerticalRuleBottomInset() = 0;
293 
298  virtual PMReal GetVerticalRuleStrokeWidth() = 0;
299 
304  virtual UID GetVerticalRuleStrokeColor() = 0;
305 
310  virtual ICompositionStyle::StrokeType GetVerticalRuleStrokeType() = 0;
311 
316  virtual PMReal GetVerticalRuleTint() = 0;
317 
322  virtual bool16 GetVerticalRuleOverprint() = 0;
323 };
324 
325 #endif // __IFramePrefsCmdData__