fl_EmbedLayout Class Reference

#include <fl_FootnoteLayout.h>

Inheritance diagram for fl_EmbedLayout:

fl_SectionLayout fl_ContainerLayout fl_Layout fl_AnnotationLayout fl_EndnoteLayout fl_FootnoteLayout

List of all members.

Public Member Functions

 fl_EmbedLayout (FL_DocLayout *pLayout, fl_DocSectionLayout *pDocSL, PL_StruxDocHandle sdh, PT_AttrPropIndex ap, fl_ContainerLayout *pMyContainerLayout, SectionType iSecType, fl_ContainerType myType, PTStruxType myStruxType)
virtual ~fl_EmbedLayout ()
virtual void setNeedsReformat (fl_ContainerLayout *pCL, UT_uint32 offset=0)
virtual void updateLayout (bool bDoAll)
virtual bool doclistener_changeStrux (const PX_ChangeRecord_StruxChange *pcrxc)
virtual bool doclistener_deleteStrux (const PX_ChangeRecord_Strux *pcrx)
virtual bool doclistener_deleteEndEmbed (const PX_ChangeRecord_Strux *pcrx)
virtual bool bl_doclistener_insertEndEmbed (fl_ContainerLayout *, const PX_ChangeRecord_Strux *pcrx, PL_StruxDocHandle sdh, PL_ListenerId lid, void(*pfnBindHandles)(PL_StruxDocHandle sdhNew, PL_ListenerId lid, PL_StruxFmtHandle sfhNew))
virtual void format (void)=0
virtual void updateLayout (void)
virtual void collapse (void)=0
virtual void markAllRunsDirty (void)
virtual fl_SectionLayout * getSectionLayout (void) const
bool recalculateFields (UT_uint32 iUpdateCount)
fl_BlockLayout * getContainingBlock (void)
virtual void redrawUpdate (void)
virtual fp_Container * getNewContainer (fp_Container *=NULL)=0
fl_DocSectionLayout * getDocSectionLayout (void) const
void setDocSectionLayout (fl_DocSectionLayout *pDSL)
bool isEndFootnoteIn (void) const
void setFootnoteEndIn (void)
PT_DocPosition getDocPosition (void)
UT_uint32 getLength (void)
UT_sint32 getOldSize (void) const
void setOldSize (UT_sint32 i)

Protected Member Functions

virtual void _purgeLayout (void)

Protected Attributes

bool m_bNeedsRebuild
bool m_bNeedsFormat
bool m_bIsOnPage

Private Attributes

fl_DocSectionLayout * m_pDocSL
bool m_bHasEndFootnote
UT_sint32 m_iOldSize

Friends

class fl_DocListener
class fp_FootnoteContainer

Constructor & Destructor Documentation

fl_EmbedLayout::fl_EmbedLayout ( FL_DocLayout *  pLayout,
fl_DocSectionLayout *  pDocSL,
PL_StruxDocHandle  sdh,
PT_AttrPropIndex  ap,
fl_ContainerLayout *  pMyContainerLayout,
SectionType  iSecType,
fl_ContainerType  myType,
PTStruxType  myStruxType 
)

References FL_CONTAINER_DOCSECTION, fl_ContainerLayout::getContainerType(), m_pDocSL, and UT_ASSERT.

fl_EmbedLayout::~fl_EmbedLayout (  )  [virtual]

Member Function Documentation

void fl_EmbedLayout::setNeedsReformat ( fl_ContainerLayout *  pCL,
UT_uint32  offset = 0 
) [virtual]

Reimplemented from fl_SectionLayout.

References getSectionLayout(), fl_SectionLayout::m_bNeedsReformat, and fl_SectionLayout::setNeedsReformat().

void fl_EmbedLayout::updateLayout ( bool  bDoAll  )  [virtual]

Implements fl_ContainerLayout.

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

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

Implements fl_SectionLayout.

References collapse(), PX_ChangeRecord::getIndexAP(), PX_ChangeRecord::getType(), PX_ChangeRecord::PXT_ChangeStrux, fl_Layout::setAttrPropIndex(), and UT_ASSERT.

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

References collapse(), FL_DocLayout::findBlockAtPosition(), getOldSize(), PX_ChangeRecord::getPosition(), fl_ContainerLayout::getPrev(), getSectionLayout(), PX_ChangeRecord::getType(), m_bHasEndFootnote, fl_SectionLayout::m_pLayout, PX_ChangeRecord::PXT_DeleteStrux, fl_ContainerLayout::remove(), fl_ContainerLayout::setNeedsReformat(), fl_BlockLayout::updateOffsets(), and UT_ASSERT.

bool fl_EmbedLayout::doclistener_deleteEndEmbed ( const PX_ChangeRecord_Strux *  pcrx  )  [virtual]

This signals an incomplete footnote section.

References m_bHasEndFootnote.

bool fl_EmbedLayout::bl_doclistener_insertEndEmbed ( fl_ContainerLayout *  ,
const PX_ChangeRecord_Strux *  pcrx,
PL_StruxDocHandle  sdh,
PL_ListenerId  lid,
void(*)(PL_StruxDocHandle sdhNew, PL_ListenerId lid, PL_StruxFmtHandle sfhNew)  pfnBindHandles 
) [virtual]

References fl_BLOCK_STRUX_OFFSET, fl_ContainerLayout::getFirstLayout(), FV_View::getPoint(), PX_ChangeRecord::getPosition(), FL_DocLayout::getView(), FV_View::isActive(), FV_View::isPreview(), m_bHasEndFootnote, fl_SectionLayout::m_pLayout, FV_View::setPoint(), and fl_BlockLayout::updateEnclosingBlockIfNeeded().

Referenced by fl_DocListener::insertStrux().

virtual void fl_EmbedLayout::format ( void   )  [pure virtual]

Implements fl_ContainerLayout.

Implemented in fl_FootnoteLayout, fl_EndnoteLayout, and fl_AnnotationLayout.

Referenced by updateLayout().

void fl_EmbedLayout::updateLayout ( void   )  [virtual]

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().

virtual void fl_EmbedLayout::collapse ( void   )  [pure virtual]

Implements fl_ContainerLayout.

Implemented in fl_FootnoteLayout, fl_EndnoteLayout, and fl_AnnotationLayout.

Referenced by doclistener_changeStrux(), and doclistener_deleteStrux().

void fl_EmbedLayout::markAllRunsDirty ( void   )  [virtual]

Implements fl_SectionLayout.

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

Referenced by fp_Page::removeAnnotationContainer(), and fp_Page::removeFootnoteContainer().

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

Implements fl_ContainerLayout.

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

Referenced by doclistener_deleteStrux(), and setNeedsReformat().

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

Reimplemented from fl_SectionLayout.

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

fl_BlockLayout * fl_EmbedLayout::getContainingBlock ( void   ) 

Return the block that contains this Embedded layout

References FL_CONTAINER_BLOCK, fl_ContainerLayout::getContainerType(), getDocPosition(), fl_BlockLayout::getPosition(), fl_ContainerLayout::getPrev(), and fl_ContainerLayout::getPrevBlockInDocument().

Referenced by FL_DocLayout::collapseAnnotations().

void fl_EmbedLayout::redrawUpdate ( void   )  [virtual]

Implements fl_ContainerLayout.

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

Referenced by fl_DocSectionLayout::redrawUpdate().

virtual fp_Container* fl_EmbedLayout::getNewContainer ( fp_Container *  = NULL  )  [pure virtual]

Implements fl_SectionLayout.

Implemented in fl_FootnoteLayout, fl_EndnoteLayout, and fl_AnnotationLayout.

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

Reimplemented from fl_ContainerLayout.

Referenced by fl_EndnoteLayout::format(), FL_DocLayout::getDocSecForEndnote(), FL_DocLayout::getEndnoteVal(), and FL_DocLayout::getFootnoteVal().

void fl_EmbedLayout::setDocSectionLayout ( fl_DocSectionLayout *  pDSL  )  [inline]

bool fl_EmbedLayout::isEndFootnoteIn ( void   )  const [inline]

Referenced by FV_View::_findGetNextBlockBuffer(), fl_BlockLayout::getEnclosingBlock(), FV_View::isInAnnotation(), FV_View::isInEndnote(), FV_View::isInFootnote(), and fl_BlockLayout::updateEnclosingBlockIfNeeded().

void fl_EmbedLayout::setFootnoteEndIn ( void   )  [inline]

Referenced by fl_DocListener::populateStrux().

PT_DocPosition fl_EmbedLayout::getDocPosition ( void   ) 

Returns the position in the document of the PTX_SectionFootnote 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(), fl_SectionLayout::m_pLayout, and UT_return_val_if_fail.

Referenced by fl_AnnotationLayout::_insertAnnotationContainer(), fl_FootnoteLayout::_insertFootnoteContainer(), Defun1(), fp_Line::getAnnotationContainers(), fl_AnnotationLayout::getAnnotationRun(), FV_View::getClosestAnnotation(), FV_View::getClosestEndnote(), FV_View::getClosestFootnote(), getContainingBlock(), FL_DocLayout::getEndnoteVal(), fp_Line::getFootnoteContainers(), FL_DocLayout::getFootnoteVal(), getLength(), FV_View::isInAnnotation(), FV_View::isInEndnote(), and FV_View::isInFootnote().

UT_uint32 fl_EmbedLayout::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 FL_CONTAINER_ANNOTATION, FL_CONTAINER_ENDNOTE, FL_CONTAINER_FOOTNOTE, fl_ContainerLayout::getContainerType(), getDocPosition(), FL_DocLayout::getDocument(), PD_Document::getNextStruxOfType(), fl_Layout::getStruxDocHandle(), PD_Document::getStruxPosition(), fl_SectionLayout::m_pLayout, PTX_EndAnnotation, PTX_EndEndnote, PTX_EndFootnote, UT_ASSERT, UT_ASSERT_HARMLESS, UT_return_val_if_fail, and UT_SHOULD_NOT_HAPPEN.

Referenced by FV_View::_deleteHyperlink(), FV_View::_deleteSelection(), FV_View::_setPoint(), FV_View::cmdCharDelete(), Defun1(), FV_View::isInAnnotation(), FV_View::isInEndnote(), and FV_View::isInFootnote().

UT_sint32 fl_EmbedLayout::getOldSize ( void   )  const [inline]

Referenced by doclistener_deleteStrux(), and fl_BlockLayout::updateEnclosingBlockIfNeeded().

void fl_EmbedLayout::setOldSize ( UT_sint32  i  )  [inline]

Referenced by fl_BlockLayout::updateEnclosingBlockIfNeeded().

void fl_EmbedLayout::_purgeLayout ( void   )  [protected, virtual]

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

Reimplemented from fl_SectionLayout.

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

Referenced by fl_AnnotationLayout::~fl_AnnotationLayout(), fl_EndnoteLayout::~fl_EndnoteLayout(), and fl_FootnoteLayout::~fl_FootnoteLayout().

Friends And Related Function Documentation

friend class fl_DocListener [friend]

Reimplemented from fl_SectionLayout.

Reimplemented in fl_FootnoteLayout, fl_EndnoteLayout, and fl_AnnotationLayout.

friend class fp_FootnoteContainer [friend]

Reimplemented in fl_FootnoteLayout.

Member Data Documentation

bool fl_EmbedLayout::m_bNeedsRebuild [protected]

bool fl_EmbedLayout::m_bNeedsFormat [protected]

Referenced by fl_EndnoteLayout::_createEndnoteContainer(), fl_EndnoteLayout::format(), fl_AnnotationLayout::format(), and fl_FootnoteLayout::format().

bool fl_EmbedLayout::m_bIsOnPage [protected]

Referenced by fl_AnnotationLayout::_insertAnnotationContainer(), fl_EndnoteLayout::_insertEndnoteContainer(), fl_FootnoteLayout::_insertFootnoteContainer(), fl_EndnoteLayout::collapse(), fl_AnnotationLayout::collapse(), fl_EndnoteLayout::format(), fl_AnnotationLayout::format(), fl_FootnoteLayout::format(), fl_EndnoteLayout::getNewContainer(), fl_AnnotationLayout::getNewContainer(), and fl_FootnoteLayout::getNewContainer().

fl_DocSectionLayout* fl_EmbedLayout::m_pDocSL [private]

Referenced by fl_EmbedLayout().

bool fl_EmbedLayout::m_bHasEndFootnote [private]

Referenced by bl_doclistener_insertEndEmbed(), doclistener_deleteEndEmbed(), and doclistener_deleteStrux().

UT_sint32 fl_EmbedLayout::m_iOldSize [private]

The documentation for this class was generated from the following files:
Generated on Sun Oct 12 00:06:53 2008 for AbiWord by  doxygen 1.5.5