The root element of a Writer document layout. More...

#include <rootfrm.hxx>

Inheritance diagram for SwRootFrame:

Collaboration diagram for SwRootFrame:

Public Member Functions
void	AllCheckPageDescs () const

void	AllInvalidateAutoCompleteWords () const

void	AllAddPaintRect () const

void	AllRemoveFootnotes ()

void	AllInvalidateSmartTagsOrSpelling (bool bSmartTags) const

	SwRootFrame (SwFrameFormat , SwViewShell )

void	Init (SwFrameFormat *)

SwViewShell *	GetCurrShell () const

void	DeRegisterShell (SwViewShell *pSh)

void	StartAllAction ()
	Set up Start-/EndAction for all Shells on an as high as possible (Shell section) level. More...

void	EndAllAction ()

void	UnoRemoveAllActions ()
	Certain UNO Actions (e.g. More...

void	UnoRestoreAllActions ()

const SdrPage *	GetDrawPage () const

SdrPage *	GetDrawPage ()

void	SetDrawPage (SdrPage *pNew)

virtual bool	GetModelPositionForViewPoint (SwPosition , Point &, SwCursorMoveState =nullptr, bool bTestBackground=false) const override
	Primary passes the call to the first page. More...

virtual void	PaintSwFrame (vcl::RenderContext &rRenderContext, SwRect const &, SwPrintData const *const pPrintData=nullptr) const override
	Paint once for every visible page which is touched by Rect. More...

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

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

virtual void	Cut () override

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

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

Point	GetNextPrevContentPos (const Point &rPoint, bool bNext) const
	Search the nearest Content to the passed point. More...

virtual Size	ChgSize (const Size &aNewSize) override

void	SetIdleFlags ()

bool	IsIdleFormat () const

void	ResetIdleFormat ()

bool	IsNeedGrammarCheck () const

void	SetNeedGrammarCheck (bool bVal)

void	SetAssertFlyPages ()
	Makes sure that all requested page-bound Flys find a Page. More...

void	AssertFlyPages ()
	Ensures that enough pages exist, so that all page bound frames and draw objects can be placed. More...

bool	IsAssertFlyPages () const

void	SetTableUpdateInProgress (bool bValue)

bool	IsTableUpdateInProgress () const

void	InvalidateAllContent (SwInvalidateFlags nInvalidate)
	Invalidate all Content, Size or PrtArea. More...

void	InvalidateAllObjPos ()
	Invalidate/re-calculate the position of all floating screen objects (Writer fly frames and drawing objects), which are anchored to paragraph or to character. More...

void	SetSuperfluous ()
	Remove superfluous Pages. More...

bool	IsSuperfluous () const

void	RemoveSuperfluous ()
	remove pages that are not needed at all More...

sal_uInt16	GetCurrPage (const SwPaM *) const
	Query/set the current Page and the collective Page count We'll format as much as necessary. More...

sal_uInt16	SetCurrPage (SwCursor *, sal_uInt16 nPageNum)
	Returns a PaM which sits at the beginning of the requested page. More...

Point	GetPagePos (sal_uInt16 nPageNum) const
	Returns the absolute document position of the desired page. More...

sal_uInt16	GetPageNum () const

void	DecrPhyPageNums ()

void	IncrPhyPageNums ()

bool	IsVirtPageNum () const

void	SetVirtPageNum (const bool bOf) const

bool	IsDummyPage (sal_uInt16 nPageNum) const

void	CalcFrameRects (SwShellCursor &)

bool	MakeTableCursors (SwTableCursor &)
	Calculates the cells included from the current selection. More...

void	DisallowTurbo () const

void	ResetTurboFlag () const

bool	IsTurboAllowed () const

void	SetTurbo (const SwContentFrame *pContent)

void	ResetTurbo ()

const SwContentFrame *	GetTurbo () const

void	UpdateFootnoteNums ()
	Update the footnote numbers of all Pages. More...

void	RemoveFootnotes (SwPageFrame *pPage=nullptr, bool bPageOnly=false, bool bEndNotes=false)
	Remove all footnotes (but no references) More...

void	CheckFootnotePageDescs (bool bEndNote)
	Change the page template of the footnote pages. More...

const SwPageFrame *	GetLastPage () const

SwPageFrame *	GetLastPage ()

tools::Long	GetBrowseWidth () const

void	InvalidateBrowseWidth ()

bool	IsNewLayout () const

void	ResetNewLayout ()

void	InsertEmptySct (SwSectionFrame *pDel)
	Empty SwSectionFrames are registered here for deletion and destroyed later on or deregistered. More...

void	InsertEmptyFly (SwFlyFrame *pDel)
	Empty SwFlyFrames are registered here for deletion and destroyed later if they are not de-registered in the meantime. More...

void	DeleteEmptySct ()

void	DeleteEmptyFlys ()

void	RemoveFromList (SwSectionFrame *pSct)

bool	IsInDelList (SwSectionFrame *pSct) const

void	SetCallbackActionEnabled (bool b)

bool	IsCallbackActionEnabled () const

bool	IsAnyShellAccessible () const

void	AddAccessibleShell ()

void	RemoveAccessibleShell ()

SwPageFrame *	GetPageByPageNum (sal_uInt16 _nPageNum) const
	Get page frame by physical page number looping through the lowers, which are page frame, in order to find the page frame with the given physical page number. More...

void	CheckViewLayout (const SwViewOption pViewOpt, const SwRect pVisArea)

bool	IsLeftToRightViewLayout () const

const SwRect &	GetPagesArea () const

void	SetSidebarChanged ()

bool	IsLayoutFreezed () const

void	FreezeLayout (bool freeze)

void	RemovePage (SwPageFrame **pDel, SwRemoveResult eResult)

bool	IsHideRedlines () const
	Replacement for sw::DocumentRedlineManager::GetRedlineFlags() (this is layout-level redline hiding). More...

void	SetHideRedlines (bool)

sw::FieldmarkMode	GetFieldmarkMode () const

void	SetFieldmarkMode (sw::FieldmarkMode, sw::ParagraphBreakMode)

sw::ParagraphBreakMode	GetParagraphBreakMode () const

bool	HasMergedParas () const

void	dumpAsXml (xmlTextWriterPtr writer=nullptr) const override


const SwPageFrame *	GetPageAtPos (const Point &rPt, const Size *pSize=nullptr, bool bExtend=false) const
	Point rPt: The point that should be used to find the page Size pSize: If given, we return the (first) page that overlaps with the rectangle defined by rPt and pSize bool bExtend: Extend each page to the left/right/top/bottom up to the next page margin. More...

bool	IsBetweenPages (const Point &rPt) const
	Point rPt: The point to test. More...

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	RemoveMasterObjs (SdrPage *pPg)
	Remove MasterObjects from the Page (called by the ctors) More...

static bool	FlushVout ()
	Output virtual Device (e.g. for animations) More...

static bool	HasSameRect (const SwRect &rRect)
	Save Clipping if exactly the ClipRect is outputted. More...

static void	AssertPageFlys (SwPageFrame *)
	Makes sure that, starting from the passed Page, all page-bound Frames are on the right Page (pagenumber). More...

static bool	IsInPaint ()

static void	SetNoVirDev (const bool bNew)

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

void	ImplInvalidateBrowseWidth ()

void	DeleteEmptySct_ ()

void	DeleteEmptyFlys_ ()
	Destroys the registered FlyFrames. More...

void	RemoveFromList_ (SwSectionFrame *pSct)

virtual void	DestroyImpl () override

virtual	~SwRootFrame () override

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

Private Attributes
std::vector< SwRect >	maPageRects

SwRect	maPagesArea

tools::Long	mnViewWidth

sal_uInt16	mnColumns

bool	mbBookMode

bool	mbSidebarChanged

bool	mbNeedGrammarCheck

bool	mbCheckSuperfluous:1

bool	mbIdleFormat:1

bool	mbBrowseWidthValid:1

bool	mbTurboAllowed:1

bool	mbAssertFlyPages:1

bool	mbTableUpdateInProgress: 1

bool	mbIsVirtPageNum:1

bool	mbIsNewLayout:1

bool	mbCallbackActionEnabled:1

bool	mbLayoutFreezed

bool	mbHideRedlines

sw::FieldmarkMode	m_FieldmarkMode

sw::ParagraphBreakMode	m_ParagraphBreakMode

tools::Long	mnBrowseWidth
	For BrowseMode mnBrowseWidth is the outer margin of the object most to the right. More...

const SwContentFrame *	mpTurbo
	If we only have to format one ContentFrame, its in mpTurbo. More...

SwPageFrame *	mpLastPage
	We should not need to always struggle to find the last page, so store it here. More...

SwViewShell *	mpCurrShell

SwViewShell *	mpWaitingCurrShell

std::unique_ptr< SwCurrShells >	mpCurrShells

SdrPage *	mpDrawPage
	One Page per DrawModel per Document; is always the size of the Root. More...

std::unique_ptr< SwDestroyList >	mpDestroy

std::unique_ptr< SwFlyDestroyList >	mpFlyDestroy

sal_uInt16	mnPhyPageNums

sal_uInt16	mnAccessibleShells
	Page count. More...

Static Private Attributes
static SwLayVout *	s_pVout = nullptr

static bool	s_isInPaint = false

static bool	s_isNoVirDev = false

static SwRootFrame *	s_pLast = nullptr
	The last, still alive SwRootFrame instance, for debugging. More...

static constexpr sal_Int64	MIN_BROWSE_WIDTH = o3tl::toTwips(20000, o3tl::Length::mm100)
	Width of the HTML / Web document if not defined otherwise: 20cm. More...

Friends
class	CurrShell
	[ Comment from the original StarOffice checkin ]: The root takes care of the shell access. More...

void	AdjustSizeChgNotify (SwRootFrame *pRoot)

void	SetLastPage (SwPageFrame *)

void	FrameInit ()

void	FrameFinit ()

void	SetShell (SwViewShell *pSh)

void	InitCurrShells (SwRootFrame *pRoot)

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

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

The root element of a Writer document layout.

Lower frames are expected to be SwPageFrame instances.

Definition at line 84 of file rootfrm.hxx.

Constructor & Destructor Documentation

◆ ~SwRootFrame()

SwRootFrame::~SwRootFrame ( )

overrideprivatevirtual

Definition at line 573 of file newfrm.cxx.

References s_pLast.

◆ SwRootFrame()

SwRootFrame::SwRootFrame	(	SwFrameFormat *	pFormat,
		SwViewShell *	pSh
	)

Definition at line 400 of file newfrm.cxx.

References SwFrame::mnFrameType, Root, s_pLast, and SwFrame::setRootFrame().

Member Function Documentation

◆ AddAccessibleShell()

void SwRootFrame::AddAccessibleShell ( )

inline

Definition at line 403 of file rootfrm.hxx.

Referenced by SwAccessibleMap::SwAccessibleMap().

◆ AllAddPaintRect()

void SwRootFrame::AllAddPaintRect ( ) const

Definition at line 605 of file newfrm.cxx.

References SwViewShell::AddPaintRect(), GetCurrShell(), and SwFrameAreaDefinition::getFrameArea().

◆ AllCheckPageDescs()

void SwRootFrame::AllCheckPageDescs ( ) const

Definition at line 589 of file newfrm.cxx.

References SwFrame::CheckPageDescs(), IsLayoutFreezed(), and SwLayoutFrame::Lower().

◆ AllInvalidateAutoCompleteWords()

void SwRootFrame::AllInvalidateAutoCompleteWords ( ) const

Definition at line 595 of file newfrm.cxx.

References SwFrame::GetNext(), SwPageFrame::InvalidateAutoCompleteWords(), and SwLayoutFrame::Lower().

◆ AllInvalidateSmartTagsOrSpelling()

void SwRootFrame::AllInvalidateSmartTagsOrSpelling ( bool bSmartTags ) const

Definition at line 615 of file newfrm.cxx.

References SwFrame::GetNext(), SwPageFrame::InvalidateSmartTags(), SwPageFrame::InvalidateSpelling(), and SwLayoutFrame::Lower().

◆ AllRemoveFootnotes()

void SwRootFrame::AllRemoveFootnotes ( )

Definition at line 610 of file newfrm.cxx.

References RemoveFootnotes().

◆ AssertFlyPages()

void SwRootFrame::AssertFlyPages ( )

Ensures that enough pages exist, so that all page bound frames and draw objects can be placed.

Definition at line 1566 of file pagechg.cxx.

References AssertPageFlys(), o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::empty(), o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::end(), o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::find(), SwPageFrame::FindPageDesc(), SwFormatAnchor::GetAnchorNode(), SwFormat::GetDoc(), SwPageDesc::GetFollow(), SwDoc::GetFootnoteIdxs(), SwLayoutFrame::GetFormat(), SwPageDesc::GetLeftFormat(), SwFrame::GetNext(), SwPageFrame::GetPageDesc(), SwFormatAnchor::GetPageNum(), SwPageFrame::GetPhyPageNum(), SwPageDesc::GetRightFormat(), SwDoc::GetSpzFrameFormats(), SwFrame::GetVirtPageNum(), i, o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::insert(), SwFrame::InsertPage(), IsAssertFlyPages(), SwPageFrame::IsEmptyPage(), SwPageFrame::IsFootnotePage(), SwLayoutFrame::Lower(), mbAssertFlyPages, mpDrawPage, SwFrame::OnRightPage(), RemoveFootnotes(), RemoveMasterObjs(), o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::reserve(), SAL_INFO, SwLayoutFrame::SetFrameFormat(), and sw::FrameFormats< value_type >::size().

Referenced by Init(), SwLayAction::InternalAction(), and SwFlyLayFrame::SwClientNotify().

◆ AssertPageFlys()

void SwRootFrame::AssertPageFlys ( SwPageFrame * pPage )

static

Makes sure that, starting from the passed Page, all page-bound Frames are on the right Page (pagenumber).

Ensure that after the given page all page-bound objects are located on the correct page.

Definition at line 1708 of file pagechg.cxx.

References SwFormat::GetAnchor(), SwFormatAnchor::GetAnchorId(), SwFrame::GetNext(), SwFormatAnchor::GetPageNum(), SwPageFrame::GetPhyPageNum(), SwFrame::GetPrev(), SwPageFrame::GetSortedObjs(), i, SwPageFrame::IsEmptyPage(), SAL_INFO, size, and SwSortedObjs::size().

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

◆ CalcFrameRects()

void SwRootFrame::CalcFrameRects ( SwShellCursor & rCursor )

Definition at line 2019 of file trvlfrm.cxx.

References a, Add(), BIDI, SwRect::Bottom(), SwRectFnSet::BottomDist(), SwSortedObjs::Contains(), SwAnchoredObject::DynCastFlyFrame(), SwFrame::FindFlyFrame(), SwFrame::FindPageFrame(), Footer, SwFormat::GetAnchor(), SwAnchoredObject::GetAnchorFrame(), SwFormatAnchor::GetAnchorId(), SwRectFnSet::GetBottom(), SwFrame::GetCharRect(), SwFormatAnchor::GetContentAnchor(), GetContentNode(), GetCurrShell(), SwTextFrame::GetDropRect(), SwShellCursor::GetEndPos(), SwTabFrame::GetFollow(), SwFlyFrame::GetFormat(), SwFrameAreaDefinition::getFrameArea(), SwAnchoredObject::GetFrameFormat(), SwFrameAreaDefinition::getFramePrintArea(), SwContentNode::getLayoutFrame(), SwRectFnSet::GetLeft(), SwFrame::GetLower(), SwFrame::GetNext(), SwContentFrame::GetNextContentFrame(), SdrObject::GetOrdNum(), SwRegionRects::GetOrigin(), SwViewShell::GetOut(), SwFrame::GetPaintArea(), SwPaM::GetPoint(), SwRectFnSet::GetRight(), SwTable::GetRowsToRepeat(), SwPageFrame::GetSortedObjs(), SwShellCursor::GetSttPos(), SwFormatSurround::GetSurround(), SwFormat::GetSurround(), SwTabFrame::GetTable(), SwRectFnSet::GetTop(), SwFrame::GetType(), SwFrame::GetUpper(), SwViewShell::GetViewOptions(), SwFlyFrame::GetVirtDrawObj(), SwRectFnSet::GetWidth(), SwRect::HasArea(), Header, SwRect::Height(), SwSortedObjs::Insert(), SwRect::Intersection(), SwRegionRects::Invert(), comphelper::LibreOfficeKit::isActive(), SwLayoutFrame::IsAnLower(), SwFrame::IsCellFrame(), SwFormatSurround::IsContour(), IsDestroyFrameAnchoredAtChar(), SwFrame::IsInDocBody(), SwFrame::IsInFly(), SwViewOption::IsPDFExport(), SwFrame::IsRightToLeft(), SwViewShell::IsSelectAll(), IsSelectFrameAnchoredAtPara(), SwFrame::IsTextFrame(), SwFrame::IsVertLRBT(), lcl_IsInRepeatedHeadline(), SwRect::Left(), SwCursorMoveState::m_b2Lines, SwCursorMoveState::m_bNoScroll, SwCursorMoveState::m_nCursorBidiLevel, SwCursorMoveState::m_p2Lines, NONE, nPos, SwRect::Overlaps(), SwRect::Pos(), pOut, SwRectFnSet::Refresh(), SwRect::Right(), ROT_270, ROT_90, RUBY, SwRectFnSet::SetBottom(), SwRectFnSet::SetLeft(), SwRectFnSet::SetRight(), SwRectFnSet::SetTop(), SwRectFnSet::SetWidth(), Point::setX(), Point::setY(), SwSortedObjs::size(), SwPaM::StartEnd(), Sub(), Tab, SwRect::Union(), SwFrame::UnionFrame(), SwViewShell::VisArea(), Width, SwRect::Width(), Point::X(), and Point::Y().

Referenced by SwShellCursor::FillRects().

◆ CheckFootnotePageDescs()

void SwRootFrame::CheckFootnotePageDescs ( bool bEndNote )

Change the page template of the footnote pages.

Definition at line 1008 of file ftnfrm.cxx.

References SwFrame::CheckPageDescs(), SwFrame::GetNext(), SwPageFrame::IsEndNotePage(), SwPageFrame::IsFootnotePage(), and SwLayoutFrame::Lower().

◆ CheckViewLayout()

void SwRootFrame::CheckViewLayout	(	const SwViewOption *	pViewOpt,
		const SwRect *	pVisArea
	)

Definition at line 2128 of file pagechg.cxx.

References SwRect::AddBottom(), SwRect::AddRight(), AdjustSizeChgNotify, BROWSE_MODE, SwFrame::Calc(), ChgSize(), SwViewOption::defGapBetweenPages, sw::proofreadingiterator::get(), GetCurrShell(), SwViewShell::GetDoc(), SwDoc::GetDocShell(), SwLayoutFrame::GetFormat(), SwPageFrame::GetFormatPage(), SwFrameAreaDefinition::getFrameArea(), SwViewOption::GetGapBetweenPages(), SwFrame::GetNext(), SwViewShell::GetOut(), SwPageFrame::GetPhyPageNum(), SwFrame::GetPrev(), SwPageFrame::GetSidebarBorderWidth(), SwViewOption::GetViewLayoutColumns(), SwViewShell::GetViewOptions(), Point::getX(), Point::getY(), SwRect::Height(), SwViewShell::InvalidateWindows(), comphelper::LibreOfficeKit::isActive(), IsCallbackActionEnabled(), SwPageFrame::IsEmptyPage(), IsLeftToRightViewLayout(), SwViewOption::IsViewLayoutBookMode(), lcl_MoveAllLowers(), sw::sidebarwindows::LEFT, SwRect::Left_(), SwLayoutFrame::Lower(), maPageRects, maPagesArea, mbBookMode, mbSidebarChanged, min(), mnColumns, mnViewWidth, nBorder, Pos, SwRect::Pos(), SAL_MAX_INT32, SetCallbackActionEnabled(), SwFrame::SetCompletePaint(), SwViewShell::SetFirstVisPageInvalid(), Point::setX(), SwPageFrame::SidebarPosition(), SSize, SwRect::SSize(), SwRect::SubLeft(), SwRect::SubTop(), TWIPS_MAX, and SwRect::Width().

Referenced by SwViewShell::ImplEndAction(), SwXTextDocument::initializeForTiledRendering(), and SwPageFrame::Paste().

◆ ChgSize()

Size SwRootFrame::ChgSize ( const Size & aNewSize )

overridevirtual

Reimplemented from SwFrame.

Definition at line 1752 of file pagechg.cxx.

References SwFrameAreaDefinition::getFrameArea(), SwFrame::InvalidatePrt_(), SwFrame::mbFixSize, and SwRect::SSize().

Referenced by CheckViewLayout().

◆ Cut()

void SwRootFrame::Cut ( )

overridevirtual

Reimplemented from SwLayoutFrame.

Definition at line 55 of file unusedf.cxx.

◆ DecrPhyPageNums()

void SwRootFrame::DecrPhyPageNums ( )

inline

Definition at line 322 of file rootfrm.hxx.

◆ DeleteEmptyFlys()

void SwRootFrame::DeleteEmptyFlys ( )

inline

Definition at line 393 of file rootfrm.hxx.

Referenced by SwLayAction::InternalAction().

◆ DeleteEmptyFlys_()

void SwRootFrame::DeleteEmptyFlys_ ( )

private

Destroys the registered FlyFrames.

Definition at line 1660 of file flycnt.cxx.

References SwLayoutFrame::ContainsContent(), SwFrame::DestroyFrame(), SwFrame::IsDeleteForbidden(), and mpFlyDestroy.

◆ DeleteEmptySct()

void SwRootFrame::DeleteEmptySct ( )

inline

Definition at line 392 of file rootfrm.hxx.

Referenced by SwLayAction::Action(), and SwLayAction::InternalAction().

◆ DeleteEmptySct_()

void SwRootFrame::DeleteEmptySct_ ( )

private

Definition at line 2903 of file sectfrm.cxx.

References SwLayoutFrame::ContainsContent(), SwLayoutFrame::Cut(), SwFrame::DestroyFrame(), SwFrameAreaDefinition::getFrameArea(), SwFrame::getRootFrame(), SwSectionFrame::GetSection(), SwFrame::GetUpper(), SwRect::HasArea(), SwFrame::IsColLocked(), SwFrame::IsDeleteForbidden(), SwFrame::IsFootnoteFrame(), SwFrame::IsPageBodyFrame(), SwLayoutFrame::Lower(), mpDestroy, SwFrame::RemoveFromLayout(), SAL_WARN_IF, and SetSuperfluous().

◆ DeRegisterShell()

void SwRootFrame::DeRegisterShell ( SwViewShell * pSh )

Definition at line 362 of file newfrm.cxx.

References sw::Ring< value_type >::GetRingContainer(), mpCurrShell, mpCurrShells, and mpWaitingCurrShell.

Referenced by SwViewShell::~SwViewShell().

◆ DestroyImpl()

void SwRootFrame::DestroyImpl ( )

overrideprivatevirtual

Reimplemented from SwLayoutFrame.

Definition at line 533 of file newfrm.cxx.

References sw::DocumentLayoutManager::ClearSwLayouterEntries(), SwDoc::DelFrameFormat(), SwLayoutFrame::DestroyImpl(), SwFrame::GetDep(), SwFormat::GetDoc(), SwDoc::GetDocumentLayoutManager(), mbTurboAllowed, mnAccessibleShells, mpCurrShells, mpDestroy, mpTurbo, and RemoveFootnotes().

◆ DisallowTurbo()

void SwRootFrame::DisallowTurbo ( ) const

inline

Definition at line 356 of file rootfrm.hxx.

Referenced by SwLayAction::Action(), SwContentFrame::DestroyImpl(), SwFrame::InvalidatePage(), and SwAnchoredDrawObject::InvalidatePage_().

◆ dumpAsXml()

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

overridevirtual

Implements SwFrame.

Definition at line 4797 of file wsfrm.cxx.

References SwView::dumpAsXml(), SwFrame::dumpAsXmlAttributes(), SwFrame::dumpChildrenAsXml(), SwFrame::dumpInfosAsXml(), GetCurrShell(), SfxViewShell::GetFirst(), SfxViewShell::GetNext(), SfxViewShell::GetObjectShell(), and SwViewShell::GetSfxViewShell().

Referenced by sw::LayoutDumpFilter::filter(), and SwEditWin::KeyInput().

◆ EndAllAction()

void SwRootFrame::EndAllAction ( )

Definition at line 1932 of file pagechg.cxx.

References GetCurrShell().

Referenced by SwViewShell::CalcPagesForPrint(), SwDrawContact::Changed(), SwDrawView::DeleteMarked(), sw::IMPL_LINK_NOARG(), sw::DocumentDeviceManager::PrtDataChanged(), SwDoc::PrtOLENotify(), SwHTMLTableLayout::Resize_(), sw::DocumentSettingManager::setCharacterCompressionType(), sw::DocumentSettingManager::setForbiddenCharacters(), SwDoc::SetLineNumberInfo(), SwLineNumberInfo::SwClientNotify(), and UnoActionContext::~UnoActionContext().

◆ FillSelection()

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

overridevirtual

Reimplemented from SwLayoutFrame.

Definition at line 403 of file trvlfrm.cxx.

References SwRect::Bottom(), SwFrame::FillSelection(), SwFrameAreaDefinition::getFrameArea(), SwFrame::GetNext(), SwSelectionList::isEmpty(), SwLayoutFrame::Lower(), and SwRect::Top().

◆ FlushVout()

bool SwRootFrame::FlushVout ( )

static

Output virtual Device (e.g. for animations)

Definition at line 30 of file virtoutp.cxx.

References SwLayVout::Flush_(), and s_pVout.

Referenced by SwNoTextFrame::ImplPaintPictureAnimate(), and SwTextSizeInfo::NoteAnimation().

◆ FreezeLayout()

void SwRootFrame::FreezeLayout ( bool freeze )

inline

Definition at line 426 of file rootfrm.hxx.

◆ GetBrowseWidth()

tools::Long SwRootFrame::GetBrowseWidth ( ) const

inline

Definition at line 444 of file rootfrm.hxx.

References ImplCalcBrowseWidth(), mbBrowseWidthValid, and mnBrowseWidth.

◆ GetCurrPage()

sal_uInt16 SwRootFrame::GetCurrPage ( const SwPaM * pActualCursor ) const

Query/set the current Page and the collective Page count We'll format as much as necessary.

Returns the number of the current page.

If the method gets a PaM then the current page is the one in which the PaM sits. Otherwise the current page is the first one inside the VisibleArea. We only work on available pages!

Definition at line 978 of file trvlfrm.cxx.

References SwFrame::FindPageFrame(), GetContentNode(), SwContentNode::getLayoutFrame(), SwPosition::GetNode(), SwPageFrame::GetPhyPageNum(), and SwPaM::GetPoint().

Referenced by SwUndoInsLayFormat::RepeatImpl().

◆ GetCurrShell()

SwViewShell * SwRootFrame::GetCurrShell ( ) const

inline

Definition at line 215 of file rootfrm.hxx.

Referenced by SwRowFrame::AdjustCells(), SwTextFrame::AdjustFrame(), SwFrame::AdjustNeighbourhood(), AllAddPaintRect(), SwFrame::AppendDrawObj(), SwTextFrame::AutoSpell_(), SwTextFrame::CalcFollow(), SwSectionFrame::CalcFootnoteContent(), CalcFrameRects(), SwTextFrame::CalcHeightOfLastLine(), SwContentFrame::CalcLowers(), SwLayHelper::CalcPageCount(), objectpositioning::SwToContentAnchoredObjectPosition::CalcPosition(), objectpositioning::SwToLayoutAnchoredObjectPosition::CalcPosition(), SwFlyFrame::CalcRel(), SwLayoutFrame::CalcRel(), SwFlyFrame::ChainFrames(), SwFlyFreeFrame::CheckClip(), SwCellFrame::CheckDirection(), SwFlyFrame::CheckDirection(), SwPageFrame::CheckDirection(), SwSectionFrame::CheckDirection(), SwTabFrame::CheckDirection(), SwTextFrame::CheckDirection(), SwFrame::CheckPageDescs(), SwPageFrame::CheckPageHeightValidForHideWhitespace(), CheckViewLayout(), ChkChartSel(), SwTextFrame::ConnectFootnote(), SwFrame::CreateProcessor2D(), SwAttrIter::CtorInitAttrIter(), SwTextInfo::CtorInitTextInfo(), SwTextSizeInfo::CtorInitTextSizeInfo(), SwCellFrame::Cut(), SwContentFrame::Cut(), SwPageFrame::Cut(), SwTableNode::DelFrames(), SwFrame::DestroyImpl(), SwCellFrame::DestroyImpl(), SwFlyFrame::DestroyImpl(), SwPageFrame::DestroyImpl(), SwTextFly::DrawFlyRect(), SwTextPaintInfo::DrawText_(), SwTextFly::DrawTextOpaque(), dumpAsXml(), SwTextFrame::EmptyHeight(), EndAllAction(), SwAutoFormat::EnsureFormatted(), SwTextFrame::FillCursorPos(), SwTextFrame::FillRegister(), SwPageFrame::FindPageDesc(), SwFlyFrame::FinitDrawObj(), SwCombinedPortion::Format(), SwFootnoteContFrame::Format(), SwLayoutFrame::Format(), SwSectionFrame::Format(), SwTabFrame::Format(), SwObjectFormatterTextFrame::FormatAnchorFrameAndItsPrevs(), SwLayAction::FormatLayout(), SwObjectFormatter::FormatLayout_(), SwTextFrame::FormatLine(), SwTextFrame::FormatOnceMore(), SwLayoutFrame::FormatWidthCols(), SwFrame::GetBackgroundBrush(), SwPageFrame::GetBoundRect(), SwFlyFrame::GetContour(), SwPageFrame::GetDrawBackgroundColor(), SwTextFrame::GetFormatted(), GetFrameOfModify(), SwCellFrame::GetModelPositionForViewPoint(), SwFlyFrame::GetModelPositionForViewPoint(), SwLayoutFrame::GetModelPositionForViewPoint(), SwFrame::GetNextLeaf(), GetNextPrevContentPos(), SwTextFrame::GetScalingOfSelectedText(), GetTableSel(), SwFootnoteBossFrame::GetVarSpace(), SwFlyFrame::Grow_(), SwSectionFrame::Grow_(), SwContentFrame::GrowFrame(), SwFootnoteContFrame::GrowFrame(), SwLayoutFrame::GrowFrame(), SwTabFrame::GrowFrame(), SwTextFrame::HideAndShowObjects(), SwTextFrame::Hyphenate(), ImplCalcBrowseWidth(), SwFrameNotify::ImplDestroy(), SwLayNotify::ImplDestroy(), SwFlyNotify::ImplDestroy(), SwContentNotify::ImplDestroy(), SwViewShell::ImplEndAction(), Init(), InsertCnt_(), SwFrame::InsertPage(), InvalidateAllContent(), IsBetweenPages(), SwTextFrame::IsHiddenNow(), SwPageFrame::IsLeftShadowNeeded(), SwPageFrame::IsOverHeaderFooterArea(), SwPageFrame::IsRightShadowNeeded(), SwLayAction::IsShortCut(), SwNoTextFrame::IsTransparent(), SwTextFrame::JoinFrame(), lcl_ClearArea(), lcl_ColumnRefresh(), lcl_EmergencyFormatFootnoteCont(), lcl_FormatContentOfLayoutFrame(), lcl_FormatLay(), lcl_InnerCalcLayout(), lcl_MoveAllLowerObjs(), lcl_MoveAllLowers(), lcl_RecalcSplitLine(), SwContentFrame::MakeAll(), SwPageFrame::MakeAll(), SwSectionFrame::MakeAll(), SwTabFrame::MakeAll(), SwSectionNode::MakeFramesForAdjacentContentNode(), SwContentNode::MakeFramesForAdjacentContentNode(), SwFlyFrameFormat::MakeGraphic(), SwFlyFrame::MakeObjPos(), SwTableNode::MakeOwnFrames(), SwContentFrame::MakePrtArea(), SwFootnoteBossFrame::MoveFootnotes_(), SwVirtFlyDrawObj::NbcCrop(), SwVirtFlyDrawObj::NbcResize(), Notify_Background(), SwGrfNumPortion::Paint(), sw::FlyContentPortion::Paint(), SwFrame::PaintBorderLine(), SwTextFrame::PaintEmpty(), SwTextFrame::PaintExtraData(), SwNoTextFrame::PaintPicture(), SwFlyFrame::PaintSwFrame(), SwNoTextFrame::PaintSwFrame(), SwTextFrame::PaintSwFrame(), SwFrame::PaintSwFrameShadowAndBorder(), SwPageFrame::Paste(), SwPageFrame::PrepareFooter(), SwPageFrame::PrepareHeader(), SwFootnoteBossFrame::RearrangeFootnotes(), SwFrame::RemoveDrawObj(), SwLayAction::RemoveEmptyBrowserPages(), SwFrame::RemoveFly(), RemoveSuperfluous(), SwTextFrame::repaintTextFrames(), SwFrame::Retouch(), SwVirtFlyDrawObj::Rotate(), SetCurrPage(), SwFootnoteBossFrame::SetFootnoteDeadLine(), SwContentFrame::ShouldBwdMoved(), SwTabFrame::ShouldBwdMoved(), SwFlyFrame::Shrink_(), SwFootnoteContFrame::ShrinkFrame(), SwLayoutFrame::ShrinkFrame(), SwPageFrame::SidebarPosition(), SwTextFrame::SplitFrame(), StartAllAction(), SwCellFrame::SwClientNotify(), SwPageFrame::SwClientNotify(), SwTextFrame::SwClientNotify(), SwFlyFrame::SwFlyFrame(), SwHandleAnchorNodeChg::SwHandleAnchorNodeChg(), SwPageFrame::SwPageFrame(), SwTestFormat::SwTestFormat(), SwTextPaintInfo::SwTextPaintInfo(), SwTextSizeInfo::SwTextSizeInfo(), SwFlyFrame::UnchainFrames(), UnHide(), SwTextFrame::UnitDown_(), SwTextFrame::UnitUp_(), UnoRemoveAllActions(), UnoRestoreAllActions(), SwFlyFrame::UpdateAttr_(), SwPageFrame::UpdateAttr_(), SwSectionFrame::UpdateAttr_(), SwCursor::UpDown(), ValidateBodyFrame_(), SwTextFrame::ValidateFrame(), and SwVirtFlyDrawObj::wrap_DoPaintObject().

◆ GetDrawPage() [1/2]

SdrPage * SwRootFrame::GetDrawPage ( )

inline

Definition at line 236 of file rootfrm.hxx.

◆ GetDrawPage() [2/2]

const SdrPage * SwRootFrame::GetDrawPage ( ) const

inline

Definition at line 235 of file rootfrm.hxx.

Referenced by SwPageFrame::AppendFlyToPage(), SwViewShellImp::Init(), sw::DocumentDrawModelManager::InitDrawModel(), and SwPageFrame::RemoveFlyFromPage().

◆ GetFieldmarkMode()

sw::FieldmarkMode SwRootFrame::GetFieldmarkMode ( ) const

inline

Definition at line 436 of file rootfrm.hxx.

Referenced by sw::CheckParaRedlineMerge(), SwAttrIter::CtorInitAttrIter(), HasMergedParas(), SwDoc::InsertTableOf(), SwCursor::LeftRight(), and SwUndoInsSection::RedoImpl().

◆ GetLastPage() [1/2]

SwPageFrame * SwRootFrame::GetLastPage ( )

inline

Definition at line 372 of file rootfrm.hxx.

◆ GetLastPage() [2/2]

const SwPageFrame * SwRootFrame::GetLastPage ( ) const

inline

Definition at line 371 of file rootfrm.hxx.

Referenced by SwFootnoteBossFrame::AppendFootnote(), SwFrame::GetPrevFootnoteLeaf(), SwPageFrame::MakeAll(), and RemoveSuperfluous().

◆ GetModelPositionForViewPoint()

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

overridevirtual

Primary passes the call to the first page.

Returns: false, if the passed Point gets changed

Reimplemented from SwLayoutFrame.

Definition at line 425 of file trvlfrm.cxx.

References Bottom, SwFrameAreaDefinition::getFrameArea(), SwFrame::GetNext(), GetPageAtPos(), IsCallbackActionEnabled(), SwFrame::IsPageFrame(), SwLayoutFrame::Lower(), SwCursorMoveState::m_bFillRet, SwCursorMoveState::m_bStop, SwCursorMoveState::m_pFill, Right, SetCallbackActionEnabled(), Point::X(), and Point::Y().

Referenced by SwFmDrawPage::add(), SwDoc::ChgAnchor(), SwFEShell::Copy(), SwFEShell::CopyDrawSel(), SwXTextView::createTextRangeByPixelPosition(), SwFEShell::FindAnchorPos(), SwCursorShell::FindValidContentNode(), SwFEShell::GetAnyCurRect(), SwEditShell::GetAnySection(), SwCursorShell::GetContentAtPos(), SwFEShell::GetFormatFromAnyObj(), SwFEShell::GetFrameType(), SwVisibleCursor::getLOKPayload(), SwCursorShell::GetTextDirection(), SwFEShell::ImpEndCreate(), SwFEShell::InsertDrawObj(), SwFEShell::IsFlyInFly(), SwEditWin::IsOverHeaderFooterFly(), SwCursorShell::IsOverReadOnlyPos(), lcl_FindAnchorPos(), SwCursor::SelectWordWT(), SwCursorShell::SetCursor(), SwXShape::setPropertyValue(), SwCursorShell::SetVisibleCursor(), and SwCursorShell::UpdateCursorPos().

◆ GetNextPrevContentPos()

Point SwRootFrame::GetNextPrevContentPos	(	const Point &	rPoint,
		bool	bNext
	)		const

Search the nearest Content to the passed point.

Only search inside the BodyText.

Note: Only the nearest vertically one will be searched.; JP 11.10.2001: only in tables we try to find the right column - Bug 72294

Definition at line 1486 of file trvlfrm.cxx.

References SwRect::Bottom(), SwFrame::Calc(), SwRect::Contains(), SwLayoutFrame::ContainsContent(), GetCurrShell(), SwFrameAreaDefinition::getFrameArea(), SwFrame::GetNext(), SwContentFrame::GetNextContentFrame(), SwViewShell::GetOut(), SwFrame::GetPrev(), SwFrame::IsInDocBody(), lcl_IsInRepeatedHeadline(), SwRect::Left(), SwLayoutFrame::Lower(), SwRect::Pos(), SwRect::Right(), SwRect::Top(), SwFrame::UnionFrame(), Point::X(), and Point::Y().

Referenced by SwFEShell::GetContentPos().

◆ GetPageAtPos()

const SwPageFrame * SwRootFrame::GetPageAtPos	(	const Point &	rPt,
		const Size *	pSize = `nullptr`,
		bool	bExtend = `false`
	)		const

Point rPt: The point that should be used to find the page Size pSize: If given, we return the (first) page that overlaps with the rectangle defined by rPt and pSize bool bExtend: Extend each page to the left/right/top/bottom up to the next page margin.

Definition at line 658 of file findfrm.cxx.

References SwRect::Bottom(), SwRect::Contains(), SwFrameAreaDefinition::getFrameArea(), SwFrame::GetNext(), GetPageNum(), SwLayoutFrame::Lower(), maPageRects, SwRect::Overlaps(), SwRect::Pos(), SwRect::SSize(), and Point::Y().

Referenced by SwFEShell::Copy(), SwFEShell::CopyDrawSel(), SwEnhancedPDFExportHelper::EnhancedPDFExport(), SwViewShell::FillPrtDoc(), FindPage(), GetModelPositionForViewPoint(), SwPostItHelper::getPageInfo(), SwViewShell::GetPageNumAndSetOffsetForPDF(), SwFEShell::ImpEndCreate(), SwEditWin::IsInHeaderFooter(), SwCursorShell::IsPageAtPos(), SwEditWin::MouseButtonDown(), and SwFEShell::ShouldObjectBeSelected().

◆ GetPageByPageNum()

SwPageFrame * SwRootFrame::GetPageByPageNum ( sal_uInt16 _nPageNum ) const

Get page frame by physical page number looping through the lowers, which are page frame, in order to find the page frame with the given physical page number.

get page frame by physical page number

if no page frame is found, 0 is returned. Note: Empty page frames are also returned.

Parameters

_nPageNum physical page number of page frame to be searched and returned.

Returns: pointer to the page frame with the given physical page number; pointer to the page frame with the given physical page number

Definition at line 1603 of file trvlfrm.cxx.

References SwFrame::GetNext(), SwPageFrame::GetPhyPageNum(), and SwLayoutFrame::Lower().

Referenced by SwPagePreviewLayout::CalcPreviewPages(), SwEnhancedPDFExportHelper::EnhancedPDFExport(), and SwPagePreviewLayout::Paint().

◆ GetPageNum()

sal_uInt16 SwRootFrame::GetPageNum ( ) const

inline

Definition at line 321 of file rootfrm.hxx.

Referenced by SwViewShell::CalcLayout(), SwDocStatFieldType::Expand(), SwViewShell::GetNumPages(), GetPageAtPos(), SwCursorShell::GetPageCnt(), SwViewShell::GetPageCount(), SwEditShell::HyphContinue(), sw::DocumentStatisticsManager::IncrementalDocStatCalculate(), IsDummyPage(), SwTextFormatter::NewFieldPortion(), SwFEShell::SetPageObjsNewPage(), SwLayAction::SetStatBar(), and SwEditShell::SpellContinue().

◆ GetPagePos()

Point SwRootFrame::GetPagePos ( sal_uInt16 nPageNum ) const

Returns the absolute document position of the desired page.

Formatting is done only as far as needed and only if bFormat=true. Pos is set to the one of the last page, if the page number was chosen too big.

Returns: Null, if the operation failed.

Definition at line 1585 of file trvlfrm.cxx.

References SwFrameAreaDefinition::getFrameArea(), SwFrame::GetNext(), SwPageFrame::GetPhyPageNum(), SwFrame::IsPageFrame(), SwLayoutFrame::Lower(), and SwRect::Pos().

Referenced by SwViewShell::GetPagePos().

◆ GetPagesArea()

const SwRect & SwRootFrame::GetPagesArea ( ) const

inline

Definition at line 422 of file rootfrm.hxx.

Referenced by SwFEShell::GetAnyCurRect().

◆ GetParagraphBreakMode()

sw::ParagraphBreakMode SwRootFrame::GetParagraphBreakMode ( ) const

inline

Definition at line 438 of file rootfrm.hxx.

Referenced by sw::CheckParaRedlineMerge(), HasMergedParas(), SwDoc::InsertTableOf(), and SwUndoInsSection::RedoImpl().

◆ GetTurbo()

const SwContentFrame * SwRootFrame::GetTurbo ( ) const

inline

Definition at line 361 of file rootfrm.hxx.

Referenced by SwLayAction::Action(), SwContentFrame::DestroyImpl(), SwFrame::InvalidatePage(), SwAnchoredDrawObject::InvalidatePage_(), and SwLayAction::TurboAction().

◆ GrowFrame()

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

overridevirtual

Reimplemented from SwLayoutFrame.

Definition at line 1481 of file pagechg.cxx.

References SwRect::AddHeight().

◆ HasMergedParas()

bool SwRootFrame::HasMergedParas ( ) const

Definition at line 4773 of file wsfrm.cxx.

References GetFieldmarkMode(), GetParagraphBreakMode(), sw::Hidden, IsHideRedlines(), and sw::ShowBoth.

Referenced by sw::CheckParaRedlineMerge(), SwTOXPara::FillText(), SwNodes::FindPrvNxtFrameNode(), sw::GetAttrMerged(), sw::GetExpandTextMerged(), sw::GetFirstAndLastNode(), sw::ToxTextGenerator::GetNumStringOfFirstNode(), SwEditShell::GetPaMAttr(), SwTextNode::GetParaAttr(), sw::GotoNextLayoutTextFrame(), sw::GotoPrevLayoutTextFrame(), sw::ToxTextGenerator::HandleTextToken(), InsertCnt_(), sw::IsMarkHidden(), sw::IsMarkHintHidden(), sw::IsParaPropsNode(), SwCursor::IsStartEndSentence(), lcl_RstAttr(), sw::DocumentContentOperationsManager::lcl_RstTextAttr(), lcl_SetTextFormatColl(), SwTableNode::MakeFramesForAdjacentContentNode(), SwSectionNode::MakeFramesForAdjacentContentNode(), SwContentNode::MakeFramesForAdjacentContentNode(), SwTableNode::MakeOwnFrames(), SetFieldmarkMode(), SetHideRedlines(), UnHide(), UnHideRedlines(), SwTOXBaseSection::Update(), SwTOXBaseSection::UpdateContent(), sw::UpdateFramesForRemoveDeleteRedline(), SwTOXBaseSection::UpdateOutline(), SwTOXBaseSection::UpdateTable(), SwTOXBaseSection::UpdateTemplate(), and SwXMLWriter::Write_().

◆ HasSameRect()

bool SwRootFrame::HasSameRect ( const SwRect & rRect )

static

Save Clipping if exactly the ClipRect is outputted.

Definition at line 40 of file virtoutp.cxx.

References s_pVout.

Referenced by SwSaveClip::ChgClip_().

◆ ImplCalcBrowseWidth()

void SwRootFrame::ImplCalcBrowseWidth ( )

private

Definition at line 1801 of file pagechg.cxx.

References SwBorderAttrs::CalcLeft(), SwBorderAttrs::CalcRight(), SwLayoutFrame::ContainsContent(), SwAnchoredObject::DynCastFlyFrame(), FAR_AWAY, SwFrame::FindNextCnt(), SwFrame::FindTabFrame(), SwBorderAttrAccess::Get(), SwFormat::GetAnchor(), SwFormatAnchor::GetAnchorId(), SdrObject::GetAnchorPos(), SwBorderAttrs::GetAttrSet(), SwViewShell::GetBrowseBorder(), SwHTMLTableLayout::GetBrowseWidthMin(), SwFrame::GetCache(), GetCurrShell(), SwAnchoredObject::GetDrawObj(), SwFrame::GetDrawObjs(), SwLayoutFrame::GetFormat(), SwAnchoredObject::GetFrameFormat(), SwFrameAreaDefinition::getFramePrintArea(), SwFormat::GetFrameSize(), SwFormatHoriOrient::GetHoriOrient(), SwFormat::GetHoriOrient(), SwAttrSet::GetHoriOrient(), SwAnchoredObject::GetObjRect(), SwViewShell::GetOut(), SwFormatHoriOrient::GetPos(), SwFormatHoriOrient::GetRelationOrient(), SwFrame::getRootFrame(), SwBorderAttrs::GetSize(), SvxSizeItem::GetWidth(), SwFormatFrameSize::GetWidthPercent(), i, comphelper::LibreOfficeKit::isActive(), SwFrame::IsInDocBody(), SwFrame::IsInTab(), SwFrame::IsTabFrame(), SwRect::Left(), mbBrowseWidthValid, min(), MIN_BROWSE_WIDTH, MINLAY, mnBrowseWidth, SwPostItHelper::NONE, SwRect::Right(), size, Size::Width(), SwRect::Width(), and Point::X().

Referenced by GetBrowseWidth().

◆ ImplInvalidateBrowseWidth()

void SwRootFrame::ImplInvalidateBrowseWidth ( )

private

Definition at line 1790 of file pagechg.cxx.

References SwFrame::GetNext(), SwFrame::InvalidateSize(), SwLayoutFrame::Lower(), and mbBrowseWidthValid.

Referenced by InvalidateBrowseWidth().

◆ IncrPhyPageNums()

void SwRootFrame::IncrPhyPageNums ( )

inline

Definition at line 323 of file rootfrm.hxx.

◆ Init()

void SwRootFrame::Init ( SwFrameFormat * pFormat )

Definition at line 440 of file newfrm.cxx.

References aIndex, AssertFlyPages(), SwFootnoteBossFrame::FindBodyCont(), SwNode::FindTableNode(), IDocumentSettingAccess::get(), GetCurrShell(), SwFormat::GetDoc(), IDocumentDrawModelAccess::GetDrawModel(), SwNodes::GetEndOfContent(), SwFrameAreaDefinition::getFrameArea(), SwTable::GetFrameFormat(), SwFormat::getIDocumentDrawModelAccess(), SwFormat::getIDocumentFieldsAccess(), SwFormat::getIDocumentLayoutAccess(), SwFormat::getIDocumentSettingAccess(), SwFormat::getIDocumentTimerAccess(), SwNodeIndex::GetIndex(), SwDoc::GetNodes(), SwFormatPageDesc::GetNumOffset(), SdrModel::GetPage(), SwFormatPageDesc::GetPageDesc(), SwFormat::GetPageDesc(), SwAttrSet::GetPageDesc(), SwDoc::GetPageDesc(), SwContentNode::GetSwAttrSet(), SwTableNode::GetTable(), SwViewShell::GetViewOptions(), GLOBAL_DOCUMENT, SwNodes::GoNextSection(), SwViewShell::Imp(), InitCurrShells, InsertCnt_(), InsertNewPage(), SwViewOption::IsOnlineSpell(), SwViewShellImp::IsUpdateExpFields(), SwLayoutFrame::Lower(), mbCallbackActionEnabled, mbIsVirtPageNum, mbNeedGrammarCheck, mpCurrShell, mpDrawPage, IDocumentLayoutAccess::SetCurrentViewShell(), SdrPage::SetSize(), SSize, IDocumentTimerAccess::StartIdling(), SwNode::StartOfSectionNode(), IDocumentTimerAccess::StopIdling(), SwRect::Top(), IDocumentFieldsAccess::UpdatePageFields(), and IDocumentFieldsAccess::UpdateRefFields().

◆ InsertEmptyFly()

void SwRootFrame::InsertEmptyFly ( SwFlyFrame * pDel )

Empty SwFlyFrames are registered here for deletion and destroyed later if they are not de-registered in the meantime.

Definition at line 1726 of file flycnt.cxx.

References mpFlyDestroy.

Referenced by SwFlyAtContentFrame::DelEmpty().

◆ InsertEmptySct()

void SwRootFrame::InsertEmptySct ( SwSectionFrame * pDel )

Empty SwSectionFrames are registered here for deletion and destroyed later on or deregistered.

Definition at line 2896 of file sectfrm.cxx.

References mpDestroy.

Referenced by SwSectionFrame::DelEmpty().

◆ InvalidateAllContent()

void SwRootFrame::InvalidateAllContent ( SwInvalidateFlags nInvalidate )

◆ InvalidateAllObjPos()

void SwRootFrame::InvalidateAllObjPos ( )

Invalidate/re-calculate the position of all floating screen objects (Writer fly frames and drawing objects), which are anchored to paragraph or to character.

Invalidate/re-calculate the position of all floating screen objects (Writer fly frames and drawing objects), that are anchored to paragraph or to character.

(2004-03-16 #i11860#)

Definition at line 4254 of file wsfrm.cxx.

References SwFormatAnchor::GetAnchorId(), SwFrame::GetNext(), SwPageFrame::GetSortedObjs(), SwPageFrame::InvalidateFlyLayout(), and SwLayoutFrame::Lower().

Referenced by lcl_InvalidateAllObjPos().

◆ InvalidateBrowseWidth()

void SwRootFrame::InvalidateBrowseWidth ( )

inline

Definition at line 451 of file rootfrm.hxx.

References ImplInvalidateBrowseWidth(), and mbBrowseWidthValid.

Referenced by SwPostItHelper::setSidebarChanged(), SwFlyFrame::SwClientNotify(), and SwFlyFrame::UpdateAttr_().

◆ IsAnyShellAccessible()

bool SwRootFrame::IsAnyShellAccessible ( ) const

inline

◆ IsAssertFlyPages()

bool SwRootFrame::IsAssertFlyPages ( ) const

inline

Definition at line 288 of file rootfrm.hxx.

Referenced by AssertFlyPages(), and SwLayAction::InternalAction().

◆ IsBetweenPages()

bool SwRootFrame::IsBetweenPages ( const Point & rPt ) const

Point rPt: The point to test.

Returns: true: if rPt is between top/bottom margins of two pages in hide-whitespace, rPt can be near the gap, but not strictly between pages (in a page) as gap is small.; false: if rPt is in a page or not strictly between two pages

Definition at line 700 of file findfrm.cxx.

References abs(), SwRect::Bottom(), SwRect::Contains(), o3tl::convert(), GetCurrShell(), SwFrameAreaDefinition::getFrameArea(), SwFrame::GetNext(), SwViewShell::GetViewOptions(), SwViewOption::IsWhitespaceHidden(), SwRect::Left(), SwLayoutFrame::Lower(), min(), o3tl::mm, SwRect::Right(), SwRect::Top(), o3tl::twip, Point::X(), and Point::Y().

Referenced by SwEditWin::MouseButtonDown(), and SwEditWin::UpdatePointer().

◆ IsCallbackActionEnabled()

bool SwRootFrame::IsCallbackActionEnabled ( ) const

inline

Definition at line 400 of file rootfrm.hxx.

Referenced by SwDrawContact::Changed(), CheckViewLayout(), SwFEShell::GetAnyCurRect(), GetModelPositionForViewPoint(), InsertCnt_(), PaintSwFrame(), and SwHTMLTableLayout::Resize_().

◆ IsDummyPage()

bool SwRootFrame::IsDummyPage ( sal_uInt16 nPageNum ) const

Returns: true, when the given physical pagenumber doesn't exist or this page is an empty page.

Definition at line 1624 of file trvlfrm.cxx.

References SwFrame::GetNext(), GetPageNum(), SwFrame::GetPhyPageNum(), SwPageFrame::IsEmptyPage(), and SwLayoutFrame::Lower().

Referenced by SwViewShell::IsDummyPage().

◆ IsHideRedlines()

bool SwRootFrame::IsHideRedlines ( ) const

inline

Replacement for sw::DocumentRedlineManager::GetRedlineFlags() (this is layout-level redline hiding).

Definition at line 434 of file rootfrm.hxx.

Referenced by SwPostItMgr::AddPostIts(), SwGetExpField::ChangeExpansion(), SwRefPageGetField::ChangeExpansion(), SwChapterField::ChangeExpansion(), sw::CheckParaRedlineMerge(), SwGetExpField::ChgExpStr(), SwSetExpField::ChgExpStr(), SwAuthorityField::ConditionalExpandAuthIdentifier(), SwTextNode::CopyExpandText(), SwAttrIter::CtorInitAttrIter(), SwFEShell::DeleteRow(), SwEnhancedPDFExportHelper::EnhancedPDFExport(), SwDocShell::Execute(), SwAuthorityField::ExpandCitation(), SwChapterField::ExpandImpl(), SwRefPageGetField::ExpandImpl(), SwGetExpField::ExpandImpl(), SwSetExpField::ExpandImpl(), SwGetRefField::ExpandImpl(), SwXMLExport::exportDoc(), MSWordExportBase::ExportDocument(), WW8Export::ExportDocument_Impl(), sw::DocumentFieldsManager::FieldsToExpand(), SwTOXIndex::FillText(), SwGetRefFieldType::FindAnchor(), sw::ToxTextGenerator::GetAttributesForNode(), SwTextNode::GetExpandText(), SwSetExpField::GetExpStr(), SwChapterField::GetLevel(), SwTextNode::GetNum(), SwChapterField::GetNumber(), SwEditShell::GetSelectedText(), SwSetExpFieldType::GetSeqFieldList(), SwEditShell::GetSeqFootnoteList(), SwAuthorityFieldType::GetSequencePos(), SwTOXContent::GetText_Impl(), SwTOXPara::GetText_Impl(), SwUnoCursorHelper::GetTextFromPam(), SwChapterField::GetTitle(), SwDoc::GetTOIKeys(), SwGetExpField::GetValue(), SwSetExpField::GetValue(), SwFormatFootnote::GetViewNumStr(), HasMergedParas(), InsertCnt_(), SwDoc::InsertTableOf(), lcl_CursorInDeletedTable(), lcl_setRedlineAttr(), FndBox_::MakeFrames(), SwRefPageGetFieldType::MakeSetList(), SwTextFormatter::NewNumberPortion(), SwFrame::PaintSwFrameBackground(), sw::ReplaceImpl(), SwAutoCorrDoc::ReplaceRange(), SaveTable::RestoreAttr(), SwRefPageGetField::SetText(), SwGetExpField::SetValue(), SwSetExpField::SetValue(), SwRowFrame::SwRowFrame(), SwTabFrame::SwTabFrame(), UnHideRedlines(), SwTOXBaseSection::UpdateAuthorities(), sw::DocumentFieldsManager::UpdateExpFieldsImpl(), SwTOXBaseSection::UpdateSequence(), sw::DocumentFieldsManager::UpdateTableFields(), SwAnnotationItem::UseElement(), and SwXMLWriter::Write_().

◆ IsIdleFormat()

bool SwRootFrame::IsIdleFormat ( ) const

inline

Definition at line 267 of file rootfrm.hxx.

◆ IsInDelList()

bool SwRootFrame::IsInDelList ( SwSectionFrame * pSct ) const

Definition at line 2943 of file sectfrm.cxx.

References mpDestroy.

◆ IsInPaint()

static bool SwRootFrame::IsInPaint ( )

inlinestatic

Definition at line 374 of file rootfrm.hxx.

Referenced by SwViewShell::Paint(), and SwPaintQueue::Repaint().

◆ IsLayoutFreezed()

bool SwRootFrame::IsLayoutFreezed ( ) const

inline

Definition at line 425 of file rootfrm.hxx.

Referenced by AllCheckPageDescs().

◆ IsLeftToRightViewLayout()

bool SwRootFrame::IsLeftToRightViewLayout ( ) const

Definition at line 2460 of file pagechg.cxx.

References SwFrame::IsRightToLeft(), SwFrame::IsVertical(), and SwLayoutFrame::Lower().

Referenced by CheckViewLayout(), SwLayAction::FormatLayout(), SwPageFrame::IsLeftShadowNeeded(), SwPageFrame::IsRightShadowNeeded(), and SwPageFrame::SidebarPosition().

◆ IsNeedGrammarCheck()

bool SwRootFrame::IsNeedGrammarCheck ( ) const

inline

Definition at line 270 of file rootfrm.hxx.

Referenced by sw::DocumentTimerManager::GetNextIdleJob().

◆ IsNewLayout()

bool SwRootFrame::IsNewLayout ( ) const

inline

Definition at line 381 of file rootfrm.hxx.

Referenced by SwViewShell::IsNewLayout().

◆ IsSuperfluous()

bool SwRootFrame::IsSuperfluous ( ) const

inline

Definition at line 311 of file rootfrm.hxx.

Referenced by SwLayAction::InternalAction(), SwPagePreviewLayout::Paint(), and RemoveSuperfluous().

◆ IsTableUpdateInProgress()

bool SwRootFrame::IsTableUpdateInProgress ( ) const

inline

Definition at line 291 of file rootfrm.hxx.

Referenced by SwLayAction::InternalAction().

◆ IsTurboAllowed()

bool SwRootFrame::IsTurboAllowed ( ) const

inline

Definition at line 358 of file rootfrm.hxx.

Referenced by SwFrame::InvalidatePage().

◆ IsVirtPageNum()

bool SwRootFrame::IsVirtPageNum ( ) const

inline

Definition at line 324 of file rootfrm.hxx.

Referenced by SwFrame::GetVirtPageNum(), and SwTextFormatter::NewFieldPortion().

◆ MakeAll()

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

overrideprivatevirtual

Reimplemented from SwLayoutFrame.

Definition at line 1764 of file pagechg.cxx.

References DOCUMENTBORDER, SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::isFrameAreaPositionValid(), SwFrameAreaDefinition::isFrameAreaSizeValid(), SwFrameAreaDefinition::isFramePrintAreaValid(), SwRect::Pos(), SwFrameAreaDefinition::setFrameAreaPositionValid(), SwFrameAreaDefinition::setFrameAreaSizeValid(), SwFrameAreaDefinition::setFramePrintAreaValid(), SSize, and SwRect::SSize().

◆ MakeTableCursors()

bool SwRootFrame::MakeTableCursors ( SwTableCursor & rTableCursor )

Calculates the cells included from the current selection.

Determines and sets those cells which are enclosed by the selection.

Returns: false: There was no result because of an invalid layout; true: Everything worked fine.

Definition at line 1871 of file trvlfrm.cxx.

References SwTableCursor::ActualizeSelection(), SwLayoutFrame::FirstCell(), SwTabFrame::GetFirstNonHeadlineRow(), SwLayoutFrame::GetFormat(), SwFrameAreaDefinition::getFrameArea(), SwContentNode::getLayoutFrame(), SwPaM::GetMarkContentNode(), SwShellCursor::GetMkPos(), SwFrame::GetNext(), SwFrame::GetNextLayoutLeaf(), SwPaM::GetPointContentNode(), SwFormat::GetProtect(), SwShellCursor::GetPtPos(), SwTabFrame::GetTable(), SwFrame::GetUpper(), o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::insert(), SwLayoutFrame::IsAnLower(), SwFrame::IsCellFrame(), SvxProtectItem::IsContentProtected(), SwFrameAreaDefinition::isFrameAreaDefinitionValid(), IsFrameInTableSel(), SwFrame::IsInTab(), SwCursor::IsReadOnlyAvailable(), SwFrame::IsRowFrame(), SwLayoutFrame::Lower(), MakeSelUnions(), SwTableCursor::NewTableSelection(), and SwRect::Overlaps().

Referenced by SwCursorShell::GetCursor(), GetTableSelCrs(), SwUnoTableCursor::MakeBoxSels(), SwCursorShell::UpdateCursor(), and SwCursorShell::UpdateTableSelBoxes().

◆ PaintSwFrame()

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

overridevirtual

Paint once for every visible page which is touched by Rect.

Paint borders and backgrounds
Paint the draw layer (frames and drawing objects) that is below the document (hell)
Paint the document content (text)
Paint the draw layer that is above the document |

Reimplemented from SwLayoutFrame.

Definition at line 3083 of file paintfrm.cxx.

References SwLayAction::Action(), SwViewShell::ActionPend(), SwPaintQueue::Add(), aGlobalRetoucheColor, BACKGROUND_PARA_OVER_DRAWINGS, SwViewShellImp::DeletePaintRegion(), SwViewShell::DLPostPaint2(), SwViewShell::DLPrePaint2(), SdrPageView::DrawPageViewGrid(), OutputDevice::DrawRect(), OutputDevice::DrawText(), SwLayVout::Enter(), vcl::Region::Exclude(), FileInit, sw::DocumentSettingManager::get(), SfxProgress::GetActiveProgress(), SwPageFrame::GetBorderAndShadowBoundRect(), SwFrameControlsManager::GetControl(), SwViewShell::GetDoc(), SwDoc::GetDocShell(), SwDoc::GetDocumentSettingManager(), SwPageFrame::GetDrawBackgroundColor(), SwViewShellImp::GetDrawView(), SwView::GetEditWin(), SwPageFrame::GetEmptyPageFont(), OutputDevice::GetFillColor(), SwViewShellImp::GetFirstVisPage(), OutputDevice::GetFont(), SwLayoutFrame::GetFormat(), SwPageFrame::GetFormatPage(), SwFrameAreaDefinition::getFrameArea(), SwEditWin::GetFrameControlsManager(), IDocumentDrawModelAccess::GetHeavenId(), IDocumentDrawModelAccess::GetHellId(), SwDoc::getIDocumentDrawModelAccess(), SwViewShell::getIDocumentDrawModelAccess(), SwRectFnSet::GetLeft(), SwFrame::GetNext(), SwViewShell::GetOut(), vcl::Window::GetOutDev(), SwPageFrame::GetPhyPageNum(), SwFrame::GetPrev(), SwViewShellImp::GetRetoucheColor(), sw::Ring< value_type >::GetRingContainer(), SdrPaintView::GetSdrPageView(), SwViewOption::GetTextGridColor(), SwWrtShell::GetView(), SwViewShell::GetViewOptions(), SwRectFnSet::GetWidth(), SwViewShell::GetWin(), gProp, SwViewShellImp::HasDrawView(), SwViewShell::Imp(), SwRect::Intersection(), SwRect::Intersection_(), vcl::Window::Invalidate(), IsCallbackActionEnabled(), SwPageFrame::IsEmptyPage(), IsExtraData(), SdrPaintView::IsGridVisible(), SwViewShell::IsInEndAction(), SfxObjectShell::IsInPlaceActive(), SwPageFrame::IsLeftShadowNeeded(), SwFrame::IsPageFrame(), SwPageFrame::IsRightShadowNeeded(), SwFrame::IsRightToLeft(), vcl::Window::IsVisible(), lcl_AdjustRectToPixelSize(), SwLayVout::Leave(), SwLayoutFrame::Lower(), mpCurrShell, NONE, OUTDEV_WINDOW, SwRect::Overlaps(), PageBreak, SwFrame::PaintBaBo(), SwPageFrame::PaintBorderAndShadow(), SwPageFrame::PaintBreak(), SwPageFrame::PaintDecorators(), SwViewShellImp::PaintLayer(), SwPageFrame::PaintNotesSidebar(), SwLayoutFrame::PaintSwFrame(), SwFrame::ProcessPrimitives(), PROTOCOL, SwPageFrame::RefreshExtraData(), SwPageFrame::RefreshSubsidiary(), ResetTurbo(), ResetTurboFlag(), sw::sidebarwindows::RIGHT, s_isInPaint, s_isNoVirDev, s_pVout, SetCallbackActionEnabled(), SwLayAction::SetComplete(), OutputDevice::SetFillColor(), OutputDevice::SetFont(), SwRectFnSet::SetLeftAndWidth(), OutputDevice::SetLineColor(), SwLayVout::SetOrgRect(), SwLayAction::SetPaint(), SwLayAction::SetReschedule(), SwPageFrame::SidebarPosition(), SwRect::SSize(), SwRect::SVRect(), SwAlignRect(), SwCalcPixStatics(), SwResId(), and SwViewShell::VisArea().

Referenced by SwViewShell::ImplEndAction(), SwViewShell::Paint(), and SwViewShell::SmoothScroll().

◆ Paste()

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

overridevirtual

Reimplemented from SwLayoutFrame.

Definition at line 60 of file unusedf.cxx.

◆ RemoveAccessibleShell()

void SwRootFrame::RemoveAccessibleShell ( )

inline

Definition at line 404 of file rootfrm.hxx.

Referenced by SwAccessibleMap::~SwAccessibleMap().

◆ RemoveFootnotes()

void SwRootFrame::RemoveFootnotes	(	SwPageFrame *	pPage = `nullptr`,
		bool	bPageOnly = `false`,
		bool	bEndNotes = `false`
	)

Remove all footnotes (but no references)

Definition at line 974 of file ftnfrm.cxx.

References SwFrame::Cut(), SwFrame::DestroyFrame(), SwFootnoteBossFrame::FindBodyCont(), SwFrame::GetNext(), SwFrame::IsColumnFrame(), SwPageFrame::IsEndNotePage(), SwPageFrame::IsFootnotePage(), SwLayoutFrame::Lower(), and sw_RemoveFootnotes().

Referenced by AllRemoveFootnotes(), AssertFlyPages(), SwLayoutFrame::ChgColumns(), DestroyImpl(), and RemovePage().

◆ RemoveFromList()

void SwRootFrame::RemoveFromList ( SwSectionFrame * pSct )

inline

Definition at line 394 of file rootfrm.hxx.

Referenced by SwSectionFrame::DelEmpty(), SwSectionFrame::DestroyImpl(), and MakeFrames().

◆ RemoveFromList_()

void SwRootFrame::RemoveFromList_ ( SwSectionFrame * pSct )

private

Definition at line 2936 of file sectfrm.cxx.

References mpDestroy.

◆ RemoveMasterObjs()

void SwRootFrame::RemoveMasterObjs ( SdrPage * pPg )

static

Remove MasterObjects from the Page (called by the ctors)

Definition at line 578 of file newfrm.cxx.

References SdrObjList::GetObj(), SdrObjList::GetObjCount(), i, and SdrObjList::RemoveObject().

Referenced by AssertFlyPages().

◆ RemovePage()

void SwRootFrame::RemovePage	(	SwPageFrame **	pDel,
		SwRemoveResult	eResult
	)

Definition at line 1506 of file pagechg.cxx.

References SwPageFrame::Cut(), SwFrame::DestroyFrame(), o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::empty(), SwFormat::GetDoc(), SwDoc::GetFootnoteIdxs(), SwLayoutFrame::GetFormat(), SwFrame::GetNext(), SwFrame::GetPrev(), Next, and RemoveFootnotes().

Referenced by RemoveSuperfluous().

◆ RemoveSuperfluous()

void SwRootFrame::RemoveSuperfluous ( )

remove pages that are not needed at all

Definition at line 1518 of file pagechg.cxx.

References GetCurrShell(), SwFormat::GetDoc(), SwLayoutFrame::GetFormat(), SwFrameAreaDefinition::getFrameArea(), SwDoc::getIDocumentFieldsAccess(), GetLastPage(), SwFrame::GetPrev(), SwFrame::getRootFrame(), SwViewShell::Imp(), SwPageFrame::IsFootnotePage(), sw::IsPageFrameEmpty(), IsSuperfluous(), SwViewShellImp::IsUpdateExpFields(), LONG_MAX, mbCheckSuperfluous, Prev, RemovePage(), SAL_INFO, SwRect::Top(), and IDocumentFieldsAccess::UpdatePageFields().

Referenced by SwLayAction::InternalAction().

◆ ResetIdleFormat()

void SwRootFrame::ResetIdleFormat ( )

inline

Definition at line 268 of file rootfrm.hxx.

Referenced by SwLayIdle::SwLayIdle(), and SwDoc::UpdatePagesForPrintingWithPostItData().

◆ ResetNewLayout()

void SwRootFrame::ResetNewLayout ( )

inline

Definition at line 382 of file rootfrm.hxx.

Referenced by SwViewShell::~SwViewShell().

◆ ResetTurbo()

void SwRootFrame::ResetTurbo ( )

inline

Definition at line 360 of file rootfrm.hxx.

Referenced by SwLayAction::Action(), SwContentFrame::DestroyImpl(), SwFrame::InvalidatePage(), SwAnchoredDrawObject::InvalidatePage_(), PaintSwFrame(), and SwLayAction::TurboAction().

◆ ResetTurboFlag()

void SwRootFrame::ResetTurboFlag ( ) const

inline

Definition at line 357 of file rootfrm.hxx.

Referenced by SwLayAction::Action(), and PaintSwFrame().

◆ SetAssertFlyPages()

void SwRootFrame::SetAssertFlyPages ( )

inline

Makes sure that all requested page-bound Flys find a Page.

Definition at line 286 of file rootfrm.hxx.

Referenced by SwFrame::CheckPageDescs(), SwDrawContact::ConnectToLayout(), SwFEShell::Insert(), SwFEShell::InsertDrawObj(), SwFEShell::InsertObject(), SwFEShell::NewFlyFrame(), SwFEShell::SetFlyFrameAttr(), SwFEShell::SetFrameFormat(), SwFEShell::SetPageObjsNewPage(), and SwFlyLayFrame::SwClientNotify().

◆ SetCallbackActionEnabled()

void SwRootFrame::SetCallbackActionEnabled ( bool b )

inline

Definition at line 399 of file rootfrm.hxx.

Referenced by CheckViewLayout(), DisableCallbackAction::DisableCallbackAction(), SwFEShell::GetAnyCurRect(), GetModelPositionForViewPoint(), InsertCnt_(), PaintSwFrame(), and DisableCallbackAction::~DisableCallbackAction().

◆ SetCurrPage()

sal_uInt16 SwRootFrame::SetCurrPage	(	SwCursor *	pToSet,
		sal_uInt16	nPageNum
	)

Returns a PaM which sits at the beginning of the requested page.

Formatting is done as far as necessary. The PaM sits on the last page, if the page number was chosen too big.

Returns: Null, if the operation was not possible.

Definition at line 994 of file trvlfrm.cxx.

References SwFrame::Calc(), SwLayoutFrame::ContainsContent(), GetCurrShell(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwFrame::GetNext(), SwContentFrame::GetNextContentFrame(), SwTextFrame::GetOffset(), SwViewShell::GetOut(), SwPageFrame::GetPhyPageNum(), SwPaM::GetPoint(), SwShellCursor::GetPtPos(), SwLayoutFrame::IsAnLower(), SwPageFrame::IsFootnotePage(), SwFrame::IsInDocBody(), SwFrame::IsInFootnote(), SwFrame::IsPageFrame(), SwFrame::IsTextFrame(), SwLayoutFrame::Lower(), SwTextFrame::MapViewToModelPos(), and SwRect::Pos().

Referenced by SwCursorShell::GotoPage().

◆ SetDrawPage()

void SwRootFrame::SetDrawPage ( SdrPage * pNew )

inline

Definition at line 237 of file rootfrm.hxx.

Referenced by SwViewShellImp::Init(), and sw::DocumentDrawModelManager::InitDrawModel().

◆ SetFieldmarkMode()

void SwRootFrame::SetFieldmarkMode	(	sw::FieldmarkMode	eFMMode,
		sw::ParagraphBreakMode	ePBMode
	)

Definition at line 4749 of file wsfrm.cxx.

References HasMergedParas(), sw::Hidden, m_FieldmarkMode, m_ParagraphBreakMode, mbHideRedlines, sw::ShowBoth, sw::Shown, and UnHide().

Referenced by SwViewShell::ImplApplyViewOptions(), and SwUndoInsSection::RedoImpl().

◆ SetHideRedlines()

void SwRootFrame::SetHideRedlines ( bool bHideRedlines )

Definition at line 4724 of file wsfrm.cxx.

References eMode, HasMergedParas(), m_FieldmarkMode, m_ParagraphBreakMode, mbHideRedlines, sw::ShowBoth, sw::Shown, and UnHide().

Referenced by SwViewShell::ImplApplyViewOptions(), and SwUndoInsSection::RedoImpl().

◆ SetIdleFlags()

void SwRootFrame::SetIdleFlags ( )

inline

Definition at line 257 of file rootfrm.hxx.

References SwViewShell::GetDoc(), SwDoc::getIDocumentTimerAccess(), and IDocumentTimerAccess::StartIdling().

Referenced by SwFrame::InvalidatePage(), and SwAnchoredDrawObject::InvalidatePage_().

◆ SetNeedGrammarCheck()

void SwRootFrame::SetNeedGrammarCheck ( bool bVal )

inline

Definition at line 271 of file rootfrm.hxx.

References SwViewShell::GetDoc(), SwDoc::getIDocumentTimerAccess(), and IDocumentTimerAccess::StartIdling().

Referenced by SwFrame::InvalidatePage(), and lcl_SetWrong().

◆ SetNoVirDev()

static void SwRootFrame::SetNoVirDev ( const bool bNew )

inlinestatic

Definition at line 376 of file rootfrm.hxx.

Referenced by SwViewShell::Paint().

◆ SetSidebarChanged()

void SwRootFrame::SetSidebarChanged ( )

inline

Definition at line 423 of file rootfrm.hxx.

Referenced by SwPostItHelper::setSidebarChanged().

◆ SetSuperfluous()

void SwRootFrame::SetSuperfluous ( )

inline

Remove superfluous Pages.

Definition at line 310 of file rootfrm.hxx.

Referenced by SwContentFrame::Cut(), SwFootnoteFrame::Cut(), SwTabFrame::Cut(), SwSectionFrame::Cut_(), and DeleteEmptySct_().

◆ SetTableUpdateInProgress()

void SwRootFrame::SetTableUpdateInProgress ( bool bValue )

inline

Definition at line 290 of file rootfrm.hxx.

Referenced by SwEditShell::UpdateTableOf().

◆ SetTurbo()

void SwRootFrame::SetTurbo ( const SwContentFrame * pContent )

inline

Definition at line 359 of file rootfrm.hxx.

Referenced by SwFrame::InvalidatePage().

◆ SetVirtPageNum()

void SwRootFrame::SetVirtPageNum ( const bool bOf ) const

inline

Definition at line 457 of file rootfrm.hxx.

References mbIsVirtPageNum.

Referenced by SwFrame::InsertPage(), SwFEShell::SetNewPageOffset(), and SwFEShell::SetPageOffset().

◆ ShrinkFrame()

SwTwips SwRootFrame::ShrinkFrame	(	SwTwips	nDist,
		bool	bTst = `false`,
		bool	bInfo = `false`
	)

overridevirtual

Reimplemented from SwLayoutFrame.

Definition at line 1492 of file pagechg.cxx.

References SwRect::AddHeight(), SwFrameAreaDefinition::getFrameArea(), and Height.

◆ StartAllAction()

void SwRootFrame::StartAllAction ( )

Set up Start-/EndAction for all Shells on an as high as possible (Shell section) level.

For the StarONE binding, which does not know the Shells directly. The ChangeLinkd of the CursorShell (UI notifications) is called automatically in the EndAllAction.

Definition at line 1920 of file pagechg.cxx.

References GetCurrShell().

Referenced by SwViewShell::CalcPagesForPrint(), SwDrawContact::Changed(), SwDrawView::DeleteMarked(), sw::IMPL_LINK_NOARG(), sw::DocumentDeviceManager::PrtDataChanged(), SwDoc::PrtOLENotify(), SwHTMLTableLayout::Resize_(), sw::DocumentSettingManager::setCharacterCompressionType(), sw::DocumentSettingManager::setForbiddenCharacters(), SwDoc::SetLineNumberInfo(), SwLineNumberInfo::SwClientNotify(), and UnoActionContext::UnoActionContext().

◆ UnoRemoveAllActions()

void SwRootFrame::UnoRemoveAllActions ( )

Certain UNO Actions (e.g.

table cursor) require that all Actions are reset temporarily In order for that to work, every SwViewShell needs to remember its old Action counter

Definition at line 1951 of file pagechg.cxx.

References EndAction, SwCursorShell::EndAction(), and GetCurrShell().

Referenced by lcl_RemoveImpl().

◆ UnoRestoreAllActions()

void SwRootFrame::UnoRestoreAllActions ( )

Definition at line 1986 of file pagechg.cxx.

References GetCurrShell().

Referenced by UnoActionRemoveContext::~UnoActionRemoveContext().

◆ UpdateFootnoteNums()

void SwRootFrame::UpdateFootnoteNums ( )

Update the footnote numbers of all Pages.

Definition at line 905 of file ftnfrm.cxx.

References FTNNUM_PAGE, SwLayoutFrame::GetFormat(), SwFrame::GetNext(), SwPageFrame::IsFootnotePage(), SwLayoutFrame::Lower(), and SwPageFrame::UpdateFootnoteNum().

Friends And Related Function Documentation

◆ AdjustSizeChgNotify

void AdjustSizeChgNotify ( SwRootFrame * pRoot )

friend

Definition at line 834 of file pagechg.cxx.

Referenced by CheckViewLayout().

◆ CurrShell

friend class CurrShell

friend

[ Comment from the original StarOffice checkin ]: The root takes care of the shell access.

Via the document it should be possible to get at the root frame, and thus always have access to the shell. the pointer mpCurrShell is the pointer to any of the shells for the document. Because sometimes it matters which shell is used, it is necessary to know the active shell. this is approximated by setting the pointer mpCurrShell when a shell gets the focus (FEShell). Additionally the pointer will be set temporarily by SwCurrShell typically via CurrShell The class can be found in the SwViewShell. These object can be created nested (also for different kinds of Shells). They are collected into the Array mpCurrShells. Furthermore it can happen that a shell is activated while a curshell object is still 'active'. This one will be entered into mpWaitingCurrShell and will be activated by the last d'tor of CurrShell. One other problem is the destruction of a shell while it is active. The pointer mpCurrShell is then reset to an arbitrary other shell. If at the time of the destruction of a shell, which is still referenced by a curshell object, that will be cleaned up as well.

Definition at line 166 of file rootfrm.hxx.

◆ FrameFinit

void FrameFinit ( )

friend

Definition at line 307 of file newfrm.cxx.

◆ FrameInit

void FrameInit ( )

friend

Definition at line 296 of file newfrm.cxx.

◆ InitCurrShells

void InitCurrShells ( SwRootFrame * pRoot )

friend

Definition at line 390 of file newfrm.cxx.

Referenced by Init().

◆ SetLastPage

void SetLastPage ( SwPageFrame * pPage )

friend

Definition at line 853 of file pagechg.cxx.

◆ SetShell

void SetShell ( SwViewShell * pSh )

friend

Definition at line 353 of file newfrm.cxx.

Member Data Documentation

◆ m_FieldmarkMode

sw::FieldmarkMode SwRootFrame::m_FieldmarkMode

private

Definition at line 128 of file rootfrm.hxx.

Referenced by SetFieldmarkMode(), and SetHideRedlines().

◆ m_ParagraphBreakMode

sw::ParagraphBreakMode SwRootFrame::m_ParagraphBreakMode

private

Definition at line 129 of file rootfrm.hxx.

Referenced by SetFieldmarkMode(), and SetHideRedlines().

◆ maPageRects

std::vector<SwRect> SwRootFrame::maPageRects

private

Definition at line 96 of file rootfrm.hxx.

Referenced by CheckViewLayout(), and GetPageAtPos().

◆ maPagesArea

SwRect SwRootFrame::maPagesArea

private

Definition at line 99 of file rootfrm.hxx.

Referenced by CheckViewLayout().

◆ mbAssertFlyPages

bool SwRootFrame::mbAssertFlyPages

private

Definition at line 120 of file rootfrm.hxx.

Referenced by AssertFlyPages().

◆ mbBookMode

bool SwRootFrame::mbBookMode

private

Definition at line 102 of file rootfrm.hxx.

Referenced by CheckViewLayout().

◆ mbBrowseWidthValid

bool SwRootFrame::mbBrowseWidthValid

private

Definition at line 118 of file rootfrm.hxx.

Referenced by GetBrowseWidth(), ImplCalcBrowseWidth(), ImplInvalidateBrowseWidth(), and InvalidateBrowseWidth().

◆ mbCallbackActionEnabled

bool SwRootFrame::mbCallbackActionEnabled

private

Definition at line 124 of file rootfrm.hxx.

Referenced by Init().

◆ mbCheckSuperfluous

bool SwRootFrame::mbCheckSuperfluous

private

Definition at line 116 of file rootfrm.hxx.

Referenced by RemoveSuperfluous().

◆ mbHideRedlines

bool SwRootFrame::mbHideRedlines

private

Definition at line 127 of file rootfrm.hxx.

Referenced by SetFieldmarkMode(), and SetHideRedlines().

◆ mbIdleFormat

bool SwRootFrame::mbIdleFormat

private

Definition at line 117 of file rootfrm.hxx.

◆ mbIsNewLayout

bool SwRootFrame::mbIsNewLayout

private

Definition at line 123 of file rootfrm.hxx.

◆ mbIsVirtPageNum

bool SwRootFrame::mbIsVirtPageNum

private

Definition at line 122 of file rootfrm.hxx.

Referenced by Init(), and SetVirtPageNum().

◆ mbLayoutFreezed

bool SwRootFrame::mbLayoutFreezed

private

Definition at line 126 of file rootfrm.hxx.

◆ mbNeedGrammarCheck

bool SwRootFrame::mbNeedGrammarCheck

private

Definition at line 105 of file rootfrm.hxx.

Referenced by Init().

◆ mbSidebarChanged

bool SwRootFrame::mbSidebarChanged

private

Definition at line 103 of file rootfrm.hxx.

Referenced by CheckViewLayout().

◆ mbTableUpdateInProgress

bool SwRootFrame::mbTableUpdateInProgress

private

Definition at line 121 of file rootfrm.hxx.

◆ mbTurboAllowed

bool SwRootFrame::mbTurboAllowed

private

Definition at line 119 of file rootfrm.hxx.

Referenced by DestroyImpl().

◆ MIN_BROWSE_WIDTH

constexpr sal_Int64 SwRootFrame::MIN_BROWSE_WIDTH = o3tl::toTwips(20000, o3tl::Length::mm100)

staticconstexprprivate

Width of the HTML / Web document if not defined otherwise: 20cm.

Definition at line 114 of file rootfrm.hxx.

Referenced by ImplCalcBrowseWidth().

◆ mnAccessibleShells

sal_uInt16 SwRootFrame::mnAccessibleShells

private

Page count.

Definition at line 180 of file rootfrm.hxx.

Referenced by DestroyImpl().

◆ mnBrowseWidth

tools::Long SwRootFrame::mnBrowseWidth

private

For BrowseMode mnBrowseWidth is the outer margin of the object most to the right.

The page's right edge should not be smaller than this value.

Definition at line 136 of file rootfrm.hxx.

Referenced by GetBrowseWidth(), and ImplCalcBrowseWidth().

◆ mnColumns

sal_uInt16 SwRootFrame::mnColumns

private

Definition at line 101 of file rootfrm.hxx.

Referenced by CheckViewLayout().

◆ mnPhyPageNums

sal_uInt16 SwRootFrame::mnPhyPageNums

private

Definition at line 179 of file rootfrm.hxx.

◆ mnViewWidth

tools::Long SwRootFrame::mnViewWidth

private

Definition at line 100 of file rootfrm.hxx.

Referenced by CheckViewLayout().

◆ mpCurrShell

SwViewShell* SwRootFrame::mpCurrShell

private

Definition at line 169 of file rootfrm.hxx.

Referenced by CurrShell::CurrShell(), DeRegisterShell(), Init(), PaintSwFrame(), and CurrShell::~CurrShell().

◆ mpCurrShells

std::unique_ptr<SwCurrShells> SwRootFrame::mpCurrShells

private

Definition at line 171 of file rootfrm.hxx.

Referenced by CurrShell::CurrShell(), DeRegisterShell(), DestroyImpl(), and CurrShell::~CurrShell().

◆ mpDestroy

std::unique_ptr<SwDestroyList> SwRootFrame::mpDestroy

private

Definition at line 176 of file rootfrm.hxx.

Referenced by DeleteEmptySct_(), DestroyImpl(), InsertEmptySct(), IsInDelList(), and RemoveFromList_().

◆ mpDrawPage

SdrPage* SwRootFrame::mpDrawPage

private

One Page per DrawModel per Document; is always the size of the Root.

Definition at line 174 of file rootfrm.hxx.

Referenced by AssertFlyPages(), and Init().

◆ mpFlyDestroy

std::unique_ptr<SwFlyDestroyList> SwRootFrame::mpFlyDestroy

private

Definition at line 177 of file rootfrm.hxx.

Referenced by DeleteEmptyFlys_(), and InsertEmptyFly().

◆ mpLastPage

SwPageFrame* SwRootFrame::mpLastPage

private

We should not need to always struggle to find the last page, so store it here.

Definition at line 142 of file rootfrm.hxx.

◆ mpTurbo

const SwContentFrame* SwRootFrame::mpTurbo

private

If we only have to format one ContentFrame, its in mpTurbo.

Definition at line 139 of file rootfrm.hxx.

Referenced by DestroyImpl().

◆ mpWaitingCurrShell

SwViewShell* SwRootFrame::mpWaitingCurrShell

private

Definition at line 170 of file rootfrm.hxx.

Referenced by DeRegisterShell(), and CurrShell::~CurrShell().

◆ s_isInPaint

bool SwRootFrame::s_isInPaint = false

staticprivate

Definition at line 108 of file rootfrm.hxx.

Referenced by PaintSwFrame().

◆ s_isNoVirDev

bool SwRootFrame::s_isNoVirDev = false

staticprivate

Definition at line 109 of file rootfrm.hxx.

Referenced by PaintSwFrame().

◆ s_pLast

SwRootFrame * SwRootFrame::s_pLast = nullptr

staticprivate

The last, still alive SwRootFrame instance, for debugging.

Definition at line 111 of file rootfrm.hxx.

Referenced by SwRootFrame(), and ~SwRootFrame().

◆ s_pVout

SwLayVout * SwRootFrame::s_pVout = nullptr

staticprivate

Definition at line 107 of file rootfrm.hxx.

Referenced by FlushVout(), HasSameRect(), and PaintSwFrame().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~SwRootFrame()

◆ SwRootFrame()

Member Function Documentation

◆ AddAccessibleShell()

◆ AllAddPaintRect()

◆ AllCheckPageDescs()

◆ AllInvalidateAutoCompleteWords()

◆ AllInvalidateSmartTagsOrSpelling()

◆ AllRemoveFootnotes()

◆ AssertFlyPages()

◆ AssertPageFlys()

◆ CalcFrameRects()

◆ CheckFootnotePageDescs()

◆ CheckViewLayout()

◆ ChgSize()

◆ Cut()

◆ DecrPhyPageNums()

◆ DeleteEmptyFlys()

◆ DeleteEmptyFlys_()

◆ DeleteEmptySct()

◆ DeleteEmptySct_()

◆ DeRegisterShell()

◆ DestroyImpl()

◆ DisallowTurbo()

◆ dumpAsXml()

◆ EndAllAction()

◆ FillSelection()

◆ FlushVout()

◆ FreezeLayout()

◆ GetBrowseWidth()

◆ GetCurrPage()

◆ GetCurrShell()

◆ GetDrawPage() [1/2]

◆ GetDrawPage() [2/2]

◆ GetFieldmarkMode()

◆ GetLastPage() [1/2]

◆ GetLastPage() [2/2]

◆ GetModelPositionForViewPoint()

◆ GetNextPrevContentPos()

◆ GetPageAtPos()

◆ GetPageByPageNum()

◆ GetPageNum()

◆ GetPagePos()

◆ GetPagesArea()

◆ GetParagraphBreakMode()

◆ GetTurbo()

◆ GrowFrame()

◆ HasMergedParas()

◆ HasSameRect()

◆ ImplCalcBrowseWidth()

◆ ImplInvalidateBrowseWidth()

◆ IncrPhyPageNums()

◆ Init()

◆ InsertEmptyFly()

◆ InsertEmptySct()

◆ InvalidateAllContent()

◆ InvalidateAllObjPos()

◆ InvalidateBrowseWidth()

◆ IsAnyShellAccessible()

◆ IsAssertFlyPages()

◆ IsBetweenPages()

◆ IsCallbackActionEnabled()

◆ IsDummyPage()

◆ IsHideRedlines()

◆ IsIdleFormat()

◆ IsInDelList()

◆ IsInPaint()

◆ IsLayoutFreezed()

◆ IsLeftToRightViewLayout()

◆ IsNeedGrammarCheck()

◆ IsNewLayout()