AbiWord: fl_EndnoteLayout Class Reference

#include <fl_FootnoteLayout.h>

Inheritance diagram for fl_EndnoteLayout:

List of all members.

Public Member Functions
	fl_EndnoteLayout (FL_DocLayout pLayout, fl_DocSectionLayout pDocSL, pf_Frag_Strux sdh, PT_AttrPropIndex ap, fl_ContainerLayout pMyContainerLayout)
virtual	~fl_EndnoteLayout ()
virtual void	format (void)
virtual void	collapse (void)
virtual fp_Container *	getNewContainer (fp_Container *=NULL)
UT_uint32	getEndnotePID (void) const
Protected Member Functions
virtual void	_lookupProperties (const PP_AttrProp *pAP)
Private Member Functions
void	_createEndnoteContainer (void)
void	_insertEndnoteContainer (fp_Container *pNewFC)
void	_localCollapse ()
Private Attributes
UT_uint32	m_iEndnotePID
Friends
class	fl_DocListener
class	fp_EndnoteContainer

Constructor & Destructor Documentation

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

References _createEndnoteContainer(), FL_DocLayout::addEndnote(), fl_ContainerLayout::getContainerString(), fl_ContainerLayout::getPosition(), fl_SectionLayout::m_pLayout, fl_ContainerLayout::myContainingLayout(), and UT_DEBUGMSG.

fl_EndnoteLayout::~fl_EndnoteLayout ( ) [virtual]

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

Member Function Documentation

void fl_EndnoteLayout::_createEndnoteContainer ( void ) [private]

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

References fp_EndnoteContainer, FL_DocLayout::getDocSecForEndnote(), FL_DocLayout::getLastPage(), fl_DocSectionLayout::getLeftMargin(), fl_DocSectionLayout::getRightMargin(), fp_Page::getWidth(), fl_ContainerLayout::lookupProperties(), fl_EmbedLayout::m_bNeedsFormat, fl_SectionLayout::m_bNeedsReformat, fl_SectionLayout::m_pLayout, fl_ContainerLayout::setFirstContainer(), fl_ContainerLayout::setLastContainer(), and fp_VerticalContainer::setWidth().

Referenced by fl_EndnoteLayout(), and getNewContainer().

void fl_EndnoteLayout::_insertEndnoteContainer ( fp_Container * pNewFC ) [private]

References FL_DocLayout::insertEndnoteContainer(), fl_EmbedLayout::m_bIsOnPage, fl_SectionLayout::m_pLayout, and xxx_UT_DEBUGMSG.

Referenced by format().

void fl_EndnoteLayout::_localCollapse ( void ) [private]

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

Referenced by collapse().

void fl_EndnoteLayout::_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_iEndnotePID, and UT_return_if_fail.

void fl_EndnoteLayout::collapse ( void ) [virtual]

Implements fl_EmbedLayout.

References _localCollapse(), fl_ContainerLayout::getFirstContainer(), fp_EndnoteContainer::getLocalNext(), fp_Container::getNext(), fp_Container::getPrev(), fl_EmbedLayout::m_bIsOnPage, fl_SectionLayout::m_pLayout, FL_DocLayout::removeEndnoteContainer(), fl_ContainerLayout::setFirstContainer(), fl_ContainerLayout::setLastContainer(), fp_Container::setNext(), fp_ContainerObject::setPrev(), and UT_DEBUGMSG.

Referenced by fp_Page::_reformatColumns(), and fp_Column::collapseEndnotes().

void fl_EndnoteLayout::format ( void ) [virtual]

Implements fl_EmbedLayout.

References _insertEndnoteContainer(), fl_ContainerLayout::format(), fl_EmbedLayout::getDocSectionLayout(), fl_ContainerLayout::getFirstContainer(), fl_ContainerLayout::getFirstLayout(), fl_ContainerLayout::getLastContainer(), getNewContainer(), fl_ContainerLayout::getNext(), fp_Container::getPage(), FL_DocLayout::getView(), AV_View::isLayoutFilling(), fl_EmbedLayout::m_bIsOnPage, fl_EmbedLayout::m_bNeedsFormat, fl_SectionLayout::m_bNeedsReformat, fl_SectionLayout::m_pLayout, fl_DocSectionLayout::setNeedsSectionBreak(), UT_ASSERT, and UT_DEBUGMSG.

UT_uint32 fl_EndnoteLayout::getEndnotePID ( void ) const [inline]

Referenced by FL_DocLayout::findEndnoteLayout(), and fp_EndnoteContainer::getValue().

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

Create a new Endote 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 Endnote container

Implements fl_EmbedLayout.

References _createEndnoteContainer(), 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_EndnoteContainer [friend]

Referenced by _createEndnoteContainer().

Member Data Documentation

UT_uint32 fl_EndnoteLayout::m_iEndnotePID [private]

Referenced by _lookupProperties().

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