#include <ITOCCmdData.h>

Inheritance diagram for ITOCCmdData:

Public Types
enum	{ kDefaultIID = IID_ITOCCMDDATA }

enum	PageNumPosition { kAfterEntry, kBeforeEntry, kNotIncluded }

Public Member Functions
virtual const bool16	GetIncludeHidderLayerFlag () const =0

virtual const bool16	GetReplaceExistingTOCFlag () const =0

virtual const bool16	GetIncludeBookPubs () const =0

virtual const bool16	GetRunInFlag () const =0

virtual void	SetIncludeHidderLayerFlag (const bool16 includeHidderLayer=kFalse)=0

virtual void	SetReplaceExistingTOCFlag (const bool16 replaceExistingTOC=kFalse)=0

virtual void	SetIncludeBookPubs (const bool16 includeBookPubs=kFalse)=0

virtual void	SetRunInFlag (const bool16 runIn=kFalse)=0

virtual const PMString &	GetBookName () const =0

virtual void	SetBookName (const PMString &bookName)=0

virtual const bool16	GetIncludeOversetFlag () const =0

virtual void	SetIncludeOversetFlag (bool16 includeOverset)=0

virtual void	SetFormatEntryMap (const FormatEntriesInfo &formatStyleMap)=0

virtual const FormatEntriesInfo &	GetFormatEntryMap () const =0

virtual const bool16	GetIncludeBookmarks () const =0

virtual void	SetIncludeBookmarks (const bool16 bIncludeBookmarks=kFalse)=0

virtual const UIDRef &	GetTargetItem () const =0

virtual void	SetTargetItem (const UIDRef &sourceItem)=0

virtual const PMString	GetTOCTitle () const =0

virtual void	SetTOCTitle (const PMString &tocTitle)=0

virtual const UID	GetTOCTitleFormatStyle () const =0

virtual void	SetTOCTitleFormatStyle (const UID formatStyle)=0

virtual const UIDRef &	GetTextModelUIDRef () const =0

virtual void	SetTextModelUIDRef (const UIDRef &textModelUIDRef=UIDRef(nil, kInvalidUID))=0

virtual void	SetTOCEntryInfoList (const K2Vector< TOCEntryInfo > &tocEntryInfoList)=0

virtual const K2Vector < TOCEntryInfo > &	GetTOCEntryInfoList () const =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 PMString &	GetTOCStyleName () const =0

virtual void	SetTOCStyleName (const PMString &styleName)=0

virtual const bool16	GetCreateTextAnchor () const =0

virtual void	SetCreateTextAnchor (bool16 createAnchor)=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

This interface is used for accessing command data for creating/editing table of content(TOC) style or table of content story. Some functions are only used for CreateTOCCmd, some functions are only used for FormatTOCCmd, some functions are used as a bridge for CreateTOCCmd and FormatTOCCmd and some functions are used for commands related to table of content styles.

See Also: kCreateTOCCmdBoss, kFormatTOCCmdBoss, kCreateTOCStyleCmdBoss and kEditTOCStyleCmdBoss.

Member Enumeration Documentation

enum ITOCCmdData::PageNumPosition

Enum values for page number position. kAfterEntry means displaying page number after page entry. kBeforeEntry means displaying page number before page entry. kNotIncluded means don't displaying page number.

Member Function Documentation

virtual const PMString& ITOCCmdData::GetBookName ( ) const

pure virtual

Get the book name which is valid when includeBookPubs flag is set as kTrue. This is used for CreateTOCCmd.

Parameters

none

Returns: const PMString& the book name.

virtual const bool16 ITOCCmdData::GetCreateTextAnchor ( ) const

pure virtual

Get the create text anchor flag.

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

virtual const FormatEntriesInfo& ITOCCmdData::GetFormatEntryMap ( ) const

pure virtual

Get the format map. This is used for FormatTOCCmd.

Parameters

none

Returns: const FormatEntriesInfo& the format information map.

virtual const bool16 ITOCCmdData::GetIncludeBookmarks ( ) const

pure virtual

Get the include bookmark flag to determine if we should include bookmark information when generating table of content. Those bookmarks can be seen through bookmark panel. This is used for FormatTOCCmd.

Parameters

none

Returns: const bool16 the boolean flag.

virtual const bool16 ITOCCmdData::GetIncludeBookPubs ( ) const

pure virtual

Get the boolean data determiningif we should include all the documents in book when collecting table of content entries. This is used for CreateTOCCmd.

Parameters

none

Returns: const bool16 the boolean flag.

virtual const bool16 ITOCCmdData::GetIncludeHidderLayerFlag ( ) const

pure virtual

Get the boolean data for hidder layer to determine if we should include hidder layer when collecting table of content entries. This is used for CreateTOCCmd.

Parameters

none

Returns: const bool16 the boolean flag.

virtual const bool16 ITOCCmdData::GetIncludeOversetFlag ( ) const

pure virtual

Get the include overset flag to determine if we should include table of content entries in overset. In fact, the include overset flag is set in runtime through user's input(a warning dialog). Currently, the function is only used for scripting to control the default behavior if we should include overset or not. This is used for CreateTOCCmd.

Parameters

none

Returns: const bool16& the boolean flag.

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

pure virtual

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

Parameters

none

Returns: ITOCStyleInfo::TOCNumberedParagraphsEntriesType the type of entry tobe generated for Numbered Paragraphs.

virtual const bool16 ITOCCmdData::GetRemoveForcedLineBreak ( ) const

pure virtual

Get the remove line feed flag.

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

virtual const bool16 ITOCCmdData::GetReplaceExistingTOCFlag ( ) const

pure virtual

Get the boolean data about replacing existing table of content story. This is used for CreateTOCCmd.

Parameters

none

Returns: const bool16 the boolean flag.

virtual const bool16 ITOCCmdData::GetRunInFlag ( ) const

pure virtual

Get the boolean data of runin to determine if we should display the table of content entries as runin. This is used for CreateTOCCmd.

Parameters

none

Returns: const bool16 the boolean flag.

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

pure virtual

Get the direction for the table of content(TOC) story to be generated.

Parameters

none

Returns: ITOCStyleInfo::TOCStoryDirection the story direction.

virtual const UIDRef& ITOCCmdData::GetTargetItem ( ) const

pure virtual

Get the UIDRef of a target(document or document/session workspace) where the table of content story will be placed on.

Parameters

none

Returns: const UIDRef& UIDRef of target.

virtual const UIDRef& ITOCCmdData::GetTextModelUIDRef ( ) const

pure virtual

Get the UIDRef of a story in which the table of content will be stored in.

Parameters

none

Returns: const UIDRef& the UIDRef of a story.

virtual const K2Vector<TOCEntryInfo>& ITOCCmdData::GetTOCEntryInfoList ( ) const

pure virtual

Get the list of table of content entries which includes information about original included paragraph style name, page number and format style. We then use the original style name to find all the format information through format entry map. This is used in FormatTOCCmd.

Parameters

none

Returns: const K2Vector<TOCEntryInfo>& the table of content entry information list.

virtual const PMString& ITOCCmdData::GetTOCStyleName ( ) const

pure virtual

Get the name of table of content(TOC) style. This is used for creating/editing table of content(TOC) style command.

Parameters

none

Returns: const PMString& the name of the style.

virtual const PMString ITOCCmdData::GetTOCTitle ( ) const

pure virtual

Get the string for table of content story's title.

Parameters

none

Returns: const PMString the title string.

virtual const UID ITOCCmdData::GetTOCTitleFormatStyle ( ) const

pure virtual

Get the format style(paragraph style) for table of content story's title.

Parameters

none

Returns: const UID the UID of a paragraph style.

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

pure virtual

Set the book name which needs to be set only when includeBookPubs flag is set as kTrue. This is used for CreateTOCCmd.

Parameters

bookName IN the name to be set for book.

virtual void ITOCCmdData::SetCreateTextAnchor ( bool16 createAnchor )

pure virtual

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

Parameters

createAnchor IN the boolean flag to be set.

virtual void ITOCCmdData::SetFormatEntryMap ( const FormatEntriesInfo & formatStyleMap )

pure virtual

Set the format map for original style name and its corresponding format information. The style map is set before processing CreateTOCCmd and get before processing FormatTOCCmd. The format information includes(format style for included paragraph style, indent level, page number position, page number format style, separator for entry and page number, separator's format style.

See Also: TOCFormatEntryInfo. This is used for FormatTOCCmd.

Parameters

formatStyleMap IN the format information map.

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

pure virtual

Set the include bookmark flag. This is used for FormatTOCCmd.

Parameters

bIncludeBookmarks IN the boolean flag to be set.

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

pure virtual

Set the include documents in book flag. This is used for CreateTOCCmd.

Parameters

includeBookPubs IN the boolean data to be set. By default, it sets as kFalse.

virtual void ITOCCmdData::SetIncludeHidderLayerFlag ( const bool16 includeHidderLayer = kFalse )

pure virtual

Set the include hidden layer flag. This is used for CreateTOCCmd.

Parameters

includeHidderLayer IN the boolean data to be set. By default, it sets as kFalse.

virtual void ITOCCmdData::SetIncludeOversetFlag ( bool16 includeOverset )

pure virtual

Set the include overset flag. This is used for CreateTOCCmd.

Parameters

includeOverset IN the boolean flag to be set.

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

pure virtual

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

Parameters

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

virtual void ITOCCmdData::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 ITOCCmdData::SetReplaceExistingTOCFlag ( const bool16 replaceExistingTOC = kFalse )

pure virtual

Set the replace existing table of content story flag. This is used for CreateTOCCmd.

Parameters

replaceExistingTOC IN the boolean data to be set. By default, it sets as kFalse.

virtual void ITOCCmdData::SetRunInFlag ( const bool16 runIn = kFalse )

pure virtual

Set the runin flag. This is used for CreateTOCCmd.

Parameters

runIn IN the boolean data to be set. By default, it sets as kFalse.

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

pure virtual

Set the direction for the table of content(TOC) story to be generated.

Parameters

storyDirection IN the direction to be set.

virtual void ITOCCmdData::SetTargetItem ( const UIDRef & sourceItem )

pure virtual

Set the UIDRef of a target(document or document/session workspace).

Parameters

sourceItem the target to be set.

virtual void ITOCCmdData::SetTextModelUIDRef ( const UIDRef & textModelUIDRef = UIDRef(nil, kInvalidUID) )

pure virtual

Set the UIDRef of a story to be the table of content story. By default, it is UIDRef(nil, kInvalidUID) which means that we need to create a new story to hold the table of content. If we pass in a valid UIDRef, it means the passed in story will be the table of content story.

Parameters

textModelUIDRef IN the story to be set.

virtual void ITOCCmdData::SetTOCEntryInfoList ( const K2Vector< TOCEntryInfo > & tocEntryInfoList )

pure virtual

Set the list of table of content entries and each entry contains information about original included paragraph style name, page number and format style. We set this information in CreateTOCCmd.

See Also: TOCEntryInfo

Parameters

tocEntryInfoList IN the list to be set.

virtual void ITOCCmdData::SetTOCStyleName ( const PMString & styleName )

pure virtual

Set the name of table of content(TOC) style. This is used for creating/editing table of content(TOC) style command.

Parameters

styleName IN the style name to be set.

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

pure virtual

Set the string for table of content story's title.

Parameters

tocTitle IN the title string to be set.

virtual void ITOCCmdData::SetTOCTitleFormatStyle ( const UID formatStyle )

pure virtual

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

Parameters

formatStyle IN the UID of a paragraph style to be set as title's format style.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation