#include <fl_TOCLayout.h>

Inheritance diagram for fl_TOCLayout:

Public Member Functions
	fl_TOCLayout (FL_DocLayout pLayout, fl_DocSectionLayout pDocSL, pf_Frag_Strux sdh, PT_AttrPropIndex ap, fl_ContainerLayout pMyContainerLayout)
virtual	~fl_TOCLayout ()
virtual bool	doclistener_changeStrux (const PX_ChangeRecord_StruxChange *pcrxc)
virtual bool	doclistener_deleteStrux (const PX_ChangeRecord_Strux *pcrx)
virtual bool	doclistener_deleteEndTOC (const PX_ChangeRecord_Strux *pcrx)
virtual bool	bl_doclistener_insertEndTOC (fl_ContainerLayout , const PX_ChangeRecord_Strux pcrx, pf_Frag_Strux sdh, PL_ListenerId lid, void(pfnBindHandles)(pf_Frag_Strux sdhNew, PL_ListenerId lid, fl_ContainerLayout sfhNew))
virtual void	format (void)
virtual void	updateLayout (bool bDoFull)
virtual void	collapse (void)
virtual void	markAllRunsDirty (void)
virtual fl_SectionLayout *	getSectionLayout (void) const
bool	recalculateFields (UT_uint32 iUpdateCount)
virtual void	redrawUpdate (void)
virtual fp_Container *	getNewContainer (fp_Container *=NULL)
fl_DocSectionLayout *	getDocSectionLayout (void) const
bool	isEndTOCIn (void) const
void	setTOCEndIn (void)
TOCEntry *	createNewEntry (fl_BlockLayout *pBL)
PT_DocPosition	getDocPosition (void)
UT_uint32	getLength (void)
fl_BlockLayout *	findMatchingBlock (fl_BlockLayout *pBlock)
UT_sint32	isInVector (fl_BlockLayout pBlock, UT_GenericVector< TOCEntry > *pVecBlocks)
UT_uint32	getTOCPID (void) const
bool	isTOCEmpty () const
bool	isStyleInTOC (UT_UTF8String &sStyle)
bool	isBlockInTOC (fl_BlockLayout *pBlock)
bool	addBlock (fl_BlockLayout *pBlock, bool bVerifyRange=true)
bool	removeBlock (fl_BlockLayout *pBlock)
fl_BlockLayout *	getMatchingBlock (fl_BlockLayout *pBlock)
UT_UTF8String &	getTOCListLabel (fl_BlockLayout *pBlock)
UT_UTF8String &	getTOCHeading (void)
UT_sint32	getCurrentLevel (void) const
FootnoteType	getNumType (UT_sint32 iLevel)
eTabLeader	getTabLeader (UT_sint32 iLevel)
UT_sint32	getTabPosition (UT_sint32 iLevel, const fl_BlockLayout *pBlock)
void	setSelected (bool bSetSelected)
bool	isSelected (void)
const UT_UTF8String &	getRangeBookmarkName () const
bool	verifyBookmarkAssumptions ()
bool	fillTOC (void)
Static Public Member Functions
static std::string	getDefaultHeading ()
static UT_UTF8String	getDefaultSourceStyle (UT_uint32 iLevel)
static UT_UTF8String	getDefaultDestStyle (UT_uint32 iLevel)
Private Member Functions
virtual void	_purgeLayout (void)
virtual void	_lookupProperties (const PP_AttrProp *pAP)
void	_createTOCContainer (void)
bool	_isStyleInTOC (UT_UTF8String &sStyle, UT_UTF8String &sTOCStyle)
void	_insertTOCContainer (fp_TOCContainer *pNewTOC)
void	_localCollapse ()
void	_createAndFillTOCEntry (PT_DocPosition posStart, PT_DocPosition posEnd, fl_BlockLayout pPrevBL, const char pszStyle, UT_sint32 iAllBlocks)
void	_addBlockInVec (fl_BlockLayout *pBlock, UT_UTF8String &sStyle)
void	_removeBlockInVec (fl_BlockLayout *pBlock, bool bDontRecurse=false)
void	_calculateLabels (void)
UT_sint32	_getStartValue (TOCEntry *pEntry)
Private Attributes
bool	m_bNeedsRebuild
bool	m_bNeedsFormat
bool	m_bIsOnPage
UT_uint32	m_iTOCPID
fl_DocSectionLayout *	m_pDocSL
bool	m_bHasEndTOC
bool	m_bDoingPurge
bool	m_bIsSelected
UT_UTF8String	m_sSourceStyle1
UT_UTF8String	m_sSourceStyle2
UT_UTF8String	m_sSourceStyle3
UT_UTF8String	m_sSourceStyle4
UT_UTF8String	m_sDestStyle1
UT_UTF8String	m_sDestStyle2
UT_UTF8String	m_sDestStyle3
UT_UTF8String	m_sDestStyle4
UT_UTF8String	m_sNumOff1
UT_UTF8String	m_sNumOff2
UT_UTF8String	m_sNumOff3
UT_UTF8String	m_sNumOff4
FootnoteType	m_iNumType1
FootnoteType	m_iNumType2
FootnoteType	m_iNumType3
FootnoteType	m_iNumType4
eTabLeader	m_iTabLeader1
eTabLeader	m_iTabLeader2
eTabLeader	m_iTabLeader3
eTabLeader	m_iTabLeader4
UT_GenericVector< TOCEntry * >	m_vecEntries
UT_sint32	m_iCurrentLevel
UT_UTF8String	m_sTOCHeading
bool	m_bTOCHeading
UT_UTF8String	m_sTOCHeadingStyle
FootnoteType	m_iLabType1
FootnoteType	m_iLabType2
FootnoteType	m_iLabType3
FootnoteType	m_iLabType4
UT_UTF8String	m_sLabBefore1
UT_UTF8String	m_sLabBefore2
UT_UTF8String	m_sLabBefore3
UT_UTF8String	m_sLabBefore4
UT_UTF8String	m_sLabAfter1
UT_UTF8String	m_sLabAfter2
UT_UTF8String	m_sLabAfter3
UT_UTF8String	m_sLabAfter4
UT_UTF8String	m_sRangeBookmark
bool	m_bHasLabel1
bool	m_bHasLabel2
bool	m_bHasLabel3
bool	m_bHasLabel4
bool	m_bInherit1
bool	m_bInherit2
bool	m_bInherit3
bool	m_bInherit4
UT_sint32	m_iStartAt1
UT_sint32	m_iStartAt2
UT_sint32	m_iStartAt3
UT_sint32	m_iStartAt4
bool	m_bMissingBookmark
bool	m_bFalseBookmarkEstimate
UT_NumberVector	m_vecBookmarkPositions
Friends
class	fl_DocListener
class	fp_FootnoteContainer

Constructor & Destructor Documentation

fl_TOCLayout::fl_TOCLayout	(	FL_DocLayout *	pLayout,
		fl_DocSectionLayout *	pDocSL,
		pf_Frag_Strux *	sdh,
		PT_AttrPropIndex	ap,
		fl_ContainerLayout *	pMyContainerLayout
	)

References FL_DocLayout::addTOC(), fl_ContainerLayout::getContainerType(), m_pDocSL, fl_SectionLayout::m_pLayout, and UT_ASSERT.

fl_TOCLayout::~fl_TOCLayout ( ) [virtual]

References _purgeLayout(), fl_ContainerLayout::getFirstContainer(), fl_ContainerLayout::getLastContainer(), fp_Container::getNext(), fl_SectionLayout::m_pLayout, FL_DocLayout::removeTOC(), fl_ContainerLayout::setFirstContainer(), fl_ContainerLayout::setLastContainer(), and UT_DEBUGMSG.

Member Function Documentation

void fl_TOCLayout::_addBlockInVec	(	fl_BlockLayout *	pBlock,
		UT_UTF8String &	sStyle
	)			`[private]`

void fl_TOCLayout::_calculateLabels ( void ) [private]

References _getStartValue(), TOCEntry::calculateLabel(), UT_Stack::getDepth(), UT_GenericVector< T >::getItemCount(), TOCEntry::getLevel(), UT_GenericVector< T >::getNthItem(), TOCEntry::getPosInList(), m_vecEntries, UT_Stack::pop(), UT_Stack::push(), TOCEntry::setPosInList(), UT_ASSERT, and UT_Stack::viewTop().

Referenced by _createAndFillTOCEntry(), and removeBlock().

void fl_TOCLayout::_createAndFillTOCEntry	(	PT_DocPosition	posStart,
		PT_DocPosition	posEnd,
		fl_BlockLayout *	pPrevBL,
		const char *	pszStyle,
		UT_sint32	iAllBlocks
	)			`[private]`

void fl_TOCLayout::_createTOCContainer ( void ) [private]

This method creates a new TOC.

References fillTOC(), fl_ContainerLayout::getContainerType(), fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getLastContainer(), fp_ContainerObject::getWidth(), fl_ContainerLayout::lookupProperties(), m_bHasEndTOC, fl_ContainerLayout::myContainingLayout(), fl_ContainerLayout::setFirstContainer(), fl_ContainerLayout::setLastContainer(), fp_VerticalContainer::setWidth(), and UT_ASSERT.

Referenced by doclistener_changeStrux(), and getNewContainer().

UT_sint32 fl_TOCLayout::_getStartValue ( TOCEntry * pEntry ) [private]

References TOCEntry::getLevel(), m_iStartAt1, m_iStartAt2, m_iStartAt3, and m_iStartAt4.

Referenced by _calculateLabels().

void fl_TOCLayout::_insertTOCContainer ( fp_TOCContainer * pNewTOC ) [private]

This method inserts the given TOCContainer into its correct place in the Vertical container.

References fp_Container::addCon(), fp_Container::countCons(), fp_Container::findCon(), fp_Container::getContainer(), fl_ContainerLayout::getContainerType(), fp_TableContainer::getFirstBrokenTable(), fl_ContainerLayout::getFirstContainer(), fp_TableContainer::getLastBrokenTable(), fl_ContainerLayout::getLastContainer(), fl_ContainerLayout::getPrev(), fp_Container::insertConAt(), fl_ContainerLayout::myContainingLayout(), fp_TOCContainer::setContainer(), UT_ASSERT, UT_return_if_fail, UT_SHOULD_NOT_HAPPEN, and xxx_UT_DEBUGMSG.

Referenced by doclistener_changeStrux(), and getNewContainer().

bool fl_TOCLayout::_isStyleInTOC	(	UT_UTF8String &	sStyle,
		UT_UTF8String &	sTOCStyle
	)			`[private]`

Does a case insensitive search of the basedon heirachy for a match.

References PD_Style::getBasedOn(), PD_Style::getName(), PD_Document::getStyle(), fl_Layout::m_pDoc, UT_UTF8String::utf8_str(), and xxx_UT_DEBUGMSG.

Referenced by addBlock(), and isStyleInTOC().

void fl_TOCLayout::_localCollapse ( void ) [private]

References fp_TOCContainer::clearScreen(), fl_ContainerLayout::collapse(), fl_ContainerLayout::getFirstContainer(), fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getNext(), and fl_SectionLayout::m_bNeedsReformat.

Referenced by collapse().

void fl_TOCLayout::_lookupProperties ( const PP_AttrProp * pSectionAP ) [private, virtual]

this function is only to be called by fl_ContainerLayout::lookupProperties() all other code must call lookupProperties() instead

Implements fl_ContainerLayout.

References UT_UTF8String::clear(), FL_DocLayout::FootnoteTypeFromString(), gchar, getDefaultDestStyle(), getDefaultHeading(), getDefaultSourceStyle(), PP_AttrProp::getProperty(), m_bHasLabel1, m_bHasLabel2, m_bHasLabel3, m_bHasLabel4, m_bInherit1, m_bInherit2, m_bInherit3, m_bInherit4, m_bTOCHeading, m_iLabType1, m_iLabType2, m_iLabType3, m_iLabType4, m_iNumType1, m_iNumType2, m_iNumType3, m_iNumType4, m_iStartAt1, m_iStartAt2, m_iStartAt3, m_iStartAt4, m_iTabLeader1, m_iTabLeader2, m_iTabLeader3, m_iTabLeader4, m_iTOCPID, fl_SectionLayout::m_pLayout, m_sDestStyle1, m_sDestStyle2, m_sDestStyle3, m_sDestStyle4, m_sLabAfter1, m_sLabAfter2, m_sLabAfter3, m_sLabAfter4, m_sLabBefore1, m_sLabBefore2, m_sLabBefore3, m_sLabBefore4, m_sNumOff1, m_sNumOff2, m_sNumOff3, m_sNumOff4, m_sRangeBookmark, m_sSourceStyle1, m_sSourceStyle2, m_sSourceStyle3, m_sSourceStyle4, m_sTOCHeading, m_sTOCHeadingStyle, and UT_return_if_fail.

void fl_TOCLayout::_purgeLayout ( void ) [private, virtual]

This method removes all layout structures contained by this layout structure.

Reimplemented from fl_SectionLayout.

References UT_GenericVector< T >::clear(), fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getNext(), m_bDoingPurge, m_vecEntries, fl_ContainerLayout::setFirstLayout(), fl_ContainerLayout::setLastLayout(), UT_DEBUGMSG, and UT_VECTOR_PURGEALL.

Referenced by collapse(), fillTOC(), and ~fl_TOCLayout().

void fl_TOCLayout::_removeBlockInVec	(	fl_BlockLayout *	pBlock,
		bool	bDontRecurse = `false`
	)			`[private]`

bool fl_TOCLayout::addBlock	(	fl_BlockLayout *	pBlock,
		bool	bVerifyRange = `true`
	)

References _addBlockInVec(), _isStyleInTOC(), UT_GenericVector< T >::addItem(), UT_GenericVector< T >::clear(), gchar, fp_BookmarkRun::getBookmarkedDocPosition(), fl_ContainerLayout::getContainerType(), FL_DocLayout::getDocument(), fl_ContainerLayout::getFirstLayout(), fl_BlockLayout::getFirstRun(), FL_DocLayout::getFirstSection(), UT_GenericVector< T >::getItemCount(), fp_BookmarkRun::getName(), fl_ContainerLayout::getNextBlockInDocument(), fp_Run::getNextRun(), UT_GenericVector< T >::getNthItem(), fl_BlockLayout::getPosition(), fl_BlockLayout::getStyle(), fp_Run::getType(), PD_Document::isBookmarkUnique(), FL_DocLayout::isLayoutFilling(), fp_BookmarkRun::isStartOfBookmark(), m_bFalseBookmarkEstimate, m_bMissingBookmark, m_iCurrentLevel, fl_Layout::m_pDoc, fl_SectionLayout::m_pLayout, m_sDestStyle1, m_sDestStyle2, m_sDestStyle3, m_sDestStyle4, m_sRangeBookmark, m_sSourceStyle1, m_sSourceStyle2, m_sSourceStyle3, m_sSourceStyle4, m_vecBookmarkPositions, UT_UTF8String::size(), UT_ASSERT_HARMLESS, UT_return_val_if_fail, UT_SHOULD_NOT_HAPPEN, and UT_UTF8String::utf8_str().

Referenced by FL_DocLayout::addOrRemoveBlockFromTOC(), and fillTOC().

bool fl_TOCLayout::bl_doclistener_insertEndTOC	(	fl_ContainerLayout *	,
		const PX_ChangeRecord_Strux *	pcrx,
		pf_Frag_Strux *	sdh,
		PL_ListenerId	lid,
		void()(pf_Frag_Strux sdhNew, PL_ListenerId lid, fl_ContainerLayout *sfhNew)	pfnBindHandles
	)			`[virtual]`

References fillTOC(), FV_View::getPoint(), PX_ChangeRecord::getPosition(), FL_DocLayout::getView(), FV_View::isActive(), FV_View::isPreview(), m_bHasEndTOC, fl_SectionLayout::m_pLayout, fl_Layout::setEndStruxDocHandle(), and FV_View::setPoint().

Referenced by fl_DocListener::insertStrux().

void fl_TOCLayout::collapse ( void ) [virtual]

TOCEntry * fl_TOCLayout::createNewEntry ( fl_BlockLayout * pBL )

bool fl_TOCLayout::doclistener_changeStrux ( const PX_ChangeRecord_StruxChange * pcrxc ) [virtual]

Implements fl_SectionLayout.

References _createTOCContainer(), _insertTOCContainer(), collapse(), getDocSectionLayout(), fl_ContainerLayout::getFirstContainer(), PX_ChangeRecord::getIndexAP(), fl_ContainerLayout::getLastContainer(), fp_Container::getPage(), PX_ChangeRecord::getType(), fl_ContainerLayout::lookupProperties(), fl_Layout::setAttrPropIndex(), fl_DocSectionLayout::setNeedsSectionBreak(), and UT_ASSERT.

Referenced by fl_DocListener::change().

bool fl_TOCLayout::doclistener_deleteEndTOC ( const PX_ChangeRecord_Strux * pcrx ) [virtual]

This signals an incomplete footnote section.

References m_bHasEndTOC.

bool fl_TOCLayout::doclistener_deleteStrux ( const PX_ChangeRecord_Strux * pcrx ) [virtual]

References collapse(), FL_DocLayout::findPage(), fl_SectionLayout::getDocLayout(), getDocSectionLayout(), fl_ContainerLayout::getFirstContainer(), fp_Container::getPage(), PX_ChangeRecord::getType(), fl_ContainerLayout::myContainingLayout(), fl_ContainerLayout::remove(), fl_DocSectionLayout::setNeedsSectionBreak(), UT_ASSERT, and UT_UNUSED.

bool fl_TOCLayout::fillTOC ( void )

References fl_BlockLayout::_doInsertTOCHeadingRun(), _purgeLayout(), addBlock(), FL_CONTAINER_BLOCK, gchar, fp_Run::getBlock(), fp_BookmarkRun::getBookmarkedDocPosition(), fl_ContainerLayout::getContainerType(), fl_SectionLayout::getDocLayout(), fl_ContainerLayout::getFirstLayout(), fl_BlockLayout::getFirstRun(), FL_DocLayout::getFirstSection(), PD_Style::getIndexAP(), fp_BookmarkRun::getName(), fl_ContainerLayout::getNextBlockInDocument(), fp_Run::getNextRun(), fl_BlockLayout::getPosition(), getRangeBookmarkName(), fl_Layout::getStruxDocHandle(), PD_Document::getStyle(), fl_BlockLayout::getStyle(), fp_Run::getType(), fl_ContainerLayout::insert(), PD_Document::isBookmarkUnique(), isStyleInTOC(), m_bTOCHeading, fl_Layout::m_pDoc, m_sTOCHeadingStyle, UT_UTF8String::size(), UT_ASSERT_HARMLESS, UT_SHOULD_NOT_HAPPEN, and UT_UTF8String::utf8_str().

Referenced by _createTOCContainer(), bl_doclistener_insertEndTOC(), FL_DocLayout::fillLayouts(), FL_DocLayout::updateTOCsOnBookmarkChange(), and verifyBookmarkAssumptions().

fl_BlockLayout * fl_TOCLayout::findMatchingBlock ( fl_BlockLayout * pBlock )

References TOCEntry::getBlock(), UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), fl_Layout::getStruxDocHandle(), and m_vecEntries.

Referenced by getMatchingBlock().

void fl_TOCLayout::format ( void ) [virtual]

Implements fl_ContainerLayout.

References fl_ContainerLayout::format(), fl_ContainerLayout::getFirstContainer(), fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getLastContainer(), getNewContainer(), fl_ContainerLayout::getNext(), fp_CellContainer::layout(), m_bNeedsFormat, fl_SectionLayout::m_bNeedsReformat, UT_DEBUGMSG, and xxx_UT_DEBUGMSG.

Referenced by updateLayout().

UT_sint32 fl_TOCLayout::getCurrentLevel ( void ) const [inline]

Referenced by fl_BlockLayout::fl_BlockLayout().

UT_UTF8String fl_TOCLayout::getDefaultDestStyle ( UT_uint32 iLevel ) [static]

References PP_Property::getInitial(), PP_lookupProperty(), UT_ASSERT_HARMLESS, UT_SHOULD_NOT_HAPPEN, UT_UTF8String_sprintf(), and UT_UTF8String::utf8_str().

Referenced by ODe_Text_Listener::_initDefaultHeadingStyles(), _lookupProperties(), and ODe_HeadingSearcher_Listener::openTOC().

std::string fl_TOCLayout::getDefaultHeading ( ) [static]

References XAP_App::getApp(), XAP_App::getStringSet(), and XAP_StringSet::getValueUTF8().

Referenced by IE_Exp_HTML_Listener::_insertTOC(), _lookupProperties(), and ODe_Text_Listener::openTOC().

UT_UTF8String fl_TOCLayout::getDefaultSourceStyle ( UT_uint32 iLevel ) [static]

References PP_Property::getInitial(), PP_lookupProperty(), UT_ASSERT_HARMLESS, UT_SHOULD_NOT_HAPPEN, UT_UTF8String_sprintf(), and UT_UTF8String::utf8_str().

Referenced by _lookupProperties().

PT_DocPosition fl_TOCLayout::getDocPosition ( void )

Returns the position in the document of the PTX_SectionTOC strux This is very useful for determining the value of the footnote reference and anchor.

References FL_DocLayout::getDocument(), fl_Layout::getStruxDocHandle(), PD_Document::getStruxPosition(), and fl_SectionLayout::m_pLayout.

Referenced by getLength().

fl_DocSectionLayout* fl_TOCLayout::getDocSectionLayout ( void ) const [inline, virtual]

Reimplemented from fl_ContainerLayout.

Referenced by _createAndFillTOCEntry(), fp_TOCContainer::deleteBrokenTOCs(), doclistener_changeStrux(), and doclistener_deleteStrux().

UT_uint32 fl_TOCLayout::getLength ( void )

This method returns the length of the footnote. This is such that getDocPosition() + getLength() is one value beyond the the EndFootnote strux

References getDocPosition(), FL_DocLayout::getDocument(), PD_Document::getNextStruxOfType(), fl_Layout::getStruxDocHandle(), PD_Document::getStruxPosition(), fl_SectionLayout::m_pLayout, PTX_EndTOC, and UT_ASSERT.

fl_BlockLayout * fl_TOCLayout::getMatchingBlock ( fl_BlockLayout * pBlock )

References findMatchingBlock().

Referenced by FL_DocLayout::getMatchingBlocksFromTOCs().

fp_Container * fl_TOCLayout::getNewContainer ( fp_Container * = NULL ) [virtual]

Create a new TOC container.

Returns:: The newly created TOC container

Implements fl_SectionLayout.

References _createTOCContainer(), _insertTOCContainer(), fl_ContainerLayout::getLastContainer(), and UT_DEBUGMSG.

Referenced by format().

FootnoteType fl_TOCLayout::getNumType ( UT_sint32 iLevel )

References m_iNumType1, m_iNumType2, m_iNumType3, m_iNumType4, UT_ASSERT, and UT_SHOULD_NOT_HAPPEN.

Referenced by fl_BlockLayout::getTOCNumType().

const UT_UTF8String& fl_TOCLayout::getRangeBookmarkName ( ) const [inline]

Referenced by fillTOC(), and FL_DocLayout::updateTOCsOnBookmarkChange().

fl_SectionLayout * fl_TOCLayout::getSectionLayout ( void ) const [virtual]

Implements fl_ContainerLayout.

References fl_ContainerLayout::getContainerType(), and fl_ContainerLayout::myContainingLayout().

Referenced by FL_DocLayout::fillLayouts().

eTabLeader fl_TOCLayout::getTabLeader ( UT_sint32 iLevel )

References m_iTabLeader1, m_iTabLeader2, m_iTabLeader3, m_iTabLeader4, UT_ASSERT, and UT_SHOULD_NOT_HAPPEN.

Referenced by fl_BlockLayout::getTOCTabLeader().

UT_sint32 fl_TOCLayout::getTabPosition	(	UT_sint32	iLevel,
		const fl_BlockLayout *	pBlock
	)

References fl_ContainerLayout::getFirstContainer(), fl_BlockLayout::getLeftMargin(), fp_VerticalContainer::getWidth(), m_sNumOff1, m_sNumOff2, m_sNumOff3, m_sNumOff4, UT_ASSERT, UT_convertToLogicalUnits(), UT_SHOULD_NOT_HAPPEN, and UT_UTF8String::utf8_str().

Referenced by fl_BlockLayout::getTOCTabPosition().

UT_UTF8String& fl_TOCLayout::getTOCHeading ( void ) [inline]

Referenced by fp_FieldTOCHeadingRun::calculateValue().

UT_UTF8String & fl_TOCLayout::getTOCListLabel ( fl_BlockLayout * pBlock )

References UT_UTF8String::clear(), TOCEntry::getBlock(), TOCEntry::getFullLabel(), UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), fl_Layout::getStruxDocHandle(), and m_vecEntries.

Referenced by fp_FieldTOCListLabelRun::calculateValue().

UT_uint32 fl_TOCLayout::getTOCPID ( void ) const [inline]

Referenced by fp_TOCContainer::getValue().

bool fl_TOCLayout::isBlockInTOC ( fl_BlockLayout * pBlock )

References TOCEntry::getBlock(), UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), fl_Layout::getStruxDocHandle(), and m_vecEntries.

Referenced by FL_DocLayout::addOrRemoveBlockFromTOC(), FL_DocLayout::getMatchingBlocksFromTOCs(), FL_DocLayout::isBlockInTOC(), and FL_DocLayout::removeBlockFromTOC().

bool fl_TOCLayout::isEndTOCIn ( void ) const [inline]

UT_sint32 fl_TOCLayout::isInVector	(	fl_BlockLayout *	pBlock,
		UT_GenericVector< TOCEntry * > *	pVecBlocks
	)

References TOCEntry::getBlock(), UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), and fl_Layout::getStruxDocHandle().

Referenced by removeBlock().

bool fl_TOCLayout::isSelected ( void ) [inline]

Referenced by fp_Run::isInSelectedTOC().

bool fl_TOCLayout::isStyleInTOC ( UT_UTF8String & sStyle )

References _isStyleInTOC(), m_sSourceStyle1, m_sSourceStyle2, m_sSourceStyle3, and m_sSourceStyle4.

Referenced by FL_DocLayout::addOrRemoveBlockFromTOC(), and fillTOC().

bool fl_TOCLayout::isTOCEmpty ( ) const [inline]

Referenced by FL_DocLayout::fillLayouts().

void fl_TOCLayout::markAllRunsDirty ( void ) [virtual]

Implements fl_SectionLayout.

References fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getNext(), and fl_ContainerLayout::markAllRunsDirty().

Referenced by _createAndFillTOCEntry(), _removeBlockInVec(), and setSelected().

bool fl_TOCLayout::recalculateFields ( UT_uint32 iUpdateCount ) [virtual]

Reimplemented from fl_SectionLayout.

References fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getNext(), and fl_ContainerLayout::recalculateFields().

Referenced by FL_DocLayout::recalculateTOCFields().

void fl_TOCLayout::redrawUpdate ( void ) [virtual]

Implements fl_ContainerLayout.

References fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getNext(), fl_ContainerLayout::needsRedraw(), and fl_ContainerLayout::redrawUpdate().

bool fl_TOCLayout::removeBlock ( fl_BlockLayout * pBlock )

References _calculateLabels(), _removeBlockInVec(), fp_TOCContainer::clearScreen(), fl_ContainerLayout::getFirstContainer(), isInVector(), FL_DocLayout::isLayoutDeleting(), m_bDoingPurge, fl_SectionLayout::m_pLayout, and m_vecEntries.

Referenced by FL_DocLayout::addOrRemoveBlockFromTOC(), and FL_DocLayout::removeBlockFromTOC().

void fl_TOCLayout::setSelected ( bool bSetSelected )

References fp_TOCContainer::forceClearScreen(), fl_ContainerLayout::getFirstContainer(), FL_DocLayout::getView(), m_bIsSelected, fl_SectionLayout::m_pLayout, markAllRunsDirty(), and FV_View::updateScreen().

Referenced by FV_Selection::setMode(), and FV_Selection::setTOCSelected().

void fl_TOCLayout::setTOCEndIn ( void )

Set boolean to tell that TOCend has been inserted. Also makes sure the layout is fully filled.

References m_bHasEndTOC.

void fl_TOCLayout::updateLayout ( bool bDoFull ) [virtual]

Implements fl_ContainerLayout.

References UT_GenericVector< T >::clear(), fl_ContainerLayout::format(), format(), fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getNext(), fl_SectionLayout::m_vecFormatLayout, fl_ContainerLayout::needsReformat(), and fl_SectionLayout::needsReformat().

bool fl_TOCLayout::verifyBookmarkAssumptions ( )

References fillTOC(), FL_DocLayout::getDocument(), PD_Document::isBookmarkUnique(), FL_DocLayout::isLayoutFilling(), m_bFalseBookmarkEstimate, m_bMissingBookmark, fl_Layout::m_pDoc, fl_SectionLayout::m_pLayout, m_sRangeBookmark, UT_UTF8String::size(), UT_return_val_if_fail, and UT_UTF8String::utf8_str().

Referenced by FL_DocLayout::fillLayouts().

Friends And Related Function Documentation

friend class fl_DocListener [friend]

Reimplemented from fl_SectionLayout.

friend class fp_FootnoteContainer [friend]

Member Data Documentation

bool fl_TOCLayout::m_bDoingPurge [private]

Referenced by _purgeLayout(), and removeBlock().

bool fl_TOCLayout::m_bFalseBookmarkEstimate [private]

Referenced by addBlock(), and verifyBookmarkAssumptions().

bool fl_TOCLayout::m_bHasEndTOC [private]

Referenced by _createTOCContainer(), bl_doclistener_insertEndTOC(), doclistener_deleteEndTOC(), and setTOCEndIn().

bool fl_TOCLayout::m_bHasLabel1 [private]

Referenced by _lookupProperties(), and createNewEntry().

bool fl_TOCLayout::m_bHasLabel2 [private]

Referenced by _lookupProperties(), and createNewEntry().

bool fl_TOCLayout::m_bHasLabel3 [private]

Referenced by _lookupProperties(), and createNewEntry().

bool fl_TOCLayout::m_bHasLabel4 [private]

Referenced by _lookupProperties(), and createNewEntry().

bool fl_TOCLayout::m_bInherit1 [private]

Referenced by _lookupProperties(), and createNewEntry().

bool fl_TOCLayout::m_bInherit2 [private]

Referenced by _lookupProperties(), and createNewEntry().

bool fl_TOCLayout::m_bInherit3 [private]

Referenced by _lookupProperties(), and createNewEntry().

bool fl_TOCLayout::m_bInherit4 [private]

Referenced by _lookupProperties(), and createNewEntry().

bool fl_TOCLayout::m_bIsOnPage [private]

bool fl_TOCLayout::m_bIsSelected [private]

Referenced by setSelected().

bool fl_TOCLayout::m_bMissingBookmark [private]

Referenced by addBlock(), and verifyBookmarkAssumptions().

bool fl_TOCLayout::m_bNeedsFormat [private]

Referenced by format().

bool fl_TOCLayout::m_bNeedsRebuild [private]

bool fl_TOCLayout::m_bTOCHeading [private]

Referenced by _lookupProperties(), and fillTOC().

UT_sint32 fl_TOCLayout::m_iCurrentLevel [private]

Referenced by _addBlockInVec(), addBlock(), and createNewEntry().

FootnoteType fl_TOCLayout::m_iLabType1 [private]

Referenced by _lookupProperties(), and createNewEntry().

FootnoteType fl_TOCLayout::m_iLabType2 [private]

Referenced by _lookupProperties(), and createNewEntry().

FootnoteType fl_TOCLayout::m_iLabType3 [private]

Referenced by _lookupProperties(), and createNewEntry().

FootnoteType fl_TOCLayout::m_iLabType4 [private]

Referenced by _lookupProperties(), and createNewEntry().

FootnoteType fl_TOCLayout::m_iNumType1 [private]

Referenced by _lookupProperties(), and getNumType().

FootnoteType fl_TOCLayout::m_iNumType2 [private]

Referenced by _lookupProperties(), and getNumType().

FootnoteType fl_TOCLayout::m_iNumType3 [private]

Referenced by _lookupProperties(), and getNumType().

FootnoteType fl_TOCLayout::m_iNumType4 [private]

Referenced by _lookupProperties(), and getNumType().

UT_sint32 fl_TOCLayout::m_iStartAt1 [private]

Referenced by _getStartValue(), _lookupProperties(), and createNewEntry().

UT_sint32 fl_TOCLayout::m_iStartAt2 [private]

Referenced by _getStartValue(), _lookupProperties(), and createNewEntry().

UT_sint32 fl_TOCLayout::m_iStartAt3 [private]

Referenced by _getStartValue(), _lookupProperties(), and createNewEntry().

UT_sint32 fl_TOCLayout::m_iStartAt4 [private]

Referenced by _getStartValue(), _lookupProperties(), and createNewEntry().

eTabLeader fl_TOCLayout::m_iTabLeader1 [private]

Referenced by _lookupProperties(), and getTabLeader().

eTabLeader fl_TOCLayout::m_iTabLeader2 [private]

Referenced by _lookupProperties(), and getTabLeader().

eTabLeader fl_TOCLayout::m_iTabLeader3 [private]

Referenced by _lookupProperties(), and getTabLeader().

eTabLeader fl_TOCLayout::m_iTabLeader4 [private]

Referenced by _lookupProperties(), and getTabLeader().

UT_uint32 fl_TOCLayout::m_iTOCPID [private]

Referenced by _lookupProperties().

fl_DocSectionLayout* fl_TOCLayout::m_pDocSL [private]

Referenced by fl_TOCLayout().

UT_UTF8String fl_TOCLayout::m_sDestStyle1 [private]

Referenced by _lookupProperties(), addBlock(), and createNewEntry().

UT_UTF8String fl_TOCLayout::m_sDestStyle2 [private]

Referenced by _lookupProperties(), addBlock(), and createNewEntry().

UT_UTF8String fl_TOCLayout::m_sDestStyle3 [private]

Referenced by _lookupProperties(), addBlock(), and createNewEntry().

UT_UTF8String fl_TOCLayout::m_sDestStyle4 [private]

Referenced by _lookupProperties(), addBlock(), and createNewEntry().

UT_UTF8String fl_TOCLayout::m_sLabAfter1 [private]

Referenced by _lookupProperties(), and createNewEntry().

UT_UTF8String fl_TOCLayout::m_sLabAfter2 [private]

Referenced by _lookupProperties(), and createNewEntry().

UT_UTF8String fl_TOCLayout::m_sLabAfter3 [private]

Referenced by _lookupProperties(), and createNewEntry().

UT_UTF8String fl_TOCLayout::m_sLabAfter4 [private]

Referenced by _lookupProperties(), and createNewEntry().

UT_UTF8String fl_TOCLayout::m_sLabBefore1 [private]

Referenced by _lookupProperties(), and createNewEntry().

UT_UTF8String fl_TOCLayout::m_sLabBefore2 [private]

Referenced by _lookupProperties(), and createNewEntry().

UT_UTF8String fl_TOCLayout::m_sLabBefore3 [private]

Referenced by _lookupProperties(), and createNewEntry().

UT_UTF8String fl_TOCLayout::m_sLabBefore4 [private]

Referenced by _lookupProperties(), and createNewEntry().

UT_UTF8String fl_TOCLayout::m_sNumOff1 [private]

Referenced by _lookupProperties(), and getTabPosition().

UT_UTF8String fl_TOCLayout::m_sNumOff2 [private]

Referenced by _lookupProperties(), and getTabPosition().

UT_UTF8String fl_TOCLayout::m_sNumOff3 [private]

Referenced by _lookupProperties(), and getTabPosition().

UT_UTF8String fl_TOCLayout::m_sNumOff4 [private]

Referenced by _lookupProperties(), and getTabPosition().

UT_UTF8String fl_TOCLayout::m_sRangeBookmark [private]

Referenced by _lookupProperties(), addBlock(), and verifyBookmarkAssumptions().

UT_UTF8String fl_TOCLayout::m_sSourceStyle1 [private]

Referenced by _lookupProperties(), addBlock(), and isStyleInTOC().

UT_UTF8String fl_TOCLayout::m_sSourceStyle2 [private]

Referenced by _lookupProperties(), addBlock(), and isStyleInTOC().

UT_UTF8String fl_TOCLayout::m_sSourceStyle3 [private]

Referenced by _lookupProperties(), addBlock(), and isStyleInTOC().

UT_UTF8String fl_TOCLayout::m_sSourceStyle4 [private]

Referenced by _lookupProperties(), addBlock(), and isStyleInTOC().

UT_UTF8String fl_TOCLayout::m_sTOCHeading [private]

Referenced by _lookupProperties().

UT_UTF8String fl_TOCLayout::m_sTOCHeadingStyle [private]

Referenced by _lookupProperties(), and fillTOC().

UT_NumberVector fl_TOCLayout::m_vecBookmarkPositions [private]

Referenced by addBlock().

UT_GenericVector<TOCEntry *> fl_TOCLayout::m_vecEntries [private]

Referenced by _addBlockInVec(), _calculateLabels(), _createAndFillTOCEntry(), _purgeLayout(), _removeBlockInVec(), findMatchingBlock(), getTOCListLabel(), isBlockInTOC(), and removeBlock().

The documentation for this class was generated from the following files:

fl_TOCLayout Class Reference

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation