A page of the document layout. More...

#include <pagefrm.hxx>

Inheritance diagram for SwPageFrame:

Collaboration diagram for SwPageFrame:

Public Member Functions
	SwPageFrame (SwFrameFormat , SwFrame , SwPageDesc *)

void	PrepareHeader ()
	Make this public, so that the SwViewShell can access it when switching from browse mode Add/remove header/footer. More...

void	PrepareFooter ()
	Creates or removes footer. More...

const SwSortedObjs *	GetSortedObjs () const

SwSortedObjs *	GetSortedObjs ()

void	AppendDrawObjToPage (SwAnchoredObject &_rNewObj)

void	RemoveDrawObjFromPage (SwAnchoredObject &_rToRemoveObj)

void	AppendFlyToPage (SwFlyFrame *pNew)

void	RemoveFlyFromPage (SwFlyFrame *pToRemove)

void	MoveFly (SwFlyFrame pToMove, SwPageFrame pDest)

void	SetPageDesc (SwPageDesc , SwFrameFormat )

SwPageDesc *	GetPageDesc ()

const SwPageDesc *	GetPageDesc () const

SwPageDesc *	FindPageDesc ()

SwContentFrame *	FindLastBodyContent ()
	Searches the last ContentFrame in BodyText below the page. More...

SwContentFrame *	FindFirstBodyContent ()

const SwContentFrame *	FindFirstBodyContent () const

const SwContentFrame *	FindLastBodyContent () const

SwRect	GetBoundRect (OutputDevice const *pOutputDevice) const

void	GetContentPosition (const Point &rPt, SwPosition &rPos) const
	Same as SwLayoutFrame::GetContentPos(). More...

bool	IsEmptyPage () const

void	UpdateFootnoteNum ()

void	PreparePage (bool bFootnote)
	Always call after Paste Creates the page-bound frames and formats the generic content. More...

void	PrepareRegisterChg ()

void	PlaceFly (SwFlyFrame pFly, SwFlyFrameFormat pFormat)

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

virtual bool	GetInfo (SfxPoolItem &) const override
	Get info from Client. More...

virtual void	Cut () override

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

virtual void	CheckDirection (bool bVert) override

void	CheckGrid (bool bInvalidate)

void	PaintGrid (OutputDevice const *pOut, SwRect const &rRect) const

bool	HasGrid () const

void	PaintDecorators () const

virtual void	PaintSubsidiaryLines (const SwPageFrame *, const SwRect &) const override

void	AddSubsidiaryLinesBounds (const SwViewShell &rShell, RectangleVector &rRects) const

virtual void	PaintBreak () const override

void	RefreshExtraData (const SwRect &) const
	Paint line number etc. More...

void	RefreshSubsidiary (const SwRect &) const
	Paint helper lines. More...

bool	IsFootnotePage () const
	Foot note interface. More...

bool	IsEndNotePage () const

void	SetFootnotePage (bool b)

void	SetEndNotePage (bool b)

sal_uInt16	GetPhyPageNum () const

void	SetPhyPageNum (sal_uInt16 nNum)

void	InvalidateFlyLayout () const
	Validate, invalidate and query the Page status Layout/Content and Fly/non-Fly respectively are inspected separately. More...

void	InvalidateFlyContent () const

void	InvalidateFlyInCnt () const

void	InvalidateLayout () const

void	InvalidateContent () const

void	InvalidateSpelling () const

void	InvalidateSmartTags () const

void	InvalidateAutoCompleteWords () const

void	InvalidateWordCount () const

void	ValidateFlyLayout () const

void	ValidateFlyContent () const

void	ValidateFlyInCnt () const

void	ValidateLayout () const

void	ValidateContent () const

void	ValidateSpelling () const

void	ValidateSmartTags () const

void	ValidateAutoCompleteWords () const

void	ValidateWordCount () const

bool	IsInvalid () const

bool	IsInvalidFly () const

bool	IsRightShadowNeeded () const

bool	IsLeftShadowNeeded () const

bool	IsInvalidFlyLayout () const

bool	IsInvalidFlyContent () const

bool	IsInvalidFlyInCnt () const

bool	IsInvalidLayout () const

bool	IsInvalidContent () const

bool	IsInvalidSpelling () const

bool	IsInvalidSmartTags () const

bool	IsInvalidAutoCompleteWords () const

bool	IsInvalidWordCount () const

Color	GetDrawBackgroundColor () const
	SwPageFrame::GetDrawBackgroundColor. More...

void	PaintMarginArea (const SwRect &_rOutputRect, SwViewShell const *_pViewShell) const
	paint margin area of a page More...

sw::sidebarwindows::SidebarPosition	SidebarPosition () const
	asks the page on which side a margin should be shown, e.g for notes returns true for left side, false for right side More...

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

SwRect	PrtWithoutHeaderAndFooter () const

const SwPageFrame &	GetFormatPage () const

bool	IsOverHeaderFooterArea (const Point &rPt, FrameControlType &rControl) const
	If in header or footer area, it also indicates the exact area in rControl. More...

bool	CheckPageHeightValidForHideWhitespace (SwTwips nDiff)
	Is bottom-of-page-frame - bottom-of-text-frame difference valid in case whitespace is hidden? If false is returned, then the caller should handle negative difference as (at least) zero difference instead. More...

const SwHeaderFrame *	GetHeaderFrame () const

const SwFooterFrame *	GetFooterFrame () const

bool	UpdateVirtPageNumInfo (SwVirtPageNumInfo &rHint, const SwFrame *pFrame) const

void	dumpAsXml (xmlTextWriterPtr writer=nullptr) const override

Public Member Functions inherited from SwFootnoteBossFrame
	SwFootnoteBossFrame (SwFrameFormat pFormat, SwFrame pSib)

SwLayoutFrame *	FindBodyCont ()
	Searches the first ContentFrame in BodyText below the page. More...

const SwLayoutFrame *	FindBodyCont () const

void	SetMaxFootnoteHeight (const SwTwips nNewMax)

void	AppendFootnote (SwContentFrame , SwTextFootnote )

bool	RemoveFootnote (const SwContentFrame , const SwTextFootnote , bool bPrep=true)

SwFootnoteContFrame *	FindFootnoteCont ()

const SwFootnoteContFrame *	FindFootnoteCont () const

const SwFootnoteFrame *	FindFirstFootnote (SwContentFrame const *) const
	Get the first footnote of a given content. More...

SwFootnoteContFrame *	FindNearestFootnoteCont (bool bDontLeave=false)
	Search the next available footnote container. More...

void	RearrangeFootnotes (const SwTwips nDeadLine, const bool bLock, const SwTextFootnote *pAttr=nullptr)

void	SetFootnoteDeadLine (const SwTwips nDeadLine)

SwTwips	GetMaxFootnoteHeight () const

SwTwips	GetVarSpace () const

void	CollectFootnotes (const SwContentFrame _pRef, SwFootnoteBossFrame _pOld, SwFootnoteFrames &_rFootnoteArr, const bool _bCollectOnlyPreviousFootnotes=false)
	OD 03.04.2003 #108446# - add parameter <_bCollectOnlyPreviousFootnotes> in order to control, if only footnotes, which are positioned before the footnote boss frame <this> have to be collected. More...

void	MoveFootnotes_ (SwFootnoteFrames &rFootnoteArr, bool bCalc=false)

void	MoveFootnotes (const SwContentFrame pSrc, SwContentFrame pDest, SwTextFootnote const *pAttr)

SwNeighbourAdjust	NeighbourhoodAdjustment () const

Public Member Functions inherited from SwLayoutFrame
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

Static Public Member Functions
static void	PaintBorderAndShadow (const SwRect &_rPageRect, const SwViewShell *_pViewShell, bool bPaintLeftShadow, bool bPaintRightShadow, bool bRightSidebar)
	paint page border and shadow More...

static void	GetBorderAndShadowBoundRect (const SwRect &_rPageRect, const SwViewShell _pViewShell, OutputDevice const pRenderContext, SwRect &_orBorderAndShadowBoundRect, const bool bLeftShadow, const bool bRightShadow, const bool bRightSidebar)
	get bound rectangle of border and shadow for repaints More...

static void	PaintNotesSidebar (const SwRect &_rPageRect, SwViewShell *_pViewShell, sal_uInt16 nPageNum, bool bRight)
	mod #i6193# paint sidebar for notes IMPORTANT: if you change the rects here, also change SwPostItMgr::ScrollbarHit More...

static void	PaintNotesSidebarArrows (const Point &rMiddleFirst, const Point &rMiddleSecond, SwViewShell const *_pViewShell, const Color &rColorUp, const Color &rColorDown)

static const vcl::Font &	GetEmptyPageFont ()
	create/return font used to paint the "empty page" string More...

static SwTwips	GetSidebarBorderWidth (const SwViewShell *)

Static Public Member Functions inherited from SwFootnoteBossFrame
static SwFootnoteFrame *	FindFootnote (const SwContentFrame , const SwTextFootnote )

static void	ChangeFootnoteRef (const SwContentFrame pOld, const SwTextFootnote , SwContentFrame *pNew)

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

Private Member Functions
void	UpdateAttr_ (const SfxPoolItem , const SfxPoolItem , SwPageFrameInvFlags &, SwAttrSetChg pa=nullptr, SwAttrSetChg pb=nullptr)

void	SetColMaxFootnoteHeight ()
	Adapt the max. footnote height in each single column. More...

virtual void	DestroyImpl () override

virtual	~SwPageFrame () override

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

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

size_t	GetContentHeight (const tools::Long nTop, const tools::Long nBottom) const
	Calculate the content height of a page (without columns). More...

std::vector< basegfx::B2DPolygon >	GetSubsidiaryLinesPolygons (const SwViewShell &rViewShell) const

Static Private Member Functions
static void	GetHorizontalShadowRect (const SwRect &_rPageRect, const SwViewShell _pViewShell, OutputDevice const pRenderContext, SwRect &_orBottomShadowRect, bool bPaintLeftShadow, bool bPaintRightShadow, bool bRightSidebar)
	determine rectangle for horizontal page shadow More...

Private Attributes
std::unique_ptr< SwSortedObjs >	m_pSortedObjs

SwPageDesc *	m_pDesc

sal_uInt16	m_nPhyPageNum
	Physical page number: index into list of SwRootFrame lowers. More...

bool	m_bInvalidContent:1

bool	m_bInvalidLayout:1

bool	m_bInvalidFlyContent:1

bool	m_bInvalidFlyLayout:1

bool	m_bInvalidFlyInCnt:1

bool	m_bFootnotePage:1

bool	m_bEmptyPage:1

bool	m_bEndNotePage:1

bool	m_bInvalidSpelling:1

bool	m_bInvalidSmartTags:1

bool	m_bInvalidAutoCmplWrds:1

bool	m_bInvalidWordCount:1

bool	m_bHasGrid:1

Static Private Attributes
static const sal_Int8	snShadowPxWidth = 9

Friends
class	SwFrame

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

Protected Member Functions inherited from SwFootnoteBossFrame
void	InsertFootnote (SwFootnoteFrame *)

Protected Member Functions inherited from SwLayoutFrame
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)

Static Protected Member Functions inherited from SwFootnoteBossFrame
static void	ResetFootnote (const SwFootnoteFrame *pAssumed)

Protected Attributes inherited from SwLayoutFrame
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

Detailed Description

A page of the document layout.

Upper frame is expected to be an SwRootFrame instance. At least an SwBodyFrame lower is expected.

Definition at line 59 of file pagefrm.hxx.

Constructor & Destructor Documentation

◆ ~SwPageFrame()

SwPageFrame::~SwPageFrame ( )

overrideprivatevirtual

Definition at line 322 of file pagechg.cxx.

◆ SwPageFrame()

SwPageFrame::SwPageFrame	(	SwFrameFormat *	pFormat,
		SwFrame *	pSib,
		SwPageDesc *	pPgDsc
	)

Definition at line 190 of file pagechg.cxx.

References SwFrame::Calc(), SwLayoutFrame::ChgColumns(), SwFrame::ChgSize(), SwViewOption::getBrowseMode(), SwFormat::GetCol(), SwRootFrame::GetCurrShell(), SwDoc::GetDfltFrameFormat(), SwFormat::GetDoc(), SwDoc::GetEmptyPageFormat(), SwFormat::GetFooter(), SwPageDesc::GetFootnoteInfo(), SwFrameAreaDefinition::getFramePrintArea(), SwFormat::GetFrameSize(), GetGridItem(), SwFormat::GetHeader(), SwPageFootnoteInfo::GetHeight(), SwFormatCol::GetNumCols(), SwViewShell::GetOut(), SwFrame::getRootFrame(), SvxSizeItem::GetSize(), SwViewShell::GetViewOptions(), SwRect::Height(), SwFrame::InvalidatePos(), SwFrame::InvalidateSize_(), SwFormatHeader::IsActive(), SwFormatFooter::IsActive(), LONG_MAX, m_bEmptyPage, m_bEndNotePage, m_bFootnotePage, m_bHasGrid, m_bInvalidAutoCmplWrds, m_bInvalidContent, m_bInvalidFlyContent, m_bInvalidFlyInCnt, m_bInvalidFlyLayout, m_bInvalidLayout, m_bInvalidSmartTags, m_bInvalidSpelling, m_bInvalidWordCount, m_pDesc, SwFrame::mnFrameType, Page, SwLayoutFrame::Paste(), PrepareFooter(), PrepareHeader(), SwFrame::SetDerivedR2L(), SwFrame::SetDerivedVert(), SwFootnoteBossFrame::SetMaxFootnoteHeight(), SSize, SwRect::SSize(), SwViewShell::VisArea(), and SwRect::Width().

Member Function Documentation

◆ AddSubsidiaryLinesBounds()

void SwPageFrame::AddSubsidiaryLinesBounds	(	const SwViewShell &	rShell,
		RectangleVector &	rRects
	)		const

Definition at line 7130 of file paintfrm.cxx.

References AddSubsidiaryLinesBounds(), SwFrameAreaDefinition::getFrameArea(), SwFrame::GetNext(), GetSubsidiaryLinesPolygons(), SwRect::HasArea(), SwFrame::IsFooterFrame(), SwFrame::IsHeaderFrame(), lclAddSubsidiaryLinesBounds(), and SwLayoutFrame::Lower().

Referenced by AddSubsidiaryLinesBounds(), and SwViewShell::InvalidatePageAndHFSubsidiaryLines().

◆ AppendDrawObjToPage()

void SwPageFrame::AppendDrawObjToPage ( SwAnchoredObject & _rNewObj )

◆ AppendFlyToPage()

void SwPageFrame::AppendFlyToPage ( SwFlyFrame * pNew )

Definition at line 801 of file flylay.cxx.

References AppendFlyToPage(), SwFrame::FindFlyFrame(), SwAnchoredObject::GetAnchorFrame(), SwFrame::GetDrawObjs(), SwRootFrame::GetDrawPage(), SwFlyFrame::GetFormat(), SdrObject::GetOrdNum(), SdrObject::GetOrdNumDirect(), SwTextBoxHelper::getOtherTextBoxFormat(), SwAnchoredObject::GetPageFrame(), SdrVirtObj::GetReferencedObj(), SwFrame::getRootFrame(), SdrObject::getSdrPageFromSdrObject(), SwFrame::GetUpper(), SwFlyFrame::GetVirtDrawObj(), SdrObjList::InsertObject(), InvalidateAutoCompleteWords(), InvalidateBrowseWidth, InvalidateFlyContent(), InvalidateFlyInCnt(), SwFlyFrame::InvalidateObjPos(), SwFrame::InvalidatePage(), InvalidateSmartTags(), InvalidateSpelling(), InvalidateWordCount(), SwFlyFrame::IsFlyInContentFrame(), SdrObject::IsInserted(), m_pSortedObjs, RES_FLYFRMFMT(), SdrObjList::SetObjectOrdNum(), SdrObject::SetOrdNum(), SwAnchoredObject::SetPageFrame(), and SwAnchoredObject::UnlockPosition().

Referenced by SwFrame::AppendFly(), AppendFlyToPage(), SwFrameNotify::ImplDestroy(), lcl_AddObjsToPage(), lcl_Regist(), SwFlyFreeFrame::MakeAll(), SwFlyAtContentFrame::MakeAll(), SwFlyLayFrame::RegisterAtPage(), and SwFlyAtContentFrame::RegisterAtPage().

◆ CheckDirection()

void SwPageFrame::CheckDirection ( bool bVert )

overridevirtual

Reimplemented from SwFrame.

Definition at line 349 of file pagechg.cxx.

References SwViewOption::getBrowseMode(), SwRootFrame::GetCurrShell(), SwLayoutFrame::GetFormat(), SwFormat::GetFormatAttr(), SwFrame::getRootFrame(), SwViewShell::GetViewOptions(), SwFrame::mbInvalidR2L, SwFrame::mbInvalidVert, SwFrame::mbRightToLeft, SwFrame::mbVertical, SwFrame::mbVertLR, and RES_FRAMEDIR().

◆ CheckGrid()

void SwPageFrame::CheckGrid ( bool bInvalidate )

Definition at line 326 of file pagechg.cxx.

References SwLayoutFrame::ContainsContent(), SwFootnoteBossFrame::FindBodyCont(), GetGridItem(), SwContentFrame::GetNextContentFrame(), SwFrame::InvalidatePrt(), SwLayoutFrame::IsAnLower(), m_bHasGrid, SwFrame::Prepare(), and SwFrame::SetCompletePaint().

Referenced by SwClientNotify().

◆ CheckPageHeightValidForHideWhitespace()

bool SwPageFrame::CheckPageHeightValidForHideWhitespace ( SwTwips nDiff )

Is bottom-of-page-frame - bottom-of-text-frame difference valid in case whitespace is hidden? If false is returned, then the caller should handle negative difference as (at least) zero difference instead.

Definition at line 2547 of file pagechg.cxx.

References SwRootFrame::GetCurrShell(), SwFrame::GetDep(), SwFrameAreaDefinition::getFrameArea(), SwFormat::GetFrameSize(), Size::getHeight(), SwFrame::getRootFrame(), SvxSizeItem::GetSize(), SwViewShell::GetViewOptions(), SwRect::Height(), and SwViewOption::IsWhitespaceHidden().

Referenced by SwTextFrameBreak::IsInside(), and SwContentFrame::MakeAll().

◆ Cut()

void SwPageFrame::Cut ( )

overridevirtual

Reimplemented from SwLayoutFrame.

Definition at line 858 of file pagechg.cxx.

References SwFrame::FindPageFrame(), SwRootFrame::GetCurrShell(), SwFrameAreaDefinition::getFrameArea(), SwFrame::GetNext(), SwFrame::GetPrev(), SwFrame::getRootFrame(), GetSortedObjs(), SwFrame::GetUpper(), SwViewShell::GetWin(), i, SwFrame::InvalidatePos(), SwViewShell::InvalidateWindows(), IsEmptyPage(), m_nPhyPageNum, MoveFly(), SwFrame::RemoveFromLayout(), SetLastPage(), and size.

Referenced by SwFrame::CheckPageDescs(), SwLayAction::RemoveEmptyBrowserPages(), and SwRootFrame::RemovePage().

◆ DestroyImpl()

void SwPageFrame::DestroyImpl ( )

overrideprivatevirtual

◆ dumpAsXml()

void SwPageFrame::dumpAsXml ( xmlTextWriterPtr writer = nullptr ) const

overridevirtual

◆ FillSelection()

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

overridevirtual

Reimplemented from SwLayoutFrame.

Definition at line 381 of file trvlfrm.cxx.

References SwAnchoredObject::DynCastFlyFrame(), SwLayoutFrame::FillSelection(), SwFrame::GetPaintArea(), GetSortedObjs(), and SwRect::Overlaps().

◆ FindFirstBodyContent() [1/2]

SwContentFrame * SwPageFrame::FindFirstBodyContent ( )

inline

◆ FindFirstBodyContent() [2/2]

const SwContentFrame * SwPageFrame::FindFirstBodyContent ( ) const

inline

Definition at line 364 of file pagefrm.hxx.

References SwLayoutFrame::ContainsContent(), and SwFootnoteBossFrame::FindBodyCont().

◆ FindLastBodyContent() [1/2]

SwContentFrame * SwPageFrame::FindLastBodyContent ( )

Searches the last ContentFrame in BodyText below the page.

Definition at line 57 of file findfrm.cxx.

References FindFirstBodyContent(), SwFrame::FindNextCnt(), SwLayoutFrame::IsAnLower(), and SwFrame::IsInDocBody().

Referenced by SwBreakDashedLine::execute(), FindLastBodyContent(), SwLayAction::FormatContent(), GetBodyTextNode(), GetLastSub(), and SwFrame::GetPrevFootnoteLeaf().

◆ FindLastBodyContent() [2/2]

const SwContentFrame * SwPageFrame::FindLastBodyContent ( ) const

inline

Definition at line 369 of file pagefrm.hxx.

References FindLastBodyContent().

◆ FindPageDesc()

SwPageDesc * SwPageFrame::FindPageDesc ( )

Definition at line 767 of file pagechg.cxx.

References SwLayoutFrame::ContainsContent(), FindFirstBodyContent(), SwFrame::FindTabFrame(), SwViewOption::getBrowseMode(), SwRootFrame::GetCurrShell(), SwFormat::GetDoc(), SwDoc::GetEndNoteInfo(), SwPageDesc::GetFollow(), SwDoc::GetFootnoteInfo(), SwLayoutFrame::GetFormat(), SwFrame::GetNext(), SwContentFrame::GetNextContentFrame(), SwFormatPageDesc::GetPageDesc(), GetPageDesc(), SwDoc::GetPageDesc(), SwEndNoteInfo::GetPageDesc(), SwFrame::GetPageDescItem(), SwFrame::GetPrev(), SwFrame::getRootFrame(), SwFrame::GetUpper(), SwViewShell::GetViewOptions(), IsEmptyPage(), IsEndNotePage(), IsFootnotePage(), SwFrame::IsInDocBody(), SwFrame::IsInTab(), and SwLayoutFrame::SwFlowFrame.

Referenced by SwRootFrame::AssertFlyPages(), SwFrame::CheckPageDescs(), SwTextFrame::FillRegister(), and SwFrame::WrongPageDesc().

◆ GetBorderAndShadowBoundRect()

void SwPageFrame::GetBorderAndShadowBoundRect	(	const SwRect &	_rPageRect,
		const SwViewShell *	_pViewShell,
		OutputDevice const *	pRenderContext,
		SwRect &	_orBorderAndShadowBoundRect,
		const bool	bLeftShadow,
		const bool	bRightShadow,
		const bool	bRightSidebar
	)

static

get bound rectangle of border and shadow for repaints

Get bound rectangle of border and shadow for repaints.

Parameters

_rPageRect	input parameter - constant instance reference of the page rectangle. Generally, it's the frame area of the page, but for empty pages in print preview, this parameter is useful.
_pViewShell	input parameter - instance of the view shell, for which the rectangle has to be generated.
_orBorderAndShadowBoundRect	output parameter - instance reference of the bounded border and shadow rectangle for the given page rectangle

for #i9719#

Definition at line 6413 of file paintfrm.cxx.

References SwRect::AddBottom(), SwRect::AddTop(), GetHorizontalShadowRect(), SwRect::Left(), OutputDevice::LogicToPixel(), OutputDevice::PixelToLogic(), SwRect::Right(), snShadowPxWidth, SwRect::SVRect(), and SwAlignRect().

Referenced by DestroyImpl(), SwLayAction::FormatLayout(), GetBoundRect(), SwPagePreviewLayout::Paint(), SwRootFrame::PaintSwFrame(), and UpdateAttr_().

◆ GetBoundRect()

SwRect SwPageFrame::GetBoundRect ( OutputDevice const * pOutputDevice ) const

Definition at line 6440 of file paintfrm.cxx.

References GetBorderAndShadowBoundRect(), SwRootFrame::GetCurrShell(), SwFrameAreaDefinition::getFrameArea(), SwFrame::getRootFrame(), IsLeftShadowNeeded(), IsRightShadowNeeded(), sw::sidebarwindows::RIGHT, and SidebarPosition().

Referenced by SwLayAction::FormatLayout(), SwViewShellImp::GetLastVisPage(), SwAnchoredDrawObject::GetObjBoundRect(), SwViewShellImp::SetFirstVisPage(), SwBreakDashedLine::UpdatePosition(), and SwViewShell::VisPortChgd().

◆ GetContentHeight()

size_t SwPageFrame::GetContentHeight	(	const tools::Long	nTop,
		const tools::Long	nBottom
	)		const

private

Calculate the content height of a page (without columns).

Definition at line 726 of file calcmove.cxx.

References SwLayoutFrame::ContainsAny(), SwFootnoteBossFrame::FindBodyCont(), SwFrame::FindNext(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwFrame::GetNext(), SwFrame::GetUpper(), SwRect::Height(), SwLayoutFrame::IsAnLower(), SwFrame::IsBodyFrame(), SwFrame::IsColumnFrame(), SwFrame::IsFooterFrame(), SwFrameAreaDefinition::isFrameAreaSizeValid(), SwFrameAreaDefinition::isFramePrintAreaValid(), SwFrame::IsHeaderFrame(), SwFrame::IsSctFrame(), SwFrame::IsTextFrame(), lcl_CheckObjects(), SwLayoutFrame::Lower(), m_pSortedObjs, min(), and SwRect::Top().

Referenced by MakeAll().

◆ GetContentPosition()

void SwPageFrame::GetContentPosition	(	const Point &	rPt,
		SwPosition &	rPos
	)		const

Same as SwLayoutFrame::GetContentPos().

Specialized for fields and border.

Definition at line 1393 of file trvlfrm.cxx.

References Bottom, SwRect::Bottom(), CalcDiff(), SwRect::Contains(), SwLayoutFrame::ContainsContent(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwFrame::GetModelPositionForViewPoint(), SwContentFrame::GetNextContentFrame(), SwContentFrame::GetPrevContentFrame(), SwFrame::GetUpper(), SwTextFrame::HasPara(), SwFrameAreaDefinition::isFrameAreaDefinitionValid(), SwFrame::IsInDocBody(), SwFrame::IsTextFrame(), SwRect::Left(), SwRect::Pos(), SwRect::Right(), SAL_MAX_UINT64, SetOnlyText, Point::setX(), Point::setY(), SwRect::SSize(), SwRect::Top(), SwFrame::UnionFrame(), Point::X(), and Point::Y().

Referenced by GetBodyTextNode().

◆ GetDrawBackgroundColor()

Color SwPageFrame::GetDrawBackgroundColor ( ) const

SwPageFrame::GetDrawBackgroundColor.

For #102450# Determine the color, that is respectively will be drawn as background for the page frame.

determine the color, that is respectively will be drawn as background for the page frame.

Returns: reference to an instance of class Color

Using existing method SwFrame::GetBackgroundBrush to determine the color that is set at the page frame respectively is parent. If none is found return the global retouche color

Returns: Color

Definition at line 7462 of file paintfrm.cxx.

References aGlobalRetoucheColor, SwFrame::GetBackgroundBrush(), Color::getBColor(), SvxBrushItem::GetColor(), SwRootFrame::GetCurrShell(), SwViewShell::GetDoc(), SvxBrushItem::GetGraphic(), SfxObjectShell::GetMedium(), SfxMedium::GetName(), SwDoc::GetPersist(), SwFrame::getRootFrame(), and SfxObjectShell::HasName().

Referenced by SwFEShell::GetShapeBackground(), SwFlyFrameFormat::MakeGraphic(), SwRootFrame::PaintSwFrame(), and SwFrame::Retouch().

◆ GetEmptyPageFont()

const vcl::Font & SwPageFrame::GetEmptyPageFont ( )

static

create/return font used to paint the "empty page" string

Definition at line 7508 of file paintfrm.cxx.

References COL_GRAY(), FAMILY_SWISS, vcl::Font::SetColor(), vcl::Font::SetFamily(), vcl::Font::SetFamilyName(), vcl::Font::SetFontSize(), vcl::Font::SetStyleName(), vcl::Font::SetTransparent(), vcl::Font::SetWeight(), and WEIGHT_BOLD.

Referenced by SwPagePreviewLayout::Paint(), and SwRootFrame::PaintSwFrame().

◆ GetFooterFrame()

const SwFooterFrame * SwPageFrame::GetFooterFrame ( ) const

Definition at line 2589 of file pagechg.cxx.

References SwFrame::GetNext(), SwFrame::IsFooterFrame(), and SwLayoutFrame::Lower().

Referenced by SwAnchoredDrawObject::GetObjBoundRect().

◆ GetFormatPage()

const SwPageFrame & SwPageFrame::GetFormatPage ( ) const

Definition at line 2470 of file pagechg.cxx.

References SwFrame::GetNext(), SwFrame::GetPrev(), IsEmptyPage(), and SwFrame::OnRightPage().

Referenced by CalcHeightWithFlys(), SwRootFrame::CheckViewLayout(), SwViewShellImp::GetLastVisPage(), SwRootFrame::PaintSwFrame(), SwViewShellImp::SetFirstVisPage(), and SwViewShell::VisPortChgd().

◆ GetHeaderFrame()

const SwHeaderFrame * SwPageFrame::GetHeaderFrame ( ) const

Definition at line 2577 of file pagechg.cxx.

References SwFrame::GetNext(), SwFrame::IsHeaderFrame(), and SwLayoutFrame::Lower().

Referenced by objectpositioning::SwToContentAnchoredObjectPosition::CalcPosition(), and SwAnchoredDrawObject::GetObjBoundRect().

◆ GetHorizontalShadowRect()

void SwPageFrame::GetHorizontalShadowRect	(	const SwRect &	_rPageRect,
		const SwViewShell *	_pViewShell,
		OutputDevice const *	pRenderContext,
		SwRect &	_orBottomShadowRect,
		bool	bPaintLeftShadow,
		bool	bPaintRightShadow,
		bool	bRightSidebar
	)

staticprivate

determine rectangle for horizontal page shadow

Determine rectangle for bottom page shadow for #i9719#.

#i9719#

Parameters

_rPageRect	input parameter - constant instance reference of the page rectangle. Generally, it's the frame area of the page, but for empty pages in print preview, this parameter is useful.
_pViewShell	input parameter - instance of the view shell, for which the rectangle has to be generated.
_orBottomShadowRect	output parameter - instance reference of the bottom shadow rectangle for the given page rectangle

Definition at line 6044 of file paintfrm.cxx.

References SwRect::AddLeft(), SwRect::AddRight(), SwRect::Chg(), SwViewShell::GetPostItMgr(), SwPostItMgr::GetSidebarBorderWidth(), SwPostItMgr::GetSidebarWidth(), SwPostItMgr::HasNotes(), SwRect::Left(), OutputDevice::LogicToPixel(), SwPostItMgr::ShowNotes(), snShadowPxWidth, SwRect::SVRect(), SwAlignRect(), and SwRect::Width().

Referenced by GetBorderAndShadowBoundRect(), and PaintBorderAndShadow().

◆ GetInfo()

bool SwPageFrame::GetInfo ( SfxPoolItem & rInfo ) const

overridevirtual

Get info from Client.

get information from Modify

Reimplemented from SwClient.

Definition at line 741 of file pagechg.cxx.

References RES_AUTOFMT_DOCNODE(), and SfxPoolItem::Which().

◆ GetModelPositionForViewPoint()

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

overridevirtual

Searches the page containing the searched point.

Reimplemented from SwLayoutFrame.

Definition at line 180 of file trvlfrm.cxx.

References SwPosition::AdjustContent(), SwPosition::Assign(), Bottom, SwFrame::GetCharRect(), SwPosition::GetContentIndex(), SwNode::GetContentNode(), SwLayoutFrame::GetContentPos(), SwFormatField::GetField(), SwTextAttr::GetFormatField(), SwFrameAreaDefinition::getFrameArea(), SwContentNode::getLayoutFrame(), SwRectFnSet::GetLeft(), SwFrame::GetModelPositionForViewPoint(), SwLayoutFrame::GetModelPositionForViewPoint(), SwPosition::GetNode(), GetNode(), SwFrame::getRootFrame(), GetSortedObjs(), SwTextNode::GetTextAttrForCharAt(), SwNode::GetTextNode(), SwRectFnSet::GetTop(), SwField::IsClickable(), SwFrame::IsNoTextFrame(), SwFrame::IsTextFrame(), SwNode::IsTextNode(), Left, SwContentNode::Len(), SwCursorMoveState::m_bExactOnly, SwCursorMoveState::m_bPosMatchesBounds, SwCursorMoveState::m_bStop, SwCursorMoveState::m_pFill, min(), basegfx::fTools::more(), RES_TXTATR_FIELD(), Right, SwRectFnSet::SetLeft(), SwRectFnSet::SetRight(), Point::setX(), Point::setY(), Top, Point::X(), and Point::Y().

◆ GetPageDesc() [1/2]

SwPageDesc * SwPageFrame::GetPageDesc ( )

inline

Definition at line 147 of file pagefrm.hxx.

Referenced by SwRootFrame::AssertFlyPages(), sw::DefaultToxTabStopTokenHandler::CanUseLayoutRectangle(), SwRefPageGetField::ChangeExpansion(), SwDocStatField::ChangeExpansion(), SwLayHelper::CheckInsertPage(), SwFrame::CheckPageDescs(), dumpAsXml(), SwHeaderFooterWin::ExecuteCommand(), SwViewShell::FillPrtDoc(), FindPageDesc(), SwNode::FindPageDesc(), SwTextFly::ForEach(), SwFootnoteContFrame::Format(), SwFEShell::GetCurPageDesc(), SwUnoCursorHelper::GetCurPageStyle(), SwViewShell::GetFirstLastVisPageNumbers(), SwAccessibleFrame::GetFormattedPageNumber(), GetGridItem(), SwFEShell::GetMousePageDesc(), SwFEShell::GetSelectedPageDescs(), IMPL_LINK_NOARG(), SwFrame::InsertPage(), SwHeaderFooterWin::IsEmptyHeaderFooter(), SwPageDesc::IsFollowNextPageOfNode(), lcl_GetPageNumber(), lcl_GetPaperBin(), lcl_SetAPageOffset(), SwEditWin::MouseButtonDown(), SwTextFormatter::NewFieldPortion(), SwFrame::OnFirstPage(), SwFootnoteContFrame::PaintLine(), SwTabFrame::Paste(), SwCursorShell::SetCursorInHdFt(), SwHeaderFooterWin::SetOffset(), SwGetRefField::UpdateField(), SwRefPageGetFieldType::UpdateField(), SwTOXBaseSection::UpdatePageNum(), SwFrame::WannaRightPage(), and SwFrame::WrongPageDesc().

◆ GetPageDesc() [2/2]

const SwPageDesc * SwPageFrame::GetPageDesc ( ) const

inline

Definition at line 148 of file pagefrm.hxx.

◆ GetPhyPageNum()

sal_uInt16 SwPageFrame::GetPhyPageNum ( ) const

inline

Definition at line 209 of file pagefrm.hxx.

Referenced by SwObjectFormatterLayFrame::AdditionalFormatObjsOnPage(), SwRootFrame::AssertFlyPages(), SwRootFrame::AssertPageFlys(), SwTabFrame::CalcFlyOffsets(), CalcHeightWithFlys(), SwPagePreviewLayout::CalcPreviewDataForPage(), SwPagePreviewLayout::CalcPreviewPages(), SwDoc::CalculatePagePairsForProspectPrinting(), SwDrawContact::Changed_(), SwRefPageGetField::ChangeExpansion(), SwLayAction::CheckFirstVisPage(), SwLayHelper::CheckFlyCache_(), SwObjectFormatterTextFrame::CheckMovedFwdCondition(), SwFrame::CheckPageDescs(), SwRootFrame::CheckViewLayout(), SwPageNumAndTypeOfAnchors::Collect(), SwLooping::Control(), SwPagePreviewLayout::ConvertAbsoluteToRelativePageNum(), SwPagePreviewLayout::ConvertRelativeToAbsolutePageNum(), SwContentFrame::Cut(), SwMovedFwdFramesByObjPos::DoesRowContainMovedFwdFrame(), SwObjectFormatterTextFrame::DoFormatObj(), SwObjectFormatterTextFrame::DoFormatObjs(), SwLayIdle::DoIdleJob(), dumpAsXml(), SwFootnoteBossFrame::FindFirstFootnote(), SwTextFrame::Format(), SwLayAction::FormatContent(), SwLayAction::FormatLayoutTab(), SwRootFrame::GetCurrPage(), SwViewShell::GetFirstLastVisPageNumbers(), SwPostItHelper::getLayoutInfos(), SwFrame::GetNextLeaf(), SwCursorShell::GetNextPrevPageNum(), SwRootFrame::GetPageByPageNum(), SwPaM::GetPageNum(), SwCursorShell::GetPageNum(), SwViewShell::GetPageNumAndSetOffsetForPDF(), SwRootFrame::GetPagePos(), SwFrame::GetPhyPageNum(), SwFrame::GetPrevFootnoteLeaf(), SwFEShell::GetSelectedPageDescs(), SwFrame::GetVirtPageNum(), SwContentNotify::ImplDestroy(), SwFrame::InsertPage(), SwLayAction::InternalAction(), SwLayoutFrame::IsBefore(), SwLayAction::IsShortCut(), lcl_MakeObjs(), lcl_SetNewFlyPos(), SwLayouter::LoopingLouieLight(), SwFlyFrameFormat::MakeFrames(), MoveFly(), SwFootnoteBossFrame::MoveFootnotes(), SwFootnoteBossFrame::MoveFootnotes_(), SwPagePreviewLayout::Paint(), SwRootFrame::PaintSwFrame(), Paste(), SwViewShell::PrintProspect(), SwRootFrame::SetCurrPage(), SwLooping::SwLooping(), SwRefPageGetFieldType::UpdateField(), UpdateVirtPageNumInfo(), SwLayoutCache::Write(), and SwFrame::WrongPageDesc().

◆ GetSidebarBorderWidth()

SwTwips SwPageFrame::GetSidebarBorderWidth ( const SwViewShell * _pViewShell )

static

Definition at line 6455 of file paintfrm.cxx.

References SwViewShell::GetPostItMgr(), SwPostItMgr::GetSidebarBorderWidth(), SwPostItMgr::GetSidebarWidth(), SwPostItMgr::HasNotes(), and SwPostItMgr::ShowNotes().

Referenced by SwRootFrame::CheckViewLayout().

◆ GetSortedObjs() [1/2]

SwSortedObjs * SwPageFrame::GetSortedObjs ( )

inline

Definition at line 137 of file pagefrm.hxx.

◆ GetSortedObjs() [2/2]

const SwSortedObjs * SwPageFrame::GetSortedObjs ( ) const

inline

Definition at line 136 of file pagefrm.hxx.

Referenced by SwObjectFormatterLayFrame::AdditionalFormatObjsOnPage(), SwRootFrame::AssertPageFlys(), SwOrderIter::Bottom(), SwTabFrame::CalcFlyOffsets(), SwRootFrame::CalcFrameRects(), SwLayHelper::CheckFlyCache_(), SwObjectFormatterTextFrame::CheckMovedFwdCondition(), SwObjectFormatterLayFrame::CreateObjFormatter(), SwTextFly::CtorInitTextFly(), Cut(), DelFlys(), SwFlyFreeFrame::DestroyImpl(), SwLayIdle::DoIdleJob(), dumpAsXml(), FillSelection(), SwCellFrame::Format(), SwTextFrame::Format(), SwLayAction::FormatContent(), SwLayoutFrame::FormatWidthCols(), SwDoc::GetAllFlyFormats(), SwFEShell::GetBox(), SwDrawView::GetMaxToTopObj(), SwFlyFrame::GetModelPositionForViewPoint(), GetModelPositionForViewPoint(), SwTextFly::InitAnchoredObjList(), SwLayAction::InternalAction(), SwRootFrame::InvalidateAllContent(), SwRootFrame::InvalidateAllObjPos(), SwObjectFormatterTextFrame::InvalidateFollowObjs(), SwTextFly::IsAnyObj(), sw::IsPageFrameEmpty(), SwLayAction::IsShortCut(), SwAccessibleChildMap::IsSortingRequired(), lcl_FindFirstInvaObj(), lcl_NotifyNeighbours(), lcl_SubtractFlys(), SwFEShell::MoveAnchor(), MoveFly(), SwAccessibleChildSList_const_iterator::next(), SwOrderIter::Next(), Notify_Background(), SwLayoutFrame::NotifyLowerObjs(), SwFrame::PaintBorderLine(), SwLayAction::PaintContent_(), SwLayoutFrame::PaintSubsidiaryLines(), SwFrame::PaintSwFrameBackground(), SwLayAction::PaintWithoutFlys(), PrepareRegisterChg(), SwOrderIter::Prev(), RefreshExtraData(), SwFrame::RemoveDrawObj(), SwLayAction::RemoveEmptyBrowserPages(), SwFrame::RemoveFly(), SwContentFrame::ShrinkFrame(), SwAccessibleChildMap::SwAccessibleChildMap(), SwAccessibleChildSList_const_iterator::SwAccessibleChildSList_const_iterator(), SwOrderIter::Top(), SwLayAction::TurboAction_(), unlockPositionOfObjects(), SwAnchoredObject::UpdateObjInSortedList(), SwViewShell::VisPortChgd(), and SwLayoutCache::Write().

◆ GetSubsidiaryLinesPolygons()

std::vector< basegfx::B2DPolygon > SwPageFrame::GetSubsidiaryLinesPolygons ( const SwViewShell & rViewShell ) const

private

Definition at line 7063 of file paintfrm.cxx.

References SwRect::AddBottom(), SwRect::Bottom(), SwFrameAreaDefinition::getFrameArea(), SwFrame::GetNext(), SwViewShell::GetViewOptions(), SwFrame::IsBodyFrame(), SwViewOption::IsDocBoundaries(), SwRect::IsEmpty(), SwFrame::IsFootnoteContFrame(), SwViewOption::IsViewMetaChars(), lcl_CreatePageAreaDelimiterPolygons(), lcl_CreateRectangleDelimiterPolygons(), and SwLayoutFrame::Lower().

Referenced by AddSubsidiaryLinesBounds(), and PaintSubsidiaryLines().

◆ HasGrid()

bool SwPageFrame::HasGrid ( ) const

inline

Definition at line 190 of file pagefrm.hxx.

Referenced by GetGridItem().

◆ InvalidateAutoCompleteWords()

void SwPageFrame::InvalidateAutoCompleteWords ( ) const

inline

Definition at line 402 of file pagefrm.hxx.

References m_bInvalidAutoCmplWrds.

Referenced by SwRootFrame::AllInvalidateAutoCompleteWords(), AppendFlyToPage(), lcl_SetWrong(), MoveFly(), and SwContentFrame::Paste().

◆ InvalidateContent()

void SwPageFrame::InvalidateContent ( ) const

inline

Definition at line 389 of file pagefrm.hxx.

References m_bInvalidContent.

Referenced by SwEditShell::HandleUndoRedoContext(), SwFEShell::Insert(), InsertCnt_(), SwLayAction::InternalAction(), SwRootFrame::InvalidateAllContent(), SwFrame::InvalidatePage(), and SwSectionFrame::MoveContentAndDelete().

◆ InvalidateFlyContent()

void SwPageFrame::InvalidateFlyContent ( ) const

inline

Definition at line 377 of file pagefrm.hxx.

References m_bInvalidFlyContent.

Referenced by AppendFlyToPage(), InsertCnt_(), SwLayAction::InternalAction(), SwRootFrame::InvalidateAllContent(), SwFrame::InvalidatePage(), and MoveFly().

◆ InvalidateFlyInCnt()

void SwPageFrame::InvalidateFlyInCnt ( ) const

inline

Definition at line 381 of file pagefrm.hxx.

References m_bInvalidFlyInCnt.

Referenced by AppendFlyToPage(), SwLayAction::InternalAction(), SwRootFrame::InvalidateAllContent(), SwFrame::InvalidatePage(), SwAnchoredDrawObject::InvalidatePage_(), and MoveFly().

◆ InvalidateFlyLayout()

void SwPageFrame::InvalidateFlyLayout ( ) const

inline

Validate, invalidate and query the Page status Layout/Content and Fly/non-Fly respectively are inspected separately.

Definition at line 373 of file pagefrm.hxx.

References m_bInvalidFlyLayout.

Referenced by AppendDrawObjToPage(), SwLayAction::FormatContent(), SwEditShell::HandleUndoRedoContext(), SwFEShell::Insert(), SwLayAction::InternalAction(), SwRootFrame::InvalidateAllContent(), SwRootFrame::InvalidateAllObjPos(), SwFrame::InvalidatePage(), and SwAnchoredDrawObject::InvalidatePage_().

◆ InvalidateLayout()

void SwPageFrame::InvalidateLayout ( ) const

inline

Definition at line 385 of file pagefrm.hxx.

References m_bInvalidLayout.

Referenced by SwRootFrame::InvalidateAllContent(), SwFrame::InvalidatePage(), and Paste().

◆ InvalidateSmartTags()

void SwPageFrame::InvalidateSmartTags ( ) const

inline

Definition at line 398 of file pagefrm.hxx.

References m_bInvalidSmartTags.

Referenced by SwRootFrame::AllInvalidateSmartTagsOrSpelling(), AppendFlyToPage(), lcl_SetWrong(), MoveFly(), and SwContentFrame::Paste().

◆ InvalidateSpelling()

void SwPageFrame::InvalidateSpelling ( ) const

inline

Definition at line 393 of file pagefrm.hxx.

References m_bInvalidSpelling.

Referenced by SwRootFrame::AllInvalidateSmartTagsOrSpelling(), AppendFlyToPage(), lcl_SetWrong(), MoveFly(), and SwContentFrame::Paste().

◆ InvalidateWordCount()

void SwPageFrame::InvalidateWordCount ( ) const

inline

Definition at line 406 of file pagefrm.hxx.

References m_bInvalidWordCount.

Referenced by AppendFlyToPage(), lcl_SetWrong(), MoveFly(), and SwContentFrame::Paste().

◆ IsEmptyPage()

bool SwPageFrame::IsEmptyPage ( ) const

inline

Definition at line 161 of file pagefrm.hxx.

Referenced by SwRootFrame::AssertFlyPages(), SwRootFrame::AssertPageFlys(), SwPagePreviewLayout::CalcPreviewDataForPage(), SwPagePreviewLayout::CalcPreviewLayoutSizes(), SwPagePreviewLayout::CalcPreviewPages(), SwLayHelper::CheckInsertPage(), SwFrame::CheckPageDescs(), SwRootFrame::CheckViewLayout(), SwFootnoteBossFrame::CollectFootnotes(), SwPagePreviewLayout::ConvertAbsoluteToRelativePageNum(), SwPagePreviewLayout::ConvertRelativeToAbsolutePageNum(), Cut(), FindPageDesc(), sw::access::SwAccessibleChild::GetBounds(), sw::access::SwAccessibleChild::GetBox(), GetFormatPage(), SwViewShellImp::GetLastVisPage(), SwFrame::GetNextFootnoteLeaf(), SwFrame::GetNextLeaf(), SwCursorShell::GetNextPrevPageNum(), SwFrame::GetNextSctLeaf(), SwCursorShell::GetPageNum(), SwCursorShell::GetPageNumSeqNonEmpty(), SwViewShell::GetPageSize(), SwRootFrame::IsDummyPage(), lcl_MakeObjs(), MakeAll(), SwPagePreviewLayout::Paint(), SwRootFrame::PaintSwFrame(), PlaceFly(), PreparePage(), SwViewShell::PrintProspect(), SwViewShellImp::SetFirstVisPage(), SwEnhancedPDFExportHelper::SwEnhancedPDFExportHelper(), SwBreakDashedLine::UpdatePosition(), and SwFrame::WannaRightPage().

◆ IsEndNotePage()

bool SwPageFrame::IsEndNotePage ( ) const

inline

Definition at line 205 of file pagefrm.hxx.

Referenced by SwFootnoteBossFrame::AppendFootnote(), SwRootFrame::CheckFootnotePageDescs(), SwFootnoteBossFrame::FindNearestFootnoteCont(), FindPageDesc(), SwFrame::GetNextFootnoteLeaf(), SwFrame::GetPrevFootnoteLeaf(), SwFootnoteBossFrame::InsertFootnote(), lcl_GetApproximateFootnotePage(), and SwRootFrame::RemoveFootnotes().

◆ IsFootnotePage()

bool SwPageFrame::IsFootnotePage ( ) const

inline

◆ IsInvalid()

bool SwPageFrame::IsInvalid ( ) const

inline

Definition at line 448 of file pagefrm.hxx.

References m_bInvalidContent, m_bInvalidFlyInCnt, and m_bInvalidLayout.

Referenced by SwViewShell::CheckInvalidForPaint(), SwTextFrame::Format(), SwPostItHelper::getLayoutInfos(), SwLayAction::InternalAction(), SwLayAction::IsShortCut(), and SwViewShellImp::NotifySizeChg().

◆ IsInvalidAutoCompleteWords()

bool SwPageFrame::IsInvalidAutoCompleteWords ( ) const

inline

Definition at line 243 of file pagefrm.hxx.

Referenced by SwLayIdle::SwLayIdle().

◆ IsInvalidContent()

bool SwPageFrame::IsInvalidContent ( ) const

inline

Definition at line 240 of file pagefrm.hxx.

Referenced by SwTextFrame::CalcFollow(), dumpAsXml(), SwLayAction::InternalAction(), SwLayAction::IsShortCut(), SwLayIdle::SwLayIdle(), and SwLayAction::TurboAction_().

◆ IsInvalidFly()

bool SwPageFrame::IsInvalidFly ( ) const

inline

Definition at line 452 of file pagefrm.hxx.

References m_bInvalidFlyContent, and m_bInvalidFlyLayout.

Referenced by SwViewShell::CheckInvalidForPaint(), SwTextFrame::Format(), SwPostItHelper::getLayoutInfos(), SwLayAction::InternalAction(), and SwLayAction::TurboAction_().

◆ IsInvalidFlyContent()

bool SwPageFrame::IsInvalidFlyContent ( ) const

inline

Definition at line 237 of file pagefrm.hxx.

Referenced by dumpAsXml(), SwLayAction::IsShortCut(), and SwLayIdle::SwLayIdle().

◆ IsInvalidFlyInCnt()

bool SwPageFrame::IsInvalidFlyInCnt ( ) const

inline

Definition at line 238 of file pagefrm.hxx.

Referenced by dumpAsXml(), SwLayAction::IsShortCut(), and SwLayIdle::SwLayIdle().

◆ IsInvalidFlyLayout()

bool SwPageFrame::IsInvalidFlyLayout ( ) const

inline

Definition at line 236 of file pagefrm.hxx.

Referenced by dumpAsXml(), SwLayAction::IsShortCut(), and SwLayIdle::SwLayIdle().

◆ IsInvalidLayout()

bool SwPageFrame::IsInvalidLayout ( ) const

inline

Definition at line 239 of file pagefrm.hxx.

Referenced by dumpAsXml(), SwLayAction::InternalAction(), SwLayAction::IsShortCut(), SwLayIdle::SwLayIdle(), and SwLayAction::TurboAction_().

◆ IsInvalidSmartTags()

bool SwPageFrame::IsInvalidSmartTags ( ) const

inline

Definition at line 242 of file pagefrm.hxx.

Referenced by SwLayIdle::SwLayIdle().

◆ IsInvalidSpelling()

bool SwPageFrame::IsInvalidSpelling ( ) const

inline

Definition at line 241 of file pagefrm.hxx.

Referenced by SwXFlatParagraphIterator::getNextPara(), and SwLayIdle::SwLayIdle().

◆ IsInvalidWordCount()

bool SwPageFrame::IsInvalidWordCount ( ) const

inline

Definition at line 244 of file pagefrm.hxx.

Referenced by SwLayIdle::SwLayIdle().

◆ IsLeftShadowNeeded()

bool SwPageFrame::IsLeftShadowNeeded ( ) const

Definition at line 6028 of file paintfrm.cxx.

References SwRootFrame::GetCurrShell(), SwFrame::GetPrev(), SwFrame::getRootFrame(), SwViewShell::GetViewOptions(), SwRootFrame::IsLeftToRightViewLayout(), SwViewOption::IsViewLayoutBookMode(), and SwFrame::OnRightPage().

Referenced by DestroyImpl(), SwLayAction::FormatLayout(), GetBoundRect(), SwPagePreviewLayout::Paint(), SwRootFrame::PaintSwFrame(), and UpdateAttr_().

◆ IsOverHeaderFooterArea()

bool SwPageFrame::IsOverHeaderFooterArea	(	const Point &	rPt,
		FrameControlType &	rControl
	)		const

If in header or footer area, it also indicates the exact area in rControl.

Header or footer must be active, otherwise returns false.

Definition at line 2500 of file pagechg.cxx.

References Bottom, SwRect::Bottom(), SwRect::Contains(), Footer, SwRootFrame::GetCurrShell(), SwFrame::GetDep(), SwFrameAreaDefinition::getFrameArea(), SwFrame::GetNext(), SwFrame::getRootFrame(), SwViewShell::GetViewOptions(), Header, SwFrame::IsBodyFrame(), SwFrame::IsFootnoteContFrame(), SwViewOption::IsHideWhitespaceMode(), Left, SwLayoutFrame::Lower(), Top, SwRect::Top(), TopLeft, and Width.

Referenced by SwEditWin::IsInHeaderFooter().

◆ IsRightShadowNeeded()

bool SwPageFrame::IsRightShadowNeeded ( ) const

Definition at line 6015 of file paintfrm.cxx.

References SwRootFrame::GetCurrShell(), SwFrame::GetNext(), SwFrame::getRootFrame(), SwViewShell::GetViewOptions(), SwRootFrame::IsLeftToRightViewLayout(), SwViewOption::IsViewLayoutBookMode(), SwLayoutFrame::Lower(), and SwFrame::OnRightPage().

Referenced by DestroyImpl(), SwLayAction::FormatLayout(), GetBoundRect(), SwPagePreviewLayout::Paint(), SwRootFrame::PaintSwFrame(), and UpdateAttr_().

◆ MakeAll()

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

overrideprivatevirtual

Reimplemented from SwLayoutFrame.

Definition at line 794 of file calcmove.cxx.

◆ MoveFly()

void SwPageFrame::MoveFly	(	SwFlyFrame *	pToMove,
		SwPageFrame *	pDest
	)

◆ PaintBorderAndShadow()

void SwPageFrame::PaintBorderAndShadow	(	const SwRect &	_rPageRect,
		const SwViewShell *	_pViewShell,
		bool	bPaintLeftShadow,
		bool	bPaintRightShadow,
		bool	bRightSidebar
	)

static

paint page border and shadow

Paint page border and shadow.

Parameters

_rPageRect	input parameter - constant instance reference of the page rectangle. Generally, it's the frame area of the page, but for empty pages in print preview, this parameter is useful.
_pViewShell	input parameter - instance of the view shell, on which the output has to be generated.
bPaintRightShadow	Should we paint shadow on the right or not (used in book mode)
bFullBottomShadow	Should we have a bottom shadow of the same size as the pages or not (for right pages in book mode in a LTR environment).
bRightSidebar	Is the note sidebar on the right or not (used to adjust the shadow with & position).

for #i9719# implement paint of page border and shadow

Definition at line 6135 of file paintfrm.cxx.

Referenced by SwPagePreviewLayout::Paint(), and SwRootFrame::PaintSwFrame().

◆ PaintBreak()

void SwPageFrame::PaintBreak ( ) const

overridevirtual

Reimplemented from SwLayoutFrame.

Definition at line 3699 of file paintfrm.cxx.

References SwLayoutFrame::ContainsContent(), SwView::GetEditWin(), SwEditWin::GetFrameControlsManager(), SwFrame::GetNext(), SwWrtShell::GetView(), gProp, SwFrame::IsBodyFrame(), SwFrame::IsTabFrame(), SwLayoutFrame::Lower(), OUTDEV_PRINTER, PageBreak, SwLayoutFrame::PaintBreak(), SwFrameControlsManager::RemoveControlsByType(), SwFrameControlsManager::SetPageBreakControl(), and SwLayoutFrame::SwFlowFrame.

Referenced by SwRootFrame::PaintSwFrame().

◆ PaintDecorators()

void SwPageFrame::PaintDecorators ( ) const

◆ PaintGrid()

void SwPageFrame::PaintGrid	(	OutputDevice const *	pOut,
		SwRect const &	rRect
	)		const

◆ PaintMarginArea()

void SwPageFrame::PaintMarginArea	(	const SwRect &	_rOutputRect,
		SwViewShell const *	_pViewShell
	)		const

paint margin area of a page

Paint margin area of a page.

implement paint of margin area; margin area will be painted for a view shell with a window and if the document is not in online layout.

Parameters

_rOutputRect	input parameter - constant instance reference of the rectangle, for which an output has to be generated.
_pViewShell	input parameter - instance of the view shell, on which the output has to be generated.

OD 20.11.2002 for #104598#: implement paint of margin area; margin area will be painted for a view shell with a window and if the document is not in online layout.

Parameters

_rOutputRect	input parameter - constant instance reference of the rectangle, for which an output has to be generated.
_pViewShell	input parameter - instance of the view shell, on which the output has to be generated.

Definition at line 5990 of file paintfrm.cxx.

References aGlobalRetoucheColor, SwViewOption::getBrowseMode(), SwFrameAreaDefinition::getFrameArea(), SwViewShell::GetOut(), SwViewShell::GetViewOptions(), SwViewShell::GetWin(), SwRect::Intersection_(), SwRect::IsEmpty(), pOut, and SwRect::SVRect().

◆ PaintNotesSidebar()

void SwPageFrame::PaintNotesSidebar	(	const SwRect &	_rPageRect,
		SwViewShell *	_pViewShell,
		sal_uInt16	nPageNum,
		bool	bRight
	)

static

mod #i6193# paint sidebar for notes IMPORTANT: if you change the rects here, also change SwPostItMgr::ScrollbarHit

Definition at line 6293 of file paintfrm.cxx.

References SwRect::Bottom(), COL_BLACK(), COL_LIGHTGRAY(), COL_WHITE(), OutputDevice::DrawLine(), OutputDevice::DrawRect(), SwPostItMgr::GetArrowColor(), SwViewOption::GetObjectBoundariesColor(), SwViewShell::GetOut(), SwViewShell::GetPostItMgr(), SwViewOption::GetSectionBoundColor(), Application::GetSettings(), SwPostItMgr::GetSidebarBorderWidth(), SwPostItMgr::GetSidebarScrollerHeight(), SwPostItMgr::GetSidebarWidth(), SwViewShell::GetViewOptions(), SwPostItMgr::HasNotes(), Height, SwRect::Height(), KEY_PAGEDOWN, KEY_PAGEUP, SwRect::Left(), tools::Rectangle::Overlaps(), PaintNotesSidebarArrows(), OutputDevice::PixelToLogic(), SwRect::Right(), OutputDevice::SetFillColor(), OutputDevice::SetLineColor(), SwPostItMgr::ShowNotes(), SwPostItMgr::ShowScrollbar(), SwRect::SVRect(), SwAlignRect(), SwRect::Top(), SwRect::TopRight(), SwViewShell::VisArea(), and Width.

Referenced by SwRootFrame::PaintSwFrame().

◆ PaintNotesSidebarArrows()

void SwPageFrame::PaintNotesSidebarArrows	(	const Point &	rMiddleFirst,
		const Point &	rMiddleSecond,
		SwViewShell const *	_pViewShell,
		const Color &	rColorUp,
		const Color &	rColorDown
	)

static

Definition at line 6389 of file paintfrm.cxx.

References OutputDevice::DrawPolygon(), SwViewShell::GetOut(), Height, OutputDevice::PixelToLogic(), OutputDevice::SetFillColor(), tools::Polygon::SetPoint(), and Width.

Referenced by PaintNotesSidebar().

◆ PaintSubsidiaryLines()

void SwPageFrame::PaintSubsidiaryLines	(	const SwPageFrame *	,
		const SwRect &
	)		const

overridevirtual

Reimplemented from SwLayoutFrame.

Definition at line 7099 of file paintfrm.cxx.

References GetSubsidiaryLinesPolygons(), gProp, lcl_CreateDelimiterPrimitives(), and SwFrame::ProcessPrimitives().

◆ Paste()

void SwPageFrame::Paste	(	SwFrame *	pParent,
		SwFrame *	pSibling = `nullptr`
	)

overridevirtual

◆ PlaceFly()

void SwPageFrame::PlaceFly	(	SwFlyFrame *	pFly,
		SwFlyFrameFormat *	pFormat
	)

Definition at line 1139 of file flylay.cxx.

References SwFrame::AppendFly(), SwFrame::GetNext(), IsEmptyPage(), PlaceFly(), and RegistFlys().

Referenced by SwFlyFrameFormat::MakeFrames(), PlaceFly(), and SwFlyLayFrame::SwClientNotify().

◆ PrepareFooter()

void SwPageFrame::PrepareFooter ( )

◆ PrepareHeader()

void SwPageFrame::PrepareHeader ( )

Make this public, so that the SwViewShell can access it when switching from browse mode Add/remove header/footer.

Creates or removes headers.

Definition at line 682 of file hffrm.cxx.

References SwLayoutFrame::Cut(), DelFlys(), SwFrame::DestroyFrame(), SwViewOption::getBrowseMode(), SwRootFrame::GetCurrShell(), SwFrame::GetDep(), SwLayoutFrame::GetFormat(), SwFormatHeader::GetHeaderFormat(), SwFrame::GetNext(), SwFrame::getRootFrame(), SwFrame::GetUpper(), SwViewShell::GetViewOptions(), SwFormatHeader::IsActive(), SwFrame::IsHeaderFrame(), SwViewOption::IsWhitespaceHidden(), SwLayoutFrame::Lower(), SwLayoutFrame::Paste(), and RegistFlys().

Referenced by SwViewShell::InvalidateLayout(), SwClientNotify(), and SwPageFrame().

◆ PreparePage()

void SwPageFrame::PreparePage ( bool bFootnote )

Always call after Paste Creates the page-bound frames and formats the generic content.

Definition at line 487 of file pagechg.cxx.

References bFootnote, SwFormat::GetDoc(), SwLayoutFrame::GetFormat(), SwFrame::GetPrev(), SwDoc::GetSpzFrameFormats(), IsEmptyPage(), lcl_FormatLay(), lcl_MakeObjs(), SwLayoutFrame::Lower(), RegistFlys(), and SetFootnotePage().

Referenced by SwFrame::CheckPageDescs(), and InsertNewPage().

◆ PrepareRegisterChg()

void SwPageFrame::PrepareRegisterChg ( )

Definition at line 984 of file pagechg.cxx.

References FindFirstBodyContent(), SwContentFrame::GetNextContentFrame(), GetSortedObjs(), SwLayoutFrame::IsAnLower(), and lcl_PrepFlyInCntRegister().

◆ PrtWithoutHeaderAndFooter()

SwRect SwPageFrame::PrtWithoutHeaderAndFooter ( ) const

Definition at line 3930 of file frmtool.cxx.

References SwRect::AddBottom(), SwRect::AddTop(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwFrame::GetNext(), SwRect::Height(), SwFrame::IsFooterFrame(), SwFrame::IsHeaderFrame(), SwLayoutFrame::Lower(), and SwRect::Pos().

◆ RefreshExtraData()

void SwPageFrame::RefreshExtraData ( const SwRect & rRect ) const

Paint line number etc.

Refreshes all extra data (line breaks a.s.o) of the page.

Basically only those objects are considered which horizontally overlap the Rect.

Definition at line 7392 of file paintfrm.cxx.

References SwRect::Bottom(), SwFormat::GetDoc(), SwLayoutFrame::GetFormat(), SwDoc::GetLineNumberInfo(), GetSortedObjs(), gProp, SwRect::HasArea(), SwLineNumberInfo::IsCountInFlys(), SwLineNumberInfo::IsPaintLineNumbers(), SwPostItHelper::NONE, SwLayoutFrame::RefreshExtraData(), SW_MOD, SwAlignRect(), and SwRect::Top().

Referenced by SwRootFrame::PaintSwFrame().

◆ RefreshSubsidiary()

void SwPageFrame::RefreshSubsidiary ( const SwRect & rRect ) const

Paint helper lines.

Refreshes all subsidiary lines of a page.

Definition at line 6786 of file paintfrm.cxx.

References gProp, SwRect::HasArea(), isSubsidiaryLinesEnabled(), isSubsidiaryLinesFlysEnabled(), isSubsidiaryLinesForSectionsEnabled(), and SwLayoutFrame::RefreshLaySubsidiary().

Referenced by SwRootFrame::PaintSwFrame(), and SwFrame::Retouch().

◆ RemoveDrawObjFromPage()

void SwPageFrame::RemoveDrawObjFromPage ( SwAnchoredObject & _rToRemoveObj )

Definition at line 1109 of file flylay.cxx.

References SwFormat::GetAnchor(), SwFormatAnchor::GetAnchorId(), SwAnchoredObject::GetFrameFormat(), SwFrame::GetUpper(), InvalidateBrowseWidth, SwFrame::InvalidatePage(), m_pSortedObjs, and SwAnchoredObject::SetPageFrame().

Referenced by SwAnchoredDrawObject::RegisterAtPage(), and SwFrame::RemoveDrawObj().

◆ RemoveFlyFromPage()

void SwPageFrame::RemoveFlyFromPage ( SwFlyFrame * pToRemove )

Definition at line 909 of file flylay.cxx.

References SwRootFrame::GetDrawPage(), SdrObject::GetOrdNum(), SwFrame::getRootFrame(), SwFrame::GetUpper(), SwFlyFrame::GetVirtDrawObj(), InvalidateBrowseWidth, SwFlyFrame::IsFlyInContentFrame(), m_pSortedObjs, SdrVirtObj::ReferencedObj(), SdrObjList::RemoveObject(), SdrObject::SetOrdNum(), and SwAnchoredObject::SetPageFrame().

Referenced by lcl_Regist(), and SwFrame::RemoveFly().

◆ SetColMaxFootnoteHeight()

void SwPageFrame::SetColMaxFootnoteHeight ( )

private

Adapt the max. footnote height in each single column.

Definition at line 2649 of file ftnfrm.cxx.

References SwFootnoteBossFrame::FindBodyCont(), SwFootnoteBossFrame::GetMaxFootnoteHeight(), SwFrame::GetNext(), SwFrame::IsColumnFrame(), SwLayoutFrame::Lower(), and SwFootnoteBossFrame::SetMaxFootnoteHeight().

Referenced by SwClientNotify().

◆ SetEndNotePage()

void SwPageFrame::SetEndNotePage ( bool b )

inline

Definition at line 207 of file pagefrm.hxx.

Referenced by SwFootnoteBossFrame::AppendFootnote().

◆ SetFootnotePage()

void SwPageFrame::SetFootnotePage ( bool b )

inline

Definition at line 206 of file pagefrm.hxx.

Referenced by PreparePage().

◆ SetPageDesc()

void SwPageFrame::SetPageDesc	(	SwPageDesc *	pNew,
		SwFrameFormat *	pFormat
	)

Definition at line 751 of file pagechg.cxx.

References m_pDesc, and SwLayoutFrame::SetFrameFormat().

Referenced by SwFrame::CheckPageDescs().

◆ SetPhyPageNum()

void SwPageFrame::SetPhyPageNum ( sal_uInt16 nNum )

inline

Definition at line 210 of file pagefrm.hxx.

Referenced by Paste().

◆ SidebarPosition()

sw::sidebarwindows::SidebarPosition SwPageFrame::SidebarPosition ( ) const

asks the page on which side a margin should be shown, e.g for notes returns true for left side, false for right side

Definition at line 1462 of file pagechg.cxx.

References SwViewOption::getBrowseMode(), SwRootFrame::GetCurrShell(), SwFrame::getRootFrame(), SwViewShell::GetViewOptions(), SwRootFrame::IsLeftToRightViewLayout(), SwViewOption::IsViewLayoutBookMode(), sw::sidebarwindows::LEFT, SwFrame::OnRightPage(), and sw::sidebarwindows::RIGHT.

Referenced by SwRootFrame::CheckViewLayout(), DestroyImpl(), SwLayAction::FormatLayout(), GetBoundRect(), SwPostItHelper::getLayoutInfos(), SwRootFrame::PaintSwFrame(), UpdateAttr_(), SwBreakDashedLine::UpdatePosition(), and SwViewShell::VisPortChgd().

◆ SwClientNotify()

void SwPageFrame::SwClientNotify	(	const SwModify &	rModify,
		const SfxHint &	rHint
	)

overrideprivatevirtual

◆ UpdateAttr_()

void SwPageFrame::UpdateAttr_	(	const SfxPoolItem *	pOld,
		const SfxPoolItem *	pNew,
		SwPageFrameInvFlags &	rInvFlags,
		SwAttrSetChg *	pa = `nullptr`,
		SwAttrSetChg *	pb = `nullptr`
	)