A layout frame is a frame that contains other frames (m_pLower), e.g. SwPageFrame or SwTabFrame. More...

#include <layfrm.hxx>

Inheritance diagram for SwLayoutFrame:

Collaboration diagram for SwLayoutFrame:

Public Member Functions
virtual void	PaintSubsidiaryLines (const SwPageFrame *, const SwRect &) const

void	RefreshLaySubsidiary (const SwPageFrame *, const SwRect &) const

void	RefreshExtraData (const SwRect &) const

void	ChgLowersProp (const Size &rOldSize)
	Change size of lowers proportionally. More...

void	AdjustColumns (const SwFormatCol *pCol, bool bAdjustAttributes)

void	ChgColumns (const SwFormatCol &rOld, const SwFormatCol &rNew, const bool bChgFootnote=false)
	add or remove columns from a layoutframe. More...

void	PaintColLines (const SwRect &, const SwFormatCol &, const SwPageFrame *) const
	Paints the column separation line for the inner columns. More...

virtual bool	FillSelection (SwSelectionList &rList, const SwRect &rRect) const override

virtual bool	GetModelPositionForViewPoint (SwPosition , Point &, SwCursorMoveState =nullptr, bool bTestBackground=false) const override
	Searches the ContentFrame owning the PrtArea containing the point. More...

virtual void	Cut () override

virtual void	Paste (SwFrame pParent, SwFrame pSibling=nullptr) override

const SwContentFrame *	GetContentPos (Point &rPoint, const bool bDontLeave, const bool bBodyOnly=false, SwCursorMoveState *pCMS=nullptr, const bool bDefaultExpand=true) const
	Finds the closest Content for the SPoint Is used for Pages, Flys and Cells if GetModelPositionForViewPoint failed. More...

	SwLayoutFrame (SwFrameFormat , SwFrame )

virtual void	PaintSwFrame (vcl::RenderContext &rRenderContext, SwRect const &, SwPrintData const *const pPrintData=nullptr) const override

const SwFrame *	Lower () const

SwFrame *	Lower ()

bool	ContainsDeleteForbiddenLayFrame () const

const SwContentFrame *	ContainsContent () const
	Checks if the frame contains one or more ContentFrame's anywhere in his subsidiary structure; if so the first found ContentFrame is returned. More...

SwContentFrame *	ContainsContent ()
	In order to save us from duplicating implementations, we cast here a little. More...

const SwCellFrame *	FirstCell () const
	Calls ContainsAny first to reach the innermost cell. More...

SwCellFrame *	FirstCell ()

const SwFrame *	ContainsAny (const bool _bInvestigateFootnoteForSections=false) const
	Method <ContainsAny()> doesn't investigate content of footnotes by default. More...

SwFrame *	ContainsAny (const bool _bInvestigateFootnoteForSections=false)

bool	IsAnLower (const SwFrame *) const

virtual const SwFrameFormat *	GetFormat () const

virtual SwFrameFormat *	GetFormat ()

void	SetFrameFormat (SwFrameFormat *)

bool	MoveLowerFootnotes (SwContentFrame pStart, SwFootnoteBossFrame pOldBoss, SwFootnoteBossFrame *pNewBoss, const bool bFootnoteNums)
	Moving the Footnotes of all Lowers - starting from StartContent. More...

void	NotifyLowerObjs (const bool _bUnlockPosOfObjs=false)
	force an unlockposition call for the lower objects. More...

void	InvaPercentLowers (SwTwips nDiff=0)
	Invalidates the inner Frames, whose width and/or height are calculated using percentages. More...

void	FormatWidthCols (const SwBorderAttrs &, const SwTwips nBorder, const SwTwips nMinHeight)
	Called by Format for Frames and Areas with columns. More...

SwTwips	InnerHeight () const
	InnerHeight returns the height of the content and may be bigger or less than the PrtArea-Height of the layoutframe himself. More...

bool	IsBefore (const SwLayoutFrame *_pCheckRefLayFrame) const
	method to check relative position of layout frame to a given layout frame. More...

SwFrame *	GetLastLower ()

virtual void	PaintBreak () const

void	SetVertPosOrientFrameFor (SwAnchoredObject *pObj)

void	ClearVertPosOrientFrameFor (SwAnchoredObject *pObj)


const SwFrame *	GetLastLower () const

Public Member Functions inherited from SwFrame
virtual css::uno::Sequence< css::style::TabStop >	GetTabStopInfo (SwTwips)

SwFrameType	GetType () const

SwTwips	Shrink (SwTwips, bool bTst=false, bool bInfo=false)

SwTwips	Grow (SwTwips, bool bTst=false, bool bInfo=false)

void	InsertBefore (SwLayoutFrame pParent, SwFrame pBehind)
	Insert SwFrame into existing structure. More...

void	InsertBehind (SwLayoutFrame pParent, SwFrame pBefore)
	Insert SwFrame into existing structure. More...

bool	InsertGroupBefore (SwFrame pParent, SwFrame pWhere, SwFrame *pSct)
	Insert a chain of SwFrames into an existing structure. More...

void	RemoveFromLayout ()

SwLayoutFrame *	GetLeaf (MakePageType eMakePage, bool bFwd)

SwLayoutFrame *	GetNextLeaf (MakePageType eMakePage)
	Returns the next layout leaf in which we can move the frame. More...

SwLayoutFrame *	GetNextFootnoteLeaf (MakePageType eMakePage)
	Return the next layout leaf in that the frame can be moved. More...

SwLayoutFrame *	GetNextSctLeaf (MakePageType eMakePage)
	Returns the next layout sheet where the frame can be moved in. More...

SwLayoutFrame *	GetNextFlyLeaf (MakePageType eMakePage)

SwLayoutFrame *	GetPrevLeaf ()
	Returns the previous layout leaf where we can move the frame. More...

SwLayoutFrame *	GetPrevFootnoteLeaf (MakePageType eMakeFootnote)
	Get the preceding layout leaf in that the frame can be moved. More...

SwLayoutFrame *	GetPrevSctLeaf ()
	Returns the preceding layout sheet where the frame can be moved into. More...

SwLayoutFrame *	GetPrevFlyLeaf ()

const SwLayoutFrame *	GetLeaf (MakePageType eMakePage, bool bFwd, const SwFrame *pAnch) const
	Returns the next/previous Layout leaf that's NOT below this (or even is this itself). More...

bool	WrongPageDesc (SwPageFrame *pNew)

void	AppendDrawObj (SwAnchoredObject &_rNewObj)

void	RemoveDrawObj (SwAnchoredObject &_rToRemoveObj)

void	AppendFly (SwFlyFrame *pNew)

void	RemoveFly (SwFlyFrame *pToRemove)

const SwSortedObjs *	GetDrawObjs () const

SwSortedObjs *	GetDrawObjs ()

void	SetDrawObjsAsDeleted (bool bDeleted)

void	InvalidateObjs (const bool _bNoInvaOfAsCharAnchoredObjs=true)

virtual void	PaintSwFrameShadowAndBorder (const SwRect &, const SwPageFrame *pPage, const SwBorderAttrs &) const
	Paints shadows and borders. More...

void	PaintBaBo (const SwRect &, const SwPageFrame *pPage, const bool bOnlyTextBackground=false) const

void	PaintSwFrameBackground (const SwRect &, const SwPageFrame *pPage, const SwBorderAttrs &, const bool bLowerMode=false, const bool bLowerBorder=false, const bool bOnlyTextBackground=false) const
	Do not paint background for fly frames without a background brush by calling <PaintBaBo> at the page or at the fly frame its anchored. More...

void	PaintBorderLine (const SwRect &, const SwRect &, const SwPageFrame , const Color pColor, const SvxBorderLineStyle=SvxBorderLineStyle::SOLID) const

std::unique_ptr< drawinglayer::processor2d::BaseProcessor2D >	CreateProcessor2D () const

void	ProcessPrimitives (const drawinglayer::primitive2d::Primitive2DContainer &rSequence) const

void	Retouch (const SwPageFrame *pPage, const SwRect &rRect) const
	Retouch for a section. More...

bool	GetBackgroundBrush (drawinglayer::attribute::SdrAllFillAttributesHelperPtr &rFillAttributes, const SvxBrushItem *&rpBrush, std::optional< Color > &rxColor, SwRect &rOrigRect, bool bLowerMode, bool bConsiderTextBox) const
	Determine the background brush for the frame: the background brush is taken from it-self or from its parent (anchor/upper). More...

void	SetCompletePaint () const

void	ResetCompletePaint () const

bool	IsCompletePaint () const

void	SetRetouche () const

void	ResetRetouche () const

bool	IsRetouche () const

void	InvalidateInfFlags ()

bool	IsInDocBody () const

bool	IsInFootnote () const

bool	IsInTab () const

bool	IsInFly () const

bool	IsInSct () const

bool	IsVertical () const

bool	IsVertLR () const

bool	IsVertLRBT () const

void	SetDerivedVert (bool bNew)

void	SetInvalidVert (bool bNew)

bool	IsRightToLeft () const

void	SetDerivedR2L (bool bNew)

void	CheckDirChange ()
	checks the layout direction and invalidates the lower frames recursively, if necessary. More...

Point	GetFrameAnchorPos (bool bIgnoreFlysAnchoredAtThisFrame) const
	returns the position for anchors based on frame direction More...

bool	IsFootnoteAllowed () const

virtual void	Format (vcl::RenderContext pRenderContext, const SwBorderAttrs pAttrs=nullptr)
	Calculates the frame area size and the print area, in case they are invalid. More...

virtual void	CheckDirection (bool bVert)

void	ReinitializeFrameSizeAttrFlags ()

bool	HasFixSize () const

SwFrame *	GetNext ()

SwFrame *	GetPrev ()

SwLayoutFrame *	GetUpper ()

SwRootFrame *	getRootFrame ()

SwPageFrame *	FindPageFrame ()

SwFrame *	GetLower ()

const SwFrame *	GetNext () const

const SwFrame *	GetPrev () const

const SwLayoutFrame *	GetUpper () const

const SwRootFrame *	getRootFrame () const

SwTabFrame *	FindTabFrame ()

SwFootnoteFrame *	FindFootnoteFrame ()

SwFlyFrame *	FindFlyFrame ()

SwSectionFrame *	FindSctFrame ()

SwFrame *	FindNext ()

SwContentFrame *	FindNextCnt (const bool _bInSameFootnote=false)

SwFrame *	FindPrev ()

const SwPageFrame *	FindPageFrame () const

const SwFootnoteBossFrame *	FindFootnoteBossFrame (bool bFootnote=false) const

const SwFrame *	FindColFrame () const

const SwFrame *	FindFooterOrHeader () const

const SwTabFrame *	FindTabFrame () const

const SwFootnoteFrame *	FindFootnoteFrame () const

const SwFlyFrame *	FindFlyFrame () const

const SwSectionFrame *	FindSctFrame () const

const SwBodyFrame *	FindBodyFrame () const

const SwFrame *	FindNext () const

const SwContentFrame *	FindNextCnt (const bool _bInSameFootnote=false) const

const SwFrame *	FindPrev () const

const SwFrame *	GetLower () const

SwContentFrame *	FindPrevCnt ()

const SwContentFrame *	FindPrevCnt () const

SwFrame *	GetIndPrev_ () const
	Called for a frame inside a section with no direct previous frame (or only previous empty section frames) the previous frame of the outer section is returned, if the frame is the first flowing content of this section. More...

SwFrame *	GetIndPrev () const

SwFrame *	GetIndNext ()

const SwFrame *	GetIndNext () const

sal_uInt16	GetPhyPageNum () const

sal_uInt16	GetVirtPageNum () const

bool	OnRightPage () const

bool	WannaRightPage () const
	Decides if the page want to be a right page or not. More...

bool	OnFirstPage () const

const SwLayoutFrame *	GetPrevLayoutLeaf () const

const SwLayoutFrame *	GetNextLayoutLeaf () const

SwLayoutFrame *	GetPrevLayoutLeaf ()

SwLayoutFrame *	GetNextLayoutLeaf ()

virtual void	Calc (vcl::RenderContext *pRenderContext) const

void	OptCalc () const

Point	GetRelPos () const

SwRect	GetPaintArea () const
	\|* The paintarea is the area, in which the content of a frame is allowed \|* to be displayed. More...

SwRect	UnionFrame (bool bBorder=false) const
	\|* The unionframe is the framearea (getFrameArea()) of a frame expanded by the \|* printarea, if there's a negative margin at the left or right side. More...

virtual Size	ChgSize (const Size &aNewSize)

virtual void	Cut ()=0

virtual void	Paste (SwFrame pParent, SwFrame pSibling=nullptr)=0

void	ValidateLineNum ()

bool	GetValidLineNumFlag () const

void	InvalidateSize_ ()

void	InvalidatePrt_ ()

void	InvalidatePos_ ()

void	InvalidateLineNum_ ()

void	InvalidateAll_ ()

void	InvalidateSize ()

void	InvalidatePrt ()

void	InvalidatePos ()

void	InvalidateLineNum ()

void	InvalidateAll ()

void	ImplInvalidateSize ()

void	ImplInvalidatePrt ()

void	ImplInvalidatePos ()

void	ImplInvalidateLineNum ()

void	InvalidateNextPos (bool bNoFootnote=false)

void	InvalidatePage (const SwPageFrame *pPage=nullptr) const
	Invalidates the page in which the Frame is currently placed. More...

virtual bool	FillSelection (SwSelectionList &rList, const SwRect &rRect) const

virtual bool	GetModelPositionForViewPoint (SwPosition , Point &, SwCursorMoveState =nullptr, bool bTestBackground=false) const

virtual bool	GetCharRect (SwRect &, const SwPosition &, SwCursorMoveState *=nullptr, bool bAllowFarAway=true) const

virtual void	PaintSwFrame (vcl::RenderContext &rRenderContext, SwRect const &, SwPrintData const *const pPrintData=nullptr) const

virtual bool	Prepare (const PrepareHint ePrep=PrepareHint::Clear, const void *pVoid=nullptr, bool bNotify=true)

bool	IsLayoutFrame () const

bool	IsRootFrame () const

bool	IsPageFrame () const

bool	IsColumnFrame () const

bool	IsFootnoteBossFrame () const

bool	IsHeaderFrame () const

bool	IsFooterFrame () const

bool	IsFootnoteContFrame () const

bool	IsFootnoteFrame () const

bool	IsBodyFrame () const

bool	IsColBodyFrame () const
	These SwFrame inlines are here, so that frame.hxx does not need to include layfrm.hxx. More...

bool	IsPageBodyFrame () const

bool	IsFlyFrame () const

bool	IsSctFrame () const

bool	IsTabFrame () const

bool	IsRowFrame () const

bool	IsCellFrame () const

bool	IsContentFrame () const

bool	IsTextFrame () const

bool	IsNoTextFrame () const

bool	IsFlowFrame () const

bool	IsRetoucheFrame () const

bool	IsAccessibleFrame () const

void	PrepareCursor ()

bool	IsProtected () const
	Is the Frame or rather the Section in which it lies protected? More...

bool	IsColLocked () const

virtual bool	IsDeleteForbidden () const

bool	IsInDtor () const

tools::Long	GetTopMargin () const

tools::Long	GetBottomMargin () const

tools::Long	GetLeftMargin () const

tools::Long	GetRightMargin () const

void	SetTopBottomMargins (tools::Long, tools::Long)

void	SetLeftRightMargins (tools::Long, tools::Long)

void	SetRightLeftMargins (tools::Long, tools::Long)

tools::Long	GetPrtLeft () const

tools::Long	GetPrtBottom () const

tools::Long	GetPrtRight () const

tools::Long	GetPrtTop () const

bool	SetMinLeft (tools::Long)

bool	SetMaxBottom (tools::Long)

bool	SetMaxRight (tools::Long)

void	MakeBelowPos (const SwFrame , const SwFrame , bool)

void	MakeLeftPos (const SwFrame , const SwFrame , bool)

void	MakeRightPos (const SwFrame , const SwFrame , bool)

bool	IsNeighbourFrame () const

virtual bool	IsLeaveUpperAllowed () const

virtual bool	IsCoveredCell () const

bool	IsInCoveredCell () const

bool	KnowsFormat (const SwFormat &rFormat) const

void	RegisterToFormat (SwFormat &rFormat)

void	ValidateThisAndAllLowers (const sal_uInt16 nStage)

void	ForbidDelete ()

void	AllowDelete ()

virtual void	dumpAsXml (xmlTextWriterPtr writer=nullptr) const =0

void	dumpTopMostAsXml (xmlTextWriterPtr writer=nullptr) const

void	dumpInfosAsXml (xmlTextWriterPtr writer) const

virtual void	dumpAsXmlAttributes (xmlTextWriterPtr writer) const

void	dumpChildrenAsXml (xmlTextWriterPtr writer) const

bool	IsCollapse () const

SwLayoutFrame *	GetNextCellLeaf ()

SwLayoutFrame *	GetPrevCellLeaf ()

void	SetInfFlags ()

const SwRowFrame *	IsInSplitTableRow () const

const SwRowFrame *	IsInFollowFlowRow () const

bool	IsInBalancedSection () const

bool	IsMoveable (const SwLayoutFrame *_pLayoutFrame=nullptr) const
	determine, if frame is moveable in given environment More...

const SwAttrSet *	GetAttrSet () const
	WARNING: this may not return correct RES_PAGEDESC/RES_BREAK items for SwTextFrame, use GetBreakItem()/GetPageDescItem() instead. More...

virtual const SvxFormatBreakItem &	GetBreakItem () const

virtual const SwFormatPageDesc &	GetPageDescItem () const

SwFrame *	FindColFrame ()

SwRowFrame *	FindRowFrame ()

SwFootnoteBossFrame *	FindFootnoteBossFrame (bool bFootnotes=false)

SwTabFrame *	ImplFindTabFrame ()

SwFootnoteFrame *	ImplFindFootnoteFrame ()

SwFlyFrame *	ImplFindFlyFrame ()

SwSectionFrame *	ImplFindSctFrame ()

const SwBodyFrame *	ImplFindBodyFrame () const

SwFrame *	FindFooterOrHeader ()

void	ImplInvalidateNextPos (bool bNoFootnote)

void	InvalidateNextPrtArea ()
	method to invalidate printing area of next frame #i11859# More...

SwTextFrame *	DynCastTextFrame ()

const SwTextFrame *	DynCastTextFrame () const

drawinglayer::attribute::SdrAllFillAttributesHelperPtr	getSdrAllFillAttributesHelper () const

bool	supportsFullDrawingLayerFillAttributeSet () const

Public Member Functions inherited from SwFrameAreaDefinition
	SwFrameAreaDefinition ()

virtual	~SwFrameAreaDefinition ()

bool	isFrameAreaPositionValid () const

bool	isFrameAreaSizeValid () const

bool	isFramePrintAreaValid () const

bool	isFrameAreaDefinitionValid () const

sal_uInt32	GetFrameId () const

const SwRect &	getFrameArea () const

const SwRect &	getFramePrintArea () const

virtual basegfx::B2DHomMatrix	getFrameAreaTransformation () const

virtual basegfx::B2DHomMatrix	getFramePrintAreaTransformation () const

virtual void	transform_translate (const Point &rOffset)

Public Member Functions inherited from SwClient
	SwClient ()

	SwClient (SwClient &&) noexcept

virtual	~SwClient () override

std::optional< sw::ModifyChangedHint >	CheckRegistration (const SfxPoolItem *pOldValue)

void	CheckRegistrationFormat (SwFormat &rOld)

const SwModify *	GetRegisteredIn () const

SwModify *	GetRegisteredIn ()

void	EndListeningAll ()

void	StartListeningToSameModifyAs (const SwClient &)

virtual bool	GetInfo (SfxPoolItem &) const

Public Member Functions inherited from sw::WriterListener
bool	IsLast () const

virtual const SwCellFrame *	DynCastCellFrame () const

virtual const SwTabFrame *	DynCastTabFrame () const

virtual const SwRowFrame *	DynCastRowFrame () const

virtual const SwTable *	DynCastTable () const

Public Member Functions inherited from SfxBroadcaster
	SfxBroadcaster ()

	SfxBroadcaster (const SfxBroadcaster &rBC)

virtual	~SfxBroadcaster () COVERITY_NOEXCEPT_FALSE

void	Broadcast (const SfxHint &rHint)

bool	HasListeners () const

size_t	GetListenerCount () const

void	ForAllListeners (std::function< bool(SfxListener *)> f) const

Protected Member Functions
virtual void	DestroyImpl () override

virtual	~SwLayoutFrame () override

virtual void	Format (vcl::RenderContext pRenderContext, const SwBorderAttrs pAttrs=nullptr) override
	"Formats" the Frame; Frame and PrtArea. More...

virtual void	MakeAll (vcl::RenderContext *pRenderContext) override

virtual SwTwips	ShrinkFrame (SwTwips, bool bTst=false, bool bInfo=false) override

virtual SwTwips	GrowFrame (SwTwips, bool bTst=false, bool bInfo=false) override

tools::Long	CalcRel (const SwFormatFrameSize &rSz) const

Protected Member Functions inherited from SwFrame
void	ColLock ()

void	ColUnlock ()

virtual void	DestroyImpl ()

virtual	~SwFrame () override

void	setRootFrame (SwRootFrame *pRoot)

SwPageFrame *	InsertPage (SwPageFrame *pSibling, bool bFootnote)

void	PrepareMake (vcl::RenderContext *pRenderContext)
	Prepares the Frame for "formatting" (MakeAll()). More...

void	OptPrepareMake ()

virtual void	MakePos ()
	Calculates the frame area position, in case it's invalid. More...

virtual void	MakeAll (vcl::RenderContext *pRenderContext)=0

SwTwips	AdjustNeighbourhood (SwTwips nDiff, bool bTst=false)
	Adjust surrounding neighbourhood after insertion. More...

virtual SwTwips	ShrinkFrame (SwTwips, bool bTst=false, bool bInfo=false)=0

virtual SwTwips	GrowFrame (SwTwips, bool bTst=false, bool bInfo=false)=0

sw::BroadcastingModify *	GetDep ()
	use these so we can grep for SwFrame's GetRegisteredIn accesses beware that SwTextFrame may return sw::WriterMultiListener More...

const sw::BroadcastingModify *	GetDep () const

	SwFrame (sw::BroadcastingModify , SwFrame )

void	CheckDir (SvxFrameDirection nDir, bool bVert, bool bOnlyBiDi, bool bBrowse)

virtual bool	InvalidationAllowed (const InvalidationType _nInvalid) const
	method to determine, if an invalidation is allowed. More...

virtual void	ActionOnInvalidation (const InvalidationType _nInvalid)
	method to perform additional actions on an invalidation More...

void	PaintShadow (const SwRect &, SwRect &, const SwBorderAttrs &) const
	Paints a shadow if the format requests so. More...

virtual void	SwClientNotify (const SwModify &, const SfxHint &) override

virtual const IDocumentDrawModelAccess &	getIDocumentDrawModelAccess ()

Protected Member Functions inherited from SwFrameAreaDefinition
void	setFrameAreaPositionValid (bool bNew)

void	setFrameAreaSizeValid (bool bNew)

void	setFramePrintAreaValid (bool bNew)

Protected Member Functions inherited from SwClient
	SwClient (SwModify *pToRegisterIn)

SwModify *	GetRegisteredInNonConst () const

virtual void	SwClientNotify (const SwModify &, const SfxHint &rHint) override

Protected Member Functions inherited from sw::WriterListener
	WriterListener ()

virtual	~WriterListener () COVERITY_NOEXCEPT_FALSE

virtual void	SwClientNotify (const SwModify &, const SfxHint &rHint)=0

Protected Member Functions inherited from SfxBroadcaster
void	Forward (SfxBroadcaster &rBC, const SfxHint &rHint)

Protected Attributes
SwFrame *	m_pLower

std::vector< SwAnchoredObject * >	m_VertPosOrientFramesFor

Protected Attributes inherited from SwFrame
std::unique_ptr< SwSortedObjs >	m_pDrawObjs

SwFrameType	mnFrameType

bool	mbInDtor: 1

bool	mbInvalidR2L: 1

bool	mbDerivedR2L: 1

bool	mbRightToLeft: 1

bool	mbInvalidVert: 1

bool	mbDerivedVert: 1

bool	mbVertical: 1

bool	mbVertLR: 1

bool	mbVertLRBT: 1

bool	mbValidLineNum: 1

bool	mbFixSize: 1

bool	mbCompletePaint: 1

bool	mbRetouche: 1

bool	mbInfInvalid: 1

bool	mbInfBody: 1

bool	mbInfTab: 1

bool	mbInfFly: 1

bool	mbInfFootnote: 1

bool	mbInfSct: 1

bool	mbColLocked: 1

bool	m_isInDestroy: 1

int	mnForbidDelete

Friends
class	SwFlowFrame

class	SwFrame

SwFrame *	SaveContent (SwLayoutFrame , SwFrame )

void	RestoreContent (SwFrame , SwLayoutFrame , SwFrame *pSibling)

Additional Inherited Members
Static Public Member Functions inherited from SwFrame
static SwCache &	GetCache ()

static SwCache *	GetCachePtr ()

static void	SetCache (SwCache *pNew)

static void	CheckPageDescs (SwPageFrame pStart, bool bNotifyFields=true, SwPageFrame *ppPrev=nullptr)
	Check all pages (starting from the given one) if they use the appropriate frame format. More...

static void	DestroyFrame (SwFrame *const pFrame)
	this is the only way to delete a SwFrame instance More...

Protected Types inherited from SwFrame
enum	InvalidationType { INVALID_SIZE , INVALID_PRTAREA , INVALID_POS , INVALID_LINENUM , INVALID_ALL }
	enumeration for the different invalidations #i28701# More...

Detailed Description

A layout frame is a frame that contains other frames (m_pLower), e.g. SwPageFrame or SwTabFrame.

Definition at line 35 of file layfrm.hxx.

Constructor & Destructor Documentation

◆ ~SwLayoutFrame()

SwLayoutFrame::~SwLayoutFrame ( )

overrideprotectedvirtual

Definition at line 586 of file ssfrm.cxx.

◆ SwLayoutFrame()

SwLayoutFrame::SwLayoutFrame	(	SwFrameFormat *	pFormat,
		SwFrame *	pSib
	)

Definition at line 2591 of file wsfrm.cxx.

References Fixed, SwFormat::GetFrameSize(), SwFormatFrameSize::GetHeightSizeType(), and SwFrame::mbFixSize.

Member Function Documentation

◆ AdjustColumns()

void SwLayoutFrame::AdjustColumns	(	const SwFormatCol *	pCol,
		bool	bAdjustAttributes
	)

Definition at line 313 of file colfrm.cxx.

References SwFormatCol::CalcColWidth(), SwFrame::ChgSize(), COLADJ_NONE, SwRectFnCollection::fnGetWidth, fnRectHori, fnRectVert, fnRectVertL2R, fnRectVertL2RB2T, SwFrame::GetAttrSet(), SwFormat::GetCol(), SwFormatCol::GetColumns(), GetFormat(), SwFrameAreaDefinition::getFramePrintArea(), GetLastLower(), SvxLRSpaceItem::GetLeft(), SwColumn::GetLeft(), SwFormatCol::GetLineAdj(), SwFormatCol::GetLineWidth(), SwAttrSet::GetLRSpace(), SwFrame::GetNext(), SwFormatCol::GetNumCols(), SwFrame::GetPrev(), SvxLRSpaceItem::GetRight(), SwColumn::GetRight(), SwAttrSet::GetULSpace(), Height, i, SwFrame::IsBodyFrame(), SwFormatCol::IsOrtho(), SwFrame::IsRightToLeft(), SwFrame::IsVertical(), SwFrame::IsVertLR(), SwFrame::IsVertLRBT(), Lower(), SwFormat::SetFormatAttr(), SvxLRSpaceItem::SetLeft(), SvxULSpaceItem::SetLower(), SvxLRSpaceItem::SetRight(), SvxULSpaceItem::SetUpper(), SSize, and Width.

Referenced by SwFrame::CheckDirChange(), ChgColumns(), ChgLowersProp(), SwFlyFrame::Format(), SwSectionFrame::Format(), and FormatWidthCols().

◆ CalcRel()

tools::Long SwLayoutFrame::CalcRel ( const SwFormatFrameSize & rSz ) const

protected

Definition at line 3647 of file wsfrm.cxx.

References SwViewOption::getBrowseMode(), SwViewShell::GetBrowseWidth(), SwRootFrame::GetCurrShell(), SwFrameAreaDefinition::getFramePrintArea(), SwFrame::getRootFrame(), SwFrame::GetUpper(), SwViewShell::GetViewOptions(), SvxSizeItem::GetWidth(), SwFormatFrameSize::GetWidthPercent(), SwFrame::IsPageBodyFrame(), LONG_MAX, min(), SwViewShell::VisArea(), and SwRect::Width().

Referenced by SwTabFrame::Format().

◆ ChgColumns()

void SwLayoutFrame::ChgColumns	(	const SwFormatCol &	rOld,
		const SwFormatCol &	rNew,
		const bool	bChgFootnote = `false`
	)

add or remove columns from a layoutframe.

Normally, a layoutframe with a column attribute of 1 or 0 columns contains no columnframe. However, a sectionframe with "footnotes at the end" needs a columnframe.

Parameters

rOld
rNew
bChgFootnote	if true, the columnframe will be inserted or removed, if necessary.

Definition at line 203 of file colfrm.cxx.

References AdjustColumns(), ATT_LEFT_TO_RIGHT, SwDoc::GetColumnContFormat(), SwFormatCol::GetColumns(), IDocumentLayoutAccess::GetCurrentLayout(), SwDoc::GetDfltFrameFormat(), SwFormat::GetDoc(), GetFormat(), SwDoc::getIDocumentLayoutAccess(), SwFormatCol::GetLineWidth(), SwFrame::GetNext(), SwFormatCol::GetNumCols(), SwFrame::GetUpper(), SwFormatCol::GetWishWidth(), i, SwFrame::IsBodyFrame(), SwFrame::IsColumnFrame(), SwFrame::IsLayoutFrame(), SwFrame::IsNoTextFrame(), SwFormatCol::IsOrtho(), SwFrame::IsPageBodyFrame(), SwFrame::IsSctFrame(), lcl_AddColumns(), lcl_RemoveColumns(), Lower(), min(), nCount, SwRootFrame::RemoveFootnotes(), RestoreContent, SaveContent, SwFormat::SetFormatAttr(), and SetFrameFormat().

Referenced by SwSectionFrame::Init(), SwFlyFrame::InsertColumns(), SwPageFrame::SwPageFrame(), SwFlyFrame::UpdateAttr_(), SwPageFrame::UpdateAttr_(), and SwSectionFrame::UpdateAttr_().

◆ ChgLowersProp()

void SwLayoutFrame::ChgLowersProp ( const Size & rOldSize )

Change size of lowers proportionally.

Changes the size of the directly subsidiary Frame's that have a fixed size, proportionally to the size change of the PrtArea of the Frame's.

The variable Frames are also proportionally adapted; they will grow/shrink again by themselves.

Definition at line 3067 of file wsfrm.cxx.

Referenced by SwFlyFreeFrame::CheckClip(), SwSectionFrame::CheckClipping(), FormatWidthCols(), SwFlyFrame::FrameSizeChg(), and SwLayNotify::ImplDestroy().

◆ ClearVertPosOrientFrameFor()

void SwLayoutFrame::ClearVertPosOrientFrameFor ( SwAnchoredObject * pObj )

inline

Definition at line 179 of file layfrm.hxx.

◆ ContainsAny() [1/2]

SwFrame * SwLayoutFrame::ContainsAny ( const bool _bInvestigateFootnoteForSections = false )

inline

Definition at line 202 of file layfrm.hxx.

References ContainsAny().

◆ ContainsAny() [2/2]

const SwFrame * SwLayoutFrame::ContainsAny ( const bool _bInvestigateFootnoteForSections = false ) const

Method <ContainsAny()> doesn't investigate content of footnotes by default.

return ContentFrames, sections, and tables.

But under certain circumstances this investigation is intended. Thus, introduce new optional parameter <_bInvestigateFootnoteForSections>. It's default is <false>, still indicating that content of footnotes isn't investigated for sections.

Parameters

_bInvestigateFootnoteForSections controls investigation of content of footnotes for sections.

See also: ContainsContent

Definition at line 131 of file findfrm.cxx.

References SwFrame::GetNextLayoutLeaf(), IsAnLower(), SwFrame::IsInFootnote(), SwFrame::IsLayoutFrame(), SwFrame::IsSctFrame(), SwFrame::IsTabFrame(), and Lower().

Referenced by SwSectionFrame::CalcFootnoteContent(), SwSectionFrame::CheckClipping(), SwEndnoter::CollectEndnote(), SwFootnoteBossFrame::CollectFootnotes_(), SwLayoutCache::CompareLayout(), ContainsAny(), SwContentFrame::Cut(), SwTabFrame::Cut(), SwSectionFrame::Cut_(), SwFlyFrame::FindLastLower(), FirstCell(), SwSectionFrame::Format(), FormatWidthCols(), SwPageFrame::GetContentHeight(), SwFootnoteFrame::InvalidateNxtFootnoteCnts(), SwSectionFrame::IsSuperfluous(), MakeFrames(), SwFootnoteBossFrame::MoveFootnotes_(), Paste(), SwFootnoteBossFrame::RearrangeFootnotes(), SwSectionFrame::SplitSect(), SwContentFrame::SwClientNotify(), SwTextFrame::SwClientNotify(), and SwLayoutCache::Write().

◆ ContainsContent() [1/2]

SwContentFrame * SwLayoutFrame::ContainsContent ( )

inline

In order to save us from duplicating implementations, we cast here a little.

Definition at line 192 of file layfrm.hxx.

References ContainsContent().

◆ ContainsContent() [2/2]

const SwContentFrame * SwLayoutFrame::ContainsContent ( ) const

Checks if the frame contains one or more ContentFrame's anywhere in his subsidiary structure; if so the first found ContentFrame is returned.

Definition at line 72 of file findfrm.cxx.

References ContainsContent(), SwFrame::GetNext(), SwFrame::GetNextLayoutLeaf(), IsAnLower(), SwFrame::IsLayoutFrame(), SwFrame::IsSctFrame(), and Lower().

Referenced by SwFootnoteBossFrame::AppendFootnote(), SwContentFrame::CalcLowers(), SwFlyFrame::ChainFrames(), SwLayAction::CheckFirstVisPage(), SwPageFrame::CheckGrid(), ContainsContent(), SwContentFrame::Cut(), SwFootnoteFrame::Cut(), SwRootFrame::DeleteEmptyFlys_(), SwRootFrame::DeleteEmptySct_(), SwLayIdle::DoIdleJob(), SwPageFrame::FindFirstBodyContent(), SwFootnoteFrame::FindLastContent(), SwSectionFrame::FindLastContent(), SwTabFrame::FindLastContentOrTable(), SwFrame::FindNextCnt_(), SwPageFrame::FindPageDesc(), SwFrame::FindPrevCnt_(), SwTextFrame::FindQuoVadisFrame(), SwFlyInContentFrame::Format(), SwSectionFrame::Format(), SwLayAction::FormatFlyContent(), SwObjectFormatter::FormatObjContent(), FormatWidthCols(), GetBodyTextNode(), GetCellContent(), GetColumnStt(), GetContentPos(), SwPageFrame::GetContentPosition(), SwAccessibleDocument::getExtendedAttributes(), SwAccessibleEmbeddedObject::getExtendedAttributes(), GetFrameInPage(), GetNextFrame(), SwXFlatParagraphIterator::getNextPara(), SwRootFrame::GetNextPrevContentPos(), GetPrevFrame(), SwFEShell::GotoFly(), SwRootFrame::ImplCalcBrowseWidth(), InsertCnt_(), SwRootFrame::InvalidateAllContent(), SwSectionFrame::InvalidateFootnotePos(), InvaPercentLowers(), SwTextFrame::IsFootnoteNumFrame_(), sw::IsPageFrameEmpty(), SwLayAction::IsShortCut(), lcl_ChangeFootnoteRef(), lcl_EmergencyFormatFootnoteCont(), lcl_FindCntDiff(), lcl_FindFirstInvaContent(), lcl_FindFrame(), lcl_IsFlyHeightClipped(), lcl_NotifyNeighbours(), lcl_PostprocessRowsInCells(), lcl_RecalcSplitLine(), lcl_UpDown(), MakeFrames(), SwContentFrame::MoveFootnoteCntFwd(), MoveLowerFootnotes(), Notify_Background(), SwColumnFrame::PaintBreak(), SwPageFrame::PaintBreak(), SwFootnoteFrame::Paste(), RefreshExtraData(), SwLayAction::RemoveEmptyBrowserPages(), SwFEShell::SelFlyGrabCursor(), SwRootFrame::SetCurrPage(), SwFEShell::ShouldObjectBeSelected(), SwTabFrame::Split(), SwFlyFrame::UnchainFrames(), and SwPageFrame::UpdateFootnoteNum().

◆ ContainsDeleteForbiddenLayFrame()

bool SwLayoutFrame::ContainsDeleteForbiddenLayFrame ( ) const

Definition at line 170 of file findfrm.cxx.

References ContainsDeleteForbiddenLayFrame(), SwFrame::GetNext(), SwFrame::IsDeleteForbidden(), and Lower().

Referenced by ContainsDeleteForbiddenLayFrame(), and sw::IsPageFrameEmpty().

◆ Cut()

void SwLayoutFrame::Cut ( )

overridevirtual

Implements SwFrame.

Reimplemented in SwCellFrame, SwFlyFrame, SwFootnoteFrame, SwPageFrame, SwRootFrame, SwRowFrame, SwSectionFrame, and SwTabFrame.

Definition at line 1447 of file wsfrm.cxx.

References AdjustGrow, SwFrame::AdjustNeighbourhood(), SwFrameAreaDefinition::getFrameArea(), SwRectFnSet::GetHeight(), SwFrame::GetNext(), SwFrame::GetUpper(), GrowAdjust, SwFrame::InvalidatePage(), SwFrame::InvalidatePos_(), SwFrame::IsFootnoteBossFrame(), Lower(), nAdjust, OnlyAdjust, SwFrame::RemoveFromLayout(), SwFrame::SetCompletePaint(), SwRectFnSet::SetHeight(), and SwFrame::Shrink().

Referenced by SwCellFrame::Cut(), SwContentFrame::Cut(), SwFootnoteFrame::Cut(), SwRowFrame::Cut(), SwTabFrame::Cut(), SwSectionFrame::Cut_(), SwRootFrame::DeleteEmptySct_(), lcl_RemoveColumns(), SwPageFrame::PrepareFooter(), and SwPageFrame::PrepareHeader().

◆ DestroyImpl()

void SwLayoutFrame::DestroyImpl ( )

overrideprotectedvirtual

Reimplemented from SwFrame.

Reimplemented in SwCellFrame, SwColumnFrame, SwFlyFrame, SwFlyFreeFrame, SwFlyInContentFrame, SwPageFrame, SwRootFrame, SwRowFrame, SwSectionFrame, and SwTabFrame.

Definition at line 487 of file ssfrm.cxx.

References SwAnchoredObject::ClearTmpConsiderWrapInfluence(), SwAnchoredObject::ClearVertPosOrientFrame(), SwFrame::DestroyFrame(), SwFrame::DestroyImpl(), SwDrawContact::DisconnectObjFromLayout(), SwAnchoredObject::DrawObj(), SwAnchoredObject::DynCastFlyFrame(), SwFrame::GetDrawObjs(), GetFormat(), SwFrame::GetNext(), SdrObject::GetUserCall(), SwFrame::IsInDtor(), m_pLower, m_VertPosOrientFramesFor, SwSortedObjs::Remove(), SwFrame::RemoveFromLayout(), size, and SwSortedObjs::size().

Referenced by SwCellFrame::DestroyImpl(), SwColumnFrame::DestroyImpl(), SwFlyFrame::DestroyImpl(), SwPageFrame::DestroyImpl(), SwRootFrame::DestroyImpl(), SwRowFrame::DestroyImpl(), SwSectionFrame::DestroyImpl(), and SwTabFrame::DestroyImpl().

◆ FillSelection()

bool SwLayoutFrame::FillSelection	(	SwSelectionList &	rList,
		const SwRect &	rRect
	)		const

overridevirtual

Reimplemented from SwFrame.

Reimplemented in SwPageFrame, and SwRootFrame.

Definition at line 367 of file trvlfrm.cxx.

References SwFrame::FillSelection(), SwFrame::GetNext(), SwFrame::GetPaintArea(), Lower(), and SwRect::Overlaps().

Referenced by SwPageFrame::FillSelection(), and SwTextFrame::FillSelection().

◆ FirstCell() [1/2]

SwCellFrame * SwLayoutFrame::FirstCell ( )

inline

Definition at line 197 of file layfrm.hxx.

References FirstCell().

◆ FirstCell() [2/2]

const SwCellFrame * SwLayoutFrame::FirstCell ( ) const

Calls ContainsAny first to reach the innermost cell.

From there we walk back up to the first SwCellFrame. Since we use SectionFrames, ContainsContent()->GetUpper() is not enough anymore.

Definition at line 118 of file findfrm.cxx.

References ContainsAny(), SwFrame::GetUpper(), and SwFrame::IsCellFrame().

Referenced by SwDoc::AdjustCellWidth(), CheckSplitCells(), ChkChartSel(), FirstCell(), GetMergeSel(), GetTableSel(), lcl_CalcColValues(), lcl_CollectCells(), lcl_FindStartEndCol(), MakeSelUnions(), and SwRootFrame::MakeTableCursors().

◆ Format()

void SwLayoutFrame::Format	(	vcl::RenderContext *	pRenderContext,
		const SwBorderAttrs *	pAttrs = `nullptr`
	)

overrideprotectedvirtual

"Formats" the Frame; Frame and PrtArea.

The Fixsize is not set here.

Reimplemented from SwFrame.

Reimplemented in SwBodyFrame, SwCellFrame, SwFlyFrame, SwFlyInContentFrame, SwFootnoteContFrame, SwHeadFootFrame, SwRowFrame, SwSectionFrame, and SwTabFrame.

Definition at line 3466 of file wsfrm.cxx.

References SwBorderAttrs::CalcBottom(), SwBorderAttrs::CalcLeft(), SwBorderAttrs::CalcRight(), SwBorderAttrs::CalcTop(), SwFrame::ChgSize(), SwRectFnCollection::fnGetHeight, SwRectFnCollection::fnGetLeft, SwRectFnCollection::fnGetPrtBottom, SwRectFnCollection::fnGetTop, fnRectHori, fnRectVert, fnRectVertL2R, fnRectVertL2RB2T, SwRectFnCollection::fnSetLimit, SwRectFnCollection::fnSetXMargins, SwRectFnCollection::fnSetYMargins, FRM_HEADFOOT, SwRootFrame::GetCurrShell(), GetFormat(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwFormat::GetFrameSize(), SvxSizeItem::GetHeight(), SwFormatFrameSize::GetHeightSizeType(), SwFrame::GetNext(), SwTextFrame::GetParHeight(), SwFrame::getRootFrame(), SwBorderAttrs::GetSize(), SwFrame::GetType(), SwFrame::GetUpper(), SwViewShell::GetViewOptions(), SwFrame::Grow(), SwFrame::HasFixSize(), Height, Size::Height(), SwFrameAreaDefinition::isFrameAreaSizeValid(), SwFrameAreaDefinition::isFramePrintAreaValid(), SwFrame::IsPageFrame(), SwFrame::IsSctFrame(), SwFrame::IsTextFrame(), SwFrame::IsVertical(), SwFrame::IsVertLR(), SwFrame::IsVertLRBT(), SwViewOption::IsWhitespaceHidden(), Lower(), SwFrame::MakePos(), Minimum, nBorder, SwFrameAreaDefinition::setFrameAreaSizeValid(), SwFrameAreaDefinition::setFramePrintAreaValid(), SwFrame::Shrink(), SwSectionFrame::Undersize(), and Width.

Referenced by SwHeadFootFrame::Format(), SwFrame::GetPrevSctLeaf(), MakeAll(), and SwPageFrame::MakeAll().

◆ FormatWidthCols()

void SwLayoutFrame::FormatWidthCols	(	const SwBorderAttrs &	rAttrs,
		const SwTwips	nBorder,
		const SwTwips	nMinHeight
	)

Called by Format for Frames and Areas with columns.

Definition at line 3731 of file wsfrm.cxx.

References abs(), SwRectFnSet::AddBottom(), AdjustColumns(), SwRectFnSet::BottomDist(), BROWSE_HEIGHT, SwFrame::Calc(), CalcContent(), SwViewShellImp::CheckWaitCursor(), ChgLowersProp(), ContainsAny(), ContainsContent(), SwFrame::FindPageFrame(), SwBorderAttrs::GetAttrSet(), SwAttrSet::GetCol(), SwRootFrame::GetCurrShell(), GetFormat(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwRectFnSet::GetHeight(), SwFrame::GetNext(), SwFormatCol::GetNumCols(), SwViewShell::GetOut(), SwRectFnSet::GetPrtBottom(), SwFrame::getRootFrame(), SwPageFrame::GetSortedObjs(), SwRectFnSet::GetTopMargin(), SwFrame::GetUpper(), SwFrame::Grow(), i, SwViewShell::Imp(), InnerHeight(), SwAnchoredObject::InvalidateObjRectWithSpaces(), SwFrame::InvalidatePos_(), IsAnLower(), SwFrame::IsFlyFrame(), SwFrame::IsFootnoteContFrame(), SwFrameAreaDefinition::isFrameAreaDefinitionValid(), SwFrameAreaDefinition::isFrameAreaSizeValid(), SwFrame::IsSctFrame(), lcl_CalcMinColDiff(), lcl_IsFlyHeightClipped(), LONG_MAX, Lower(), nBorder, NotifyLowerObjs(), SwFrameAreaDefinition::setFrameAreaSizeValid(), SwRectFnSet::SetYMargins(), and SSize.

Referenced by SwFlyFrame::CalcContentHeight(), and SwSectionFrame::Format().

◆ GetContentPos()

const SwContentFrame * SwLayoutFrame::GetContentPos	(	Point &	rPoint,
		const bool	bDontLeave,
		const bool	bBodyOnly = `false`,
		SwCursorMoveState *	pCMS = `nullptr`,
		const bool	bDefaultExpand = `true`
	)		const

Finds the closest Content for the SPoint Is used for Pages, Flys and Cells if GetModelPositionForViewPoint failed.

Search for the nearest Content to pass.

Considers the previous, the current and the next page. If no content is found, the area gets expanded until one is found.

Returns: The 'semantically correct' position inside the PrtArea of the found ContentFrame.

Definition at line 1183 of file trvlfrm.cxx.

References SwRect::Bottom(), CalcDiff(), SwRect::Contains(), ContainsContent(), SwPageFrame::FindFirstBodyContent(), SwFrame::FindPageFrame(), SwFrame::FindTabFrame(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwFrame::GetNext(), SwContentFrame::GetNextContentFrame(), SwFrame::GetPhyPageNum(), SwFrame::GetPrev(), SwRectFnSet::GetPrtBottom(), SwRectFnSet::GetPrtTop(), SwFrame::GetUpper(), Size::Height(), SwRect::Height(), IsAnLower(), SwFrame::IsFootnoteContFrame(), SwTextFrame::IsHiddenNow(), SwFrame::IsInDocBody(), SwFrame::IsInFootnote(), SwTabFrame::IsInHeadline(), SwFrame::IsInTab(), SwFrame::IsLayoutFrame(), SwFrame::IsRightToLeft(), SwFrame::IsTextFrame(), SwRectFnSet::IsVert(), lcl_GetNxtCnt(), lcl_Inside(), lcl_MissProtectedFrames(), SwRect::Left(), SwCursorMoveState::m_bSetInReadOnly, SwCursorMoveState::m_bStop, SwCursorMoveState::m_eState, SwRect::Pos(), SwRect::Right(), SAL_MAX_UINT64, Size::setHeight(), Point::setX(), Point::setY(), SwRect::SSize(), TableSel, SwRect::Top(), SwFrame::UnionFrame(), SwRect::Width(), Point::X(), Point::Y(), and SwRectFnSet::YDiff().

Referenced by FindAnchor(), GetBodyTextNode(), SwCellFrame::GetModelPositionForViewPoint(), SwFlyFrame::GetModelPositionForViewPoint(), SwPageFrame::GetModelPositionForViewPoint(), and SwCursorShell::GotoFlyAnchor().

◆ GetFormat() [1/2]

SwFrameFormat * SwLayoutFrame::GetFormat ( )

virtual

Reimplemented in SwFlyFrame.

Definition at line 406 of file ssfrm.cxx.

References SwFrame::GetDep().

◆ GetFormat() [2/2]

const SwFrameFormat * SwLayoutFrame::GetFormat ( ) const

virtual

Reimplemented in SwFlyFrame.

Definition at line 401 of file ssfrm.cxx.

References SwFrame::GetDep().

◆ GetLastLower() [1/2]

SwFrame * SwLayoutFrame::GetLastLower ( )

inline

Definition at line 220 of file layfrm.hxx.

References GetLastLower().

◆ GetLastLower() [2/2]

const SwFrame * SwLayoutFrame::GetLastLower ( ) const

◆ GetModelPositionForViewPoint()

bool SwLayoutFrame::GetModelPositionForViewPoint	(	SwPosition *	pPos,
		Point &	rPoint,
		SwCursorMoveState *	pCMS = `nullptr`,
		bool	bTestBackground = `false`
	)		const

overridevirtual

Searches the ContentFrame owning the PrtArea containing the point.

Reimplemented from SwFrame.

Reimplemented in SwCellFrame, SwFlyFrame, SwPageFrame, and SwRootFrame.

Definition at line 151 of file trvlfrm.cxx.

References SwFrame::Calc(), SwRect::Contains(), SwRootFrame::GetCurrShell(), SwFrame::GetModelPositionForViewPoint(), SwFrame::GetNext(), SwViewShell::GetOut(), SwFrame::GetPaintArea(), SwFrame::getRootFrame(), SwFrame::IsTextFrame(), Lower(), SwCursorMoveState::m_bContentCheck, SwCursorMoveState::m_bStop, and SwFrame::UnionFrame().

Referenced by SwCellFrame::GetModelPositionForViewPoint(), and SwPageFrame::GetModelPositionForViewPoint().

◆ GrowFrame()

SwTwips SwLayoutFrame::GrowFrame	(	SwTwips	nDist,
		bool	bTst = `false`,
		bool	bInfo = `false`
	)

overrideprotectedvirtual

Implements SwFrame.

Reimplemented in SwFootnoteContFrame, SwHeadFootFrame, SwRootFrame, SwRowFrame, and SwTabFrame.

Definition at line 2641 of file wsfrm.cxx.

References AdjustGrow, SwFrame::AdjustNeighbourhood(), Body, Cell, Column, ePos, SwFrame::FindPageFrame(), SwCellFrame::FindStartEndOfRowSpanCell(), FtnCont, SwViewOption::getBrowseMode(), SwRootFrame::GetCurrShell(), GetFormat(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwRectFnSet::GetHeight(), SwCellFrame::GetLayoutRowSpan(), SwFrame::GetNext(), SwFrame::getRootFrame(), SwTableBox::getRowSpan(), SwCellFrame::GetTabBox(), SwFrame::GetType(), SwFrame::GetUpper(), SwViewShell::GetViewOptions(), GPOS_NONE, GPOS_TILED, SwFrame::Grow(), GrowAdjust, GrowShrink, SwFrame::HasFixSize(), SwViewShell::Imp(), SwFrame::InvalidateAll_(), SwFrame::InvalidatePage(), SwFrame::InvalidatePos_(), InvaPercentLowers(), SwFrame::IsAccessibleFrame(), SwRootFrame::IsAnyShellAccessible(), SwFrame::IsCellFrame(), SwFrame::IsContentFrame(), SwFrame::IsFootnoteBossFrame(), SwFrame::IsFootnoteFrame(), SwFrame::IsPageBodyFrame(), SwFrame::IsRowFrame(), SwFrame::IsVertical(), SwFrame::IsVertLR(), LONG_MAX, Lower(), SwViewShellImp::MoveAccessibleFrame(), nAdjust, nFramePos, NotifyLowerObjs(), OnlyAdjust, Page, SwRect::Pos(), Root, Row, o3tl::saturating_add(), SwFrame::SetCompletePaint(), SwRectFnSet::SetHeight(), and Tab.

Referenced by SwHeadFootFrame::GrowFrame(), and SwRowFrame::GrowFrame().

◆ InnerHeight()

SwTwips SwLayoutFrame::InnerHeight ( ) const

InnerHeight returns the height of the content and may be bigger or less than the PrtArea-Height of the layoutframe himself.

Definition at line 2602 of file wsfrm.cxx.

References SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwRectFnSet::GetHeight(), SwFrame::GetNext(), SwTextFrame::GetParHeight(), InnerHeight(), SwFrame::IsCellFrame(), SwFrame::IsColumnFrame(), SwFrame::IsContentFrame(), SwFrameAreaDefinition::isFramePrintAreaValid(), SwFrame::IsLayoutFrame(), SwFrame::IsTabFrame(), and Lower().

Referenced by SwSectionFrame::CalcUndersize(), SwSectionFrame::Format(), FormatWidthCols(), and InnerHeight().

◆ InvaPercentLowers()

void SwLayoutFrame::InvaPercentLowers ( SwTwips nDiff = 0 )

Invalidates the inner Frames, whose width and/or height are calculated using percentages.

Frames that are anchored to this or inner Frames, are also invalidated.

Definition at line 3616 of file wsfrm.cxx.

References ContainsContent(), SwFrame::FindNextCnt(), SwFrame::FindTabFrame(), SwFrame::GetDrawObjs(), GetFormat(), SwFormat::GetFrameSize(), SwFormatFrameSize::GetHeightPercent(), SwFormatFrameSize::GetWidthPercent(), SwFrame::InvalidatePrt(), InvaPercentFlys(), IsAnLower(), SwFrame::IsInTab(), and SwFrame::IsTabFrame().

Referenced by GrowFrame(), SwLayNotify::ImplDestroy(), SwViewShell::InvalidateLayout(), and ShrinkFrame().

◆ IsAnLower()

bool SwLayoutFrame::IsAnLower ( const SwFrame * pAssumed ) const

Definition at line 233 of file findfrm.cxx.

References SwFrame::GetUpper(), and SwFrame::IsFlyFrame().

Referenced by SwTabFrame::CalcFlyOffsets(), SwTextFrame::CalcFollow(), SwSectionFrame::CalcFootnoteContent(), SwRootFrame::CalcFrameRects(), SwContentFrame::CalcLowers(), SwPageFrame::CheckGrid(), CheckSplitCells(), ChgLowersProp(), ChkChartSel(), ContainsAny(), ContainsContent(), SwSectionFrame::ContainsFootnoteCont(), DelFlys(), SwMovedFwdFramesByObjPos::DoesRowContainMovedFwdFrame(), SwLayIdle::DoIdleJob(), SwTextNode::fillSoftPageBreakList(), SwPageFrame::FindLastBodyContent(), SwTabFrame::FindLastContentOrTable(), SwFlyFrame::FindLastLower(), SwFrame::FindNext_(), SwFrame::FindPrev_(), SwTextFrame::FindQuoVadisFrame(), SwCellFrame::Format(), FormatWidthCols(), GetCellContent(), GetColumnEnd(), SwPageFrame::GetContentHeight(), GetContentPos(), SwDrawView::GetMaxChildOrdNum(), SwDrawView::GetMaxToTopObj(), GetMergeSel(), SwXFlatParagraphIterator::getNextPara(), GetTableSel(), SwDoc::GetTabRows(), SwTableLine::hasSoftPageBreak(), SwFrame::ImplGetNextLayoutLeaf(), SwFootnoteFrame::InvalidateNxtFootnoteCnts(), InvaPercentLowers(), IsBefore(), SwTabFrame::IsInHeadline(), lcl_ArrangeLowers(), lcl_CalcColValues(), lcl_CalcDownDist(), lcl_CollectCells(), lcl_FindCntDiff(), lcl_FindCorrespondingCellFrame(), lcl_FindFirstInvaContent(), lcl_FindFrame(), lcl_FindFrameInTab(), lcl_FindNextCellFrame(), lcl_FindStartEndCol(), lcl_RefreshLine(), lcl_UpDown(), MakeSelUnions(), SwRootFrame::MakeTableCursors(), SwFootnoteBossFrame::MoveFootnotes_(), MoveLowerFootnotes(), Notify_Background(), NotifyLowerObjs(), PaintSwFrame(), SwSectionFrame::Paste(), SwPageFrame::PrepareRegisterChg(), RefreshExtraData(), SwFrame::ReinitializeFrameSizeAttrFlags(), SwRootFrame::SetCurrPage(), SwDoc::SetTabRows(), SwTabFrame::Split(), and SwSectionFrame::SplitSect().

◆ IsBefore()

bool SwLayoutFrame::IsBefore ( const SwLayoutFrame * _pCheckRefLayFrame ) const

method to check relative position of layout frame to a given layout frame.

refactoring of pseudo-local method <lcl_Apres(..)> in <txtftn.cxx> for #104840#.

Parameters

_aCheckRefLayFrame constant reference of an instance of class <SwLayoutFrame> which is used as the reference for the relative position check.

Returns: true, if <this> is positioned before the layout frame

OD 08.11.2002 - refactoring of pseudo-local method <lcl_Apres(..)> in <txtftn.cxx> for #104840#.

Parameters

_aCheckRefLayFrame constant reference of an instance of class <SwLayoutFrame> which is used as the reference for the relative position check.

Returns: true, if <this> is positioned before the layout frame

Definition at line 260 of file findfrm.cxx.

References SwFrame::FindPageFrame(), SwFrame::GetNext(), SwPageFrame::GetPhyPageNum(), SwFrame::GetUpper(), IsAnLower(), and SwFrame::IsRootFrame().

Referenced by SwSectionFrame::CheckClipping(), SwFootnoteBossFrame::CollectFootnotes_(), SwTextFrame::ConnectFootnote(), SwContentFrame::MakeAll(), and SwTextFrame::RemoveFootnote().

◆ Lower() [1/2]

SwFrame * SwLayoutFrame::Lower ( )

inline

Definition at line 102 of file layfrm.hxx.

◆ Lower() [2/2]

const SwFrame * SwLayoutFrame::Lower ( ) const

inline

Definition at line 101 of file layfrm.hxx.

◆ MakeAll()

void SwLayoutFrame::MakeAll ( vcl::RenderContext * pRenderContext )

overrideprotectedvirtual

Implements SwFrame.

Reimplemented in SwFlyFreeFrame, SwFlyAtContentFrame, SwFlyInContentFrame, SwPageFrame, SwRootFrame, SwRowFrame, SwSectionFrame, and SwTabFrame.

Definition at line 944 of file calcmove.cxx.

References SwRectFnCollection::fnAddRight, SwRectFnCollection::fnGetPrtBottom, SwRectFnCollection::fnGetWidth, SwRectFnCollection::fnOverStep, fnRectHori, fnRectVert, fnRectVertL2R, fnRectVertL2RB2T, SwRectFnCollection::fnSubLeft, Format(), SwFrame::GetCache(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwFrame::GetNext(), SwFrame::GetPrev(), SwFrame::getRootFrame(), SwFrame::GetUpper(), SwRect::Height(), SwFrame::IsBodyFrame(), SwFrame::IsCellFrame(), SwFrame::IsColumnFrame(), SwFrame::IsFooterFrame(), SwFrame::IsFootnoteContFrame(), SwFrameAreaDefinition::isFrameAreaPositionValid(), SwFrameAreaDefinition::isFrameAreaSizeValid(), SwFrameAreaDefinition::isFramePrintAreaValid(), SwFrame::IsHeaderFrame(), SwFrame::IsLeaveUpperAllowed(), SwFrame::IsNeighbourFrame(), SwFrame::IsRightToLeft(), SwFrame::IsVertical(), SwFrame::IsVertLR(), SwFrame::IsVertLRBT(), MakeAll, SwFrame::MakePos(), NONE, PROTOCOL_ENTER, SwFrameAreaDefinition::setFrameAreaSizeValid(), and SwFrameAreaDefinition::setFramePrintAreaValid().

Referenced by SwFlyFrame::Grow_(), SwRowFrame::MakeAll(), SwSectionFrame::MakeAll(), and SwFlyFrame::Shrink_().

◆ MoveLowerFootnotes()

bool SwLayoutFrame::MoveLowerFootnotes	(	SwContentFrame *	pStart,
		SwFootnoteBossFrame *	pOldBoss,
		SwFootnoteBossFrame *	pNewBoss,
		const bool	bFootnoteNums
	)