InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITextFrameOptionsSuite.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: rkamicar
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 // Note:
24 //
25 //========================================================================================
26 
27 #ifndef _ITextFrameOptionsSuite_
28 #define _ITextFrameOptionsSuite_
29 
30 #include "IPMUnknown.h"
31 
32 class IBaselineFrameGridData;
33 class ITextFrameOptionsData;
34 
37 class ITextFrameOptionsSuite : public IPMUnknown
38 {
39 //____________________________________________________________________________________________
40 // Data Types
41 //____________________________________________________________________________________________
42 public:
43  enum { kDefaultIID = IID_ITEXTFRAMEOPTIONS_ISUITE };
44 //____________________________________________________________________________________________
45 // Member functions
46 //____________________________________________________________________________________________
47 public:
48 
55  virtual void FreezeSelectionForModalDialog() = 0;
56 
61  virtual void ThawSelectionForModalDialog() = 0;
62 
66  virtual bool16 CanApplyTextFrameOptions (void) const = 0;
67 
73  virtual void GetColumnsAndGutter(K2Vector<int32> & numberOfColumnsVector, K2Vector<PMReal> & gutterWidthVector, bool16 sortedAndUnique ) const = 0;
74 
78  virtual bool16 GetTextFrameOptionsData(ITextFrameOptionsData* tfoData) const = 0;
79 
82  virtual void SetTextFrameOptionsData(ITextFrameOptionsData* tfoData) = 0;
83 
86  virtual void SetTFOWidthOptions(ITextFrameOptionsData* tfoData) const = 0;
87  virtual void SetTFOInsetOptions(ITextFrameOptionsData* tfoData) const = 0;
88  virtual void SetTFOColumns(ITextFrameOptionsData* tfoData) const = 0;
89  virtual void SetTFOGutterWidth(ITextFrameOptionsData* tfoData) const = 0;
90  virtual void SetTFOIgnoreWrap(ITextFrameOptionsData* tfoData) const = 0;
91  virtual void SetTFOFirstLineOffsetMetric(ITextFrameOptionsData* tfoData) const = 0;
92  virtual void SetTFOMinFirstLineOffset(ITextFrameOptionsData* tfoData) const = 0;
93  virtual void SetTFOVerticalJustify(ITextFrameOptionsData* tfoData) const = 0;
94  virtual void SetTFOMaxVJInterParaSpace(ITextFrameOptionsData* tfoData) const = 0;
95  virtual void SetTFOVJBalanceColumns(ITextFrameOptionsData* tfoData) const = 0;
96 
100  virtual void GetBaselineFrameGridData(ITextFrameOptionsData* tfoData, bool16 convertColorUIDToLayerColor = kTrue) const = 0;
101 
104  virtual void SetBaselineFrameGridData(ITextFrameOptionsData* tfoData) = 0;
105 
108  virtual void SetUseCustomBaselineGridFlag(ITextFrameOptionsData* tfoData) const = 0;
109  virtual void SetStartingOffset(ITextFrameOptionsData* tfoData) const = 0;
110  virtual void SetRelativeOption(ITextFrameOptionsData* tfoData) const = 0;
111  virtual void SetIncrement(ITextFrameOptionsData* tfoData) const = 0;
112  virtual void SetBaselineFrameGridColor(ITextFrameOptionsData* tfoData) const = 0;
113 
116  virtual void SetAutoSizeDimension(ITextFrameOptionsData* tfoData) const =0;
117  virtual void SetAutoSizeRefPoint(ITextFrameOptionsData* tfoData) const =0;
118  virtual void SetAutoSizeHasMinHeight(ITextFrameOptionsData* tfoData) const =0;
119  virtual void SetAutoSizeMinHeightValue(ITextFrameOptionsData* tfoData) const =0;
120  virtual void SetAutoSizeHasMinWidth(ITextFrameOptionsData* tfoData) const =0;
121  virtual void SetAutoSizeMinWidthValue(ITextFrameOptionsData* tfoData) const =0;
122  virtual void SetAutoSizeNoLineBreak(ITextFrameOptionsData* tfoData) const =0;
123 
126  virtual void GetTextFrameFootnoteOptions(ITextFrameOptionsData* tfoData) const = 0;
127 
130  virtual void SetTextFrameFootnoteOptions(ITextFrameOptionsData* tfoData) = 0;
131 
134  virtual void SetFootnoteOptionsHasEnableOverrides(ITextFrameOptionsData* tfoData) const = 0;
135  virtual void SetFootnoteOptionsHasSpanFootnotesAcross(ITextFrameOptionsData* tfoData) const = 0;
136  virtual void SetFootnoteOptionsMinimumSpacingValue(ITextFrameOptionsData* tfoData) const = 0;
137  virtual void SetFootnoteOptionsSpaceBetweenFootnotesValue(ITextFrameOptionsData* tfoData) const = 0;
138 
141  virtual void GetTextFrameVerticalRuleOptions(ITextFrameOptionsData* tfoData) const = 0;
142 
145  virtual void SetTextFrameVerticalRuleOptions(ITextFrameOptionsData* tfoData) const = 0;
146 
149  virtual void SetUseVerticalRule(ITextFrameOptionsData* tfoData) const = 0;
150  virtual void SetVerticalRuleOffset(ITextFrameOptionsData* tfoData) const = 0;
151  virtual void SetVerticalRuleTopInset(ITextFrameOptionsData* tfoData)const = 0;
152  virtual void SetVerticalRuleInsetChain(ITextFrameOptionsData* tfoData) const = 0;
153  virtual void SetVerticalRuleBottomInset(ITextFrameOptionsData* tfoData) const = 0;
154  virtual void SetVerticalRuleStrokeWidth(ITextFrameOptionsData* tfoData)const = 0;
155  virtual void SetVerticalRuleStrokeColor(ITextFrameOptionsData* tfoData) const = 0;
156  virtual void SetVerticalRuleStrokeType(ITextFrameOptionsData* tfoData) const = 0;
157  virtual void SetVerticalRuleTint(ITextFrameOptionsData* tfoData) const = 0;
158  virtual void SetVerticalRuleOverprint(ITextFrameOptionsData* tfoData) const = 0;
159 };
160 
161 #endif // _ITextFrameOptionsSuite_