Inheritance diagram for IFootnoteNumber:

Public Types
enum	{ kDefaultIID = IID_IFOOTNOTENUMBER }

enum	FootnoteLocation { kFootnoteReferenceInText, kFootnoteNumberInFootnote }

Public Member Functions
virtual int32	GetTheNumber (bool16 calculateWhenInvalid) const =0

virtual void	GetNumberString (FootnoteLocation location, PMString &noteNum) const =0

virtual void	GetNominalNumberString (FootnoteLocation location, PMString &noteNum) const =0

virtual bool16	ResetFootnoteNumber (int32 n=kInvalidFootnoteNumber, bool16 damageIfChanged=kTrue)=0

virtual bool16	RecalculateFootnoteNumber ()=0

virtual IFootnoteNumbering *	QueryFootnoteNumbering () const =0

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

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual void IFootnoteNumber::GetNominalNumberString	(	FootnoteLocation	location,
		PMString &	noteNum
	)		const

pure virtual

GetNominalNumberString fills out the string with the text used to display the note's initial number. This is used when composing text that contains footnotes that restart every page/spread.

Parameters

noteNum will be filled out with the number-related string.

virtual void IFootnoteNumber::GetNumberString	(	FootnoteLocation	location,
		PMString &	noteNum
	)		const

pure virtual

GetNumberString fills out the string with the text used to display the note's number.

Parameters

noteNum will be filled out with the number-related string.

virtual int32 IFootnoteNumber::GetTheNumber ( bool16 calculateWhenInvalid ) const

pure virtual

GetNumber returns the number stored internally. It may be "kInvalidFootnoteNumber" if it hasn't been calculated yet.

virtual IFootnoteNumbering* IFootnoteNumber::QueryFootnoteNumbering ( ) const

pure virtual

Returns the IFootnoteNumbering interface managing this footnote.

Returns: IFootnoteNumbering

virtual bool16 IFootnoteNumber::RecalculateFootnoteNumber ( )

pure virtual

RecalculateFootnoteNumber tells the footnote to recalculate personal number.

Returns: RecalculateFootnoteNumber returns kTrue if the number changed.

virtual bool16 IFootnoteNumber::ResetFootnoteNumber	(	int32	n = `kInvalidFootnoteNumber`,
		bool16	damageIfChanged = `kTrue`
	)

pure virtual

ResetFootnoteNumber tells the footnote to invalidate its personal number.

Parameters

n	is the footnote number to set to.
damageIfChanged	tells the footnote to damage its WaxLine(s) or not when the number changes.

Returns: ResetFootnoteNumber returns kFalse if the footnote was already damaged.

Public Types

Public Member Functions

Member Function Documentation