#include <IEndnoteFacade.h>

Inheritance diagram for Facade::IEndnoteFacade:

Public Types
enum	{ kDefaultIID = IID_IENDNOTEFACADE }

Public Member Functions
virtual WideString	GetTitle (IEndnoteSettings *target) const =0

virtual void	SetTitle (IEndnoteSettings *target, WideString title)=0

virtual UID	GetHeaderParaStyle (IEndnoteSettings *target) const =0

virtual void	SetHeaderParaStyle (IEndnoteSettings *target, UID styleID)=0

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

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

virtual int32	GetStartingNumber (IEndnoteSettings *target) const =0

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

virtual ClassID	GetNumberingMethod (IEndnoteSettings *target) const =0

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

virtual IEndnoteSettings::MarkerPositionOptions	GetMarkerPositioning (IEndnoteSettings *target) const =0

virtual void	SetMarkerPositioning (IEndnoteSettings *target, IEndnoteSettings::MarkerPositionOptions option)=0

virtual UID	GetMarkerStyle (IEndnoteSettings *target) const =0

virtual void	SetMarkerStyle (IEndnoteSettings *target, UID styleID)=0

virtual UID	GetEndnoteParagraphStyle (IEndnoteSettings *target) const =0

virtual void	SetEndnoteParagraphStyle (IEndnoteSettings *target, UID s)=0

virtual const WideString &	GetEndnoteSeparator (IEndnoteSettings *target) const =0

virtual void	SetEndnoteSeparator (IEndnoteSettings *target, const WideString &sep)=0

virtual IEndnoteSettings::Scope	GetScope (IEndnoteSettings *target) const =0

virtual void	SetScope (IEndnoteSettings *target, IEndnoteSettings::Scope scope)=0

virtual IEndnoteSettings::Place	GetPlace (IEndnoteSettings *target) const =0

virtual void	SetPlace (IEndnoteSettings *target, IEndnoteSettings::Place place)=0

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

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

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

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

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

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

virtual void	SetAllSettings (IEndnoteSettings target, const IEndnoteSettings::EndnotePrefs settings)=0

virtual IEndnoteSettings *	QueryEndnoteSettings (IDataBase *db) const =0

virtual bool16	IsEndnoteStory (const UIDRef textModelRef) const =0

virtual bool16	IsEndnoteTextRange (const TextIndex &startPosition, const TextIndex &endPosition, const ITextModel *textModel) const =0

virtual bool16	IsEndnoteAnchor (TextIndex &position, const ITextModel *textModel) const =0

virtual bool16	IsEndnoteTextRangeMarker (const TextIndex &position, ITextModel *textModel) const =0

virtual void	AppendEndnoteRelatedStories (const UIDRef &modelRef, UIDList &storiesList) const =0

virtual bool16	IsEndnoteAnchorOrEndnoteStoryInAssignment (const UIDRef &storyRef) const =0

virtual bool16	IsEndnoteAnchorOrEndnoteStory (const UIDRef &storyRef) const =0

virtual UIDList	GetEndnoteAnchorStories (UIDRef endnoteStoryRef) const =0

virtual int32	GetEndnoteCount (UIDRef endnoteStoryRef) const =0

virtual UIDRef	GetEndnoteStoryRef (const ITextModel *textModel) const =0

virtual bool16	IsSeparatorChar (const UIDRef textModelRef, const TextIndex index) const =0

virtual void	MoveEndnoteRange (const UIDRef &storyRef)=0

virtual void	DeleteEndnoteRangesInStory (ITextModel *model, TextIndex start, TextIndex end) const =0

virtual void	CopyEndnoteDataFromSourceStoryToDestStory (UIDRef sourceEndnoteStoryRef, UIDRef destEndnoteStoryRef)=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 Endnotes. To use this Facade, include this header file and the use the following example syntax: Utils<IEndnoteFacade>()->SetTitle( ... );

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

Member Function Documentation

virtual void Facade::IEndnoteFacade::AppendEndnoteRelatedStories	(	const UIDRef &	modelRef,
		UIDList &	storiesList
	)		const

pure virtual

Given a story containing an endnote reference/range, returns the related stories containing endnote references/ranges.

Parameters

modelRef,:	[IN}UIDRef of the story containing endnote reference/range
storiesList,:	[OUT] list of related stories containing endnote references/ranges.

virtual void Facade::IEndnoteFacade::CopyEndnoteDataFromSourceStoryToDestStory	(	UIDRef	sourceEndnoteStoryRef,
		UIDRef	destEndnoteStoryRef
	)

pure virtual

ADOBE INTERNAL USE ONLY

virtual void Facade::IEndnoteFacade::DeleteEndnoteRangesInStory	(	ITextModel *	model,
		TextIndex	start,
		TextIndex	end
	)		const

pure virtual

ADOBE INTERNAL USE ONLY

virtual UIDList Facade::IEndnoteFacade::GetEndnoteAnchorStories ( UIDRef endnoteStoryRef ) const

pure virtual

Returns UIDList of all the stories containing endnote references corresponding to story

containing endnote ranges

Parameters

endnoteStoryRef,: [IN} UIDRef of the story containing endnote ranges

Returns: UIDList of all the stories containing endnote references

virtual int32 Facade::IEndnoteFacade::GetEndnoteCount ( UIDRef endnoteStoryRef ) const

pure virtual

Returns count of all the endnotes corresponding to story containing endnote ranges

Parameters

endnoteStoryRef,: [IN} UIDRef of the story containing endnote ranges

Returns: count of all the endnotes

virtual UID Facade::IEndnoteFacade::GetEndnoteParagraphStyle ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual const WideString& Facade::IEndnoteFacade::GetEndnoteSeparator ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual UIDRef Facade::IEndnoteFacade::GetEndnoteStoryRef ( const ITextModel * textModel ) const

pure virtual

Returns UIDRef of the endnote story corresponding to story containing endnote references

Parameters

textModel,: [IN} story containing endnote references

Returns: UIDRef of the endnote story corresponding to story containing endnote references

virtual UID Facade::IEndnoteFacade::GetHeaderParaStyle ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual IEndnoteSettings::MarkerPositionOptions Facade::IEndnoteFacade::GetMarkerPositioning ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual const WideString& Facade::IEndnoteFacade::GetMarkerPrefix ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual UID Facade::IEndnoteFacade::GetMarkerStyle ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual const WideString& Facade::IEndnoteFacade::GetMarkerSuffix ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual ClassID Facade::IEndnoteFacade::GetNumberingMethod ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual IEndnoteSettings::Place Facade::IEndnoteFacade::GetPlace ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual IEndnoteSettings::SuffixPrefixUsageOptions Facade::IEndnoteFacade::GetPrefixSuffixUsage ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual IEndnoteSettings::RestartNumberingOptions Facade::IEndnoteFacade::GetRestartOption ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual IEndnoteSettings::Scope Facade::IEndnoteFacade::GetScope ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual int32 Facade::IEndnoteFacade::GetStartingNumber ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual WideString Facade::IEndnoteFacade::GetTitle ( IEndnoteSettings * target ) const

pure virtual

See IEndnoteSettings

virtual bool16 Facade::IEndnoteFacade::IsEndnoteAnchor	(	TextIndex &	position,
		const ITextModel *	textModel
	)		const

pure virtual

Returns if the character at the given text index position is an endnote reference

Parameters

position,:	text index of the character
textModel,:	textModel of the containing character

Returns: true if the character is an endnote reference, false otherwise

virtual bool16 Facade::IEndnoteFacade::IsEndnoteAnchorOrEndnoteStory ( const UIDRef & storyRef ) const

pure virtual

Returns true if the given story is a story containing endnote references/ranges

Parameters

storyRef,: [IN} UIDRef of the given story

Returns: true if the given story is a story containing endnote references/ranges

virtual bool16 Facade::IEndnoteFacade::IsEndnoteAnchorOrEndnoteStoryInAssignment ( const UIDRef & storyRef ) const

pure virtual

Returns true if the given story is a story containing endnote references/ranges and is in the assignment

Parameters

storyRef,: [IN} UIDRef of the given story

Returns: true if the given story is a story containing endnote references/ranges and is in the assignment, else return false

virtual bool16 Facade::IEndnoteFacade::IsEndnoteTextRange	(	const TextIndex &	startPosition,
		const TextIndex &	endPosition,
		const ITextModel *	textModel
	)		const

pure virtual

Returns if the passed text range is an endnote text range

Parameters

startPosition,:	start index of the text range
endPosition,:	end index of the text range
textModel,:	textModel of the text range

Returns: true if the text range is endnote text range, false otherwise

virtual bool16 Facade::IEndnoteFacade::IsEndnoteTextRangeMarker	(	const TextIndex &	position,
		ITextModel *	textModel
	)		const

pure virtual

Returns true if the character at the given text index is endnote text range start/end marker

Parameters

position,:	text index of the character
textModel,:	textModel of the containing character

Returns: true if the character is endnote range marker, else returns false

virtual bool16 Facade::IEndnoteFacade::IsSeparatorChar	(	const UIDRef	textModelRef,
		const TextIndex	index
	)		const

pure virtual

Returns true if the character at the given text index is a separator

Parameters

textModel,: [IN} story containing the character

Returns: true if the character is a separator, else returns false

virtual void Facade::IEndnoteFacade::MoveEndnoteRange ( const UIDRef & storyRef )

pure virtual

ADOBE INTERNAL USE ONLY

virtual void Facade::IEndnoteFacade::SetAllSettings	(	IEndnoteSettings *	target,
		const IEndnoteSettings::EndnotePrefs *	settings
	)

pure virtual

See IEndnoteSettings

Public Types

Public Member Functions

Detailed Description

Member Function Documentation