ITOCStyleInfo Class Reference

#include <ITOCStyleInfo.h>

Inheritance diagram for ITOCStyleInfo:

Public Types
enum	{ kDefaultIID = IID_ITOCSTYLEINFO }
enum	TOCStoryDirection { kHorizontal, kVertical }
enum	TOCNumberedParagraphsEntriesType { kIncludeFullParagraph, kIncludeNumbersOnly, kExcludeNumbers }

Public Member Functions
virtual const PMString &	GetName () const =0
virtual void	SetName (const PMString &s, bool16 translatable=kFalse)=0
virtual const FormatEntriesInfo &	GetTOCEntryMap () const =0
virtual void	SetTOCEntryMap (const FormatEntriesInfo &tocEntryMap)=0
virtual const bool16	GetIncludeHidderLayerFlag () const =0
virtual void	SetIncludeHidderLayerFlag (bool16 includeHidderLayer=kFalse)=0
virtual const bool16	GetIncludeBookPubs () const =0
virtual void	SetIncludeBookPubs (const bool16 includeBookPubs=kFalse)=0
virtual const bool16	GetRunInFlag () const =0
virtual void	SetRunInFlag (bool16 runIn=kFalse)=0
virtual const UID	GetTOCTitleFormatStyle () const =0
virtual void	SetTOCTitleFormatStyle (const UID formatStyle)=0
virtual const PMString &	GetTOCTitle () const =0
virtual void	SetTOCTitle (const PMString &tocTitle)=0
virtual const PMString &	GetBookName () const =0
virtual void	SetBookName (const PMString &bookName)=0
virtual const bool16	GetIncludeBookmarks () const =0
virtual void	SetIncludeBookmarks (const bool16 bIncludeBookmarks=kFalse)=0
virtual const ITOCStyleInfo::TOCStoryDirection	GetStoryDirection () const =0
virtual void	SetStoryDirection (const ITOCStyleInfo::TOCStoryDirection storyDirection=ITOCStyleInfo::kHorizontal)=0
virtual const ITOCStyleInfo::TOCNumberedParagraphsEntriesType	GetNumberedParagraphsEntriesType () const =0
virtual void	SetNumberedParagraphsEntriesType (const ITOCStyleInfo::TOCNumberedParagraphsEntriesType numberedParagraphsEntriesType=ITOCStyleInfo::kIncludeFullParagraph)=0
virtual const bool16	GetCreateTextAnchor () const =0
virtual void	SetCreateTextAnchor (bool16 insertTextAnchor)=0
virtual const bool16	GetRemoveForcedLineBreak () const =0
virtual void	SetRemoveForcedLineBreak (bool16 removeForcedLineBreak)=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 interface for the non-attribute parts of a table of content style. It is necessary for anything listed by an ITOCStyleNameTable. This interface may be part of the style itself, or part of a command that operates on styles.

See Also

ITOCStyleNameTable

Member Enumeration Documentation

enum ITOCStyleInfo::TOCNumberedParagraphsEntriesType

Enum value about the type of entries to be generated for numbered paragraphs.

Enumerator
kIncludeFullParagraph	kIncludeFullParagraph : Include the numbering and the paragraph text.
kIncludeNumbersOnly	kIncludeNumbersOnly : Include the numbers only.
kExcludeNumbers	kExcludeNumbers : Include the paragraph text only and exclude the numbers.

enum ITOCStyleInfo::TOCStoryDirection

Enum value about story direction for generated table of content story.

Member Function Documentation

virtual const PMString& ITOCStyleInfo::GetBookName ( ) const

pure virtual

Get the book name if we want to include all the documents in book when generate table of content.

Parameters

none

Returns

const PMString& the name of the book.

virtual const bool16 ITOCStyleInfo::GetCreateTextAnchor ( ) const

pure virtual

Get the create text anchor flag.

Returns

bool16 kTrue create text anchor at source paragraph, otherwise kFalse.

virtual const bool16 ITOCStyleInfo::GetIncludeBookmarks ( ) const

pure virtual

Get the flag about whether to include bookmarks or not when generate table of content.

Parameters

none

Returns

bool16 kTrue means we do include bookmarks, otherwise kFalse.

virtual const bool16 ITOCStyleInfo::GetIncludeBookPubs ( ) const

pure virtual

Get the flag about include all the documents in the book or not when generate table of content(TOC).

Parameters

none

Returns

bool16 kTrue menas include all the documents in the book, otherwise kFalse.

virtual const bool16 ITOCStyleInfo::GetIncludeHidderLayerFlag ( ) const

pure virtual

Get the flag about include hidder layer or not when generate table of content(TOC).

Parameters

none

Returns

bool16 kTrue means include hidder layer, otherwise kFalse.

virtual const PMString& ITOCStyleInfo::GetName ( ) const

pure virtual

Get the name of this style.

Parameters

none

Returns

const PMString& the name of the style.

virtual const ITOCStyleInfo::TOCNumberedParagraphsEntriesType ITOCStyleInfo::GetNumberedParagraphsEntriesType ( ) const

pure virtual

Get the type of entries for Numbered Paragraphs to be generated.

Parameters

none

Returns

ITOCStyleInfo::TOCNumberedParagraphsEntriesType the type of entry to be generated for numbered paragraphs.

virtual const bool16 ITOCStyleInfo::GetRemoveForcedLineBreak ( ) const

pure virtual

Get the remove line feed flag.

Returns

bool16 kTrue remove line feed at source paragraph, otherwise kFalse.

virtual const bool16 ITOCStyleInfo::GetRunInFlag ( ) const

pure virtual

Get the flag about if we should honor run-in.

Parameters

none

Returns

bool16 kTrue means do honor run-in, otherwise kFalse.

virtual const ITOCStyleInfo::TOCStoryDirection ITOCStyleInfo::GetStoryDirection ( ) const

pure virtual

Get the story direction for the generated table of content story.

Parameters

none

Returns

ITOCStyleInfo::TOCStoryDirection the story direction.

virtual const FormatEntriesInfo& ITOCStyleInfo::GetTOCEntryMap ( ) const

pure virtual

Get the map of included paragraph style and its format information of this style. The key is original paragraph style name and the value is the corresponding format information.

See Also

TOCFormatEntryInfo.

Parameters

none

Returns

const FormatEntriesInfo& a list of included style and its format information.

virtual const PMString& ITOCStyleInfo::GetTOCTitle ( ) const

pure virtual

Get the title for table of content story.

Parameters

none

Returns

const PMString& IN the title for table of content story.

virtual const UID ITOCStyleInfo::GetTOCTitleFormatStyle ( ) const

pure virtual

Get the format style for table of content's title.

Parameters

none

Returns

const UID IN the format style.

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

pure virtual

Set the book name.

Parameters

bookName

IN the name to be set for book.

virtual void ITOCStyleInfo::SetCreateTextAnchor ( bool16  insertTextAnchor )

pure virtual

Set the flag which inserts text anchor at source paragraph location. This is for html/epub export.

Parameters

insertTextAnchor

IN the boolean flag to be set.

virtual void ITOCStyleInfo::SetIncludeBookmarks ( const bool16  bIncludeBookmarks = kFalse )

pure virtual

Set the flag about whether to include bookmarks or not.

Parameters

bIncludeBookmarks

IN the boolean flag to be set.

virtual void ITOCStyleInfo::SetIncludeBookPubs ( const bool16  includeBookPubs = kFalse )

pure virtual

Set the flag about include all the documents in the book or not.

Parameters

includeBookPubs

IN the boolean flag to be set.

virtual void ITOCStyleInfo::SetIncludeHidderLayerFlag ( bool16  includeHidderLayer = kFalse )

pure virtual

Set the flag about include hidder layer.

Parameters

includeHidderLayer

IN the boolean flag to be set.

virtual void ITOCStyleInfo::SetName ( const PMString &  s, bool16  translatable = kFalse  )

pure virtual

Set the name of this style.

Parameters

s	IN the style name to be set.
translatable	IN flag indicates if style name should be translated or not. It would always be kFalse for user-specified names and kTrue for predefined style.

virtual void ITOCStyleInfo::SetNumberedParagraphsEntriesType ( const ITOCStyleInfo::TOCNumberedParagraphsEntriesType  numberedParagraphsEntriesType = ITOCStyleInfo::kIncludeFullParagraph )

pure virtual

Set the type of entries for Numbered Paragraphs to be generated.

Parameters

numberedParagraphsEntriesType

IN the type of entries to be generated for numbered paragraphs.

virtual void ITOCStyleInfo::SetRemoveForcedLineBreak ( bool16  removeForcedLineBreak )

pure virtual

Set the flag which removes line feed at source paragraph location.

Parameters

removeForcedLineBreak

IN the boolean flag to be set.

virtual void ITOCStyleInfo::SetRunInFlag ( bool16  runIn = kFalse )

pure virtual

Get the flag about run-in.

Parameters

runIn

IN the boolean flag to be set.

virtual void ITOCStyleInfo::SetStoryDirection ( const ITOCStyleInfo::TOCStoryDirection  storyDirection = ITOCStyleInfo::kHorizontal )

pure virtual

Set the story direction for the generated table of content story.

Parameters

storyDirection

IN the story direction to be set.

virtual void ITOCStyleInfo::SetTOCEntryMap ( const FormatEntriesInfo &  tocEntryMap )

pure virtual

Set the included style and its corresponding format information into the style.

Parameters

tocEntryMap

IN the new map.

virtual void ITOCStyleInfo::SetTOCTitle ( const PMString &  tocTitle )

pure virtual

Set the title for table of content story.

Parameters

tocTitle

IN the title to be set as table of content story.

virtual void ITOCStyleInfo::SetTOCTitleFormatStyle ( const UID  formatStyle )

pure virtual

Set the format style for table of content's title.

Parameters

formatStyle

IN the style used to format the table of content's title.