LibreOffice Module sw (master) 1
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
SwSectionFrame Class Referencefinal

#include <sectfrm.hxx>

Inheritance diagram for SwSectionFrame:
Collaboration diagram for SwSectionFrame:

Public Member Functions

 SwSectionFrame (SwSection &, SwFrame *)
 SwSectionFrame (SwSectionFrame &, bool bMaster)
void Init ()
virtual void CheckDirection (bool bVert) override
virtual void PaintSubsidiaryLines (const SwPageFrame *, const SwRect &) const override
virtual void Cut () override
virtual void Paste (SwFrame *pParent, SwFrame *pSibling=nullptr) override
const SwSectionFrameGetFollow () const
SwSectionFrameGetFollow ()
SwSectionFrameFindMaster () const
SwContentFrameFindLastContent (SwFindMode nMode=SwFindMode::None)
const SwContentFrameFindLastContent () const
SwSectionGetSection ()
const SwSectionGetSection () const
void ColLock ()
void ColUnlock ()
void CalcFootnoteContent ()
void SimpleFormat ()
bool IsDescendantFrom (const SwSectionFormat *pSect) const
bool HasToBreak (const SwFrame *pFrame) const
 |* Here it's decided whether the this-SectionFrame should break up |* the passed (Section)frm (or not). More...
void MergeNext (SwSectionFrame *pNxt)
 |* Merges two SectionFrames, in case it's about the same section. More...
SwSectionFrameSplitSect (SwFrame *pFrameStartAfter, SwFrame *pFramePutAfter)
 Splits the SectionFrame surrounding the pFrame up in two parts: pFrame and the start of the 2nd part. More...
void DelEmpty (bool bRemove)
SwFootnoteContFrameContainsFootnoteCont (const SwFootnoteContFrame *pCont=nullptr) const
 Check every Column for FootnoteContFrames. More...
bool Growable () const
 checks whether the SectionFrame is still able to grow, as case may be the environment has to be asked More...
SwTwips Shrink_ (SwTwips, bool bTst)
SwTwips Grow_ (SwTwips, bool bTst)
bool ToMaximize (bool bCheckFollow) const
 A sectionfrm has to maximize, if he has a follow or a ftncontainer at the end of the page. More...
bool ToMaximize_ () const
bool MoveAllowed (const SwFrame *) const
bool CalcMinDiff (SwTwips &rMinDiff) const
SwTwips Undersize ()
 Returns the size delta that the section would like to be greater if it has undersized TextFrames in it. More...
SwTwips CalcUndersize () const
void CheckClipping (bool bGrow, bool bMaximize)
 Adapt size to surroundings. More...
void InvalidateFootnotePos ()
void CollectEndnotes (SwLayouter *pLayouter)
const SwSectionFormatGetEndSectFormat () const
bool IsBalancedSection () const
virtual void dumpAsXml (xmlTextWriterPtr writer=nullptr) const override
virtual void dumpAsXmlAttributes (xmlTextWriterPtr writer) const override
bool IsFootnoteAtEnd () const
bool IsEndnAtEnd () const
bool IsAnyNoteAtEnd () const
void SetContentLock (bool bNew)
bool IsContentLocked () const
bool IsOwnFootnoteNum () const
void SetFootnoteLock (bool bNew)
bool IsFootnoteLock () const
- Public Member Functions inherited from SwLayoutFrame
virtual void PaintSubsidiaryLines (const SwPageFrame *, const SwRect &) const
void RefreshLaySubsidiary (const SwPageFrame *, const SwRect &) const
void RefreshExtraData (const SwRect &) const
void ChgLowersProp (const Size &rOldSize)
 Change size of lowers proportionally. More...
void AdjustColumns (const SwFormatCol *pCol, bool bAdjustAttributes)
void ChgColumns (const SwFormatCol &rOld, const SwFormatCol &rNew, const bool bChgFootnote=false)
 add or remove columns from a layoutframe. More...
void PaintColLines (const SwRect &, const SwFormatCol &, const SwPageFrame *) const
 Paints the column separation line for the inner columns. More...
virtual bool FillSelection (SwSelectionList &rList, const SwRect &rRect) const override
virtual bool GetModelPositionForViewPoint (SwPosition *, Point &, SwCursorMoveState *=nullptr, bool bTestBackground=false) const override
 Searches the ContentFrame owning the PrtArea containing the point. More...
virtual void Cut () override
virtual void Paste (SwFrame *pParent, SwFrame *pSibling=nullptr) override
const SwContentFrameGetContentPos (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 SwFrameLower () const
SwFrameLower ()
bool ContainsDeleteForbiddenLayFrame () const
const SwContentFrameContainsContent () 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...
SwContentFrameContainsContent ()
 In order to save us from duplicating implementations, we cast here a little. More...
const SwCellFrameFirstCell () const
 Calls ContainsAny first to reach the innermost cell. More...
SwCellFrameFirstCell ()
const SwFrameContainsAny (const bool _bInvestigateFootnoteForSections=false) const
 Method <ContainsAny()> doesn't investigate content of footnotes by default. More...
SwFrameContainsAny (const bool _bInvestigateFootnoteForSections=false)
bool IsAnLower (const SwFrame *) const
virtual const SwFrameFormatGetFormat () const
virtual SwFrameFormatGetFormat ()
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...
SwFrameGetLastLower ()
virtual void PaintBreak () const
void SetVertPosOrientFrameFor (SwAnchoredObject *pObj)
void ClearVertPosOrientFrameFor (SwAnchoredObject *pObj)
const SwFrameGetLastLower () 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 ()
SwLayoutFrameGetLeaf (MakePageType eMakePage, bool bFwd)
SwLayoutFrameGetNextLeaf (MakePageType eMakePage)
 Returns the next layout leaf in which we can move the frame. More...
SwLayoutFrameGetNextFootnoteLeaf (MakePageType eMakePage)
 Return the next layout leaf in that the frame can be moved. More...
SwLayoutFrameGetNextSctLeaf (MakePageType eMakePage)
 Returns the next layout sheet where the frame can be moved in. More...
SwLayoutFrameGetNextFlyLeaf (MakePageType eMakePage)
SwLayoutFrameGetPrevLeaf ()
 Returns the previous layout leaf where we can move the frame. More...
SwLayoutFrameGetPrevFootnoteLeaf (MakePageType eMakeFootnote)
 Get the preceding layout leaf in that the frame can be moved. More...
SwLayoutFrameGetPrevSctLeaf ()
 Returns the preceding layout sheet where the frame can be moved into. More...
SwLayoutFrameGetPrevFlyLeaf ()
const SwLayoutFrameGetLeaf (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 SwSortedObjsGetDrawObjs () const
SwSortedObjsGetDrawObjs ()
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::BaseProcessor2DCreateProcessor2D () 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
SwFrameGetNext ()
SwFrameGetPrev ()
SwLayoutFrameGetUpper ()
SwRootFramegetRootFrame ()
SwPageFrameFindPageFrame ()
SwFrameGetLower ()
const SwFrameGetNext () const
const SwFrameGetPrev () const
const SwLayoutFrameGetUpper () const
const SwRootFramegetRootFrame () const
SwTabFrameFindTabFrame ()
SwFootnoteFrameFindFootnoteFrame ()
SwFlyFrameFindFlyFrame ()
SwSectionFrameFindSctFrame ()
SwFrameFindNext ()
SwContentFrameFindNextCnt (const bool _bInSameFootnote=false)
SwFrameFindPrev ()
const SwPageFrameFindPageFrame () const
const SwFootnoteBossFrameFindFootnoteBossFrame (bool bFootnote=false) const
const SwFrameFindColFrame () const
const SwFrameFindFooterOrHeader () const
const SwTabFrameFindTabFrame () const
const SwFootnoteFrameFindFootnoteFrame () const
const SwFlyFrameFindFlyFrame () const
const SwSectionFrameFindSctFrame () const
const SwBodyFrameFindBodyFrame () const
const SwFrameFindNext () const
const SwContentFrameFindNextCnt (const bool _bInSameFootnote=false) const
const SwFrameFindPrev () const
const SwFrameGetLower () const
SwContentFrameFindPrevCnt ()
const SwContentFrameFindPrevCnt () const
SwFrameGetIndPrev_ () 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...
SwFrameGetIndPrev () const
SwFrameGetIndNext ()
const SwFrameGetIndNext () 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 SwLayoutFrameGetPrevLayoutLeaf () const
const SwLayoutFrameGetNextLayoutLeaf () const
SwLayoutFrameGetPrevLayoutLeaf ()
SwLayoutFrameGetNextLayoutLeaf ()
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
SwLayoutFrameGetNextCellLeaf ()
SwLayoutFrameGetPrevCellLeaf ()
void SetInfFlags ()
const SwRowFrameIsInSplitTableRow () const
const SwRowFrameIsInFollowFlowRow () const
bool IsInBalancedSection () const
bool IsMoveable (const SwLayoutFrame *_pLayoutFrame=nullptr) const
 determine, if frame is moveable in given environment More...
const SwAttrSetGetAttrSet () const
 WARNING: this may not return correct RES_PAGEDESC/RES_BREAK items for SwTextFrame, use GetBreakItem()/GetPageDescItem() instead. More...
virtual const SvxFormatBreakItemGetBreakItem () const
virtual const SwFormatPageDescGetPageDescItem () const
SwFrameFindColFrame ()
SwRowFrameFindRowFrame ()
SwFootnoteBossFrameFindFootnoteBossFrame (bool bFootnotes=false)
SwTabFrameImplFindTabFrame ()
SwFootnoteFrameImplFindFootnoteFrame ()
SwFlyFrameImplFindFlyFrame ()
SwSectionFrameImplFindSctFrame ()
const SwBodyFrameImplFindBodyFrame () const
SwFrameFindFooterOrHeader ()
void ImplInvalidateNextPos (bool bNoFootnote)
void InvalidateNextPrtArea ()
 method to invalidate printing area of next frame #i11859# More...
SwTextFrameDynCastTextFrame ()
const SwTextFrameDynCastTextFrame () 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 SwRectgetFrameArea () const
const SwRectgetFramePrintArea () 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::ModifyChangedHintCheckRegistration (const SfxPoolItem *pOldValue)
void CheckRegistrationFormat (SwFormat &rOld)
const SwModifyGetRegisteredIn () const
SwModifyGetRegisteredIn ()
void EndListeningAll ()
void StartListeningToSameModifyAs (const SwClient &)
virtual bool GetInfo (SfxPoolItem &) const
- Public Member Functions inherited from sw::WriterListener
bool IsLast () const
virtual const SwCellFrameDynCastCellFrame () const
virtual const SwTabFrameDynCastTabFrame () const
virtual const SwRowFrameDynCastRowFrame () const
virtual const SwTableDynCastTable () 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
- Public Member Functions inherited from SvtListener
 SvtListener ()=default
 SvtListener (const SvtListener &r)=default
virtual ~SvtListener () COVERITY_NOEXCEPT_FALSE
bool StartListening (SvtBroadcaster &rBroadcaster)
void EndListening (SvtBroadcaster &rBroadcaster)
void EndListeningAll ()
void CopyAllBroadcasters (const SvtListener &r)
bool HasBroadcaster () const
virtual void Notify (const SfxHint &rHint)
virtual void Query (QueryBase &rQuery) const

Static Public Member Functions

static void MoveContentAndDelete (SwSectionFrame *pDel, bool bSave)
- Static Public Member Functions inherited from SwFrame
static SwCacheGetCache ()
static SwCacheGetCachePtr ()
static void SetCache (SwCache *pNew)
static void CheckPageDescs (SwPageFrame *pStart, bool bNotifyFields=true, SwPageFrame **ppPrev=nullptr)
 Check all pages (starting from the given one) if they use the appropriate frame format. More...
static void DestroyFrame (SwFrame *const pFrame)
 this is the only way to delete a SwFrame instance More...

Private Member Functions

void UpdateAttr_ (const SfxPoolItem *, const SfxPoolItem *, SwSectionFrameInvFlags &, SwAttrSetChg *pa=nullptr, SwAttrSetChg *pb=nullptr)
void Cut_ (bool bRemove)
bool IsSuperfluous () const
void CalcFootnoteAtEndFlag ()
void CalcEndAtEndFlag ()
const SwSectionFormatGetEndSectFormat_ () const
bool IsEndnoteAtMyEnd () const
virtual void DestroyImpl () override
virtual ~SwSectionFrame () override
virtual void MakeAll (vcl::RenderContext *pRenderContext) override
virtual bool ShouldBwdMoved (SwLayoutFrame *pNewUpper, bool &rReformat) override
virtual void Format (vcl::RenderContext *pRenderContext, const SwBorderAttrs *pAttrs=nullptr) override
 "formats" the frame; Frame and PrtArea More...
virtual void Notify (SfxHint const &rHint) override
virtual void SwClientNotify (const SwModify &, const SfxHint &) override

Private Attributes

bool m_bFootnoteAtEnd
bool m_bEndnAtEnd
bool m_bContentLock
bool m_bOwnFootnoteNum
bool m_bFootnoteLock

Additional Inherited Members

- Protected Types inherited from SwFrame
enum  InvalidationType {
 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)
SwPageFrameInsertPage (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 IDocumentDrawModelAccessgetIDocumentDrawModelAccess ()
- 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)
SwModifyGetRegisteredInNonConst () 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
std::vector< SwAnchoredObject * > m_VertPosOrientFramesFor
- Protected Attributes inherited from SwFrame
std::unique_ptr< SwSortedObjsm_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

Definition at line 49 of file sectfrm.hxx.

Constructor & Destructor Documentation

◆ ~SwSectionFrame()

SwSectionFrame::~SwSectionFrame ( )

Definition at line 188 of file sectfrm.cxx.

◆ SwSectionFrame() [1/2]

SwSectionFrame::SwSectionFrame ( SwSection rSect,
SwFrame pSib 

◆ SwSectionFrame() [2/2]

SwSectionFrame::SwSectionFrame ( SwSectionFrame rSect,
bool  bMaster 

Member Function Documentation

◆ CalcEndAtEndFlag()

void SwSectionFrame::CalcEndAtEndFlag ( )

◆ CalcFootnoteAtEndFlag()

void SwSectionFrame::CalcFootnoteAtEndFlag ( )

◆ CalcFootnoteContent()

void SwSectionFrame::CalcFootnoteContent ( )

◆ CalcMinDiff()

bool SwSectionFrame::CalcMinDiff ( SwTwips rMinDiff) const

◆ CalcUndersize()

SwTwips SwSectionFrame::CalcUndersize ( ) const

◆ CheckClipping()

void SwSectionFrame::CheckClipping ( bool  bGrow,
bool  bMaximize 

Adapt size to surroundings.

Fits the size to the surroundings.

|* |* Those that have a Follow or foot notes, have to extend until |* the lower edge of a upper (bMaximize) |* They must not extend above the Upper, as the case may be one can |* try to grow its upper (bGrow) |* If the size had to be changed, the content is calculated. |* |*

: perform calculation of content, only if height has changed (OD 18.09.2002 #100522#) |

Definition at line 1097 of file sectfrm.cxx.

References SwRectFnSet::BottomDist(), CalcContent(), SwLayoutFrame::ChgLowersProp(), SwLayoutFrame::ContainsAny(), SwFrame::FindFlyFrame(), SwFrame::FindFootnoteBossFrame(), FindLastContent(), GetFollow(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwRectFnSet::GetHeight(), SwRectFnSet::GetPrtBottom(), SwRectFnSet::GetTop(), SwRectFnSet::GetTopMargin(), SwFrame::GetUpper(), SwFrame::Grow(), Size::Height(), SwRect::Height(), IsAnyNoteAtEnd(), SwLayoutFrame::IsBefore(), SwFrame::IsColBodyFrame(), SwFrame::IsColumnFrame(), IsContentLocked(), IsEndnAtEnd(), SwFrame::IsInFly(), SwFrame::IsInFootnote(), SwRectFnSet::IsVert(), LastCnt, lcl_ColumnRefresh(), lcl_FindEndnote(), SwLayoutFrame::Lower(), SwRectFnSet::SetBottom(), SwRectFnSet::SetYMargins(), SSize, Undersize(), Size::Width(), SwRect::Width(), and SwRectFnSet::YDiff().

Referenced by Format().

◆ CheckDirection()

void SwSectionFrame::CheckDirection ( bool  bVert)

◆ CollectEndnotes()

void SwSectionFrame::CollectEndnotes ( SwLayouter pLayouter)

◆ ColLock()

void SwSectionFrame::ColLock ( )

◆ ColUnlock()

void SwSectionFrame::ColUnlock ( )

◆ ContainsFootnoteCont()

SwFootnoteContFrame * SwSectionFrame::ContainsFootnoteCont ( const SwFootnoteContFrame pCont = nullptr) const

◆ Cut()

void SwSectionFrame::Cut ( )

Reimplemented from SwLayoutFrame.

Definition at line 260 of file sectfrm.cxx.

References Cut_().

Referenced by MergeNext(), and SwFootnoteBossFrame::RearrangeFootnotes().

◆ Cut_()

void SwSectionFrame::Cut_ ( bool  bRemove)

◆ DelEmpty()

void SwSectionFrame::DelEmpty ( bool  bRemove)

◆ DestroyImpl()

void SwSectionFrame::DestroyImpl ( )

◆ dumpAsXml()

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

Implements SwFrame.

Definition at line 2959 of file sectfrm.cxx.

References dumpAsXmlAttributes(), SwFrame::dumpChildrenAsXml(), and SwFrame::dumpInfosAsXml().

◆ dumpAsXmlAttributes()

void SwSectionFrame::dumpAsXmlAttributes ( xmlTextWriterPtr  writer) const

Reimplemented from SwFrame.

Definition at line 327 of file xmldump.cxx.

References SwFrame::dumpAsXmlAttributes(), GetFollow(), and SwFrameAreaDefinition::GetFrameId().

Referenced by dumpAsXml().

◆ FindLastContent() [1/2]

const SwContentFrame * SwSectionFrame::FindLastContent ( ) const

Definition at line 182 of file sectfrm.hxx.

References FindLastContent().

Referenced by CheckClipping(), and FindLastContent().

◆ FindLastContent() [2/2]

SwContentFrame * SwSectionFrame::FindLastContent ( SwFindMode  nMode = SwFindMode::None)

◆ FindMaster()

SwSectionFrame * SwSectionFrame::FindMaster ( ) const

◆ Format()

void SwSectionFrame::Format ( vcl::RenderContext pRenderContext,
const SwBorderAttrs pAttrs = nullptr 

"formats" the frame; Frame and PrtArea

Reimplemented from SwLayoutFrame.

Definition at line 1359 of file sectfrm.cxx.

References SwRectFnSet::AddBottom(), SwLayoutFrame::AdjustColumns(), AdjustSizeWithoutFormatting, SwFrame::Calc(), CalcContent(), CalcFootnoteContent(), CheckClipping(), ColLock(), ColUnlock(), CONSIDER_WRAP_ON_OBJECT_POSITION, SwLayoutFrame::ContainsAny(), SwLayoutFrame::ContainsContent(), DelEmpty(), SwFrame::FindFlyFrame(), SwLayoutFrame::FormatWidthCols(), sw::proofreadingiterator::get(), SwRectFnSet::GetBottom(), SwViewOption::getBrowseMode(), SwRootFrame::GetCurrShell(), GetFollow(), SwLayoutFrame::GetFormat(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwRectFnSet::GetHeight(), SvxLRSpaceItem::GetLeft(), SwFormat::GetLRSpace(), SwFrame::GetNext(), SwRectFnSet::GetPrtBottom(), SvxLRSpaceItem::GetRight(), SwFrame::getRootFrame(), SwRectFnSet::GetTopMargin(), SwFrame::GetUpper(), GetValue, SwViewShell::GetViewOptions(), SwRectFnSet::GetWidth(), SwFrame::Grow(), SwLayoutFrame::InnerHeight(), SwFrame::InvalidateNextPos(), SwFrame::InvalidatePos_(), SwFrame::InvalidateSize_(), SwFrame::IsColLocked(), SwFrame::IsColumnFrame(), IsContentLocked(), SwFrame::IsFooterFrame(), SwFrameAreaDefinition::isFrameAreaDefinitionValid(), SwFrameAreaDefinition::isFrameAreaSizeValid(), SwFrameAreaDefinition::isFramePrintAreaValid(), SwFrame::IsInFly(), SwFrame::IsTextFrame(), SwLayoutFrame::Lower(), SwLayoutFrame::m_pLower, m_pSection, MINLAY, NONE, SwFrame::Prepare(), PrintArea, PROTOCOL, PROTOCOL_ENTER, SwFrameAreaDefinition::setFrameAreaPositionValid(), SwFrameAreaDefinition::setFrameAreaSizeValid(), SwFrameAreaDefinition::setFramePrintAreaValid(), SwFrame::SetRetouche(), SwRectFnSet::SetWidth(), SwRectFnSet::SetXMargins(), SwRectFnSet::SetYMargins(), SwFrame::Shrink(), Size, ToMaximize(), SwRectFnSet::YDiff(), and SwRectFnSet::YInc().

◆ GetEndSectFormat()

const SwSectionFormat * SwSectionFrame::GetEndSectFormat ( ) const

Definition at line 149 of file sectfrm.hxx.

References GetEndSectFormat_(), and IsEndnAtEnd().

Referenced by FindLastContent(), and SwFootnoteBossFrame::InsertFootnote().

◆ GetEndSectFormat_()

const SwSectionFormat * SwSectionFrame::GetEndSectFormat_ ( ) const

◆ GetFollow() [1/2]

SwSectionFrame * SwSectionFrame::GetFollow ( )

Definition at line 178 of file sectfrm.hxx.

◆ GetFollow() [2/2]

const SwSectionFrame * SwSectionFrame::GetFollow ( ) const

◆ GetSection() [1/2]

SwSection * SwSectionFrame::GetSection ( )

◆ GetSection() [2/2]

const SwSection * SwSectionFrame::GetSection ( ) const

Definition at line 98 of file sectfrm.hxx.

References m_pSection.

◆ Grow_()

SwTwips SwSectionFrame::Grow_ ( SwTwips  nDist,
bool  bTst 

◆ Growable()

bool SwSectionFrame::Growable ( ) const

◆ HasToBreak()

bool SwSectionFrame::HasToBreak ( const SwFrame pFrame) const

|* Here it's decided whether the this-SectionFrame should break up |* the passed (Section)frm (or not).

|* Initially, all superior sections are broken up. Later on that could |* be made configurable. |

Definition at line 453 of file sectfrm.cxx.

References SwLayoutFrame::GetFormat(), SwSectionFormat::GetParent(), and SwFrame::IsSctFrame().

Referenced by Paste().

◆ Init()

void SwSectionFrame::Init ( void  )

◆ InvalidateFootnotePos()

void SwSectionFrame::InvalidateFootnotePos ( )

◆ IsAnyNoteAtEnd()

bool SwSectionFrame::IsAnyNoteAtEnd ( ) const

Definition at line 163 of file sectfrm.hxx.

References m_bEndnAtEnd, and m_bFootnoteAtEnd.

Referenced by CheckClipping(), Init(), and sw_RemoveFootnotes().

◆ IsBalancedSection()

bool SwSectionFrame::IsBalancedSection ( ) const

◆ IsContentLocked()

bool SwSectionFrame::IsContentLocked ( ) const

Definition at line 166 of file sectfrm.hxx.

References m_bContentLock.

Referenced by CheckClipping(), and Format().

◆ IsDescendantFrom()

bool SwSectionFrame::IsDescendantFrom ( const SwSectionFormat pSect) const

Definition at line 2539 of file sectfrm.cxx.

References SwSection::GetFormat(), and m_pSection.

Referenced by FindLastContent(), and SwFootnoteBossFrame::InsertFootnote().

◆ IsEndnAtEnd()

bool SwSectionFrame::IsEndnAtEnd ( ) const

◆ IsEndnoteAtMyEnd()

bool SwSectionFrame::IsEndnoteAtMyEnd ( ) const

◆ IsFootnoteAtEnd()

bool SwSectionFrame::IsFootnoteAtEnd ( ) const

◆ IsFootnoteLock()

bool SwSectionFrame::IsFootnoteLock ( ) const

Definition at line 171 of file sectfrm.hxx.

References m_bFootnoteLock.

Referenced by SwFrame::GetPrevFootnoteLeaf(), and SwContentFrame::ShouldBwdMoved().

◆ IsOwnFootnoteNum()

bool SwSectionFrame::IsOwnFootnoteNum ( ) const

Definition at line 168 of file sectfrm.hxx.

References m_bOwnFootnoteNum.

Referenced by SwPageFrame::UpdateFootnoteNum().

◆ IsSuperfluous()

bool SwSectionFrame::IsSuperfluous ( ) const

Definition at line 64 of file sectfrm.hxx.

References SwLayoutFrame::ContainsAny(), and ContainsFootnoteCont().

Referenced by MakeAll(), and ToMaximize().

◆ MakeAll()

void SwSectionFrame::MakeAll ( vcl::RenderContext pRenderContext)

◆ MergeNext()

void SwSectionFrame::MergeNext ( SwSectionFrame pNxt)

|* Merges two SectionFrames, in case it's about the same section.

|* This can be necessary when a (sub)section is deleted that had |* divided another part into two. |

Definition at line 476 of file sectfrm.cxx.

References Cut(), SwFrame::DestroyFrame(), GetFollow(), SwFrame::GetNext(), GetSection(), SwFrame::InvalidateSize(), SwFrame::IsColumnFrame(), SwFrame::IsDeleteForbidden(), SwLayoutFrame::Lower(), Merge, PROTOCOL, SwLayoutFrame::RestoreContent, SwLayoutFrame::SaveContent, and Section.

Referenced by MakeAll(), and MoveContentAndDelete().

◆ MoveAllowed()

bool SwSectionFrame::MoveAllowed ( const SwFrame pFrame) const

◆ MoveContentAndDelete()

void SwSectionFrame::MoveContentAndDelete ( SwSectionFrame pDel,
bool  bSave 

◆ Notify()

void SwSectionFrame::Notify ( SfxHint const &  rHint)

Reimplemented from SvtListener.

Definition at line 2596 of file sectfrm.cxx.

References SwLayoutFrame::GetFormat(), GetSection(), and SwClientNotify().

◆ PaintSubsidiaryLines()

void SwSectionFrame::PaintSubsidiaryLines ( const SwPageFrame pPage,
const SwRect rRect 
) const

◆ Paste()

void SwSectionFrame::Paste ( SwFrame pParent,
SwFrame pSibling = nullptr 

◆ SetContentLock()

void SwSectionFrame::SetContentLock ( bool  bNew)

Definition at line 165 of file sectfrm.hxx.

References m_bContentLock.

◆ SetFootnoteLock()

void SwSectionFrame::SetFootnoteLock ( bool  bNew)

Definition at line 170 of file sectfrm.hxx.

References m_bFootnoteLock.

◆ ShouldBwdMoved()

bool SwSectionFrame::ShouldBwdMoved ( SwLayoutFrame pNewUpper,
bool &  rReformat 

Definition at line 886 of file sectfrm.cxx.

◆ Shrink_()

SwTwips SwSectionFrame::Shrink_ ( SwTwips  nDist,
bool  bTst 

◆ SimpleFormat()

void SwSectionFrame::SimpleFormat ( )

◆ SplitSect()

SwSectionFrame * SwSectionFrame::SplitSect ( SwFrame pFrameStartAfter,
SwFrame pFramePutAfter 

Splits the SectionFrame surrounding the pFrame up in two parts: pFrame and the start of the 2nd part.

|* Divides a SectionFrame into two parts.

The content of the second one |* starts after pFrameStartAfter; the created second section frame itself |* is put after pFramePutAfter. |* If pFrameStartAfter is nullptr, the split happens at the start. |* This is required when inserting an inner section, because the MoveFwd |* cannot have the desired effect within a frame or a table cell. |* Splitting at the start/end makes sense, because the empty frame would |* be removed after the InsertCnt_ finished. |

Definition at line 523 of file sectfrm.cxx.

References SwLayoutFrame::ContainsAny(), SwFrame::FindNext(), GetFollow(), GetSection(), SwFrame::GetUpper(), Init(), SwFrame::InsertBehind(), SwFrame::InvalidateSize_(), SwLayoutFrame::IsAnLower(), SwFrame::IsLayoutFrame(), SwLayoutFrame::Lower(), SwRectFnSet::MakePos(), SwLayoutFrame::RestoreContent, SwLayoutFrame::SaveContent, and SwSectionFrame().

◆ SwClientNotify()

void SwSectionFrame::SwClientNotify ( const SwModify rMod,
const SfxHint rHint 

◆ ToMaximize()

bool SwSectionFrame::ToMaximize ( bool  bCheckFollow) const

A sectionfrm has to maximize, if he has a follow or a ftncontainer at the end of the page.

A follow or a ftncontainer at the end of the page causes a maximal Size of the sectionframe.

A superfluous follow will be ignored, if bCheckFollow is set.

Definition at line 2773 of file sectfrm.cxx.

References ContainsFootnoteCont(), SwFootnoteContFrame::FindFootNote(), GetFollow(), IsEndnAtEnd(), IsFootnoteAtEnd(), and IsSuperfluous().

Referenced by CalcMinDiff(), SwFootnoteFrame::Cut(), Format(), SwFootnoteContFrame::GrowFrame(), MakeAll(), Shrink_(), and ToMaximize_().

◆ ToMaximize_()

bool SwSectionFrame::ToMaximize_ ( ) const

Definition at line 125 of file sectfrm.hxx.

References m_pSection, and ToMaximize().

Referenced by SwLayoutFrame::ChgLowersProp().

◆ Undersize()

SwTwips SwSectionFrame::Undersize ( )

Returns the size delta that the section would like to be greater if it has undersized TextFrames in it.

The return value is > 0 for undersized Frames, or 0 otherwise.

If necessary the undersized-flag is corrected. We need this in the FormatWidthCols to "deflate" columns there.

Definition at line 2848 of file sectfrm.cxx.

References CalcUndersize().

Referenced by SwFlyFrame::CalcContentHeight(), CheckClipping(), SwLayoutFrame::Format(), SwHeadFootFrame::FormatSize(), and lcl_CalcCellRstHeight().

◆ UpdateAttr_()

void SwSectionFrame::UpdateAttr_ ( const SfxPoolItem pOld,
const SfxPoolItem pNew,
SwSectionFrameInvFlags rInvFlags,
SwAttrSetChg pa = nullptr,
SwAttrSetChg pb = nullptr 

Member Data Documentation

◆ m_bContentLock

bool SwSectionFrame::m_bContentLock

Definition at line 55 of file sectfrm.hxx.

Referenced by IsContentLocked(), and SetContentLock().

◆ m_bEndnAtEnd

bool SwSectionFrame::m_bEndnAtEnd

Definition at line 54 of file sectfrm.hxx.

Referenced by CalcEndAtEndFlag(), IsAnyNoteAtEnd(), and IsEndnAtEnd().

◆ m_bFootnoteAtEnd

bool SwSectionFrame::m_bFootnoteAtEnd

Definition at line 53 of file sectfrm.hxx.

Referenced by CalcFootnoteAtEndFlag(), IsAnyNoteAtEnd(), and IsFootnoteAtEnd().

◆ m_bFootnoteLock

bool SwSectionFrame::m_bFootnoteLock

Definition at line 57 of file sectfrm.hxx.

Referenced by IsFootnoteLock(), and SetFootnoteLock().

◆ m_bOwnFootnoteNum

bool SwSectionFrame::m_bOwnFootnoteNum

Definition at line 56 of file sectfrm.hxx.

Referenced by CalcFootnoteAtEndFlag(), and IsOwnFootnoteNum().

◆ m_pSection

SwSection* SwSectionFrame::m_pSection

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