#include <IEndnoteSettings.h>

Inheritance diagram for IEndnoteSettings:

Classes
struct	EndnotePrefs

Public Types
enum	{ kDefaultIID = IID_IENDNOTESETTINGS }

enum	RestartNumberingOptions { kContinuous, kRestartEveryStory, kUnknown }

enum	Scope { kStory, kDocument }

enum	Place { kPlacegun, kNewPage }

enum	SuffixPrefixUsageOptions { kPrefixSuffixNone, kPrefixSuffixReference, kPrefixSuffixMarker, kPrefixSuffixBoth }

enum	MarkerPositionOptions { kPositionNormal, kPositionSuperscript, kPositionSubscript, kPositionRuby }

Public Member Functions
virtual WideString	GetTitle () const =0

virtual void	SetTitle (WideString title)=0

virtual UID	GetHeaderParaStyle () const =0

virtual void	SetHeaderParaStyle (UID styleID)=0

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 MarkerPositionOptions	GetMarkerPositioning () const =0

virtual void	SetMarkerPositioning (MarkerPositionOptions option)=0

virtual UID	GetMarkerStyle () const =0

virtual void	SetMarkerStyle (UID styleID)=0

virtual UID	GetEndnoteParagraphStyle () const =0

virtual void	SetEndnoteParagraphStyle (UID s)=0

virtual const WideString &	GetEndnoteSeparator () const =0

virtual void	SetEndnoteSeparator (const WideString &sep)=0

virtual Scope	GetScope () const =0

virtual void	SetScope (Scope scope)=0

virtual Place	GetPlace () const =0

virtual void	SetPlace (Place place)=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 option)=0

virtual void	CopyFrom (IEndnoteSettings *settings)=0

virtual const UIDRef &	GetDocument ()=0

virtual bool16	GetHasSettings () const =0

virtual void	Set (const EndnotePrefs *prefs, const UIDRef &doc)=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 endnotes.

Member Enumeration Documentation

enum IEndnoteSettings::MarkerPositionOptions

The different ways to apply positioning to the endnote marker.

enum IEndnoteSettings::Place

Locations to place endnotes

enum IEndnoteSettings::RestartNumberingOptions

The different ways to restart numbering of endnotes.

enum IEndnoteSettings::Scope

Different scopes for endnote placement

enum IEndnoteSettings::SuffixPrefixUsageOptions

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

Member Function Documentation

virtual void IEndnoteSettings::CopyFrom ( IEndnoteSettings * settings )

pure virtual

Copy setting into current object

virtual const UIDRef& IEndnoteSettings::GetDocument ( )

pure virtual

Get the document associated to these changes(when settings are used as command data).Returns nil, if no document.

virtual UID IEndnoteSettings::GetEndnoteParagraphStyle ( ) const

pure virtual

Return the paragraph style applied to the endnotes themselves

virtual const WideString& IEndnoteSettings::GetEndnoteSeparator ( ) const

pure virtual

Return what text is automatically added between the endnote symbol and the endnote in the endnotes frame.

virtual bool16 IEndnoteSettings::GetHasSettings ( ) const

pure virtual

Return whether command data has settings or not.

virtual UID IEndnoteSettings::GetHeaderParaStyle ( ) const

pure virtual

Return paragraph style for endnotes header

virtual MarkerPositionOptions IEndnoteSettings::GetMarkerPositioning ( ) const

pure virtual

Return marker positioning

virtual const WideString& IEndnoteSettings::GetMarkerPrefix ( ) const

pure virtual

Return the string to appear before the endnote number

virtual UID IEndnoteSettings::GetMarkerStyle ( ) const

pure virtual

Get character style for endnote marker

virtual const WideString& IEndnoteSettings::GetMarkerSuffix ( ) const

pure virtual

Return the string to appear after the endnote number

virtual ClassID IEndnoteSettings::GetNumberingMethod ( ) const

pure virtual

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

virtual Place IEndnoteSettings::GetPlace ( ) const

pure virtual

Return where endnotes are placed (new page or placegun)

virtual SuffixPrefixUsageOptions IEndnoteSettings::GetPrefixSuffixUsage ( ) const

pure virtual

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

virtual RestartNumberingOptions IEndnoteSettings::GetRestartOption ( ) const

pure virtual

Return the option showing when endnotes restart numbering.

virtual Scope IEndnoteSettings::GetScope ( ) const

pure virtual

Return scope for endnotes placement

virtual int32 IEndnoteSettings::GetStartingNumber ( ) const

pure virtual

Return the number endnotes should start with.

virtual WideString IEndnoteSettings::GetTitle ( ) const

pure virtual

Return endnotes title

virtual void IEndnoteSettings::Set	(	const EndnotePrefs *	prefs,
		const UIDRef &	doc
	)

pure virtual

Initialize the data.

virtual void IEndnoteSettings::SetEndnoteParagraphStyle ( UID s )

pure virtual

Set the paragraph style applied to the endnotes themselves

virtual void IEndnoteSettings::SetEndnoteSeparator ( const WideString & sep )

pure virtual

Set what text is automatically added between the endnote symbol and the endnote in the endnotes frame.

virtual void IEndnoteSettings::SetHeaderParaStyle ( UID styleID )

pure virtual

Set paragraph style for endnotes header

virtual void IEndnoteSettings::SetMarkerPositioning ( MarkerPositionOptions option )

pure virtual

Set marker positioning

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

pure virtual

Set the string to appear before the endnote number

virtual void IEndnoteSettings::SetMarkerStyle ( UID styleID )

pure virtual

Get character style for endnote marker

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

pure virtual

Set the string to appear after the endnote number

virtual void IEndnoteSettings::SetNumberingMethod ( ClassID whichMethod )

pure virtual

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

virtual void IEndnoteSettings::SetPlace ( Place place )

pure virtual

Set place for positioning endnotes (new page or placegun)

virtual void IEndnoteSettings::SetPrefixSuffixUsage ( SuffixPrefixUsageOptions option )

pure virtual

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

virtual void IEndnoteSettings::SetRestartOption ( RestartNumberingOptions option )

pure virtual

Set the option showing when endnotes restart numbering.

virtual void IEndnoteSettings::SetScope ( Scope scope )

pure virtual

Set scope for endnotes placement

virtual void IEndnoteSettings::SetStartingNumber ( int32 n )

pure virtual

Set the number endnotes should start with.

virtual void IEndnoteSettings::SetTitle ( WideString title )

pure virtual

Set endnotes title

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation