#include <fl_FrameLayout.h>

Inheritance diagram for fl_FrameLayout:

Public Member Functions
	fl_FrameLayout (FL_DocLayout pLayout, pf_Frag_Strux sdh, PT_AttrPropIndex ap, fl_ContainerLayout *pMyContainerLayout)
virtual	~fl_FrameLayout ()
virtual bool	doclistener_changeStrux (const PX_ChangeRecord_StruxChange *pcrxc)
virtual bool	doclistener_deleteStrux (const PX_ChangeRecord_Strux *pcrx)
virtual bool	doclistener_deleteEndFrame (const PX_ChangeRecord_Strux *pcrx)
virtual bool	bl_doclistener_insertEndFrame (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))
bool	insertBlockAfter (fl_ContainerLayout pCL, 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	miniFormat (void)
virtual void	format (void)
virtual void	updateLayout (bool bDoFull)
virtual void	collapse (void)
void	localCollapse ()
virtual void	markAllRunsDirty (void)
virtual fl_SectionLayout *	getSectionLayout (void) const
bool	recalculateFields (UT_uint32 iUpdateCount)
virtual void	redrawUpdate (void)
virtual fp_Container *	getNewContainer (fp_Container *=NULL)
PT_DocPosition	getDocPosition (void)
UT_uint32	getLength (void)
virtual void	setNeedsReformat (fl_ContainerLayout *pCL, UT_uint32 offset=0)
void	setContainerProperties (void)
UT_sint32	getBoundingSpace (void) const
FL_FrameType	getFrameType (void) const
FL_FrameFormatMode	getFramePositionTo (void) const
FL_FrameWrapMode	getFrameWrapMode (void) const
UT_sint32	getFrameWidth (void) const
UT_sint32	getFrameHeight (void) const
UT_sint32	getFrameXpos (void) const
UT_sint32	getFrameYpos (void) const
UT_sint32	getFrameXColpos (void) const
UT_sint32	getFrameYColpos (void) const
UT_sint32	getFrameXPagepos (void) const
UT_sint32	getFrameYPagepos (void) const
void	setFrameWidth (UT_sint32 iW)
void	setFrameHeight (UT_sint32 iH)
void	setFrameXpos (UT_sint32 iX)
void	setFrameYpos (UT_sint32 iY)
bool	isEndFrameIn (void) const
bool	isTightWrap (void)
bool	expandHeight (void) const
UT_sint32	minHeight (void) const
fl_ContainerLayout *	getParentContainer (void) const
void	setParentContainer (fl_ContainerLayout *pCon)
Private Member Functions
virtual void	_lookupProperties (const PP_AttrProp *pAP)
virtual void	_lookupMarginProperties (const PP_AttrProp *pAP)
void	_purgeLayout (void)
void	_createFrameContainer (void)
void	_insertFrameContainer (fp_Container *pNewFC)
Private Attributes
FL_FrameType	m_iFrameType
FL_FrameFormatMode	m_iFramePositionTo
bool	m_bNeedsRebuild
bool	m_bNeedsFormat
bool	m_bIsOnPage
bool	m_bHasEndFrame
PP_PropertyMap::Background	m_background
PP_PropertyMap::Line	m_lineBottom
PP_PropertyMap::Line	m_lineLeft
PP_PropertyMap::Line	m_lineRight
PP_PropertyMap::Line	m_lineTop
UT_sint32	m_iWidth
UT_sint32	m_iHeight
UT_sint32	m_iXpos
UT_sint32	m_iYpos
UT_sint32	m_iXpad
UT_sint32	m_iYpad
UT_sint32	m_iXColumn
UT_sint32	m_iYColumn
UT_sint32	m_iXPage
UT_sint32	m_iYPage
UT_sint32	m_iBoundingSpace
FL_FrameWrapMode	m_iFrameWrapMode
bool	m_bIsTightWrap
UT_sint32	m_iPrefPage
UT_sint32	m_iPrefColumn
bool	m_bExpandHeight
UT_sint32	m_iMinHeight
fl_ContainerLayout *	m_pParentContainer
Friends
class	fl_DocListener
class	fp_FrameContainer

Constructor & Destructor Documentation

fl_FrameLayout::fl_FrameLayout	(	FL_DocLayout *	pLayout,
		pf_Frag_Strux *	sdh,
		PT_AttrPropIndex	ap,
		fl_ContainerLayout *	pMyContainerLayout
	)

fl_FrameLayout::~fl_FrameLayout ( ) [virtual]

References _purgeLayout(), FV_FrameEdit_NOT_ACTIVE, fl_SectionLayout::getDocLayout(), fl_ContainerLayout::getFirstContainer(), FV_View::getFrameEdit(), FV_FrameEdit::getFrameLayout(), fl_ContainerLayout::getLastContainer(), fp_Container::getNext(), FL_DocLayout::getView(), fp_VerticalContainer::getView(), fl_ContainerLayout::setFirstContainer(), fl_ContainerLayout::setLastContainer(), FV_FrameEdit::setMode(), and UT_DEBUGMSG.

Member Function Documentation

void fl_FrameLayout::_createFrameContainer ( void ) [private]

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

References FG_Graphic::createFromStrux(), DELETEP, fp_FrameContainer, gchar, fl_ContainerLayout::getAP(), PP_AttrProp::getAttribute(), fp_FrameContainer::getFullHeight(), fp_FrameContainer::getFullWidth(), fl_ContainerLayout::lookupProperties(), m_iHeight, m_iWidth, fl_SectionLayout::m_pGraphicImage, fl_SectionLayout::m_pImageImage, PT_STRUX_IMAGE_DATAID, setContainerProperties(), fl_ContainerLayout::setFirstContainer(), fp_FrameContainer::setHeight(), fl_SectionLayout::setImageHeight(), fl_SectionLayout::setImageWidth(), fl_ContainerLayout::setLastContainer(), fp_VerticalContainer::setWidth(), and UT_DEBUGMSG.

Referenced by getNewContainer().

void fl_FrameLayout::_insertFrameContainer ( fp_Container * pNewFC ) [private]

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

void fl_FrameLayout::_lookupProperties ( const PP_AttrProp * pSectionAP ) [private, virtual]

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

Implements fl_ContainerLayout.

References gchar, fl_DocSectionLayout::getActualColumnWidth(), fl_SectionLayout::getDocLayout(), fl_ContainerLayout::getDocSectionLayout(), fp_ContainerObject::getGraphics(), FL_DocLayout::getGraphics(), PP_AttrProp::getProperty(), FL_DocLayout::getView(), m_background, m_bExpandHeight, m_bIsTightWrap, m_iBoundingSpace, m_iFramePositionTo, m_iFrameType, m_iFrameWrapMode, m_iHeight, m_iMinHeight, m_iPrefColumn, m_iPrefPage, m_iWidth, m_iXColumn, m_iXpad, m_iXPage, m_iXpos, m_iYColumn, m_iYpad, m_iYPage, m_iYpos, m_lineBottom, m_lineLeft, m_lineRight, m_lineTop, fl_SectionLayout::m_pLayout, PP_PropertyMap::Background::reset(), s_background_properties(), s_border_properties(), GR_Graphics::tlu(), UT_ASSERT, UT_convertFraction(), UT_convertToLogicalUnits(), UT_DEBUGMSG, UT_return_if_fail, and UT_SHOULD_NOT_HAPPEN.

void fl_FrameLayout::_purgeLayout ( void ) [private]

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

Reimplemented from fl_SectionLayout.

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

Referenced by ~fl_FrameLayout().

bool fl_FrameLayout::bl_doclistener_insertEndFrame	(	fl_ContainerLayout *	,
		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 FV_View::getPoint(), PX_ChangeRecord::getPosition(), FL_DocLayout::getView(), FV_View::isActive(), FV_View::isPreview(), m_bHasEndFrame, fl_SectionLayout::m_pLayout, fl_Layout::setEndStruxDocHandle(), FV_View::setPoint(), and FV_View::updateCarets().

Referenced by fl_DocListener::insertStrux().

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

bool fl_FrameLayout::doclistener_deleteEndFrame ( const PX_ChangeRecord_Strux * pcrx ) [virtual]

This signals an incomplete frame section.

References m_bHasEndFrame.

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

References collapse(), fl_BlockLayout::collapse(), fl_BlockLayout::format(), fp_FrameContainer::getBlocksAroundFrame(), fl_ContainerLayout::getFirstContainer(), UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), getParentContainer(), PX_ChangeRecord::getType(), fl_ContainerLayout::myContainingLayout(), fl_ContainerLayout::remove(), fl_ContainerLayout::removeFrame(), UT_ASSERT, UT_DEBUGMSG, UT_SHOULD_NOT_HAPPEN, UT_UNUSED, and xxx_UT_DEBUGMSG.

bool fl_FrameLayout::expandHeight ( void ) const [inline]

Referenced by fp_FrameContainer::layout().

void fl_FrameLayout::format ( void ) [virtual]

Implements fl_ContainerLayout.

Referenced by doclistener_changeStrux(), and updateLayout().

UT_sint32 fl_FrameLayout::getBoundingSpace ( void ) const

References m_iBoundingSpace.

Referenced by fp_FrameContainer::getLeftPad(), fl_BlockLayout::getLeftRightForWrapping(), fp_FrameContainer::getRightPad(), and fp_FrameContainer::overlapsRect().

PT_DocPosition fl_FrameLayout::getDocPosition ( void )

Returns the position in the document of the PTX_SectionFrame strux

References FL_DocLayout::getDocument(), fl_Layout::getStruxDocHandle(), PD_Document::getStruxPosition(), and fl_SectionLayout::m_pLayout.

Referenced by getLength().

UT_sint32 fl_FrameLayout::getFrameHeight ( void ) const [inline]

References fp_VerticalContainer::m_iHeight.

Referenced by fp_ImageRun::_lookupProperties().

FL_FrameFormatMode fl_FrameLayout::getFramePositionTo ( void ) const [inline]

Referenced by AP_Dialog_FormatFrame::applyChanges(), FV_View::cmdCharDelete(), Defun1(), fl_BlockLayout::doclistener_insertBlock(), and fl_BlockLayout::setFramesOnPage().

FL_FrameType fl_FrameLayout::getFrameType ( void ) const [inline]

Referenced by FV_View::_getMouseContext(), Defun(), Defun_EV_GetMenuItemState_Fn(), FV_FrameEdit::drawFrame(), fp_FrameContainer::getLeftPad(), fp_FrameContainer::getRightPad(), FV_FrameEdit::isImageWrapper(), fp_Page::mapXYToPosition(), fp_VerticalContainer::mapXYToPosition(), FV_FrameEdit::mouseLeftPress(), and FL_DocLayout::relocateFrame().

UT_sint32 fl_FrameLayout::getFrameWidth ( void ) const [inline]

References fp_VerticalContainer::m_iWidth.

Referenced by fp_ImageRun::_lookupProperties().

FL_FrameWrapMode fl_FrameLayout::getFrameWrapMode ( void ) const [inline]

Referenced by Defun1(), and AP_UnixDialog_FormatFrame::notifyActiveFrame().

UT_sint32 fl_FrameLayout::getFrameXColpos ( void ) const [inline]

Referenced by fl_BlockLayout::setFramesOnPage().

UT_sint32 fl_FrameLayout::getFrameXPagepos ( void ) const [inline]

Referenced by fl_BlockLayout::setFramesOnPage().

UT_sint32 fl_FrameLayout::getFrameXpos ( void ) const [inline]

Referenced by fl_BlockLayout::setFramesOnPage().

UT_sint32 fl_FrameLayout::getFrameYColpos ( void ) const [inline]

Referenced by fl_BlockLayout::setFramesOnPage().

UT_sint32 fl_FrameLayout::getFrameYPagepos ( void ) const [inline]

Referenced by fl_BlockLayout::setFramesOnPage().

UT_sint32 fl_FrameLayout::getFrameYpos ( void ) const [inline]

Referenced by fl_BlockLayout::setFramesOnPage().

UT_uint32 fl_FrameLayout::getLength ( void )

This method returns the length of the Frame. This is such that getDocPosition() + getLength() is one value beyond the the EndFrame strux

References getDocPosition(), FL_DocLayout::getDocument(), PD_Document::getNextStruxOfType(), fl_Layout::getStruxDocHandle(), PD_Document::getStruxPosition(), fl_SectionLayout::m_pLayout, PTX_EndFrame, and UT_ASSERT.

Referenced by FV_View::_deleteSelection(), FV_View::cmdCharDelete(), FV_View::cmdSelect(), FV_View::copyFrame(), FL_DocLayout::relocateFrame(), FV_View::selectFrame(), and FV_FrameEdit::setPointInside().

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

Create a new Frame container.

Parameters:

If

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

Returns:: The newly created Frame container

Implements fl_SectionLayout.

References _createFrameContainer(), fl_ContainerLayout::getLastContainer(), m_bIsOnPage, and UT_DEBUGMSG.

Referenced by format().

fl_ContainerLayout* fl_FrameLayout::getParentContainer ( void ) const [inline]

Referenced by fl_ContainerLayout::addFrame(), doclistener_deleteStrux(), format(), FV_FrameEdit::mouseRelease(), fl_ContainerLayout::removeFrame(), and FV_View::setFrameFormat().

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

Implements fl_ContainerLayout.

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

Referenced by fp_FrameContainer::getDocSectionLayout().

bool fl_FrameLayout::insertBlockAfter	(	fl_ContainerLayout *	pCL,
		const PX_ChangeRecord_Strux *	pcrx,
		pf_Frag_Strux *	sdh,
		PL_ListenerId	lid,
		void()(pf_Frag_Strux sdhNew, PL_ListenerId lid, fl_ContainerLayout *sfhNew)	pfnBindHandles
	)