TOCFormatEntryInfo Class Reference

#include <TOCEntryInfo.h>

Public Types
typedef object_type	data_type

Public Member Functions
	TOCFormatEntryInfo ()
	TOCFormatEntryInfo (const PMString &sourceDoc, const UID paraFormatStyle, const int32 level, const bool16 bSort, const ITOCCmdData::PageNumPosition position, const UID pageNumFormatStyle, const WideString separator, const UID separatorStyle, const bool16 bRunIn, const WideString runInSep, const bool16 includeSectionName)
bool16	operator== (const TOCFormatEntryInfo &other) const
void	ReadWrite (IPMStream *s)

Public Attributes
PMString	fSourceDoc
UID	fParaFormatStyle
int16	fLevel
bool16	fLevelSort
ITOCCmdData::PageNumPosition	fPosition
UID	fPageNumFormatStyle
WideString	fSeparator
UID	fSeparatorStyle
bool16	fRunIn
WideString	fRunInSep
bool16	fIncludeSectionName

Detailed Description

Helper class to cache formating information for each table of content(TOC) entry. This class has the sort information.

Constructor & Destructor Documentation

TOCFormatEntryInfo::TOCFormatEntryInfo ( )

inline

Default constructor.

TOCFormatEntryInfo::TOCFormatEntryInfo ( const PMString &  sourceDoc, const UID  paraFormatStyle, const int32  level, const bool16  bSort, const ITOCCmdData::PageNumPosition  position, const UID  pageNumFormatStyle, const WideString  separator, const UID  separatorStyle, const bool16  bRunIn, const WideString  runInSep, const bool16  includeSectionName  )

inline

Copy constructor with given values.

Parameters

sourceDoc	IN document name from the paraFormatStyle from
paraFormatStyle	IN the UID of paragraph style to format TOC entries
level	IN level of paragraph style included in TOC
bSort	IN sort flag for paragraph style included in TOC
position	IN position for where page number should be inserted
pageNumFormatStyle	IN the UID of character style to format page number of TOC entry
separator	IN separator between TOC entry and page number
separatorStyle	IN the UID of character style to separator of TOC entry
bRunIn	IN run in flag for TOC entry
runInSep	IN run in separator
includeSectionName	IN flag for including section name of page number

Member Function Documentation

bool16 TOCFormatEntryInfo::operator== ( const TOCFormatEntryInfo &  other ) const

inline

Equal operator for comparison.

Parameters

other

IN the object to compare with.

Returns

bool16 kTrue means equal, otherwise kFalse.

void TOCFormatEntryInfo::ReadWrite ( IPMStream *  s )

inline

Persist the table of content entries(TOCFormatEntryInfo) in the document.

Parameters

s	IN stream where we read/write object of TOCFormatEntryInfo.