#include <IIndexOptions.h>

Inheritance diagram for IIndexOptions:

Public Types
enum	{ kDefaultIID = IID_IINDEXOPTIONS }

enum	Scope { kDocumentScope = 0, kBookScope = 1 }

enum	IndexFormat { kNested, kRunIn }

enum	FrameType { kHorizontal, kVertical }

Public Member Functions
virtual const WideString &	GetTitle () const =0

virtual void	SetTitle (const WideString &indexTitle)=0

virtual const PMString &	GetTitleParagraphStyle () const =0

virtual void	SetTitleParagraphStyle (const PMString &style)=0

virtual const bool16	GetReplaceExistingIndexFlag () const =0

virtual void	SetReplaceExistingIndexFlag (bool16 replaceExistingIndex=kFalse)=0

virtual const PMString &	GetBookName () const =0

virtual void	SetBookName (const PMString &bookName)=0

virtual const IIndexOptions::Scope	GetScope () const =0

virtual void	SetScope (const IIndexOptions::Scope scope=kDocumentScope)=0

virtual const bool16	GetShowEntriesOnHiddenLayerFlag () const =0

virtual void	SetShowEntriesOnHiddenLayerFlag (bool16 showEntriesOnHiddenLayer=kFalse)=0

virtual const IIndexOptions::IndexFormat	GetIndexFormat () const =0

virtual void	SetIndexFormat (const IIndexOptions::IndexFormat format=kNested)=0

virtual const bool16	GetShowSectionHeadersFlag () const =0

virtual void	SetShowSectionHeadersFlag (bool16 showSectionHeaders=kTrue)=0

virtual const bool16	GetShowEmptySectionsFlag () const =0

virtual void	SetShowEmptySectionsFlag (bool16 showEmptySections=kFalse)=0

virtual const WideString &	GetFollowingTopicSeparator () const =0

virtual void	SetFollowingTopicSeparator (const WideString &separator)=0

virtual const WideString &	GetBetweenPageNumberSeparator () const =0

virtual void	SetBetweenPageNumberSeparator (const WideString &separator)=0

virtual const WideString &	GetBetweenEntriesSeparator () const =0

virtual void	SetBetweenEntriesSeparator (const WideString &separator)=0

virtual const WideString &	GetBeforeXRefSeparator () const =0

virtual void	SetBeforeXRefSeparator (const WideString &separator)=0

virtual const WideString &	GetPageRangeSeparator () const =0

virtual void	SetPageRangeSeparator (const WideString &separator)=0

virtual const WideString &	GetEntryEndSeparator () const =0

virtual void	SetEntryEndSeparator (const WideString &separator)=0

virtual void	GetTopicLevelParagraphStyle (const int32 level, PMString &style) const =0

virtual void	SetTopicLevelParagraphStyle (const int32 level, const PMString &style)=0

virtual const PMString &	GetSectionHeaderParagraphStyle () const =0

virtual void	SetSectionHeaderParagraphStyle (const PMString &style)=0

virtual const PMString &	GetPageNumberCharacterStyle () const =0

virtual void	SetPageNumberCharacterStyle (const PMString &style)=0

virtual const PMString &	GetCrossRefCharacterStyle () const =0

virtual void	SetCrossRefCharacterStyle (const PMString &style)=0

virtual const PMString &	GetReferencedCharacterStyle () const =0

virtual void	SetReferencedCharacterStyle (const PMString &style)=0

virtual const IIndexOptions::FrameType	GetFrameType () const =0

virtual void	SetFrameType (const IIndexOptions::FrameType frameType=kHorizontal)=0

virtual void	CopyDataFrom (const IIndexOptions *source, bool16 bDirty=kTrue)=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

Data interfaces that aggregates information regarding a generated index (an index instance).

Member Enumeration Documentation

enum IIndexOptions::FrameType

Specifies the direction of frame for the index story.

enum IIndexOptions::IndexFormat

Specifies if the last level entries of the index are run-in or nested format

enum IIndexOptions::Scope

Specifies if the index refers to a single document or a book.

Member Function Documentation

virtual void IIndexOptions::CopyDataFrom	(	const IIndexOptions *	source,
		bool16	bDirty = `kTrue`
	)

pure virtual

Utility function that copied the index options from another interface.

Parameters

source	[IN] - source index options that will be copied in this instance.
bDirty	[IN] - flag that specifies if the data will be marked as "dirty", causing the observers to be notified.

virtual const WideString& IIndexOptions::GetBeforeXRefSeparator ( ) const

pure virtual

Retrieves the separator used before each cross-reference.

Returns: the separator.

virtual const WideString& IIndexOptions::GetBetweenEntriesSeparator ( ) const

pure virtual

Retrieves the string used between each index entry.

Returns: the separator.

virtual const WideString& IIndexOptions::GetBetweenPageNumberSeparator ( ) const

pure virtual

Gets the separator between the page numbers or page ranges.

Returns: the separator.

virtual const PMString& IIndexOptions::GetBookName ( ) const

pure virtual

Retrieves the book name to which the index belongs (if the scope is book).

See Also: SetScope().

Returns: the name of the book.

virtual const PMString& IIndexOptions::GetCrossRefCharacterStyle ( ) const

pure virtual

Retrieves the paragraph style used for formatting the cross-reference specifiers ("see, see also", etc) in the index story.

Returns: the style name for the cross-reference specifiers.

virtual const WideString& IIndexOptions::GetEntryEndSeparator ( ) const

pure virtual

Retrieves the separator at the end of each index entry.

Returns: the separator.

virtual const WideString& IIndexOptions::GetFollowingTopicSeparator ( ) const

pure virtual

Gets the separator string that follows after each index topic.

Returns: the separator.

virtual const IIndexOptions::FrameType IIndexOptions::GetFrameType ( ) const

pure virtual

Retrieves the direction of the frame for the index story. Used for the J version.

Returns: the direction of the frame.

virtual const IIndexOptions::IndexFormat IIndexOptions::GetIndexFormat ( ) const

pure virtual

Retrieves the format for the index.

See Also: IndexFormat enumeration.

Returns: the format of the index.

virtual const PMString& IIndexOptions::GetPageNumberCharacterStyle ( ) const

pure virtual

Retrieves the paragraph style used for formatting the page numbers in the index story.

Returns: the style name for the page numbers.

virtual const WideString& IIndexOptions::GetPageRangeSeparator ( ) const

pure virtual

Retrieves the separator between the page ranges.

Returns: the separator.

virtual const PMString& IIndexOptions::GetReferencedCharacterStyle ( ) const

pure virtual

Retrieves the paragraph style used for formatting the cross-reference index entries in the index story.

Returns: the style name for the cross-references.

virtual const bool16 IIndexOptions::GetReplaceExistingIndexFlag ( ) const

pure virtual

Retrieves the "replace existing" flag option.

Returns: kTrue if the flag is true (index will be replaced).

virtual const IIndexOptions::Scope IIndexOptions::GetScope ( ) const

pure virtual

Retrieves the scope of the index.

Returns: the scope of the index.

virtual const PMString& IIndexOptions::GetSectionHeaderParagraphStyle ( ) const

pure virtual

Retrieves the paragraph style used for formatting the section headers in the index story.

Returns: the style name for the section headers.

virtual const bool16 IIndexOptions::GetShowEmptySectionsFlag ( ) const

pure virtual

Retrieves the flag that specifies whether the empty section headers are included in the index.

Returns: kTrue if the empty section headers are included in the index.

virtual const bool16 IIndexOptions::GetShowEntriesOnHiddenLayerFlag ( ) const

pure virtual

Retrieves the flag that specifies if the topics included on hidden layers should be included in the index.

Returns: kTrue if the entries on hidden layers are visible in the index.

virtual const bool16 IIndexOptions::GetShowSectionHeadersFlag ( ) const

pure virtual

Retrieves the flag that specifies whether the section headers are included in the index.

Returns: kTrue if the section headers are included in the index.

virtual const WideString& IIndexOptions::GetTitle ( ) const

pure virtual

Retrieves the title for the index.

Returns: the title string.

virtual const PMString& IIndexOptions::GetTitleParagraphStyle ( ) const

pure virtual

Retrieves the paragraph style used for formatting the title of indexing story.

Returns: the style name of the title.

virtual void IIndexOptions::GetTopicLevelParagraphStyle	(	const int32	level,
		PMString &	style
	)		const

pure virtual

Retrieves the paragraph style used for formatting the topics in the index story.

Parameters

level	[IN] - level of the topic.
style	[OUT] - style name for the specified level.

virtual void IIndexOptions::SetBeforeXRefSeparator ( const WideString & separator )

pure virtual

Sets the separator used before each cross-reference.

Parameters

separator [IN] - the separator string.

virtual void IIndexOptions::SetBetweenEntriesSeparator ( const WideString & separator )

pure virtual

Sets the separator used between each index entry.

Parameters

separator [IN] - the separator string.

virtual void IIndexOptions::SetBetweenPageNumberSeparator ( const WideString & separator )

pure virtual

Sets the separator between the page numbers or page ranges.

Parameters

separator [IN] - the separator.

virtual void IIndexOptions::SetBookName ( const PMString & bookName )

pure virtual

Sets the name of the book to which the index belongs.

Parameters

bookName [IN] - the book name.

virtual void IIndexOptions::SetCrossRefCharacterStyle ( const PMString & style )

pure virtual

Sets the paragraph style used for formatting the cross-reference specifiers ("see, see also", etc) in the index story.

Parameters

style [IN] - the style name for the cross-reference specifiers.

virtual void IIndexOptions::SetEntryEndSeparator ( const WideString & separator )

pure virtual

Sets the separator used at the end of each index entry.

Parameters

separator [IN] - the separator string.

virtual void IIndexOptions::SetFollowingTopicSeparator ( const WideString & separator )

pure virtual

Sets the separator string that follows after each index topic.

Parameters

separator [IN] - the separator.

virtual void IIndexOptions::SetFrameType ( const IIndexOptions::FrameType frameType = kHorizontal )

pure virtual

Sets the direction of the frame for the index story. Used for the J version. The Roman version used the default value (kHorizontal).

Parameters

frameType [IN] - the direction of the frame.

virtual void IIndexOptions::SetIndexFormat ( const IIndexOptions::IndexFormat format = kNested )

pure virtual

Sets the format for the index.

See Also: IndexFormat enumeration.

Parameters

format [IN] - the format of the index.

virtual void IIndexOptions::SetPageNumberCharacterStyle ( const PMString & style )

pure virtual

Sets the paragraph style used for formatting the page numbers in the index story.

Parameters

style [IN] - the style name for the page numbers.

virtual void IIndexOptions::SetPageRangeSeparator ( const WideString & separator )

pure virtual

Sets the separator between the page ranges.

Parameters

separator [IN] - the separator string.

virtual void IIndexOptions::SetReferencedCharacterStyle ( const PMString & style )

pure virtual

Sets the paragraph style used for formatting the cross-reference index entries in the index story.

Parameters

style [IN] - the style name for the cross-references.

virtual void IIndexOptions::SetReplaceExistingIndexFlag ( bool16 replaceExistingIndex = kFalse )

pure virtual

Sets the "replace existing" flag option.

Parameters

replaceExistingIndex [IN] - the flag for replacing an existing index.

virtual void IIndexOptions::SetScope ( const IIndexOptions::Scope scope = kDocumentScope )

pure virtual

Sets the scope of the index.

Parameters

scope [IN] - the scope of the index.

virtual void IIndexOptions::SetSectionHeaderParagraphStyle ( const PMString & style )

pure virtual

Sets the paragraph style used for formatting the section headers in the index story.

Parameters

style [IN] - the style name for the section headers.

virtual void IIndexOptions::SetShowEmptySectionsFlag ( bool16 showEmptySections = kFalse )

pure virtual

Sets the flag that specifies whether the empty section headers are included in the index.

Parameters

showEmptySections [IN] - the flag value.

virtual void IIndexOptions::SetShowEntriesOnHiddenLayerFlag ( bool16 showEntriesOnHiddenLayer = kFalse )

pure virtual

Sets the flag that specifies if the topics included on hidden layers should be included in the index.

Parameters

showEntriesOnHiddenLayer [IN] - flag for the option.

virtual void IIndexOptions::SetShowSectionHeadersFlag ( bool16 showSectionHeaders = kTrue )

pure virtual

Sets the flag that specifies whether the section headers are included in the index.

Parameters

showSectionHeaders [IN] - flag value.

virtual void IIndexOptions::SetTitle ( const WideString & indexTitle )

pure virtual

Sets the index title.

Parameters

indexTitle [IN] - the index title.

virtual void IIndexOptions::SetTitleParagraphStyle ( const PMString & style )

pure virtual

Sets the paragraph style for formatting the title of indexing story.

Parameters

style [IN] - the name of the paragraph style.

virtual void IIndexOptions::SetTopicLevelParagraphStyle	(	const int32	level,
		const PMString &	style
	)

pure virtual

Sets the paragraph style used for formatting the topics in the index story.

Parameters

level	[IN] - level of the topic.
style	[IN] - style name for the specified level.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation