#include <fl_SectionLayout.h>

Inheritance diagram for fl_DocSectionLayout:

Public Member Functions
	fl_DocSectionLayout (FL_DocLayout pLayout, pf_Frag_Strux sdh, PT_AttrPropIndex ap, SectionType iType)
virtual	~fl_DocSectionLayout ()
fl_DocSectionLayout *	getNextDocSection (void) const
fl_DocSectionLayout *	getPrevDocSection (void) const
virtual void	format (void)
virtual void	updateLayout (bool bDoFull)
void	updateDocSection (void)
virtual void	collapse (void)
virtual fp_Container *	getFirstContainer (void) const
virtual fp_Container *	getLastContainer (void) const
virtual void	setFirstContainer (fp_Container *pCon)
virtual void	setLastContainer (fp_Container *pCon)
fl_FootnoteLayout *	getFootnoteLayout (UT_uint32 footnotePID)
fl_AnnotationLayout *	getAnnotationLayout (UT_uint32 footnotePID)
virtual void	markAllRunsDirty (void)
virtual fl_SectionLayout *	getSectionLayout (void) const
virtual void	redrawUpdate (void)
virtual fp_Container *	getNewContainer (fp_Container *pFirstContainer=NULL)
UT_sint32	getLeftMargin (void) const
UT_sint32	getRightMargin (void) const
UT_sint32	getTopMargin (void) const
UT_sint32	getBottomMargin (void) const
UT_sint32	getFooterMargin (void) const
UT_sint32	getHeaderMargin (void) const
UT_sint32	getSpaceAfter (void) const
UT_sint32	getMaxSectionColumnHeight (void) const
UT_sint32	getColumnGap (void) const
UT_uint32	getFootnoteLineThickness (void) const
UT_uint32	getFootnoteYoff (void) const
void	completeBreakSection (void)
bool	arePageNumbersRestarted (void) const
UT_sint32	getRestartedPageNumber (void) const
UT_uint32	getNumColumns (void) const
bool	getColumnLineBetween (void) const
UT_uint32	getColumnOrder (void) const
void	setPaperColor ()
void	deleteEmptyColumns (void)
virtual bool	doclistener_changeStrux (const PX_ChangeRecord_StruxChange *pcrxc)
bool	doclistener_deleteStrux (const PX_ChangeRecord_Strux *pcrx)
virtual bool	bl_doclistener_insertFootnote (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 bool	bl_doclistener_insertAnnotation (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))
void	setHdrFtr (HdrFtrType iType, fl_HdrFtrSectionLayout *pHFSL)
fl_HdrFtrSectionLayout *	getHeader (void) const
fl_HdrFtrSectionLayout *	getFooter (void) const
fl_HdrFtrSectionLayout *	getHeaderEven (void) const
fl_HdrFtrSectionLayout *	getFooterEven (void) const
fl_HdrFtrSectionLayout *	getHeaderFirst (void) const
fl_HdrFtrSectionLayout *	getFooterFirst (void) const
fl_HdrFtrSectionLayout *	getHeaderLast (void) const
fl_HdrFtrSectionLayout *	getFooterLast (void) const
bool	setHdrFtrHeightChange (bool bDoHdr, UT_sint32 newHeight)
void	addOwnedPage (fp_Page *)
void	prependOwnedHeaderPage (fp_Page *p_Page)
void	prependOwnedFooterPage (fp_Page *p_Page)
void	deleteOwnedPage (fp_Page *, bool bReallyDeleteIT=true)
fp_Page *	getFirstOwnedPage (void) const
void	markForRebuild (void)
void	clearRebuild (void)
bool	needsRebuild (void) const
void	checkAndAdjustColumnGap (UT_sint32 iLayoutWidth)
void	markForReformat (void)
bool	needsReFormat (void) const
bool	isThisPageValid (HdrFtrType hfType, fp_Page *pThisPage) const
bool	isFirstPageValid (void) const
void	getVecOfHdrFtrs (UT_GenericVector< fl_HdrFtrSectionLayout * > *vecHdrFtr) const
void	formatAllHdrFtr (void)
void	doMarginChangeOnly (void)
void	checkAndRemovePages (void)
void	addValidPages (void)
UT_sint32	getPageCount (void) const
void	setNeedsSectionBreak (bool bSet, fp_Page *pPage)
bool	needsSectionBreak (void) const
void	setFirstEndnoteContainer (fp_EndnoteContainer *pECon)
void	setLastEndnoteContainer (fp_EndnoteContainer *pECon)
fp_Container *	getFirstEndnoteContainer (void) const
fp_Container *	getLastEndnoteContainer (void) const
void	deleteBrokenTablesFromHere (fl_ContainerLayout *pTL)
UT_sint32	getWidth (void) const
UT_sint32	getActualColumnHeight (void) const
UT_sint32	getActualColumnWidth (void) const
bool	isCollapsing (void) const
Static Public Member Functions
static void	_HdrFtrChangeCallback (UT_Worker *pWorker)
Private Member Functions
virtual void	_lookupProperties (const PP_AttrProp *pAP)
virtual void	_lookupMarginProperties (const PP_AttrProp *pAP)
Private Attributes
fb_ColumnBreaker	m_ColumnBreaker
fl_HdrFtrSectionLayout *	m_pHeaderSL
fl_HdrFtrSectionLayout *	m_pFooterSL
fl_HdrFtrSectionLayout *	m_pHeaderEvenSL
fl_HdrFtrSectionLayout *	m_pFooterEvenSL
fl_HdrFtrSectionLayout *	m_pHeaderFirstSL
fl_HdrFtrSectionLayout *	m_pFooterFirstSL
fl_HdrFtrSectionLayout *	m_pHeaderLastSL
fl_HdrFtrSectionLayout *	m_pFooterLastSL
UT_uint32	m_iNumColumns
UT_sint32	m_iColumnGap
bool	m_bColumnLineBetween
UT_uint32	m_iColumnOrder
UT_sint32	m_iSpaceAfter
bool	m_bRestart
UT_sint32	m_iRestartValue
UT_sint32	m_iLeftMargin
double	m_dLeftMarginUserUnits
UT_sint32	m_iRightMargin
double	m_dRightMarginUserUnits
UT_sint32	m_iTopMargin
double	m_dTopMarginUserUnits
UT_sint32	m_iBottomMargin
double	m_dBottomMarginUserUnits
UT_sint32	m_iFooterMargin
double	m_dFooterMarginUserUnits
UT_sint32	m_iHeaderMargin
double	m_dHeaderMarginUserUnits
UT_sint32	m_iMaxSectionColumnHeight
double	m_dMaxSectionColumnHeight
UT_sint32	m_iFootnoteLineThickness
UT_sint32	m_iFootnoteYoff
fp_Column *	m_pFirstColumn
	First column in the section.
fp_Column *	m_pLastColumn
	Last column in the section.
fp_Page *	m_pFirstOwnedPage
UT_sint32	m_iPageCount
bool	m_bNeedsFormat
bool	m_bNeedsRebuild
bool	m_bNeedsSectionBreak
fp_EndnoteContainer *	m_pFirstEndnoteContainer
fp_EndnoteContainer *	m_pLastEndnoteContainer
bool	m_bDeleteingBrokenContainers
std::string	m_sPaperColor
std::string	m_sScreenColor
UT_sint32	m_iNewHdrHeight
UT_sint32	m_iNewFtrHeight
UT_Worker *	m_pHdrFtrChangeTimer
std::string	m_sHdrFtrChangeProps
bool	m_bDoingCollapse
Friends
class	fl_DocListener

Constructor & Destructor Documentation

fl_DocSectionLayout::fl_DocSectionLayout	(	FL_DocLayout *	pLayout,
		pf_Frag_Strux *	sdh,
		PT_AttrPropIndex	ap,
		SectionType	iType
	)

References FL_SECTION_DOC, FL_DocLayout::getDocument(), fl_ContainerLayout::lookupProperties(), fl_Layout::m_pDoc, m_sPaperColor, m_sScreenColor, and UT_ASSERT.

fl_DocSectionLayout::~fl_DocSectionLayout ( ) [virtual]

References fl_SectionLayout::_purgeLayout(), DELETEP, UT_GenericVector< T >::getItemCount(), fp_Container::getNext(), UT_GenericVector< T >::getNthItem(), getVecOfHdrFtrs(), m_pFirstColumn, m_pHdrFtrChangeTimer, and UT_Worker::stop().

Member Function Documentation

void fl_DocSectionLayout::_HdrFtrChangeCallback ( UT_Worker * pWorker ) [static]

The calback that implements the HdrFtr size change

References AV_CHG_HDRFTR, AV_CHG_MOTION, PD_Document::changeStruxFmtNoUndo(), DELETEP, FV_View::ensureInsertionPointOnScreen(), FL_DocLayout::findPage(), format(), formatAllHdrFtr(), PD_Document::getAllowChangeInsPoint(), fl_Layout::getDocument(), FV_View::getEditShadow(), fp_Page::getHdrFtrP(), fl_HdrFtrShadow::getHdrFtrSectionLayout(), fl_HdrFtrSectionLayout::getHFType(), UT_Worker::getInstanceData(), FL_DocLayout::getNthPage(), fl_HdrFtrShadow::getPage(), FV_View::getPoint(), fl_ContainerLayout::getPrev(), fp_ShadowContainer::getShadow(), fl_Layout::getStruxDocHandle(), FL_DocLayout::getView(), FL_DocLayout::isLayoutFilling(), AD_Document::isPieceTableChanging(), PD_Document::isRedrawHappenning(), m_pHdrFtrChangeTimer, fl_SectionLayout::m_pLayout, m_sHdrFtrChangeProps, FV_View::notifyListeners(), PD_Document::notifyPieceTableChangeEnd(), PD_Document::notifyPieceTableChangeStart(), PD_SIGNAL_UPDATE_LAYOUT, PTC_AddFmt, FV_View::setHdrFtrEdit(), PD_Document::setMarginChangeOnly(), FV_View::setPoint(), PD_Document::signalListeners(), UT_Worker::stop(), updateLayout(), UT_DEBUGMSG, and UT_return_if_fail.

Referenced by setHdrFtrHeightChange().

void fl_DocSectionLayout::_lookupMarginProperties ( const PP_AttrProp * pAP ) [private, virtual]

Reimplemented from fl_ContainerLayout.

References fl_ContainerLayout::getFirstLayout(), UT_GenericVector< T >::getItemCount(), fl_ContainerLayout::getNext(), UT_GenericVector< T >::getNthItem(), getVecOfHdrFtrs(), and fl_ContainerLayout::lookupMarginProperties().

void fl_DocSectionLayout::_lookupProperties ( const PP_AttrProp * pAP ) [private, virtual]

Implements fl_ContainerLayout.

References AP_PREF_KEY_RulerUnits, FG_Graphic::createFromStrux(), DELETEP, dim, gchar, XAP_App::getApp(), PP_AttrProp::getAttribute(), FV_View::getBidiOrder(), fp_PageSize::getDefaultPageMargin(), fl_Layout::getDocument(), PD_Document::getNewFtrHeight(), PD_Document::getNewHdrHeight(), PP_AttrProp::getProperty(), FL_DocLayout::getView(), m_bColumnLineBetween, m_bRestart, m_dBottomMarginUserUnits, m_dFooterMarginUserUnits, m_dHeaderMarginUserUnits, m_dLeftMarginUserUnits, m_dRightMarginUserUnits, m_dTopMarginUserUnits, m_iBottomMargin, m_iColumnGap, m_iColumnOrder, m_iFooterMargin, m_iFootnoteLineThickness, m_iFootnoteYoff, m_iHeaderMargin, m_iLeftMargin, m_iMaxSectionColumnHeight, m_iNewFtrHeight, m_iNewHdrHeight, m_iNumColumns, m_iRestartValue, m_iRightMargin, m_iSpaceAfter, m_iTopMargin, fl_Layout::m_pDoc, fl_SectionLayout::m_pGraphicImage, fl_SectionLayout::m_pImageImage, fl_SectionLayout::m_pLayout, m_sHdrFtrChangeProps, PP_evalProperty(), PT_STRUX_IMAGE_DATAID, setPaperColor(), UT_ASSERT, UT_convertDimensionless(), UT_convertToLogicalUnits(), UT_DEBUGMSG, UT_determineDimension(), UT_return_if_fail, and UT_UTF8String::utf8_str().

void fl_DocSectionLayout::addOwnedPage ( fp_Page * pPage )

References fl_HdrFtrSectionLayout::addPage(), addValidPages(), checkAndRemovePages(), FL_HDRFTR_FOOTER, FL_HDRFTR_HEADER, fl_ContainerLayout::getAP(), fl_SectionLayout::getDocLayout(), fp_Page::getFillType(), FL_DocLayout::getGraphicTick(), fp_Page::getHdrFtrP(), fp_Page::getHeight(), fl_HdrFtrSectionLayout::getHFType(), UT_GenericVector< T >::getItemCount(), getNextDocSection(), UT_GenericVector< T >::getNthItem(), fp_Page::getOwningSection(), getVecOfHdrFtrs(), fp_Page::getWidth(), fl_SectionLayout::m_iGraphicTick, m_iPageCount, m_pFirstOwnedPage, fl_SectionLayout::m_pGraphicImage, fl_SectionLayout::m_pImageImage, m_sPaperColor, m_sScreenColor, fg_FillType::markTransparentForPrint(), prependOwnedFooterPage(), prependOwnedHeaderPage(), GR_Image::scaleImageTo(), fg_FillType::setColor(), fg_FillType::setDocLayout(), fl_SectionLayout::setImageHeight(), fg_FillType::setImagePointer(), fl_SectionLayout::setImageWidth(), and fg_FillType::setTransColor().

Referenced by FL_DocLayout::addNewPage(), fp_Page::insertColumnLeader(), and fp_Page::removeColumnLeader().

void fl_DocSectionLayout::addValidPages ( void )

This method adds valid pages to every valid header/footer in the docsection if they're not there already.

References fl_HdrFtrSectionLayout::addValidPages(), UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), and getVecOfHdrFtrs().

Referenced by addOwnedPage(), deleteOwnedPage(), redrawUpdate(), and updateLayout().

bool fl_DocSectionLayout::arePageNumbersRestarted ( void ) const [inline]

Referenced by fp_Page::resetFieldPageNumber().

bool fl_DocSectionLayout::bl_doclistener_insertAnnotation	(	fl_ContainerLayout *	pFootnote,
		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 PX_ChangeRecord::getIndexAP(), FV_View::getPoint(), PX_ChangeRecord::getPosition(), FL_DocLayout::getView(), fl_ContainerLayout::insert(), FV_View::isActive(), FV_View::isPreview(), fl_SectionLayout::m_pLayout, fl_ContainerLayout::myContainingLayout(), FV_View::setPoint(), and FV_View::updateCarets().

bool fl_DocSectionLayout::bl_doclistener_insertFootnote	(	fl_ContainerLayout *	pFootnote,
		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 PX_ChangeRecord::getIndexAP(), FV_View::getPoint(), PX_ChangeRecord::getPosition(), FL_DocLayout::getView(), fl_ContainerLayout::insert(), FV_View::isActive(), FV_View::isPreview(), fl_SectionLayout::m_pLayout, fl_ContainerLayout::myContainingLayout(), FV_View::setPoint(), and FV_View::updateCarets().

void fl_DocSectionLayout::checkAndAdjustColumnGap ( UT_sint32 iLayoutWidth )

References m_iColumnGap, m_iNumColumns, UT_ASSERT, and UT_convertToLogicalUnits().

void fl_DocSectionLayout::checkAndRemovePages ( void )

This method checks each header for valid pages and removes the page if it's not valid. ie it remove odd pages from even headers etc.

References fl_HdrFtrSectionLayout::checkAndRemovePages(), UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), and getVecOfHdrFtrs().

Referenced by addOwnedPage(), deleteOwnedPage(), FL_DocLayout::formatAll(), redrawUpdate(), setHdrFtr(), updateDocSection(), and updateLayout().

void fl_DocSectionLayout::clearRebuild ( void ) [inline]

Referenced by FL_DocLayout::rebuildFromHere().

void fl_DocSectionLayout::collapse ( void ) [virtual]

Implements fl_ContainerLayout.

References fl_HdrFtrSectionLayout::clearScreen(), fp_VerticalContainer::clearScreen(), fl_ContainerLayout::collapse(), fl_HdrFtrSectionLayout::collapse(), fp_Column::collapseEndnotes(), FL_DocLayout::deleteEmptyPages(), fp_Container::getColumn(), fl_ContainerLayout::getContainerType(), fl_SectionLayout::getDocLayout(), fl_ContainerLayout::getFirstContainer(), fl_ContainerLayout::getFirstLayout(), UT_GenericVector< T >::getItemCount(), fp_Column::getLeader(), fl_ContainerLayout::getNext(), fp_Container::getNext(), UT_GenericVector< T >::getNthItem(), fp_Column::getPage(), fb_ColumnBreaker::getStartPage(), getVecOfHdrFtrs(), fp_Page::isEmpty(), m_bDoingCollapse, m_ColumnBreaker, m_pFirstColumn, m_pFirstOwnedPage, m_pLastColumn, fp_Page::removeColumnLeader(), fp_VerticalContainer::removeContainer(), setFirstEndnoteContainer(), setLastEndnoteContainer(), fb_ColumnBreaker::setStartPage(), UT_ASSERT_HARMLESS, and UT_DEBUGMSG.

Referenced by FL_DocLayout::changeDocSections(), doclistener_deleteStrux(), fl_BlockLayout::doclistener_insertSection(), FL_DocLayout::formatAll(), FL_DocLayout::rebuildFromHere(), and updateLayout().

void fl_DocSectionLayout::completeBreakSection ( void )

References fb_ColumnBreaker::breakSection(), m_bNeedsSectionBreak, m_ColumnBreaker, fb_ColumnBreaker::setStartPage(), and updateLayout().

Referenced by fl_BlockLayout::doclistener_insertFrame(), and doMarginChangeOnly().

void fl_DocSectionLayout::deleteBrokenTablesFromHere ( fl_ContainerLayout * pTL )

References fp_TableContainer::deleteBrokenTables(), fp_TOCContainer::deleteBrokenTOCs(), fl_ContainerLayout::getContainerType(), fl_ContainerLayout::getFirstContainer(), fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getNext(), FL_DocLayout::isLayoutDeleting(), m_bDeleteingBrokenContainers, fl_SectionLayout::m_pLayout, and xxx_UT_DEBUGMSG.

Referenced by fp_TableContainer::deleteBrokenTables(), fp_TOCContainer::deleteBrokenTOCs(), and doMarginChangeOnly().

void fl_DocSectionLayout::deleteEmptyColumns ( void )

Delete Empty Column containers in this section.

References fp_Column::getFollower(), fp_Column::getLeader(), fp_Container::getNext(), fp_Column::getPage(), fp_Container::getPrev(), fp_Container::isEmpty(), m_pFirstColumn, m_pLastColumn, fp_Page::removeColumnLeader(), fp_ContainerObject::setNext(), fp_ContainerObject::setPrev(), and UT_ASSERT.

Referenced by FL_DocLayout::deleteEmptyColumnsAndPages().

void fl_DocSectionLayout::deleteOwnedPage	(	fp_Page *	pPage,
		bool	bReallyDeleteIt = `true`
	)

This method deletes the owned page from the DocSectionLayout and all the header files.

References addValidPages(), checkAndRemovePages(), FL_DocLayout::deletePage(), fl_HdrFtrSectionLayout::deletePage(), FL_DocLayout::findPage(), fl_SectionLayout::getDocLayout(), UT_GenericVector< T >::getItemCount(), fp_Page::getNext(), getNextDocSection(), UT_GenericVector< T >::getNthItem(), fp_Page::getOwningSection(), getVecOfHdrFtrs(), FL_DocLayout::isLayoutDeleting(), fl_HdrFtrSectionLayout::isPageHere(), m_iPageCount, m_pFirstOwnedPage, fl_SectionLayout::m_pLayout, UT_DEBUGMSG, and xxx_UT_DEBUGMSG.

Referenced by fp_Page::insertColumnLeader(), fp_Page::removeColumnLeader(), and fp_Page::~fp_Page().

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

Implements fl_SectionLayout.

References gchar, PD_Document::getAttrProp(), fl_Layout::getAttrPropIndex(), fl_SectionLayout::getDocLayout(), fl_Layout::getDocument(), fl_ContainerLayout::getFirstLayout(), PX_ChangeRecord::getIndexAP(), fl_ContainerLayout::getNext(), PP_AttrProp::getProperty(), PX_ChangeRecord::getType(), fl_ContainerLayout::lookupProperties(), FL_DocLayout::rebuildFromHere(), fl_Layout::setAttrPropIndex(), and UT_ASSERT.

Referenced by fl_DocListener::change(), and FL_DocLayout::changeDocSections().

bool fl_DocSectionLayout::doclistener_deleteStrux ( const PX_ChangeRecord_Strux * pcrx )

void fl_DocSectionLayout::doMarginChangeOnly ( void )

This method is called if the top and bottom margins of the pages have changed following an auto-resize request from the header. We try to avoid a complete rebuild.

References completeBreakSection(), deleteBrokenTablesFromHere(), gchar, fl_ContainerLayout::getAP(), PP_AttrProp::getAttribute(), FL_DocLayout::getFirstPage(), fp_Page::getNext(), getNextDocSection(), fp_Page::getOwningSection(), fl_ContainerLayout::lookupProperties(), fl_SectionLayout::m_pLayout, fp_Page::TopBotMarginChanged(), and UT_return_if_fail.

Referenced by FL_DocLayout::changeDocSections().

void fl_DocSectionLayout::format ( void ) [virtual]

Implements fl_ContainerLayout.

References fb_ColumnBreaker::breakSection(), fl_ContainerLayout::format(), FP_HIDDEN_REVISION, FP_HIDDEN_REVISION_AND_TEXT, FP_HIDDEN_TEXT, getFirstContainer(), fl_ContainerLayout::getFirstContainer(), fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getLastContainer(), fl_ContainerLayout::getNext(), FV_View::getShowPara(), FL_DocLayout::getView(), fl_ContainerLayout::isHidden(), FL_DocLayout::isLayoutFilling(), m_bNeedsFormat, m_ColumnBreaker, fl_SectionLayout::m_pLayout, fp_VerticalContainer::removeAll(), and UT_DEBUGMSG.

Referenced by _HdrFtrChangeCallback(), fl_HdrFtrSectionLayout::doclistener_deleteStrux(), doclistener_deleteStrux(), FL_DocLayout::formatAll(), getNewContainer(), FL_DocLayout::loadPendingObjects(), fl_DocListener::populateStrux(), updateDocSection(), and updateLayout().

void fl_DocSectionLayout::formatAllHdrFtr ( void )

This method formats all the header/footers

References fl_HdrFtrSectionLayout::format(), UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), getVecOfHdrFtrs(), and xxx_UT_DEBUGMSG.

Referenced by _HdrFtrChangeCallback(), and updateDocSection().

UT_sint32 fl_DocSectionLayout::getActualColumnHeight ( void ) const

Returns the usuable height of the Column in logical units (after subtracting top and bottom margins)

References DIM_IN, getBottomMargin(), fp_PageSize::getScale(), getTopMargin(), fp_PageSize::Height(), Height, FL_DocLayout::m_docViewPageSize, m_iMaxSectionColumnHeight, fl_SectionLayout::m_pLayout, and UT_LAYOUT_RESOLUTION.

Referenced by fb_ColumnBreaker::_breakSection(), fp_ImageRun::_lookupProperties(), FV_View::cmdInsertPositionedGraphic(), Defun1(), fp_FrameContainer::draw(), fp_FootnoteContainer::draw(), fp_FrameContainer::drawBoundaries(), fp_CellContainer::drawBroken(), fp_FrameContainer::drawHandles(), fp_AnnotationContainer::layout(), fp_FootnoteContainer::layout(), fb_ColumnBreaker::needsRebreak(), s_doFormatImageDlg(), and fp_TableContainer::wantVBreakAtNoFootnotes().

UT_sint32 fl_DocSectionLayout::getActualColumnWidth ( void ) const

Returns the usuable width of the Column in logical units (after subtracting left and right margins)

References DIM_IN, getLeftMargin(), getRightMargin(), fp_PageSize::getScale(), FL_DocLayout::m_docViewPageSize, m_iColumnGap, m_iNumColumns, fl_SectionLayout::m_pLayout, UT_LAYOUT_RESOLUTION, and fp_PageSize::Width().

Referenced by AP_UnixDialog_Lists::_gatherData(), fp_ImageRun::_lookupProperties(), fl_TableLayout::_lookupProperties(), fl_FrameLayout::_lookupProperties(), FV_View::cmdInsertPositionedGraphic(), Defun1(), FV_VisualDragText::getImageFromSelection(), AP_TopRuler::mouseRelease(), and s_doFormatImageDlg().

fl_AnnotationLayout * fl_DocSectionLayout::getAnnotationLayout ( UT_uint32 footnotePID )

References fl_AnnotationLayout::getAnnotationPID(), fl_ContainerLayout::getContainerType(), fl_ContainerLayout::getFirstLayout(), and fl_ContainerLayout::getNext().

UT_sint32 fl_DocSectionLayout::getColumnGap ( void ) const

References m_iColumnGap, and UT_ASSERT.

Referenced by fp_Line::_doClearScreenFromRunToEnd(), fp_Line::clearScreen(), fp_Page::getColumnGap(), FV_View::getTopRulerInfo(), and fp_Line::recalcMaxWidth().

bool fl_DocSectionLayout::getColumnLineBetween ( void ) const [inline]

Referenced by fp_Page::draw().

UT_uint32 fl_DocSectionLayout::getColumnOrder ( void ) const

References m_iColumnOrder.

Referenced by Defun1().

fp_Container * fl_DocSectionLayout::getFirstContainer ( void ) const [virtual]

Reimplemented from fl_ContainerLayout.

References m_pFirstColumn.

Referenced by fb_ColumnBreaker::_breakSection(), fp_MathRun::_lookupProperties(), fp_EmbedRun::_lookupProperties(), fl_HdrFtrSectionLayout::addValidPages(), fl_HdrFtrSectionLayout::changeIntoHdrFtrSection(), format(), fl_HdrFtrSectionLayout::getNewContainer(), and isFirstPageValid().

fp_Container * fl_DocSectionLayout::getFirstEndnoteContainer ( void ) const

References m_pFirstEndnoteContainer.

Referenced by fb_ColumnBreaker::_getNext(), FL_DocLayout::insertEndnoteContainer(), redrawUpdate(), and FL_DocLayout::removeEndnoteContainer().

fp_Page* fl_DocSectionLayout::getFirstOwnedPage ( void ) const [inline]

Referenced by FV_View::_draw(), FV_View::_getPageXandYOffset(), and fp_Page::resetFieldPageNumber().

fl_HdrFtrSectionLayout * fl_DocSectionLayout::getFooter ( void ) const

References m_pFooterSL.

Referenced by FV_View::_insertSectionBreak(), FV_View::cmdRemoveHdrFtr(), Defun1(), FV_View::populateThisHdrFtr(), FV_View::processPageNumber(), and FV_View::removeThisHdrFtr().

fl_HdrFtrSectionLayout * fl_DocSectionLayout::getFooterEven ( void ) const

References m_pFooterEvenSL.

Referenced by FV_View::_insertSectionBreak(), FV_View::cmdRemoveHdrFtr(), Defun1(), FV_View::populateThisHdrFtr(), and FV_View::removeThisHdrFtr().

fl_HdrFtrSectionLayout * fl_DocSectionLayout::getFooterFirst ( void ) const

References m_pFooterFirstSL.

Referenced by FV_View::_insertSectionBreak(), FV_View::cmdRemoveHdrFtr(), Defun1(), FV_View::populateThisHdrFtr(), and FV_View::removeThisHdrFtr().

fl_HdrFtrSectionLayout * fl_DocSectionLayout::getFooterLast ( void ) const

References m_pFooterLastSL.

Referenced by FV_View::_insertSectionBreak(), FV_View::cmdRemoveHdrFtr(), Defun1(), FV_View::populateThisHdrFtr(), and FV_View::removeThisHdrFtr().

UT_sint32 fl_DocSectionLayout::getFooterMargin ( void ) const [inline]

Referenced by fp_Page::buildHdrFtrContainer(), FV_View::getLeftRulerInfo(), setHdrFtrHeightChange(), and fp_Page::TopBotMarginChanged().

fl_FootnoteLayout * fl_DocSectionLayout::getFootnoteLayout ( UT_uint32 footnotePID )

References fl_ContainerLayout::getContainerType(), fl_ContainerLayout::getFirstLayout(), fl_FootnoteLayout::getFootnotePID(), and fl_ContainerLayout::getNext().

UT_uint32 fl_DocSectionLayout::getFootnoteLineThickness ( void ) const [inline]

Referenced by fp_Page::_reformatColumns(), fp_Page::breakPage(), fp_FootnoteContainer::clearScreen(), and fp_FootnoteContainer::draw().

UT_uint32 fl_DocSectionLayout::getFootnoteYoff ( void ) const [inline]

fl_HdrFtrSectionLayout * fl_DocSectionLayout::getHeader ( void ) const

References m_pHeaderSL.

Referenced by FV_View::_insertSectionBreak(), FV_View::cmdRemoveHdrFtr(), Defun1(), FV_View::populateThisHdrFtr(), FV_View::processPageNumber(), and FV_View::removeThisHdrFtr().

fl_HdrFtrSectionLayout * fl_DocSectionLayout::getHeaderEven ( void ) const

References m_pHeaderEvenSL.

Referenced by FV_View::_insertSectionBreak(), FV_View::cmdRemoveHdrFtr(), Defun1(), FV_View::populateThisHdrFtr(), and FV_View::removeThisHdrFtr().

fl_HdrFtrSectionLayout * fl_DocSectionLayout::getHeaderFirst ( void ) const

References m_pHeaderFirstSL.

Referenced by FV_View::_insertSectionBreak(), FV_View::cmdRemoveHdrFtr(), Defun1(), FV_View::populateThisHdrFtr(), and FV_View::removeThisHdrFtr().

fl_HdrFtrSectionLayout * fl_DocSectionLayout::getHeaderLast ( void ) const

References m_pHeaderLastSL.

Referenced by FV_View::_insertSectionBreak(), FV_View::cmdRemoveHdrFtr(), Defun1(), FV_View::populateThisHdrFtr(), and FV_View::removeThisHdrFtr().

UT_sint32 fl_DocSectionLayout::getHeaderMargin ( void ) const [inline]

Referenced by fp_Page::buildHdrFtrContainer(), FV_View::getLeftRulerInfo(), setHdrFtrHeightChange(), and fp_Page::TopBotMarginChanged().

fp_Container * fl_DocSectionLayout::getLastContainer ( void ) const [virtual]

Reimplemented from fl_ContainerLayout.

References m_pLastColumn.

Referenced by fb_ColumnBreaker::_breakSection(), getNewContainer(), and FL_DocLayout::insertEndnoteContainer().

fp_Container * fl_DocSectionLayout::getLastEndnoteContainer ( void ) const

References m_pLastEndnoteContainer.

Referenced by FL_DocLayout::insertEndnoteContainer(), and FL_DocLayout::removeEndnoteContainer().

UT_sint32 fl_DocSectionLayout::getLeftMargin ( void ) const [inline]

Referenced by fl_AnnotationLayout::_createAnnotationContainer(), fl_EndnoteLayout::_createEndnoteContainer(), fl_FootnoteLayout::_createFootnoteContainer(), fp_Page::_drawCropMarks(), fp_MathRun::_lookupProperties(), fp_EmbedRun::_lookupProperties(), fp_Page::_reformatAnnotations(), fp_Page::_reformatFootnotes(), fp_Page::buildHdrFtrContainer(), FV_View::calculateZoomPercentForPageWidth(), fp_EndnoteContainer::clearScreen(), fp_AnnotationContainer::clearScreen(), fp_FootnoteContainer::clearScreen(), fp_FootnoteContainer::draw(), getActualColumnWidth(), fp_Container::getPageRelativeOffsets(), FV_View::getTopRulerInfo(), and fp_Line::recalcMaxWidth().

UT_sint32 fl_DocSectionLayout::getMaxSectionColumnHeight ( void ) const [inline]

Referenced by FV_View::getMaxHeight().

fp_Container * fl_DocSectionLayout::getNewContainer ( fp_Container * pFirstContainer = NULL ) [virtual]

Create new container

Returns:: The newly created container

This creates a new column or row of same.

Implements fl_SectionLayout.

References FL_DocLayout::addNewPage(), fp_Page::countColumnLeaders(), FL_DocLayout::countPages(), fp_Page::findFrameContainer(), FL_DocLayout::findFramesToBeInserted(), format(), fp_Page::getAvailableHeight(), fp_Container::getContainer(), fp_Column::getDocSectionLayout(), fp_Page::getFilledHeight(), FL_DocLayout::getFirstPage(), fp_Column::getFollower(), fp_ContainerObject::getHeight(), fp_VerticalContainer::getLastContainer(), getLastContainer(), fp_Container::getNext(), fp_Page::getNext(), fp_Page::getNthColumnLeader(), fp_Column::getPage(), fp_ContainerObject::getPrevContainerInSection(), getPrevDocSection(), fp_Page::insertColumnLeader(), fp_Page::insertFrameContainer(), FL_DocLayout::isLayoutFilling(), m_iNumColumns, m_pFirstColumn, m_pLastColumn, fl_SectionLayout::m_pLayout, FL_DocLayout::removeFramesToBeInserted(), fp_Column::setFollower(), fp_Column::setLeader(), fp_Container::setNext(), fp_Container::setPrev(), UT_ASSERT, UT_DEBUGMSG, UT_return_val_if_fail, and xxx_UT_DEBUGMSG.

Referenced by fb_ColumnBreaker::_breakSection(), and FL_DocLayout::insertEndnoteContainer().

fl_DocSectionLayout * fl_DocSectionLayout::getNextDocSection ( void ) const

References fl_ContainerLayout::getNext(), and fl_SectionLayout::getType().

Referenced by addOwnedPage(), FL_DocLayout::changeDocSections(), FV_View::cmdFindRevision(), FL_DocLayout::deleteEmptyColumnsAndPages(), deleteOwnedPage(), doclistener_deleteStrux(), fl_BlockLayout::doclistener_insertSection(), doMarginChangeOnly(), FL_DocLayout::findSectionForHdrFtr(), FV_View::getSectionFormat(), fp_Column::layout(), FL_DocLayout::loadPendingObjects(), FL_DocLayout::rebuildFromHere(), FL_DocLayout::removeSection(), FL_DocLayout::updateColor(), and FL_DocLayout::~FL_DocLayout().

UT_uint32 fl_DocSectionLayout::getNumColumns ( void ) const

References m_iNumColumns.

Referenced by fp_Line::_doClearScreenFromRunToEnd(), fp_Line::clearScreen(), fp_Column::getColumnIndex(), fp_Page::getNthColumn(), FV_View::getTopRulerInfo(), fp_Line::recalcMaxWidth(), and fl_BlockLayout::setFramesOnPage().

UT_sint32 fl_DocSectionLayout::getPageCount ( void ) const [inline]

Referenced by FV_View::_draw(), and FV_View::_getPageXandYOffset().

fl_DocSectionLayout * fl_DocSectionLayout::getPrevDocSection ( void ) const

References fl_ContainerLayout::getPrev(), and fl_SectionLayout::getType().

Referenced by fl_HdrFtrSectionLayout::changeIntoHdrFtrSection(), FV_View::cmdFindRevision(), doclistener_deleteStrux(), getNewContainer(), FL_DocLayout::removeSection(), and fp_Page::resetFieldPageNumber().

UT_sint32 fl_DocSectionLayout::getRestartedPageNumber ( void ) const [inline]

Referenced by fp_Page::resetFieldPageNumber().

UT_sint32 fl_DocSectionLayout::getRightMargin ( void ) const [inline]

Referenced by fl_AnnotationLayout::_createAnnotationContainer(), fl_EndnoteLayout::_createEndnoteContainer(), fl_FootnoteLayout::_createFootnoteContainer(), fp_Line::_doClearScreenFromRunToEnd(), fp_Page::_drawCropMarks(), fp_MathRun::_lookupProperties(), fp_EmbedRun::_lookupProperties(), fp_Page::buildHdrFtrContainer(), FV_View::calculateZoomPercentForPageWidth(), fp_Line::clearScreen(), fp_EndnoteContainer::clearScreen(), fp_AnnotationContainer::clearScreen(), fp_FootnoteContainer::clearScreen(), fp_FootnoteContainer::draw(), getActualColumnWidth(), FV_View::getTopRulerInfo(), and fp_Line::recalcMaxWidth().

virtual fl_SectionLayout* fl_DocSectionLayout::getSectionLayout ( void ) const [inline, virtual]

Implements fl_ContainerLayout.

UT_sint32 fl_DocSectionLayout::getSpaceAfter ( void ) const [inline]

Referenced by fp_Page::_reformatColumns(), fp_Page::breakPage(), and fp_Page::getFilledHeight().

UT_sint32 fl_DocSectionLayout::getTopMargin ( void ) const

void fl_DocSectionLayout::getVecOfHdrFtrs ( UT_GenericVector< fl_HdrFtrSectionLayout * > * vecHdrFtr ) const

This fills a vector with all the valid header/footers.

References UT_GenericVector< T >::addItem(), UT_GenericVector< T >::clear(), m_pFooterEvenSL, m_pFooterFirstSL, m_pFooterLastSL, m_pFooterSL, m_pHeaderEvenSL, m_pHeaderFirstSL, m_pHeaderLastSL, and m_pHeaderSL.

Referenced by FV_View::_insertSectionBreak(), _lookupMarginProperties(), addOwnedPage(), addValidPages(), checkAndRemovePages(), collapse(), deleteOwnedPage(), formatAllHdrFtr(), prependOwnedFooterPage(), prependOwnedHeaderPage(), and ~fl_DocSectionLayout().

UT_sint32 fl_DocSectionLayout::getWidth ( void ) const

References DIM_IN, FL_DocLayout::getGraphics(), GR_Graphics::getResolution(), FL_DocLayout::m_docViewPageSize, fl_SectionLayout::m_pLayout, and fp_PageSize::Width().

Referenced by fl_CellLayout::createCellContainer(), fl_TableLayout::createTableContainer(), and FV_View::getWidthPagesInRow().

bool fl_DocSectionLayout::isCollapsing ( void ) const [inline]

Referenced by fl_BlockLayout::collapse(), and fp_Line::remove().

bool fl_DocSectionLayout::isFirstPageValid ( void ) const

References getFirstContainer(), fl_ContainerLayout::getLastContainer(), fp_Container::getPage(), fp_Page::getPageNumber(), fl_ContainerLayout::getPrev(), and UT_return_val_if_fail.

Referenced by FL_DocLayout::formatAll(), and updateLayout().

bool fl_DocSectionLayout::isThisPageValid	(	HdrFtrType	hfType,
		fp_Page *	pThisPage
	)			const

This method returns true if the pPage pointer matches the header/footer type given.

Parameters:

	hfType	The type of the header/Footer
	fp_Page	* pThisPage pointer to the page queried.

References FL_DocLayout::countPages(), FL_HDRFTR_FOOTER, FL_HDRFTR_FOOTER_EVEN, FL_HDRFTR_FOOTER_FIRST, FL_HDRFTR_FOOTER_LAST, FL_HDRFTR_HEADER_EVEN, FL_HDRFTR_HEADER_FIRST, FL_HDRFTR_HEADER_LAST, FL_HDRFTR_NONE, fl_SectionLayout::getDocLayout(), fp_Page::getNext(), FL_DocLayout::getNthPage(), fp_Page::getOwningSection(), m_pFirstOwnedPage, m_pFooterEvenSL, m_pFooterFirstSL, m_pFooterLastSL, m_pHeaderEvenSL, m_pHeaderFirstSL, m_pHeaderLastSL, and UT_ASSERT.

void fl_DocSectionLayout::markAllRunsDirty ( void ) [virtual]

Implements fl_SectionLayout.

References fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getNext(), m_pFooterEvenSL, m_pFooterFirstSL, m_pFooterLastSL, m_pFooterSL, m_pHeaderEvenSL, m_pHeaderFirstSL, m_pHeaderLastSL, m_pHeaderSL, fl_HdrFtrSectionLayout::markAllRunsDirty(), and fl_ContainerLayout::markAllRunsDirty().

Referenced by fl_FrameLayout::doclistener_changeStrux(), and updateDocSection().

void fl_DocSectionLayout::markForRebuild ( void ) [inline]

Referenced by fp_Page::annotationHeightChanged(), fp_Page::columnHeightChanged(), and fp_Page::footnoteHeightChanged().

void fl_DocSectionLayout::markForReformat ( void ) [inline]

bool fl_DocSectionLayout::needsRebuild ( void ) const [inline]

Referenced by redrawUpdate(), and updateLayout().

bool fl_DocSectionLayout::needsReFormat ( void ) const [inline]

bool fl_DocSectionLayout::needsSectionBreak ( void ) const [inline]

Referenced by redrawUpdate(), and updateLayout().

void fl_DocSectionLayout::prependOwnedFooterPage ( fp_Page * p_Page )

References fl_HdrFtrSectionLayout::addPage(), FL_HDRFTR_FOOTER, fp_Page::getHdrFtrP(), fl_HdrFtrSectionLayout::getHFType(), UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), fp_Page::getOwningSection(), fp_Page::getPrev(), and getVecOfHdrFtrs().

Referenced by addOwnedPage().

void fl_DocSectionLayout::prependOwnedHeaderPage ( fp_Page * p_Page )

References fl_HdrFtrSectionLayout::addPage(), FL_HDRFTR_HEADER, fp_Page::getHdrFtrP(), fl_HdrFtrSectionLayout::getHFType(), UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), fp_Page::getOwningSection(), fp_Page::getPrev(), getVecOfHdrFtrs(), and xxx_UT_DEBUGMSG.

Referenced by addOwnedPage().

void fl_DocSectionLayout::setFirstContainer ( fp_Container * pCon ) [virtual]

Reimplemented from fl_ContainerLayout.

References m_pFirstColumn, and UT_DEBUGMSG.

void fl_DocSectionLayout::setFirstEndnoteContainer ( fp_EndnoteContainer * pECon )

References m_pFirstEndnoteContainer.

Referenced by collapse(), FL_DocLayout::insertEndnoteContainer(), and FL_DocLayout::removeEndnoteContainer().

void fl_DocSectionLayout::setHdrFtr	(	HdrFtrType	iType,
		fl_HdrFtrSectionLayout *	pHFSL
	)

bool fl_DocSectionLayout::setHdrFtrHeightChange	(	bool	bHdrFtr,
		UT_sint32	newHeight
	)

Signal a PT change at the next opportunity to change the height of a Hdr (true) or footer (false)

newHeight is the value in layout units of the new height of the header/footer

In both caes the header/footers grow "into" the document area.

References _HdrFtrChangeCallback(), DIM_IN, fl_Layout::getDocument(), getFooterMargin(), FL_DocLayout::getGraphics(), getHeaderMargin(), UT_WorkerFactory::IDLE, GR_Graphics::invertDimension(), m_iNewFtrHeight, m_iNewHdrHeight, m_pHdrFtrChangeTimer, fl_SectionLayout::m_pLayout, m_sHdrFtrChangeProps, UT_WorkerFactory::NONE, PD_Document::setNewFtrHeight(), PD_Document::setNewHdrHeight(), UT_Worker::start(), UT_WorkerFactory::static_constructor(), UT_WorkerFactory::TIMER, UT_ASSERT, UT_std_string_setProperty(), and xxx_UT_DEBUGMSG.

Referenced by fp_ShadowContainer::layout().

void fl_DocSectionLayout::setLastContainer ( fp_Container * pCon ) [virtual]

Reimplemented from fl_ContainerLayout.

References m_pLastColumn.

void fl_DocSectionLayout::setLastEndnoteContainer ( fp_EndnoteContainer * pECon )

References m_pLastEndnoteContainer.

Referenced by collapse(), FL_DocLayout::insertEndnoteContainer(), and FL_DocLayout::removeEndnoteContainer().

void fl_DocSectionLayout::setNeedsSectionBreak	(	bool	bSet,
		fp_Page *	pPage
	)

References FL_DocLayout::findPage(), fl_SectionLayout::getDocLayout(), fp_Page::getOwningSection(), fb_ColumnBreaker::getStartPage(), m_bNeedsSectionBreak, m_ColumnBreaker, fb_ColumnBreaker::setStartPage(), and xxx_UT_DEBUGMSG.

Referenced by fl_TOCLayout::_createAndFillTOCEntry(), FV_FrameEdit::_mouseDrag(), fp_Page::annotationHeightChanged(), fb_ColumnBreaker::breakSection(), fl_TOCLayout::doclistener_changeStrux(), fl_BlockLayout::doclistener_changeStrux(), fl_TOCLayout::doclistener_deleteStrux(), fl_BlockLayout::doclistener_deleteStrux(), fl_BlockLayout::doclistener_insertSection(), fl_BlockLayout::doclistener_insertSpan(), fp_Page::footnoteHeightChanged(), fl_CellLayout::format(), fl_TableLayout::format(), fl_FrameLayout::format(), fl_EndnoteLayout::format(), fl_BlockLayout::format(), fp_EndnoteContainer::layout(), fp_Column::layout(), FL_DocLayout::loadPendingObjects(), fp_FrameContainer::setHeight(), fp_FrameContainer::setPage(), fl_BlockLayout::shuffleEmbeddedIfNeeded(), and updateDocSection().

void fl_DocSectionLayout::setPaperColor ( void )

Set the color of the background paper in the following order of precedence 1. If The section level proper "background-color" is present and is not transparent use that. 2. If this section is being displayed to the screen use the ColorForTransparency preference item color. 3. Otherwise use white

References GR_Graphics::DGP_SCREEN, gchar, fl_ContainerLayout::getAP(), AV_View::getApp(), FV_View::getGraphics(), XAP_App::getPrefs(), XAP_Prefs::getPrefsValue(), PP_AttrProp::getProperty(), FL_DocLayout::getView(), fl_SectionLayout::m_pLayout, m_sPaperColor, m_sScreenColor, GR_Graphics::queryProperties(), UT_return_if_fail, and XAP_PREF_KEY_ColorForTransparent.