#include <IFootnoteSettings.h>

Inheritance diagram for IFootnoteSettings:

Public Types
enum	{ kDefaultIID = IID_IFOOTNOTESETTINGS }

enum	RestartNumberingOptions { kDontRestart, kPageRestart, kSpreadRestart, kSectionRestart, kUnknown }

enum	FootnoteRuleKind { kNew, kContinuing }

enum	SuffixPrefixUsageOptions { kPrefixSuffixNone, kPrefixSuffixReference, kPrefixSuffixMarker, kPrefixSuffixBoth }

enum	MarkerPositionOptions { kPositionNormal, kPositionSuperscript, kPositionSubscript, kPositionRuby }

Public Member Functions
virtual RestartNumberingOptions	GetRestartOption () const =0

virtual void	SetRestartOption (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 WideString &	GetMarkerPrefix () const =0

virtual void	SetMarkerPrefix (const WideString &pre)=0

virtual const WideString &	GetMarkerSuffix () const =0

virtual void	SetMarkerSuffix (const WideString &suf)=0

virtual SuffixPrefixUsageOptions	GetPrefixSuffixUsage () const =0

virtual void	SetPrefixSuffixUsage (SuffixPrefixUsageOptions options)=0

virtual UID	GetFootnoteMarkerStyle () const =0

virtual void	SetFootnoteMarkerStyle (UID s)=0

virtual MarkerPositionOptions	GetMarkerPositioning () const =0

virtual void	SetMarkerPositioning (MarkerPositionOptions positioning)=0

virtual UID	GetFootnoteParagraphStyle () const =0

virtual void	SetFootnoteParagraphStyle (UID s)=0

virtual const WideString &	GetFootnoteSeparator () 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 (FootnoteRuleKind k) const =0

virtual void	SetSeparatorLineOn (FootnoteRuleKind k, bool16 b)=0

virtual PMReal	GetWeightStroke (FootnoteRuleKind k) const =0

virtual void	SetWeightStroke (FootnoteRuleKind k, PMReal g)=0

virtual ICompositionStyle::StrokeType	GetStrokeType (FootnoteRuleKind k) const =0

virtual void	SetStrokeType (FootnoteRuleKind k, ICompositionStyle::StrokeType s)=0

virtual PMReal	GetIndentLeft (FootnoteRuleKind k) const =0

virtual void	SetIndentLeft (FootnoteRuleKind k, PMReal g)=0

virtual PMReal	GetWidth (FootnoteRuleKind k) const =0

virtual void	SetWidth (FootnoteRuleKind k, PMReal g)=0

virtual PMReal	GetOffset (FootnoteRuleKind k) const =0

virtual void	SetOffset (FootnoteRuleKind k, PMReal g)=0

virtual UID	GetColorStroke (FootnoteRuleKind k) const =0

virtual void	SetColorStroke (FootnoteRuleKind k, UID s)=0

virtual PMReal	GetTintStroke (FootnoteRuleKind k) const =0

virtual void	SetTintStroke (FootnoteRuleKind k, PMReal g)=0

virtual bool16	GetOverprintStroke (FootnoteRuleKind k) const =0

virtual void	SetOverprintStroke (FootnoteRuleKind k, bool16 b)=0

virtual UID	GetColorGap (FootnoteRuleKind k) const =0

virtual void	SetColorGap (FootnoteRuleKind k, UID s)=0

virtual PMReal	GetTintGap (FootnoteRuleKind k) const =0

virtual void	SetTintGap (FootnoteRuleKind k, PMReal g)=0

virtual bool16	GetOverprintGap (FootnoteRuleKind k) const =0

virtual void	SetOverprintGap (FootnoteRuleKind k, bool16 b)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

This interface is used to set or retrieve the settings associated with footnotes.

Member Enumeration Documentation

enum IFootnoteSettings::FootnoteRuleKind

There are two types of footnote rules. One is applied when a new footnote is the first footnote to appear in the column. The second is when a footnote continues from the previous column. This enum is used to designate which one the caller is interested in.

enum IFootnoteSettings::MarkerPositionOptions

The different ways to apply positioning to the footnote marker.

Note: : kPositionRuby is available in the Japanese Feature Set only.

enum IFootnoteSettings::RestartNumberingOptions

The different ways to restart numbering of footnotes.

enum IFootnoteSettings::SuffixPrefixUsageOptions

The different ways to apply prefixes and suffixes to the numbering of footnotes.

Note: : kPrefixSuffixReference refers to the footnote number as it appears in the main text flow; : kPrefixSuffixMarker refers to the footnote number as it appears in the footnote text itself

Member Function Documentation

virtual UID IFootnoteSettings::GetColorGap ( FootnoteRuleKind k ) const

pure virtual

Return the color of the line gap, if any, that separates the footnotes from the main text.

virtual UID IFootnoteSettings::GetColorStroke ( FootnoteRuleKind k ) const

pure virtual

Return the color of the desired line that separates the footnotes from the main text.

virtual bool16 IFootnoteSettings::GetEndOfStoryPlacement ( ) const

pure virtual

Return whether the footnote at the end of the story will be placed at the bottom of the column (kFalse) or just below the text (kTrue).

virtual Text::FirstLineOffsetMetric IFootnoteSettings::GetFirstLineOffset ( ) const

pure virtual

Return the baseline offset of the first line in the footnote

virtual UID IFootnoteSettings::GetFootnoteMarkerStyle ( ) const

pure virtual

Return the character style applied to the footnote symbol in the text

Note: : can return kInvalidUID - see GetFootnoteMarkerStyle

virtual UID IFootnoteSettings::GetFootnoteParagraphStyle ( ) const

pure virtual

Return the paragraph style applied to the footnotes themselves

virtual const WideString& IFootnoteSettings::GetFootnoteSeparator ( ) const

pure virtual

Return what text is automatically added between the footnote symbol and the footnote in the footnote.

virtual PMReal IFootnoteSettings::GetIndentLeft ( FootnoteRuleKind k ) const

pure virtual

Return the left indent of the desired line that separates the footnotes from the main text.

virtual MarkerPositionOptions IFootnoteSettings::GetMarkerPositioning ( ) const

pure virtual

Return the current positioning style for the footnote marker.

virtual const WideString& IFootnoteSettings::GetMarkerPrefix ( ) const

pure virtual

Return the string to appear before the footnote number

virtual const WideString& IFootnoteSettings::GetMarkerSuffix ( ) const

pure virtual

Return the string to appear after the footnote number

virtual PMReal IFootnoteSettings::GetMinFirstLineOffset ( ) const

pure virtual

Return the minimum baseline offset of the first line in the footnote

virtual bool16 IFootnoteSettings::GetNoSplitting ( ) const

pure virtual

Return whether the footnotes that don't fit in the current column can flow into the next column (kFalse) or force the marker to the next column where the entire footnote will fit (kTrue).

virtual ClassID IFootnoteSettings::GetNumberingMethod ( ) const

pure virtual

Return how the footnotes are numbered. Arabic, roman numerals, etc.

virtual PMReal IFootnoteSettings::GetOffset ( FootnoteRuleKind k ) const

pure virtual

Return the offset of the desired line that separates the footnotes from the main text.

virtual bool16 IFootnoteSettings::GetOverprintGap ( FootnoteRuleKind k ) const

pure virtual

Return whether overprint is on for the line gap, if any, that separates the footnotes from the main text.

virtual bool16 IFootnoteSettings::GetOverprintStroke ( FootnoteRuleKind k ) const

pure virtual

Return whether overprint is on for the desired line that separates the footnotes from the main text.

virtual SuffixPrefixUsageOptions IFootnoteSettings::GetPrefixSuffixUsage ( ) const

pure virtual

Return where the prefix/suffix strings should occur with regards to footnotes

virtual RestartNumberingOptions IFootnoteSettings::GetRestartOption ( ) const

pure virtual

Return the option showing when footnotes restart numbering.

virtual bool16 IFootnoteSettings::GetSeparatorLineOn ( FootnoteRuleKind k ) const

pure virtual

Return whether we are showing the separator line or not.

virtual PMReal IFootnoteSettings::GetSpaceBetween ( ) const

pure virtual

Return the space between footnote parcels

virtual PMReal IFootnoteSettings::GetSpacerHeight ( ) const

pure virtual

Return the space between the main text and the first footnote

virtual int32 IFootnoteSettings::GetStartingNumber ( ) const

pure virtual

Return the number footnotes should start with.

virtual bool16 IFootnoteSettings::GetStraddlingInfo ( ) const

pure virtual

Return whether straddling is enabled or not.

virtual ICompositionStyle::StrokeType IFootnoteSettings::GetStrokeType ( FootnoteRuleKind k ) const

pure virtual

Return the type/style of the desired line that separates the footnotes from the main text. e.g. solid line, dashed line, etc

virtual PMReal IFootnoteSettings::GetTintGap ( FootnoteRuleKind k ) const

pure virtual

Return the tint of the line gap, if any, that separates the footnotes from the main text.

virtual PMReal IFootnoteSettings::GetTintStroke ( FootnoteRuleKind k ) const

pure virtual

Return the tint of the desired line that separates the footnotes from the main text.

virtual PMReal IFootnoteSettings::GetWeightStroke ( FootnoteRuleKind k ) const

pure virtual

Return the weight of the desired line that separates the footnotes from the main text.

virtual PMReal IFootnoteSettings::GetWidth ( FootnoteRuleKind k ) const

pure virtual

Return the width of the desired line that separates the footnotes from the main text.

virtual void IFootnoteSettings::SetColorGap	(	FootnoteRuleKind	k,
		UID	s
	)

pure virtual

Set the color of the line gap, if any, that separates the footnotes from the main text.

virtual void IFootnoteSettings::SetColorStroke	(	FootnoteRuleKind	k,
		UID	s
	)

pure virtual

Set the color of the desired line that separates the footnotes from the main text.

virtual void IFootnoteSettings::SetEndOfStoryPlacement ( bool16 b )

pure virtual

Set whether the footnote at the end of the story will be placed at the bottom of the column (kFalse) or just below the text (kTrue).

virtual void IFootnoteSettings::SetFirstLineOffset ( Text::FirstLineOffsetMetric flo )

pure virtual

Set the baseline offset of the first line in the footnote

virtual void IFootnoteSettings::SetFootnoteMarkerStyle ( UID s )

pure virtual

Set the character style applied to the footnote symbol in the text

Note: : The UID can be kInvalidUID which uses the default style for new footnotes, but doesn't change the style of existing footnotes. (All others change the style of existing footnotes to the new style.)

virtual void IFootnoteSettings::SetFootnoteParagraphStyle ( UID s )

pure virtual

Set the paragraph style applied to the footnotes themselves

virtual void IFootnoteSettings::SetFootnoteSeparator ( const WideString & sep )

pure virtual

Set what text is automatically added between the footnote symbol and the footnote in the footnote.

virtual void IFootnoteSettings::SetIndentLeft	(	FootnoteRuleKind	k,
		PMReal	g
	)

pure virtual

Set the left indent of the desired line that separates the footnotes from the main text.

virtual void IFootnoteSettings::SetMarkerPositioning ( MarkerPositionOptions positioning )

pure virtual

Set the current positioning style for the footnote marker.

virtual void IFootnoteSettings::SetMarkerPrefix ( const WideString & pre )

pure virtual

Set the string to appear before the footnote number

virtual void IFootnoteSettings::SetMarkerSuffix ( const WideString & suf )

pure virtual

Set the string to appear after the footnote number

virtual void IFootnoteSettings::SetMinFirstLineOffset ( PMReal g )

pure virtual

Set the minimum baseline offset of the first line in the footnote

virtual void IFootnoteSettings::SetNoSplitting ( bool16 b )

pure virtual

Set whether the footnotes that don't fit in the current column can flow into the next column (kFalse) or force the marker to the next column where the entire footnote will fit (kTrue).

virtual void IFootnoteSettings::SetNumberingMethod ( ClassID whichMethod )

pure virtual

Set how the footnotes are numbered. Arabic, roman numerals, etc.

virtual void IFootnoteSettings::SetOffset	(	FootnoteRuleKind	k,
		PMReal	g
	)

pure virtual

Set the offset of the desired line that separates the footnotes from the main text.

virtual void IFootnoteSettings::SetOverprintGap	(	FootnoteRuleKind	k,
		bool16	b
	)

pure virtual

Set whether overprint is on for the line gap, if any, that separates the footnotes from the main text.

virtual void IFootnoteSettings::SetOverprintStroke	(	FootnoteRuleKind	k,
		bool16	b
	)

pure virtual

Set whether overprint is on for the desired line that separates the footnotes from the main text.

virtual void IFootnoteSettings::SetPrefixSuffixUsage ( SuffixPrefixUsageOptions options )

pure virtual

Set where the prefix/suffix strings should occur with regards to footnotes

virtual void IFootnoteSettings::SetRestartOption ( RestartNumberingOptions option )

pure virtual

Set the option showing when footnotes restart numbering.

virtual void IFootnoteSettings::SetSeparatorLineOn	(	FootnoteRuleKind	k,
		bool16	b
	)

pure virtual

Set whether we are showing the separator line or not.

virtual void IFootnoteSettings::SetSpaceBetween ( PMReal g )

pure virtual

Set the space between footnote parcels

virtual void IFootnoteSettings::SetSpacerHeight ( PMReal g )

pure virtual

Set the space between the main text and the first footnote

virtual void IFootnoteSettings::SetStartingNumber ( int32 n )

pure virtual

Set the number footnotes should start with.

virtual void IFootnoteSettings::SetStraddlingInfo ( bool16 b )

pure virtual

Set whether straddling is enabled or not.

virtual void IFootnoteSettings::SetStrokeType	(	FootnoteRuleKind	k,
		ICompositionStyle::StrokeType	s
	)

pure virtual

Set the type/style of the desired line that separates the footnotes from the main text. e.g. solid line, dashed line, etc

virtual void IFootnoteSettings::SetTintGap	(	FootnoteRuleKind	k,
		PMReal	g
	)

pure virtual

Set the tint of the line gap, if any, that separates the footnotes from the main text.

virtual void IFootnoteSettings::SetTintStroke	(	FootnoteRuleKind	k,
		PMReal	g
	)

pure virtual

Set the tint of the desired line that separates the footnotes from the main text.

virtual void IFootnoteSettings::SetWeightStroke	(	FootnoteRuleKind	k,
		PMReal	g
	)

pure virtual

Set the weight of the desired line that separates the footnotes from the main text.

virtual void IFootnoteSettings::SetWidth	(	FootnoteRuleKind	k,
		PMReal	g
	)

pure virtual

Set the width of the desired line that separates the footnotes from the main text.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation