InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IFootnoteOptionsSuite Class Referenceabstract

#include <IFootnoteOptionsSuite.h>

Inheritance diagram for IFootnoteOptionsSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IFOOTNOTEOPTIONS_ISUITE }
 

Public Member Functions

virtual bool16 CanApplyFootnoteOptions (void) const =0
 
virtual
IFootnoteSettings::MarkerPositionOptions 
GetMarkerPositioning () const =0
 
virtual void SetMarkerPositioning (IFootnoteSettings::MarkerPositionOptions positioning)=0
 
virtual
IFootnoteSettings::RestartNumberingOptions 
GetRestartOption () const =0
 
virtual void SetRestartOption (IFootnoteSettings::RestartNumberingOptions option)=0
 
virtual int32 GetStartingNumber () const =0
 
virtual void SetStartingNumber (int32 n)=0
 
virtual ClassID GetNumberingMethod () const =0
 
virtual void SetNumberingMethod (ClassID whichMethod)=0
 
virtual const WideStringGetMarkerPrefix () const =0
 
virtual void SetMarkerPrefix (const WideString &pre)=0
 
virtual const WideStringGetMarkerSuffix () const =0
 
virtual void SetMarkerSuffix (const WideString &suf)=0
 
virtual
IFootnoteSettings::SuffixPrefixUsageOptions 
GetPrefixSuffixUsage () const =0
 
virtual void SetPrefixSuffixUsage (IFootnoteSettings::SuffixPrefixUsageOptions options)=0
 
virtual UID GetFootnoteMarkerStyle () const =0
 
virtual void SetFootnoteMarkerStyle (UID s)=0
 
virtual UID GetFootnoteParagraphStyle () const =0
 
virtual void SetFootnoteParagraphStyle (UID s)=0
 
virtual const WideStringGetFootnoteSeparator () const =0
 
virtual void SetFootnoteSeparator (const WideString &sep)=0
 
virtual PMReal GetSpaceBetween () const =0
 
virtual void SetSpaceBetween (PMReal g)=0
 
virtual PMReal GetSpacerHeight () const =0
 
virtual void SetSpacerHeight (PMReal g)=0
 
virtual Text::FirstLineOffsetMetric GetFirstLineOffset () const =0
 
virtual void SetFirstLineOffset (Text::FirstLineOffsetMetric flo)=0
 
virtual PMReal GetMinFirstLineOffset () const =0
 
virtual void SetMinFirstLineOffset (PMReal g)=0
 
virtual bool16 GetEndOfStoryPlacement () const =0
 
virtual void SetEndOfStoryPlacement (bool16 b)=0
 
virtual bool16 GetNoSplitting () const =0
 
virtual void SetNoSplitting (bool16 b)=0
 
virtual bool16 GetStraddlingInfo () const =0
 
virtual void SetStraddlingInfo (bool16 b)=0
 
virtual bool16 GetSeparatorLineOn (IFootnoteSettings::FootnoteRuleKind k) const =0
 
virtual void SetSeparatorLineOn (IFootnoteSettings::FootnoteRuleKind k, bool16 b)=0
 
virtual PMReal GetWeightStroke (IFootnoteSettings::FootnoteRuleKind k) const =0
 
virtual void SetWeightStroke (IFootnoteSettings::FootnoteRuleKind k, PMReal g)=0
 
virtual
ICompositionStyle::StrokeType 
GetStrokeType (IFootnoteSettings::FootnoteRuleKind k) const =0
 
virtual void SetStrokeType (IFootnoteSettings::FootnoteRuleKind k, ICompositionStyle::StrokeType s)=0
 
virtual PMReal GetIndentLeft (IFootnoteSettings::FootnoteRuleKind k) const =0
 
virtual void SetIndentLeft (IFootnoteSettings::FootnoteRuleKind k, PMReal g)=0
 
virtual PMReal GetWidth (IFootnoteSettings::FootnoteRuleKind k) const =0
 
virtual void SetWidth (IFootnoteSettings::FootnoteRuleKind k, PMReal g)=0
 
virtual PMReal GetOffset (IFootnoteSettings::FootnoteRuleKind k) const =0
 
virtual void SetOffset (IFootnoteSettings::FootnoteRuleKind k, PMReal g)=0
 
virtual UID GetColorStroke (IFootnoteSettings::FootnoteRuleKind k) const =0
 
virtual void SetColorStroke (IFootnoteSettings::FootnoteRuleKind k, UID s)=0
 
virtual PMReal GetTintStroke (IFootnoteSettings::FootnoteRuleKind k) const =0
 
virtual void SetTintStroke (IFootnoteSettings::FootnoteRuleKind k, PMReal g)=0
 
virtual bool16 GetOverprintStroke (IFootnoteSettings::FootnoteRuleKind k) const =0
 
virtual void SetOverprintStroke (IFootnoteSettings::FootnoteRuleKind k, bool16 b)=0
 
virtual UID GetColorGap (IFootnoteSettings::FootnoteRuleKind k) const =0
 
virtual void SetColorGap (IFootnoteSettings::FootnoteRuleKind k, UID s)=0
 
virtual PMReal GetTintGap (IFootnoteSettings::FootnoteRuleKind k) const =0
 
virtual void SetTintGap (IFootnoteSettings::FootnoteRuleKind k, PMReal g)=0
 
virtual bool16 GetOverprintGap (IFootnoteSettings::FootnoteRuleKind k) const =0
 
virtual void SetOverprintGap (IFootnoteSettings::FootnoteRuleKind k, bool16 b)=0
 
virtual void SetAllSettings (const IFootnoteSettingsCmdData::FootnotePrefs *settings, const IFootnoteSettingsCmdData::FootnoteLinePrefs *separator, const IFootnoteSettingsCmdData::FootnoteLinePrefs *continuing)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

IFootnoteOptionsSuite

Note
See IFootnoteSettings for descriptions of most of these methods as this is a mirror interface to that.

Member Function Documentation

virtual bool16 IFootnoteOptionsSuite::CanApplyFootnoteOptions (void ) const
pure virtual

Can the options be set? (i.e. does the current selection make sense for footnote options)

virtual UID IFootnoteOptionsSuite::GetColorGap (IFootnoteSettings::FootnoteRuleKind k) const
pure virtual
virtual UID IFootnoteOptionsSuite::GetColorStroke (IFootnoteSettings::FootnoteRuleKind k) const
pure virtual
virtual bool16 IFootnoteOptionsSuite::GetEndOfStoryPlacement () const
pure virtual
virtual Text::FirstLineOffsetMetric IFootnoteOptionsSuite::GetFirstLineOffset () const
pure virtual
virtual UID IFootnoteOptionsSuite::GetFootnoteMarkerStyle () const
pure virtual
virtual UID IFootnoteOptionsSuite::GetFootnoteParagraphStyle () const
pure virtual
virtual const WideString& IFootnoteOptionsSuite::GetFootnoteSeparator () const
pure virtual
virtual PMReal IFootnoteOptionsSuite::GetIndentLeft (IFootnoteSettings::FootnoteRuleKind k) const
pure virtual
virtual IFootnoteSettings::MarkerPositionOptions IFootnoteOptionsSuite::GetMarkerPositioning () const
pure virtual
virtual const WideString& IFootnoteOptionsSuite::GetMarkerPrefix () const
pure virtual
virtual const WideString& IFootnoteOptionsSuite::GetMarkerSuffix () const
pure virtual
virtual PMReal IFootnoteOptionsSuite::GetMinFirstLineOffset () const
pure virtual
virtual bool16 IFootnoteOptionsSuite::GetNoSplitting () const
pure virtual
virtual ClassID IFootnoteOptionsSuite::GetNumberingMethod () const
pure virtual
virtual PMReal IFootnoteOptionsSuite::GetOffset (IFootnoteSettings::FootnoteRuleKind k) const
pure virtual
virtual bool16 IFootnoteOptionsSuite::GetOverprintGap (IFootnoteSettings::FootnoteRuleKind k) const
pure virtual
virtual bool16 IFootnoteOptionsSuite::GetOverprintStroke (IFootnoteSettings::FootnoteRuleKind k) const
pure virtual
virtual IFootnoteSettings::SuffixPrefixUsageOptions IFootnoteOptionsSuite::GetPrefixSuffixUsage () const
pure virtual
virtual IFootnoteSettings::RestartNumberingOptions IFootnoteOptionsSuite::GetRestartOption () const
pure virtual
virtual bool16 IFootnoteOptionsSuite::GetSeparatorLineOn (IFootnoteSettings::FootnoteRuleKind k) const
pure virtual
virtual PMReal IFootnoteOptionsSuite::GetSpaceBetween () const
pure virtual
virtual PMReal IFootnoteOptionsSuite::GetSpacerHeight () const
pure virtual
virtual int32 IFootnoteOptionsSuite::GetStartingNumber () const
pure virtual
virtual bool16 IFootnoteOptionsSuite::GetStraddlingInfo () const
pure virtual
virtual ICompositionStyle::StrokeType IFootnoteOptionsSuite::GetStrokeType (IFootnoteSettings::FootnoteRuleKind k) const
pure virtual
virtual PMReal IFootnoteOptionsSuite::GetTintGap (IFootnoteSettings::FootnoteRuleKind k) const
pure virtual
virtual PMReal IFootnoteOptionsSuite::GetTintStroke (IFootnoteSettings::FootnoteRuleKind k) const
pure virtual
virtual PMReal IFootnoteOptionsSuite::GetWeightStroke (IFootnoteSettings::FootnoteRuleKind k) const
pure virtual
virtual PMReal IFootnoteOptionsSuite::GetWidth (IFootnoteSettings::FootnoteRuleKind k) const
pure virtual
virtual void IFootnoteOptionsSuite::SetAllSettings (const IFootnoteSettingsCmdData::FootnotePrefssettings,
const IFootnoteSettingsCmdData::FootnoteLinePrefsseparator,
const IFootnoteSettingsCmdData::FootnoteLinePrefscontinuing 
)
pure virtual
virtual void IFootnoteOptionsSuite::SetColorGap (IFootnoteSettings::FootnoteRuleKind k,
UID s 
)
pure virtual
virtual void IFootnoteOptionsSuite::SetColorStroke (IFootnoteSettings::FootnoteRuleKind k,
UID s 
)
pure virtual
virtual void IFootnoteOptionsSuite::SetEndOfStoryPlacement (bool16 b)
pure virtual
virtual void IFootnoteOptionsSuite::SetFirstLineOffset (Text::FirstLineOffsetMetric flo)
pure virtual
virtual void IFootnoteOptionsSuite::SetFootnoteMarkerStyle (UID s)
pure virtual
virtual void IFootnoteOptionsSuite::SetFootnoteParagraphStyle (UID s)
pure virtual
virtual void IFootnoteOptionsSuite::SetFootnoteSeparator (const WideStringsep)
pure virtual
virtual void IFootnoteOptionsSuite::SetIndentLeft (IFootnoteSettings::FootnoteRuleKind k,
PMReal g 
)
pure virtual
virtual void IFootnoteOptionsSuite::SetMarkerPositioning (IFootnoteSettings::MarkerPositionOptions positioning)
pure virtual
virtual void IFootnoteOptionsSuite::SetMarkerPrefix (const WideStringpre)
pure virtual
virtual void IFootnoteOptionsSuite::SetMarkerSuffix (const WideStringsuf)
pure virtual
virtual void IFootnoteOptionsSuite::SetMinFirstLineOffset (PMReal g)
pure virtual
virtual void IFootnoteOptionsSuite::SetNoSplitting (bool16 b)
pure virtual
virtual void IFootnoteOptionsSuite::SetNumberingMethod (ClassID whichMethod)
pure virtual
virtual void IFootnoteOptionsSuite::SetOffset (IFootnoteSettings::FootnoteRuleKind k,
PMReal g 
)
pure virtual
virtual void IFootnoteOptionsSuite::SetOverprintGap (IFootnoteSettings::FootnoteRuleKind k,
bool16 b 
)
pure virtual
virtual void IFootnoteOptionsSuite::SetOverprintStroke (IFootnoteSettings::FootnoteRuleKind k,
bool16 b 
)
pure virtual
virtual void IFootnoteOptionsSuite::SetPrefixSuffixUsage (IFootnoteSettings::SuffixPrefixUsageOptions options)
pure virtual
virtual void IFootnoteOptionsSuite::SetRestartOption (IFootnoteSettings::RestartNumberingOptions option)
pure virtual
virtual void IFootnoteOptionsSuite::SetSeparatorLineOn (IFootnoteSettings::FootnoteRuleKind k,
bool16 b 
)
pure virtual
virtual void IFootnoteOptionsSuite::SetSpaceBetween (PMReal g)
pure virtual
virtual void IFootnoteOptionsSuite::SetSpacerHeight (PMReal g)
pure virtual
virtual void IFootnoteOptionsSuite::SetStartingNumber (int32 n)
pure virtual
virtual void IFootnoteOptionsSuite::SetStraddlingInfo (bool16 b)
pure virtual
virtual void IFootnoteOptionsSuite::SetStrokeType (IFootnoteSettings::FootnoteRuleKind k,
ICompositionStyle::StrokeType s 
)
pure virtual
virtual void IFootnoteOptionsSuite::SetTintGap (IFootnoteSettings::FootnoteRuleKind k,
PMReal g 
)
pure virtual
virtual void IFootnoteOptionsSuite::SetTintStroke (IFootnoteSettings::FootnoteRuleKind k,
PMReal g 
)
pure virtual
virtual void IFootnoteOptionsSuite::SetWeightStroke (IFootnoteSettings::FootnoteRuleKind k,
PMReal g 
)
pure virtual
virtual void IFootnoteOptionsSuite::SetWidth (IFootnoteSettings::FootnoteRuleKind k,
PMReal g 
)
pure virtual