#include <IFootnoteFacade.h>

Inheritance diagram for IFootnoteFacade:

Public Types
enum	{ kDefaultIID = IID_IFOOTNOTEFACADE }

Public Member Functions
virtual IFootnoteSettings::MarkerPositionOptions	GetMarkerPositioning (IFootnoteSettings *target) const =0

virtual void	SetMarkerPositioning (IFootnoteSettings *target, IFootnoteSettings::MarkerPositionOptions positioning)=0

virtual IFootnoteSettings::RestartNumberingOptions	GetRestartOption (IFootnoteSettings *target) const =0

virtual void	SetRestartOption (IFootnoteSettings *target, IFootnoteSettings::RestartNumberingOptions option)=0

virtual int32	GetStartingNumber (IFootnoteSettings *target) const =0

virtual void	SetStartingNumber (IFootnoteSettings *target, int32 n)=0

virtual ClassID	GetNumberingMethod (IFootnoteSettings *target) const =0

virtual void	SetNumberingMethod (IFootnoteSettings *target, ClassID whichMethod)=0

virtual const WideString &	GetMarkerPrefix (IFootnoteSettings *target) const =0

virtual void	SetMarkerPrefix (IFootnoteSettings *target, const WideString &pre)=0

virtual const WideString &	GetMarkerSuffix (IFootnoteSettings *target) const =0

virtual void	SetMarkerSuffix (IFootnoteSettings *target, const WideString &suf)=0

virtual IFootnoteSettings::SuffixPrefixUsageOptions	GetPrefixSuffixUsage (IFootnoteSettings *target) const =0

virtual void	SetPrefixSuffixUsage (IFootnoteSettings *target, IFootnoteSettings::SuffixPrefixUsageOptions options)=0

virtual UID	GetFootnoteMarkerStyle (IFootnoteSettings *target) const =0

virtual void	SetFootnoteMarkerStyle (IFootnoteSettings *target, UID s)=0

virtual UID	GetFootnoteParagraphStyle (IFootnoteSettings *target) const =0

virtual void	SetFootnoteParagraphStyle (IFootnoteSettings *target, UID s)=0

virtual const WideString &	GetFootnoteSeparator (IFootnoteSettings *target) const =0

virtual void	SetFootnoteSeparator (IFootnoteSettings *target, const WideString &sep)=0

virtual PMReal	GetSpaceBetween (IFootnoteSettings *target) const =0

virtual void	SetSpaceBetween (IFootnoteSettings *target, PMReal g)=0

virtual PMReal	GetSpacerHeight (IFootnoteSettings *target) const =0

virtual void	SetSpacerHeight (IFootnoteSettings *target, PMReal g)=0

virtual Text::FirstLineOffsetMetric	GetFirstLineOffset (IFootnoteSettings *target) const =0

virtual void	SetFirstLineOffset (IFootnoteSettings *target, Text::FirstLineOffsetMetric flo)=0

virtual PMReal	GetMinFirstLineOffset (IFootnoteSettings *target) const =0

virtual void	SetMinFirstLineOffset (IFootnoteSettings *target, PMReal g)=0

virtual bool16	GetEndOfStoryPlacement (IFootnoteSettings *target) const =0

virtual void	SetEndOfStoryPlacement (IFootnoteSettings *target, bool16 b)=0

virtual bool16	GetNoSplitting (IFootnoteSettings *target) const =0

virtual void	SetNoSplitting (IFootnoteSettings *target, bool16 b)=0

virtual bool16	GetStraddlingInfo (IFootnoteSettings *target) const =0

virtual void	SetStraddlingInfo (IFootnoteSettings *target, bool16 b)=0

virtual bool16	GetSeparatorLineOn (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k) const =0

virtual void	SetSeparatorLineOn (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k, bool16 b)=0

virtual PMReal	GetWeightStroke (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k) const =0

virtual void	SetWeightStroke (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k, PMReal g)=0

virtual ICompositionStyle::StrokeType	GetStrokeType (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k) const =0

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

virtual PMReal	GetIndentLeft (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k) const =0

virtual void	SetIndentLeft (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k, PMReal g)=0

virtual PMReal	GetWidth (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k) const =0

virtual void	SetWidth (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k, PMReal g)=0

virtual PMReal	GetOffset (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k) const =0

virtual void	SetOffset (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k, PMReal g)=0

virtual UID	GetColorStroke (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k) const =0

virtual void	SetColorStroke (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k, UID s)=0

virtual PMReal	GetTintStroke (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k) const =0

virtual void	SetTintStroke (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k, PMReal g)=0

virtual bool16	GetOverprintStroke (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k) const =0

virtual void	SetOverprintStroke (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k, bool16 b)=0

virtual UID	GetColorGap (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k) const =0

virtual void	SetColorGap (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k, UID s)=0

virtual PMReal	GetTintGap (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k) const =0

virtual void	SetTintGap (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k, PMReal g)=0

virtual bool16	GetOverprintGap (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k) const =0

virtual void	SetOverprintGap (IFootnoteSettings *target, IFootnoteSettings::FootnoteRuleKind k, bool16 b)=0

virtual void	SetAllSettings (IFootnoteSettings target, const IFootnoteSettingsCmdData::FootnotePrefs settings, const IFootnoteSettingsCmdData::FootnoteLinePrefs separator, const IFootnoteSettingsCmdData::FootnoteLinePrefs continuing)=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

A high level API for dealing with footnotes. To use this Facade, include this header file and the use the following example syntax: Utils<IFootnoteFacade>()->SetMode( pageItem, mode );

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

Member Function Documentation

virtual UID IFootnoteFacade::GetColorGap	(	IFootnoteSettings *	target,
		IFootnoteSettings::FootnoteRuleKind	k
	)		const

pure virtual

See IFootnoteSettings

virtual UID IFootnoteFacade::GetColorStroke	(	IFootnoteSettings *	target,
		IFootnoteSettings::FootnoteRuleKind	k
	)		const

pure virtual

See IFootnoteSettings

virtual bool16 IFootnoteFacade::GetEndOfStoryPlacement ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual Text::FirstLineOffsetMetric IFootnoteFacade::GetFirstLineOffset ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual UID IFootnoteFacade::GetFootnoteMarkerStyle ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual UID IFootnoteFacade::GetFootnoteParagraphStyle ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual const WideString& IFootnoteFacade::GetFootnoteSeparator ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteFacade::GetIndentLeft	(	IFootnoteSettings *	target,
		IFootnoteSettings::FootnoteRuleKind	k
	)		const

pure virtual

See IFootnoteSettings

virtual IFootnoteSettings::MarkerPositionOptions IFootnoteFacade::GetMarkerPositioning ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual const WideString& IFootnoteFacade::GetMarkerPrefix ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual const WideString& IFootnoteFacade::GetMarkerSuffix ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteFacade::GetMinFirstLineOffset ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual bool16 IFootnoteFacade::GetNoSplitting ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual ClassID IFootnoteFacade::GetNumberingMethod ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteFacade::GetOffset	(	IFootnoteSettings *	target,
		IFootnoteSettings::FootnoteRuleKind	k
	)		const

pure virtual

See IFootnoteSettings

virtual bool16 IFootnoteFacade::GetOverprintGap	(	IFootnoteSettings *	target,
		IFootnoteSettings::FootnoteRuleKind	k
	)		const

pure virtual

See IFootnoteSettings

virtual bool16 IFootnoteFacade::GetOverprintStroke	(	IFootnoteSettings *	target,
		IFootnoteSettings::FootnoteRuleKind	k
	)		const

pure virtual

See IFootnoteSettings

virtual IFootnoteSettings::SuffixPrefixUsageOptions IFootnoteFacade::GetPrefixSuffixUsage ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual IFootnoteSettings::RestartNumberingOptions IFootnoteFacade::GetRestartOption ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual bool16 IFootnoteFacade::GetSeparatorLineOn	(	IFootnoteSettings *	target,
		IFootnoteSettings::FootnoteRuleKind	k
	)		const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteFacade::GetSpaceBetween ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteFacade::GetSpacerHeight ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual int32 IFootnoteFacade::GetStartingNumber ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual bool16 IFootnoteFacade::GetStraddlingInfo ( IFootnoteSettings * target ) const

pure virtual

See IFootnoteSettings

virtual ICompositionStyle::StrokeType IFootnoteFacade::GetStrokeType	(	IFootnoteSettings *	target,
		IFootnoteSettings::FootnoteRuleKind	k
	)		const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteFacade::GetTintGap	(	IFootnoteSettings *	target,
		IFootnoteSettings::FootnoteRuleKind	k
	)		const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteFacade::GetTintStroke	(	IFootnoteSettings *	target,
		IFootnoteSettings::FootnoteRuleKind	k
	)		const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteFacade::GetWeightStroke	(	IFootnoteSettings *	target,
		IFootnoteSettings::FootnoteRuleKind	k
	)		const

pure virtual

See IFootnoteSettings

virtual PMReal IFootnoteFacade::GetWidth	(	IFootnoteSettings *	target,
		IFootnoteSettings::FootnoteRuleKind	k
	)		const

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetAllSettings	(	IFootnoteSettings *	target,
		const IFootnoteSettingsCmdData::FootnotePrefs *	settings,
		const IFootnoteSettingsCmdData::FootnoteLinePrefs *	separator,
		const IFootnoteSettingsCmdData::FootnoteLinePrefs *	continuing
	)

pure virtual

See IFootnoteSettings

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

pure virtual

See IFootnoteSettings

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

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetEndOfStoryPlacement	(	IFootnoteSettings *	target,
		bool16	b
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetFirstLineOffset	(	IFootnoteSettings *	target,
		Text::FirstLineOffsetMetric	flo
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetFootnoteMarkerStyle	(	IFootnoteSettings *	target,
		UID	s
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetFootnoteParagraphStyle	(	IFootnoteSettings *	target,
		UID	s
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetFootnoteSeparator	(	IFootnoteSettings *	target,
		const WideString &	sep
	)

pure virtual

See IFootnoteSettings

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

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetMarkerPositioning	(	IFootnoteSettings *	target,
		IFootnoteSettings::MarkerPositionOptions	positioning
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetMarkerPrefix	(	IFootnoteSettings *	target,
		const WideString &	pre
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetMarkerSuffix	(	IFootnoteSettings *	target,
		const WideString &	suf
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetMinFirstLineOffset	(	IFootnoteSettings *	target,
		PMReal	g
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetNoSplitting	(	IFootnoteSettings *	target,
		bool16	b
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetNumberingMethod	(	IFootnoteSettings *	target,
		ClassID	whichMethod
	)

pure virtual

See IFootnoteSettings

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

pure virtual

See IFootnoteSettings

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

pure virtual

See IFootnoteSettings

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

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetPrefixSuffixUsage	(	IFootnoteSettings *	target,
		IFootnoteSettings::SuffixPrefixUsageOptions	options
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetRestartOption	(	IFootnoteSettings *	target,
		IFootnoteSettings::RestartNumberingOptions	option
	)

pure virtual

See IFootnoteSettings

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

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetSpaceBetween	(	IFootnoteSettings *	target,
		PMReal	g
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetSpacerHeight	(	IFootnoteSettings *	target,
		PMReal	g
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetStartingNumber	(	IFootnoteSettings *	target,
		int32	n
	)

pure virtual

See IFootnoteSettings

virtual void IFootnoteFacade::SetStraddlingInfo	(	IFootnoteSettings *	target,
		bool16	b
	)

pure virtual

See IFootnoteSettings

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

pure virtual

See IFootnoteSettings

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

pure virtual

See IFootnoteSettings

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

pure virtual

See IFootnoteSettings

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

pure virtual

See IFootnoteSettings

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

pure virtual

See IFootnoteSettings

Public Types

Public Member Functions

Detailed Description

Member Function Documentation