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

Represents one footnote or endnote in the layout. More...

#include <ftnfrm.hxx>

Inheritance diagram for SwFootnoteFrame:
[legend]
Collaboration diagram for SwFootnoteFrame:
[legend]

Public Member Functions

 SwFootnoteFrame (SwFrameFormat *, SwFrame *, SwContentFrame *, SwTextFootnote *)
 
virtual bool IsDeleteForbidden () const override
 
virtual void Cut () override
 
virtual void Paste (SwFrame *pParent, SwFrame *pSibling=nullptr) override
 
virtual void PaintSubsidiaryLines (const SwPageFrame *, const SwRect &) const override
 This method is overridden in order to have no subsidiary lines around the footnotes. More...
 
bool operator< (const SwTextFootnote *pTextFootnote) const
 
const SwContentFrameGetRef () const
 
SwContentFrameGetRef ()
 
const SwContentFrameGetRefFromAttr () const
 
SwContentFrameGetRefFromAttr ()
 
const SwFootnoteFrameGetFollow () const
 
SwFootnoteFrameGetFollow ()
 
const SwFootnoteFrameGetMaster () const
 
SwFootnoteFrameGetMaster ()
 
const SwTextFootnoteGetAttr () const
 
SwTextFootnoteGetAttr ()
 
void SetFollow (SwFootnoteFrame *pNew)
 
void SetMaster (SwFootnoteFrame *pNew)
 
void SetRef (SwContentFrame *pNew)
 
void InvalidateNxtFootnoteCnts (SwPageFrame const *pPage)
 
void LockBackMove ()
 
void UnlockBackMove ()
 
bool IsBackMoveLocked () const
 
void ColLock ()
 
void ColUnlock ()
 
void UnlockPosOfLowerObjs ()
 
void KeepLockPosOfLowerObjs ()
 
bool IsUnlockPosOfLowerObjs () const
 
SwContentFrameFindLastContent ()
 search for last content in the current footnote frame More...
 
void dumpAsXml (xmlTextWriterPtr writer=nullptr) const override
 
- 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
 

Private Attributes

SwFootnoteFramempFollow
 
SwFootnoteFramempMaster
 
SwContentFramempReference
 
SwTextFootnotempAttribute
 
bool mbBackMoveLocked: 1
 
bool mbUnlockPosOfLowerObjs: 1
 

Additional Inherited Members

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

Represents one footnote or endnote in the layout.

Typical upper is an SwFootnoteContFrame, typical lower is an SwTextFrame.

Definition at line 83 of file ftnfrm.hxx.

Constructor & Destructor Documentation

◆ SwFootnoteFrame()

SwFootnoteFrame::SwFootnoteFrame ( SwFrameFormat pFormat,
SwFrame pSib,
SwContentFrame pCnt,
SwTextFootnote pAt 
)

Definition at line 485 of file ftnfrm.cxx.

References Ftn, and SwFrame::mnFrameType.

Member Function Documentation

◆ ColLock()

void SwFootnoteFrame::ColLock ( )
inline

◆ ColUnlock()

void SwFootnoteFrame::ColUnlock ( )
inline

◆ Cut()

void SwFootnoteFrame::Cut ( )
overridevirtual

◆ dumpAsXml()

void SwFootnoteFrame::dumpAsXml ( xmlTextWriterPtr  writer = nullptr) const
overridevirtual

◆ FindLastContent()

SwContentFrame * SwFootnoteFrame::FindLastContent ( )

search for last content in the current footnote frame

OD 2005-12-02 #i27138#

Returns
SwContentFrame* pointer to found last content frame. NULL, if none is found.

OD 2005-12-02 #i27138#

Definition at line 2949 of file ftnfrm.cxx.

References SwLayoutFrame::ContainsContent(), FindLastContent(), SwFrame::GetLower(), SwFrame::GetNext(), SwSectionFrame::GetSection(), SwTextFrame::IsHiddenNow(), SwFrame::IsSctFrame(), SwFrame::IsTabFrame(), and SwFrame::IsTextFrame().

Referenced by FindLastContent(), and SwFrame::FindPrevCnt_().

◆ GetAttr() [1/2]

SwTextFootnote * SwFootnoteFrame::GetAttr ( void  )
inline

Definition at line 127 of file ftnfrm.hxx.

References mpAttribute.

◆ GetAttr() [2/2]

const SwTextFootnote * SwFootnoteFrame::GetAttr ( void  ) const
inline

◆ GetFollow() [1/2]

SwFootnoteFrame * SwFootnoteFrame::GetFollow ( )
inline

Definition at line 121 of file ftnfrm.hxx.

References mpFollow.

◆ GetFollow() [2/2]

const SwFootnoteFrame * SwFootnoteFrame::GetFollow ( ) const
inline

◆ GetMaster() [1/2]

SwFootnoteFrame * SwFootnoteFrame::GetMaster ( )
inline

Definition at line 124 of file ftnfrm.hxx.

References mpMaster.

◆ GetMaster() [2/2]

const SwFootnoteFrame * SwFootnoteFrame::GetMaster ( ) const
inline

◆ GetRef() [1/2]

SwContentFrame * SwFootnoteFrame::GetRef ( )

Definition at line 2919 of file ftnfrm.cxx.

References GetRefFromAttr(), and mpReference.

◆ GetRef() [2/2]

const SwContentFrame * SwFootnoteFrame::GetRef ( ) const

◆ GetRefFromAttr() [1/2]

SwContentFrame * SwFootnoteFrame::GetRefFromAttr ( )

◆ GetRefFromAttr() [2/2]

const SwContentFrame * SwFootnoteFrame::GetRefFromAttr ( ) const

Definition at line 2930 of file ftnfrm.cxx.

References GetRefFromAttr().

Referenced by SwContentNode::DelFrames(), GetRef(), and GetRefFromAttr().

◆ InvalidateNxtFootnoteCnts()

void SwFootnoteFrame::InvalidateNxtFootnoteCnts ( SwPageFrame const *  pPage)

◆ IsBackMoveLocked()

bool SwFootnoteFrame::IsBackMoveLocked ( ) const
inline

◆ IsDeleteForbidden()

bool SwFootnoteFrame::IsDeleteForbidden ( ) const
overridevirtual

◆ IsUnlockPosOfLowerObjs()

bool SwFootnoteFrame::IsUnlockPosOfLowerObjs ( ) const
inline

Definition at line 152 of file ftnfrm.hxx.

References mbUnlockPosOfLowerObjs.

◆ KeepLockPosOfLowerObjs()

void SwFootnoteFrame::KeepLockPosOfLowerObjs ( )
inline

◆ LockBackMove()

void SwFootnoteFrame::LockBackMove ( )
inline

◆ operator<()

bool SwFootnoteFrame::operator< ( const SwTextFootnote pTextFootnote) const

◆ PaintSubsidiaryLines()

void SwFootnoteFrame::PaintSubsidiaryLines ( const SwPageFrame ,
const SwRect  
) const
overridevirtual

This method is overridden in order to have no subsidiary lines around the footnotes.

Reimplemented from SwLayoutFrame.

Definition at line 7249 of file paintfrm.cxx.

◆ Paste()

void SwFootnoteFrame::Paste ( SwFrame pParent,
SwFrame pSibling = nullptr 
)
overridevirtual

◆ SetFollow()

void SwFootnoteFrame::SetFollow ( SwFootnoteFrame pNew)
inline

Definition at line 129 of file ftnfrm.hxx.

References mpFollow.

Referenced by SwFootnoteContFrame::AddChained(), and Cut().

◆ SetMaster()

void SwFootnoteFrame::SetMaster ( SwFootnoteFrame pNew)
inline

Definition at line 130 of file ftnfrm.hxx.

References mpMaster.

Referenced by SwFootnoteContFrame::AddChained(), and Cut().

◆ SetRef()

void SwFootnoteFrame::SetRef ( SwContentFrame pNew)
inline

◆ UnlockBackMove()

void SwFootnoteFrame::UnlockBackMove ( )
inline

◆ UnlockPosOfLowerObjs()

void SwFootnoteFrame::UnlockPosOfLowerObjs ( )
inline

Member Data Documentation

◆ mbBackMoveLocked

bool SwFootnoteFrame::mbBackMoveLocked
private

Definition at line 95 of file ftnfrm.hxx.

Referenced by IsBackMoveLocked(), LockBackMove(), and UnlockBackMove().

◆ mbUnlockPosOfLowerObjs

bool SwFootnoteFrame::mbUnlockPosOfLowerObjs
private

Definition at line 97 of file ftnfrm.hxx.

Referenced by IsUnlockPosOfLowerObjs(), KeepLockPosOfLowerObjs(), and UnlockPosOfLowerObjs().

◆ mpAttribute

SwTextFootnote* SwFootnoteFrame::mpAttribute
private

Definition at line 92 of file ftnfrm.hxx.

Referenced by GetAttr(), and GetRefFromAttr().

◆ mpFollow

SwFootnoteFrame* SwFootnoteFrame::mpFollow
private

Definition at line 89 of file ftnfrm.hxx.

Referenced by GetFollow(), and SetFollow().

◆ mpMaster

SwFootnoteFrame* SwFootnoteFrame::mpMaster
private

Definition at line 90 of file ftnfrm.hxx.

Referenced by GetMaster(), and SetMaster().

◆ mpReference

SwContentFrame* SwFootnoteFrame::mpReference
private

Definition at line 91 of file ftnfrm.hxx.

Referenced by GetRef(), and SetRef().


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