InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IFootnoteOptionsSuite.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 _IFootnoteOptionsSuite_
28 #define _IFootnoteOptionsSuite_
29 
30 #include "IPMUnknown.h"
31 #include "IFootnoteSettings.h"
32 #include "IFootnoteSettingsCmdData.h"
33 
38 class IFootnoteOptionsSuite : public IPMUnknown
39 {
40 public:
41  enum { kDefaultIID = IID_IFOOTNOTEOPTIONS_ISUITE };
42 
45  virtual bool16 CanApplyFootnoteOptions(void) const = 0;
46 
47 
50  virtual IFootnoteSettings::MarkerPositionOptions GetMarkerPositioning() const = 0;
53  virtual void SetMarkerPositioning(IFootnoteSettings::MarkerPositionOptions positioning) = 0;
54 
57  virtual IFootnoteSettings::RestartNumberingOptions GetRestartOption() const = 0;
60  virtual void SetRestartOption(IFootnoteSettings::RestartNumberingOptions option) = 0;
61 
64  virtual int32 GetStartingNumber() const = 0;
67  virtual void SetStartingNumber(int32 n) = 0;
68 
71  virtual ClassID GetNumberingMethod() const = 0;
74  virtual void SetNumberingMethod(ClassID whichMethod) = 0;
75 
78  virtual const WideString& GetMarkerPrefix() const = 0;
81  virtual void SetMarkerPrefix(const WideString& pre) = 0;
82 
85  virtual const WideString& GetMarkerSuffix() const = 0;
88  virtual void SetMarkerSuffix(const WideString& suf) = 0;
89 
92  virtual IFootnoteSettings::SuffixPrefixUsageOptions GetPrefixSuffixUsage() const = 0;
95  virtual void SetPrefixSuffixUsage(IFootnoteSettings::SuffixPrefixUsageOptions options) = 0;
96 
99  virtual UID GetFootnoteMarkerStyle() const = 0;
102  virtual void SetFootnoteMarkerStyle(UID s) = 0;
103 
106  virtual UID GetFootnoteParagraphStyle() const = 0;
109  virtual void SetFootnoteParagraphStyle(UID s) = 0;
110 
113  virtual const WideString& GetFootnoteSeparator() const = 0;
116  virtual void SetFootnoteSeparator(const WideString& sep) = 0;
117 
120  virtual PMReal GetSpaceBetween() const = 0;
123  virtual void SetSpaceBetween(PMReal g) = 0;
124 
127  virtual PMReal GetSpacerHeight() const = 0;
130  virtual void SetSpacerHeight(PMReal g) = 0;
131 
134  virtual Text::FirstLineOffsetMetric GetFirstLineOffset() const = 0;
137  virtual void SetFirstLineOffset(Text::FirstLineOffsetMetric flo) = 0;
138 
141  virtual PMReal GetMinFirstLineOffset() const = 0;
144  virtual void SetMinFirstLineOffset(PMReal g) = 0;
145 
148  virtual bool16 GetEndOfStoryPlacement() const = 0;
151  virtual void SetEndOfStoryPlacement(bool16 b) = 0;
152 
155  virtual bool16 GetNoSplitting() const = 0;
158  virtual void SetNoSplitting(bool16 b) = 0;
159 
162  virtual bool16 GetStraddlingInfo() const = 0;
165  virtual void SetStraddlingInfo(bool16 b) = 0;
166 
169  virtual bool16 GetSeparatorLineOn(IFootnoteSettings::FootnoteRuleKind k) const = 0;
172  virtual void SetSeparatorLineOn(IFootnoteSettings::FootnoteRuleKind k, bool16 b) = 0;
173 
176  virtual PMReal GetWeightStroke(IFootnoteSettings::FootnoteRuleKind k) const = 0;
179  virtual void SetWeightStroke(IFootnoteSettings::FootnoteRuleKind k, PMReal g) = 0;
180 
183  virtual ICompositionStyle::StrokeType GetStrokeType(IFootnoteSettings::FootnoteRuleKind k) const = 0;
186  virtual void SetStrokeType(IFootnoteSettings::FootnoteRuleKind k, ICompositionStyle::StrokeType s) = 0;
187 
190  virtual PMReal GetIndentLeft(IFootnoteSettings::FootnoteRuleKind k) const = 0;
193  virtual void SetIndentLeft(IFootnoteSettings::FootnoteRuleKind k, PMReal g) = 0;
194 
197  virtual PMReal GetWidth(IFootnoteSettings::FootnoteRuleKind k) const = 0;
200  virtual void SetWidth(IFootnoteSettings::FootnoteRuleKind k, PMReal g) = 0;
201 
204  virtual PMReal GetOffset(IFootnoteSettings::FootnoteRuleKind k) const = 0;
207  virtual void SetOffset(IFootnoteSettings::FootnoteRuleKind k, PMReal g) = 0;
208 
211  virtual UID GetColorStroke(IFootnoteSettings::FootnoteRuleKind k) const = 0;
214  virtual void SetColorStroke(IFootnoteSettings::FootnoteRuleKind k, UID s) = 0;
215 
218  virtual PMReal GetTintStroke(IFootnoteSettings::FootnoteRuleKind k) const = 0;
221  virtual void SetTintStroke(IFootnoteSettings::FootnoteRuleKind k, PMReal g) = 0;
222 
225  virtual bool16 GetOverprintStroke(IFootnoteSettings::FootnoteRuleKind k) const = 0;
228  virtual void SetOverprintStroke(IFootnoteSettings::FootnoteRuleKind k, bool16 b) = 0;
229 
232  virtual UID GetColorGap(IFootnoteSettings::FootnoteRuleKind k) const = 0;
235  virtual void SetColorGap(IFootnoteSettings::FootnoteRuleKind k, UID s) = 0;
236 
239  virtual PMReal GetTintGap(IFootnoteSettings::FootnoteRuleKind k) const = 0;
242  virtual void SetTintGap(IFootnoteSettings::FootnoteRuleKind k, PMReal g) = 0;
243 
246  virtual bool16 GetOverprintGap(IFootnoteSettings::FootnoteRuleKind k) const = 0;
249  virtual void SetOverprintGap(IFootnoteSettings::FootnoteRuleKind k, bool16 b) = 0;
250 
253  virtual void SetAllSettings(const IFootnoteSettingsCmdData::FootnotePrefs* settings,
254  const IFootnoteSettingsCmdData::FootnoteLinePrefs* separator,
255  const IFootnoteSettingsCmdData::FootnoteLinePrefs* continuing) = 0;
256 };
257 
258 #endif // _IFootnoteOptionsSuite_