Public Member Functions | Protected Attributes | Private Attributes

fl_Layout Class Reference

#include <fl_Layout.h>

Inheritance diagram for fl_Layout:
fl_ContainerLayout fl_BlockLayout fl_SectionLayout fl_CellLayout fl_DocSectionLayout fl_EmbedLayout fl_FrameLayout fl_HdrFtrSectionLayout fl_HdrFtrShadow fl_TableLayout fl_TOCLayout

List of all members.

Public Member Functions

 fl_Layout (PTStruxType type, pf_Frag_Strux *sdh)
virtual ~fl_Layout ()
pf_Frag_Strux * getStruxDocHandle (void) const
pf_Frag_Strux * getEndStruxDocHandle (void) const
void setEndStruxDocHandle (pf_Frag_Strux *pfs)
PTStruxType getType (void) const
void setType (PTStruxType type)
PT_AttrPropIndex getAttrPropIndex (void) const
void setAttrPropIndex (PT_AttrPropIndex apIndex)
bool getAttrProp (const PP_AttrProp **ppAP, std::unique_ptr< PP_RevisionAttr > &pRevisions, bool bShowRevisions, UT_uint32 iRevisionId, bool &bHiddenRevision) const
bool getSpanAttrProp (UT_uint32 offset, bool bLeftSide, const PP_AttrProp **ppAP, std::unique_ptr< PP_RevisionAttr > &pRevisions, bool bShowRevisions, UT_uint32 iRevisionId, bool &bHiddenRevision) const
bool getField (UT_uint32 offset, fd_Field *&pField)
po_Bookmark * getBookmark (UT_uint32 offset)
virtual void listUpdate (void)
const fl_AutoNumPtr & getAutoNum (void) const
void setAutoNum (const fl_AutoNumPtr &pAutoNum)
PD_Document * getDocument (void) const

Protected Attributes

PTStruxType m_type
PT_AttrPropIndex m_apIndex
fl_AutoNumPtr m_pAutoNum
PD_Document * m_pDoc

Private Attributes

pf_Frag_Strux * m_sdh
pf_Frag_Strux * m_endSdh

Detailed Description

fl_Layout is the base class for all layout objects which correspond to logical elements of the PD_Document.

We use an enum to remember type, rather than use any of the run-time stuff.

Constructor & Destructor Documentation

fl_Layout::fl_Layout ( PTStruxType  type,
pf_Frag_Strux *  sdh 
)

References pf_Frag::getType(), UT_ASSERT, and xxx_UT_DEBUGMSG.

fl_Layout::~fl_Layout (  )  [virtual]

Member Function Documentation

bool fl_Layout::getAttrProp ( const PP_AttrProp **  ppAP,
std::unique_ptr< PP_RevisionAttr > &  pRevisions,
bool  bShowRevisions,
UT_uint32  iRevisionId,
bool &  bHiddenRevision 
) const

ppAP [out] -- the requested AP

pRevisions [in/out] -- revisions attribute; can be set to NULL, in which case an instance will be created; the caller is responsible for deleting

bShowRevisions -- indicates if in the current view revisions are to be shown

iRevisionId -- the id of revision which is shown in the current view

bHiddenRevision [out] indicates if the element associated with ppAP is hidden or visible

bDelete [out] -- if set, the caller must delete ppAP when done with it.

References PD_Document::getAttrProp(), m_apIndex, m_pDoc, and UT_return_val_if_fail.

Referenced by fl_ContainerLayout::getAP().

PT_AttrPropIndex fl_Layout::getAttrPropIndex ( void   )  const [inline]

Referenced by fl_DocSectionLayout::doclistener_changeStrux().

const fl_AutoNumPtr& fl_Layout::getAutoNum ( void   )  const [inline]

Referenced by fl_BlockLayout::_addBlockToPrevList(), FV_View::_charInsert(), fl_BlockLayout::_prependBlockToPrevList(), AP_Dialog_Lists::Apply(), FV_View::cmdCharDelete(), FV_View::getAllBlocksInList(), AP_Dialog_Lists::getAutoNum(), fl_BlockLayout::getListAttributesVector(), fl_BlockLayout::getListType(), fl_BlockLayout::getNextList(), fl_BlockLayout::getPreviousList(), FV_View::processSelectedBlocks(), fl_BlockLayout::remItemFromList(), fl_BlockLayout::resumeList(), fl_BlockLayout::StopListInBlock(), and fl_BlockLayout::transferListFlags().

po_Bookmark * fl_Layout::getBookmark ( UT_uint32  offset  ) 

References PD_Document::getBookmark(), m_pDoc, and m_sdh.

Referenced by fp_BookmarkRun::fp_BookmarkRun().

PD_Document* fl_Layout::getDocument ( void   )  const [inline]

Referenced by fp_TabRun::_draw(), fp_MathRun::_getLayoutPropFromObject(), fp_EmbedRun::_getLayoutPropFromObject(), fl_DocSectionLayout::_HdrFtrChangeCallback(), fp_TextRun::_lookupProperties(), fp_FieldRun::_lookupProperties(), fp_ImageRun::_lookupProperties(), fp_MathRun::_lookupProperties(), fp_FmtMarkRun::_lookupProperties(), fp_EmbedRun::_lookupProperties(), fl_DocSectionLayout::_lookupProperties(), fp_MathRun::_updatePropValuesIfNeeded(), fp_EmbedRun::_updatePropValuesIfNeeded(), AP_Dialog_Lists::Apply(), fp_FieldMetaRun::calculateValue(), fp_FieldMailMergeRun::calculateValue(), fp_FieldShortFileNameRun::calculateValue(), fp_FieldFileNameRun::calculateValue(), fp_FieldTOCNumRun::calculateValue(), fp_FieldTableSumCols::calculateValue(), fp_FieldTableSumRows::calculateValue(), fp_FieldListLabelRun::calculateValue(), fl_Squiggles::clear(), fl_ContainerLayout::containsAnnotationLayouts(), fl_ContainerLayout::containsFootnoteLayouts(), FG_GraphicVector::createFromChangeRecord(), FG_GraphicRaster::createFromChangeRecord(), FG_Graphic::createFromChangeRecord(), FG_GraphicVector::createFromStrux(), FG_GraphicRaster::createFromStrux(), FG_Graphic::createFromStrux(), fl_DocSectionLayout::doclistener_changeStrux(), fp_Run::drawDecors(), fl_ContainerLayout::fl_ContainerLayout(), fl_TableLayout::format(), fl_BlockLayout::getEnclosingBlock(), fp_Run::lookupProperties(), fl_TableLayout::redrawUpdate(), fp_TextRun::setDirOverride(), fl_BlockLayout::setDominantDirection(), fl_DocSectionLayout::setHdrFtrHeightChange(), fl_BlockLayout::shuffleEmbeddedIfNeeded(), fp_EmbedRun::update(), fl_BlockLayout::updateEnclosingBlockIfNeeded(), fl_TableLayout::updateLayout(), and fl_DocSectionLayout::updateLayout().

pf_Frag_Strux* fl_Layout::getEndStruxDocHandle ( void   )  const [inline]

Referenced by FV_View::cmdInsertCol(), FV_View::cmdInsertRow(), fl_ContainerLayout::containsAnnotationLayouts(), and fl_ContainerLayout::containsFootnoteLayouts().

bool fl_Layout::getField ( UT_uint32  offset,
fd_Field *&  pField 
)

References PD_Document::getField(), m_pDoc, and m_sdh.

Referenced by fp_ForcedPageBreakRun::_lookupProperties(), fp_ForcedColumnBreakRun::_lookupProperties(), fp_FieldRun::_lookupProperties(), fp_ImageRun::_lookupProperties(), fp_FieldEndRun::_lookupProperties(), fp_FieldStartRun::_lookupProperties(), fp_ForcedLineBreakRun::_lookupProperties(), fp_TabRun::_lookupProperties(), and fp_FieldRun::fp_FieldRun().

bool fl_Layout::getSpanAttrProp ( UT_uint32  offset,
bool  bLeftSide,
const PP_AttrProp **  ppAP,
std::unique_ptr< PP_RevisionAttr > &  pRevisions,
bool  bShowRevisions,
UT_uint32  iRevisionId,
bool &  bHiddenRevision 
) const

if pRevisions is not needed, set the pointer to NULL(this speeds up things)

References PD_Document::getSpanAttrProp(), m_pDoc, m_sdh, and UT_return_val_if_fail.

Referenced by fl_BlockLayout::_doInsertFieldRun(), fp_Run::getSpanAP(), and fl_ContainerLayout::getSpanAP().

pf_Frag_Strux* fl_Layout::getStruxDocHandle ( void   )  const [inline]

Referenced by fl_BlockLayout::_addBlockToPrevList(), fl_BlockLayout::_assertRunListIntegrityImpl(), FV_View::_deleteSelection(), FV_View::_findGetNextBlockBuffer(), fl_DocSectionLayout::_HdrFtrChangeCallback(), fl_BlockLayout::_lookupProperties(), FV_View::_populateThisHdrFtr(), fl_BlockLayout::_prependBlockToPrevList(), fl_TOCLayout::_removeBlockInVec(), FV_View::_removeThisHdrFtr(), FV_Selection::addCellToSelection(), fl_HdrFtrSectionLayout::addPage(), AP_Dialog_Lists::Apply(), fp_FieldTOCNumRun::calculateValue(), fp_FieldTableSumCols::calculateValue(), fp_FieldTableSumRows::calculateValue(), fp_FieldListLabelRun::calculateValue(), fl_DocListener::change(), FV_View::cmdAdvanceNextPrevCell(), FV_View::cmdCharDelete(), FV_View::cmdInsertCol(), FV_View::cmdInsertRow(), FV_View::cmdSplitCells(), FV_View::cmdStopList(), fl_ContainerLayout::containsAnnotationLayouts(), fl_ContainerLayout::containsFootnoteLayouts(), FV_FrameEdit::deleteFrame(), fl_BlockLayout::doclistener_deleteStrux(), fl_BlockLayout::doclistener_insertSection(), fl_TOCLayout::fillTOC(), fl_HdrFtrShadow::findBlockAtPosition(), fl_TOCLayout::findMatchingBlock(), fl_HdrFtrShadow::findMatchingContainer(), fl_HdrFtrSectionLayout::findMatchingContainer(), fl_BlockLayout::fl_BlockLayout(), FV_View::getAllBlocksInList(), FV_View::getAnnotationText(), FV_View::getAttrPropForPoint(), fl_BlockLayout::getBlockBuf(), fl_TOCLayout::getDocPosition(), fl_FrameLayout::getDocPosition(), fl_EmbedLayout::getDocPosition(), fl_BlockLayout::getEmbeddedOffset(), fl_BlockLayout::getEnclosingBlock(), fl_TOCLayout::getLength(), fl_CellLayout::getLength(), fl_TableLayout::getLength(), fl_FrameLayout::getLength(), fl_EmbedLayout::getLength(), fl_BlockLayout::getLength(), fl_ContainerLayout::getLevelInList(), fl_BlockLayout::getListLabel(), fl_ContainerLayout::getPosition(), fl_BlockLayout::getPosition(), fl_BlockLayout::getPreviousList(), fl_TOCLayout::getTOCListLabel(), FV_View::insertAnnotationDescription(), FV_View::insertParagraphBreak(), fl_DocListener::insertStrux(), fl_TOCLayout::isBlockInTOC(), fl_CellLayout::isCellSelected(), fl_BlockLayout::isFirstInList(), FV_View::isInTable(), fl_TOCLayout::isInVector(), fl_HdrFtrSectionLayout::isPointInHere(), fl_BlockLayout::itemizeSpan(), FV_FrameEdit::mouseRelease(), fl_DocListener::populate(), fl_BlockLayout::prependList(), FL_DocLayout::relocateFrame(), fl_BlockLayout::remItemFromList(), fl_BlockLayout::resumeList(), FV_View::selectAnnotation(), FV_View::setAnnotationAuthor(), FV_View::setAnnotationText(), FV_View::setAnnotationTitle(), FV_View::setBlockIndents(), fp_FrameContainer::setPreferedColumnNo(), fp_FrameContainer::setPreferedPageNo(), FV_View::setStyleAtPos(), fl_BlockLayout::shuffleEmbeddedIfNeeded(), fl_BlockLayout::StartList(), fl_BlockLayout::StopListInBlock(), fl_BlockLayout::updateEnclosingBlockIfNeeded(), and fl_BlockLayout::~fl_BlockLayout().

PTStruxType fl_Layout::getType ( void   )  const [inline]

Reimplemented in fl_SectionLayout, and fl_TableLayout.

Referenced by s_RTF_ListenerWriteDoc::_getFieldValue(), fl_DocListener::change(), FL_DocLayout::findBlockAtPosition(), FL_DocLayout::findBlockAtPositionReverse(), fl_BlockLayout::getDocSectionLayout(), fl_DocListener::insertStrux(), fl_BlockLayout::isHdrFtr(), fl_BlockLayout::listUpdate(), fl_ShadowListener::populate(), and fl_DocListener::populate().

virtual void fl_Layout::listUpdate ( void   )  [inline, virtual]

Reimplemented in fl_BlockLayout.

void fl_Layout::setAttrPropIndex ( PT_AttrPropIndex  apIndex  ) 

References m_apIndex.

Referenced by fl_DocListener::change(), fl_TOCLayout::doclistener_changeStrux(), fl_CellLayout::doclistener_changeStrux(), fl_TableLayout::doclistener_changeStrux(), fl_HdrFtrShadow::doclistener_changeStrux(), fl_HdrFtrSectionLayout::doclistener_changeStrux(), fl_DocSectionLayout::doclistener_changeStrux(), fl_FrameLayout::doclistener_changeStrux(), fl_EmbedLayout::doclistener_changeStrux(), fl_BlockLayout::doclistener_changeStrux(), fl_BlockLayout::fl_BlockLayout(), and fl_ContainerLayout::fl_ContainerLayout().

void fl_Layout::setAutoNum ( const fl_AutoNumPtr &  pAutoNum  ) 

References m_pAutoNum.

Referenced by AP_Dialog_Lists::generateFakeLabels().

void fl_Layout::setEndStruxDocHandle ( pf_Frag_Strux *  pfs  ) 

References m_endSdh, and UT_ASSERT.

Referenced by fl_CellLayout::bl_doclistener_insertEndCell(), fl_EmbedLayout::bl_doclistener_insertEndEmbed(), fl_FrameLayout::bl_doclistener_insertEndFrame(), fl_TableLayout::bl_doclistener_insertEndTable(), fl_TOCLayout::bl_doclistener_insertEndTOC(), and fl_DocListener::populateStrux().

void fl_Layout::setType ( PTStruxType  type  ) 

References m_type.

Referenced by fl_HdrFtrSectionLayout::fl_HdrFtrSectionLayout(), and fl_HdrFtrShadow::fl_HdrFtrShadow().

Member Data Documentation

PT_AttrPropIndex fl_Layout::m_apIndex [protected]

Referenced by fl_CellLayout::_lookupProperties(), fl_HdrFtrSectionLayout::addPage(), getAttrProp(), and setAttrPropIndex().

pf_Frag_Strux* fl_Layout::m_endSdh [private]

Referenced by setEndStruxDocHandle().

fl_AutoNumPtr fl_Layout::m_pAutoNum [protected]

Referenced by fl_BlockLayout::_addBlockToPrevList(), fl_BlockLayout::_createListLabel(), fl_BlockLayout::_lookupProperties(), fl_BlockLayout::_prependBlockToPrevList(), fl_BlockLayout::doclistener_deleteObject(), fl_BlockLayout::doclistener_deleteStrux(), fl_BlockLayout::format(), fl_BlockLayout::getLevel(), fl_BlockLayout::getListLabel(), fl_BlockLayout::getParentItem(), fl_BlockLayout::getPreviousList(), fl_BlockLayout::isFirstInList(), fl_BlockLayout::listUpdate(), setAutoNum(), and fl_BlockLayout::StartList().

PD_Document* fl_Layout::m_pDoc [protected]

Referenced by fl_TOCLayout::_createAndFillTOCEntry(), fl_BlockLayout::_createListLabel(), fl_TOCLayout::_isStyleInTOC(), fl_DocSectionLayout::_lookupProperties(), fl_BlockLayout::_lookupProperties(), fl_TOCLayout::addBlock(), fl_HdrFtrSectionLayout::addPage(), fl_HdrFtrSectionLayout::bl_doclistener_changeFmtMark(), fl_HdrFtrSectionLayout::bl_doclistener_changeObject(), fl_HdrFtrSectionLayout::bl_doclistener_changeSpan(), fl_HdrFtrSectionLayout::bl_doclistener_changeStrux(), fl_HdrFtrSectionLayout::bl_doclistener_deleteFmtMark(), fl_HdrFtrSectionLayout::bl_doclistener_deleteObject(), fl_HdrFtrSectionLayout::bl_doclistener_deleteSpan(), fl_HdrFtrSectionLayout::bl_doclistener_deleteStrux(), fl_SectionLayout::bl_doclistener_insertBlock(), fl_HdrFtrSectionLayout::bl_doclistener_insertCell(), fl_HdrFtrSectionLayout::bl_doclistener_insertEndTable(), fl_HdrFtrSectionLayout::bl_doclistener_insertFirstBlock(), fl_HdrFtrSectionLayout::bl_doclistener_insertFmtMark(), fl_HdrFtrSectionLayout::bl_doclistener_insertObject(), fl_SectionLayout::bl_doclistener_insertSection(), fl_HdrFtrSectionLayout::bl_doclistener_insertSpan(), fl_TableLayout::bl_doclistener_insertTable(), fl_HdrFtrSectionLayout::bl_doclistener_insertTable(), fl_SectionLayout::bl_doclistener_insertTable(), fl_HdrFtrSectionLayout::bl_doclistener_populateObject(), fl_HdrFtrSectionLayout::bl_doclistener_populateSpan(), fl_BlockLayout::doclistener_changeStrux(), fl_BlockLayout::doclistener_deleteFmtMark(), fl_BlockLayout::doclistener_insertBlock(), fl_BlockLayout::doclistener_insertFrame(), fl_BlockLayout::doclistener_insertSection(), fl_BlockLayout::doclistener_insertSpan(), fl_BlockLayout::doclistener_insertTable(), fl_BlockLayout::doclistener_populateSpan(), fl_TOCLayout::fillTOC(), fl_HdrFtrShadow::findBlockAtPosition(), fl_HdrFtrShadow::findMatchingContainer(), fl_BlockLayout::fl_BlockLayout(), fl_ContainerLayout::fl_ContainerLayout(), fl_DocSectionLayout::fl_DocSectionLayout(), fl_SectionLayout::fl_SectionLayout(), getAttrProp(), fl_BlockLayout::getBlockBuf(), getBookmark(), FL_DocLayout::getDocument(), fl_BlockLayout::getEmbeddedOffset(), getField(), fl_CellLayout::getLength(), fl_TableLayout::getLength(), fl_BlockLayout::getLength(), fl_BlockLayout::getNextTableElement(), fl_BlockLayout::getPosition(), fl_BlockLayout::getProperty(), fl_BlockLayout::getPropertyType(), getSpanAttrProp(), fl_CellLayout::isCellSelected(), fl_HdrFtrSectionLayout::isPointInHere(), fl_BlockLayout::itemizeSpan(), fl_BlockLayout::prependList(), fl_BlockLayout::remItemFromList(), fl_BlockLayout::resumeList(), fl_BlockLayout::StartList(), fl_BlockLayout::StopListInBlock(), fl_TOCLayout::verifyBookmarkAssumptions(), and fl_BlockLayout::~fl_BlockLayout().

pf_Frag_Strux* fl_Layout::m_sdh [private]

Referenced by getBookmark(), getField(), and getSpanAttrProp().

PTStruxType fl_Layout::m_type [protected]

Referenced by setType().

The documentation for this class was generated from the following files:
Generated on Sun Feb 14 2021 for AbiWord by  doxygen 1.7.1