AbiWord: fl_FootnoteLayout Class Reference

#include <fl_FootnoteLayout.h>

Inheritance diagram for fl_FootnoteLayout:

List of all members.

Public Member Functions
	fl_FootnoteLayout (FL_DocLayout pLayout, fl_DocSectionLayout pDocSL, pf_Frag_Strux sdh, PT_AttrPropIndex ap, fl_ContainerLayout pMyContainerLayout)
virtual	~fl_FootnoteLayout ()
virtual void	format (void)
virtual void	collapse (void)
virtual fp_Container *	getNewContainer (fp_Container *=NULL)
UT_uint32	getFootnotePID (void) const
Protected Member Functions
virtual void	_lookupProperties (const PP_AttrProp *pAP)
Private Member Functions
void	_createFootnoteContainer (void)
void	_insertFootnoteContainer (fp_Container *pNewFC)
void	_localCollapse ()
Private Attributes
UT_uint32	m_iFootnotePID
Friends
class	fl_DocListener
class	fp_FootnoteContainer

Constructor & Destructor Documentation

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

References _createFootnoteContainer(), FL_DocLayout::addFootnote(), and fl_SectionLayout::m_pLayout.

fl_FootnoteLayout::~fl_FootnoteLayout ( ) [virtual]

References fl_EmbedLayout::_purgeLayout(), fl_ContainerLayout::getFirstContainer(), fl_ContainerLayout::getLastContainer(), fp_Container::getNext(), fl_SectionLayout::m_pLayout, FL_DocLayout::removeFootnote(), fl_ContainerLayout::setFirstContainer(), fl_ContainerLayout::setLastContainer(), UT_return_if_fail, and xxx_UT_DEBUGMSG.

Member Function Documentation

void fl_FootnoteLayout::_createFootnoteContainer ( void ) [private]

This method creates a new footnote with its properties initially set from the Attributes/properties of this Layout

References fp_FootnoteContainer, fl_ContainerLayout::getContainerType(), fl_ContainerLayout::getLastContainer(), fl_DocSectionLayout::getLeftMargin(), fp_Container::getPage(), fl_DocSectionLayout::getRightMargin(), fp_Page::getWidth(), fl_ContainerLayout::lookupProperties(), fl_ContainerLayout::myContainingLayout(), fl_ContainerLayout::setFirstContainer(), fl_ContainerLayout::setLastContainer(), fp_VerticalContainer::setWidth(), and UT_return_if_fail.

Referenced by fl_FootnoteLayout(), and getNewContainer().

void fl_FootnoteLayout::_insertFootnoteContainer ( fp_Container * pNewFC ) [private]

References FL_DocLayout::findBlockAtPosition(), fp_Run::getBlockOffset(), fp_Container::getContainer(), fl_ContainerLayout::getContainerType(), fl_EmbedLayout::getDocPosition(), fl_ContainerLayout::getLastContainer(), fp_Run::getLength(), fp_Run::getLine(), fp_Run::getNextRun(), fp_Container::getPage(), fp_Page::insertFootnoteContainer(), fl_EmbedLayout::m_bIsOnPage, fl_SectionLayout::m_pLayout, fl_ContainerLayout::myContainingLayout(), fp_Container::setContainer(), UT_ASSERT, and UT_DEBUGMSG.

Referenced by format().

void fl_FootnoteLayout::_localCollapse ( void ) [private]

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

Referenced by collapse().

void fl_FootnoteLayout::_lookupProperties ( const PP_AttrProp * pSectionAP ) [protected, virtual]

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

Implements fl_ContainerLayout.

References gchar, PP_AttrProp::getAttribute(), m_iFootnotePID, and UT_return_if_fail.

void fl_FootnoteLayout::collapse ( void ) [virtual]

Implements fl_EmbedLayout.

References _localCollapse(), fl_ContainerLayout::getFirstContainer(), fp_Container::getNext(), fp_FootnoteContainer::getPage(), fp_Container::getPrev(), fp_Page::removeFootnoteContainer(), fl_ContainerLayout::setFirstContainer(), fl_ContainerLayout::setLastContainer(), fp_Container::setNext(), fp_FootnoteContainer::setPage(), and fp_ContainerObject::setPrev().

void fl_FootnoteLayout::format ( void ) [virtual]

Implements fl_EmbedLayout.

References _insertFootnoteContainer(), fl_ContainerLayout::format(), fl_ContainerLayout::getFirstContainer(), fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getLastContainer(), getNewContainer(), fl_ContainerLayout::getNext(), fl_EmbedLayout::m_bIsOnPage, fl_EmbedLayout::m_bNeedsFormat, fl_SectionLayout::m_bNeedsReformat, UT_DEBUGMSG, and xxx_UT_DEBUGMSG.

UT_uint32 fl_FootnoteLayout::getFootnotePID ( void ) const [inline]

Referenced by FL_DocLayout::findFootnoteLayout(), fl_BlockLayout::findLineWithFootnotePID(), fl_DocSectionLayout::getFootnoteLayout(), and fp_FootnoteContainer::getValue().

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

Create a new Footnote container.

Parameters:

If

pPrevFootnote is non-null place the new cell after this in the linked list, otherwise just append it to the end.

Returns:: The newly created Footnote container

Implements fl_EmbedLayout.

References _createFootnoteContainer(), fl_ContainerLayout::getLastContainer(), fl_EmbedLayout::m_bIsOnPage, and UT_DEBUGMSG.

Referenced by format().

Friends And Related Function Documentation

friend class fl_DocListener [friend]

Reimplemented from fl_EmbedLayout.

friend class fp_FootnoteContainer [friend]

Reimplemented from fl_EmbedLayout.

Referenced by _createFootnoteContainer().

Member Data Documentation

UT_uint32 fl_FootnoteLayout::m_iFootnotePID [private]

Referenced by _lookupProperties().

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