LibreOffice Module sw (master)  1
flyfrm.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #ifndef INCLUDED_SW_SOURCE_CORE_INC_FLYFRM_HXX
21 #define INCLUDED_SW_SOURCE_CORE_INC_FLYFRM_HXX
22 
23 #include "layfrm.hxx"
24 #include <vector>
25 #include <frmfmt.hxx>
26 #include <anchoredobject.hxx>
27 #include <swdllapi.h>
28 
29 class SwFormatAnchor;
30 class SwPageFrame;
31 class SwFormatFrameSize;
32 struct SwCursorMoveState;
33 class SwBorderAttrs;
34 class SwVirtFlyDrawObj;
35 class SwAttrSetChg;
36 namespace tools { class PolyPolygon; }
37 class SwFormat;
38 class SwViewShell;
39 class SwFEShell;
40 class SwWrtShell;
41 
42 
50 const SwContentFrame *FindAnchor( const SwFrame *pOldAnch, const Point &rNew,
51  const bool bBody = false );
52 
54 bool CalcClipRect( const SdrObject *pSdrObj, SwRect &rRect, bool bMove = true );
55 
61 {
62  // is allowed to lock, implemented in frmtool.cxx
63  friend void AppendObj(SwFrame *const pFrame, SwPageFrame *const pPage, SwFrameFormat *const pFormat, const SwFormatAnchor & rAnch);
64  friend void Notify( SwFlyFrame *, SwPageFrame *pOld, const SwRect &rOld,
65  const SwRect* pOldPrt );
66 
67  void InitDrawObj(); // these to methods are called in the
68  void FinitDrawObj(); // constructors
69 
70  void UpdateAttr_( const SfxPoolItem*, const SfxPoolItem*, sal_uInt8 &,
71  SwAttrSetChg *pa = nullptr, SwAttrSetChg *pb = nullptr );
72 
74 
75 protected:
76  // Predecessor/Successor for chaining with text flow
77  SwFlyFrame *m_pPrevLink, *m_pNextLink;
78 
79 private:
80  // It must be possible to block Content-bound flys so that they will be not
81  // formatted; in this case MakeAll() returns immediately. This is necessary
82  // for page changes during formatting. In addition, it is needed during
83  // the constructor call of the root object since otherwise the anchor will
84  // be formatted before the root is anchored correctly to a shell and
85  // because too much would be formatted as a result.
86  bool m_bLocked :1;
87  // true if the background of NotifyDTor needs to be notified at the end
88  // of a MakeAll() call.
89  bool m_bNotifyBack :1;
90 
91 protected:
92  // Pos, PrtArea or SSize have been invalidated - they will be evaluated
93  // again immediately because they have to be valid _at all time_.
94  // The invalidation is tracked here so that LayAction knows about it and
95  // can handle it properly. Exceptions prove the rule.
96  bool m_bInvalid :1;
97 
98  // true if the proposed height of an attribute is a minimal height
99  // (this means that the frame can grow higher if needed)
100  bool m_bMinHeight :1;
101  // true if the fly frame could not format position/size based on its
102  // attributes, e.g. because there was not enough space.
103  bool m_bHeightClipped :1;
104  bool m_bWidthClipped :1;
105  // If true then call only the format after adjusting the width (CheckClip);
106  // but the width will not be re-evaluated based on the attributes.
107  bool m_bFormatHeightOnly :1;
108 
109  bool m_bInCnt :1;
110  bool m_bAtCnt :1;
111  bool m_bLayout :1;
112  bool m_bAutoPosition :1;
113 
114  friend class SwNoTextFrame; // is allowed to call NotifyBackground
115 
116  Point m_aContentPos; // content area's position relatively to Frame
118 
119  virtual void Format( vcl::RenderContext* pRenderContext, const SwBorderAttrs *pAttrs = nullptr ) override;
120  void MakePrtArea( const SwBorderAttrs &rAttrs );
121  void MakeContentPos( const SwBorderAttrs &rAttrs );
122 
123  void Lock() { m_bLocked = true; }
124  void Unlock() { m_bLocked = false; }
125 
126  Size CalcRel( const SwFormatFrameSize &rSz ) const;
127 
128  SwFlyFrame( SwFlyFrameFormat*, SwFrame*, SwFrame *pAnchor );
129 
130  virtual void DestroyImpl() override;
131  virtual ~SwFlyFrame() override;
132 
136  virtual void RegisterAtCorrectPage() override;
137 
138  virtual bool SetObjTop_( const SwTwips _nTop ) override;
139  virtual bool SetObjLeft_( const SwTwips _nLeft ) override;
140 
141  virtual SwRect GetObjBoundRect() const override;
142  virtual void Modify( const SfxPoolItem*, const SfxPoolItem* ) override;
143  virtual void SwClientNotify(const SwModify& rMod, const SfxHint& rHint) override;
144 
145  virtual const IDocumentDrawModelAccess& getIDocumentDrawModelAccess( ) override;
146 
147  SwTwips CalcContentHeight(const SwBorderAttrs *pAttrs, const SwTwips nMinHeight, const SwTwips nUL);
148 
149 public:
150  // #i26791#
151 
152  // get client information
153  virtual bool GetInfo( SfxPoolItem& ) const override;
154  virtual void PaintSwFrame( vcl::RenderContext& rRenderContext, SwRect const&,
155  SwPrintData const*const pPrintData = nullptr ) const override;
156  virtual Size ChgSize( const Size& aNewSize ) override;
157  virtual bool GetCursorOfst( SwPosition *, Point&,
158  SwCursorMoveState* = nullptr, bool bTestBackground = false ) const override;
159 
160  virtual void CheckDirection( bool bVert ) override;
161  virtual void Cut() override;
162 #ifdef DBG_UTIL
163  virtual void Paste( SwFrame* pParent, SwFrame* pSibling = nullptr ) override;
164 #endif
165 
166  SwTwips Shrink_( SwTwips, bool bTst );
167  SwTwips Grow_ ( SwTwips, bool bTst );
168  void Invalidate_( SwPageFrame const *pPage = nullptr );
169 
170  bool FrameSizeChg( const SwFormatFrameSize & );
171 
172  SwFlyFrame *GetPrevLink() const { return m_pPrevLink; }
173  SwFlyFrame *GetNextLink() const { return m_pNextLink; }
174 
175  static void ChainFrames( SwFlyFrame *pMaster, SwFlyFrame *pFollow );
176  static void UnchainFrames( SwFlyFrame *pMaster, SwFlyFrame *pFollow );
177 
178  SwFlyFrame *FindChainNeighbour( SwFrameFormat const &rFormat, SwFrame *pAnch = nullptr );
179 
180  // #i26791#
181  const SwVirtFlyDrawObj* GetVirtDrawObj() const;
182  SwVirtFlyDrawObj *GetVirtDrawObj();
183  void NotifyDrawObj();
184 
185  void ChgRelPos( const Point &rAbsPos );
186  bool IsInvalid() const { return m_bInvalid; }
187  void Invalidate() const { const_cast<SwFlyFrame*>(this)->m_bInvalid = true; }
188  void Validate() const { const_cast<SwFlyFrame*>(this)->m_bInvalid = false; }
189 
190  bool IsMinHeight() const { return m_bMinHeight; }
191  bool IsLocked() const { return m_bLocked; }
192  bool IsAutoPos() const { return m_bAutoPosition; }
193  bool IsFlyInContentFrame() const { return m_bInCnt; }
194  bool IsFlyFreeFrame() const { return m_bAtCnt || m_bLayout; }
195  bool IsFlyLayFrame() const { return m_bLayout; }
196  bool IsFlyAtContentFrame() const { return m_bAtCnt; }
197 
198  bool IsNotifyBack() const { return m_bNotifyBack; }
199  void SetNotifyBack() { m_bNotifyBack = true; }
200  void ResetNotifyBack() { m_bNotifyBack = false; }
201 
202  bool IsClipped() const { return m_bHeightClipped || m_bWidthClipped; }
203  bool IsHeightClipped() const { return m_bHeightClipped; }
204 
205  bool IsLowerOf( const SwLayoutFrame* pUpper ) const;
206  bool IsUpperOf( const SwFlyFrame& _rLower ) const
207  {
208  return _rLower.IsLowerOf( this );
209  }
210 
211  SwFrame *FindLastLower();
212 
213  // #i13147# - add parameter <_bForPaint> to avoid load of
214  // the graphic during paint. Default value: false
215  bool GetContour( tools::PolyPolygon& rContour,
216  const bool _bForPaint = false ) const;
217 
218  // Paint on this shell (consider Preview, print flag, etc. recursively)?
219  static bool IsPaint( SdrObject *pObj, const SwViewShell *pSh );
220 
230  bool IsBackgroundTransparent() const;
231 
232  void Chain( SwFrame* _pAnchor );
233  void Unchain();
234  void InsertCnt();
235  void DeleteCnt();
236  void InsertColumns();
237 
238  // #i26791# - pure virtual methods of base class <SwAnchoredObject>
239  virtual void MakeObjPos() override;
240  virtual void InvalidateObjPos() override;
241 
242  virtual SwFrameFormat& GetFrameFormat() override;
243  virtual const SwFrameFormat& GetFrameFormat() const override;
244 
245  virtual SwRect GetObjRect() const override;
246 
254  virtual bool IsFormatPossible() const override;
255  static void GetAnchoredObjects( std::vector<SwAnchoredObject*>&, const SwFormat& rFormat );
256 
257  // overwriting "SwFrameFormat *SwLayoutFrame::GetFormat" to provide the correct derived return type.
258  // (This is in order to skip on the otherwise necessary casting of the result to
259  // 'SwFlyFrameFormat *' after calls to this function. The casting is now done in this function.)
260  virtual const SwFlyFrameFormat *GetFormat() const override;
261  virtual SwFlyFrameFormat *GetFormat() override;
262 
263  virtual void dumpAsXml( xmlTextWriterPtr writer ) const override { SwLayoutFrame::dumpAsXml( writer ); };
264 
265  virtual void Calc(vcl::RenderContext* pRenderContext) const override;
266 
267  const Point& ContentPos() const { return m_aContentPos; }
268  Point& ContentPos() { return m_aContentPos; }
269 
270  void InvalidateContentPos();
271 
272  void SelectionHasChanged(SwFEShell* pShell);
273  bool IsShowUnfloatButton(SwWrtShell* pWrtSh) const;
274 
275  // For testing only (see uiwriter)
276  void ActiveUnfloatButton(SwWrtShell* pWrtSh);
277 
278 private:
279  void UpdateUnfloatButton(SwWrtShell* pWrtSh, bool bShow) const;
280  void PaintDecorators() const;
281 };
282 #endif
283 
284 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual void MakeObjPos()=0
method to determine position for the object and set the position at the object
Base class of the Writer layout elements.
Definition: frame.hxx:295
virtual SwRect GetObjRect() const =0
bool IsFlyLayFrame() const
Definition: flyfrm.hxx:195
void SetNotifyBack()
Definition: flyfrm.hxx:199
Marks a position in the document model.
Definition: pam.hxx:35
void MakePrtArea(const SwBorderAttrs &)
Definition: calcmove.cxx:1069
void Notify(SwFlyFrame *pFly, SwPageFrame *pOld, const SwRect &rOld, const SwRect *pOldRect=nullptr)
Notify the background based on the difference between old and new rectangle.
Definition: frmtool.cxx:3003
bool IsLowerOf(const SwLayoutFrame *pUpper) const
Definition: fly.cxx:2109
virtual bool SetObjTop_(const SwTwips _nTop)=0
Point & ContentPos()
Definition: flyfrm.hxx:268
void Unlock()
Definition: flyfrm.hxx:124
long SwTwips
Definition: swtypes.hxx:49
void Invalidate() const
Definition: flyfrm.hxx:187
virtual void dumpAsXml(xmlTextWriterPtr writer=nullptr) const
Definition: xmldump.cxx:255
virtual void Calc(vcl::RenderContext *pRenderContext) const
Definition: trvlfrm.cxx:1791
virtual void SwClientNotify(const SwModify &, const SfxHint &rHint) override
Definition: calbck.cxx:108
bool CalcClipRect(const SdrObject *pSdrObj, SwRect &rRect, bool bMove=true)
calculate rectangle in that the object can be moved or rather be resized
Definition: flylay.cxx:1161
Of course Writer needs its own rectangles.
Definition: swrect.hxx:34
void Format(vcl::RenderContext *pRenderContext, const SwBorderAttrs *pAttrs=nullptr) override
Calculate the Bitmap's site, if needed.
Definition: notxtfrm.cxx:647
SwFlyFrame * m_pPrevLink
Definition: flyfrm.hxx:77
virtual SwRect GetObjBoundRect() const =0
bool IsFlyAtContentFrame() const
Definition: flyfrm.hxx:196
Used by the UI to modify the document model.
Definition: wrtsh.hxx:90
wrapper class for the positioning of Writer fly frames and drawing objects
bool IsInvalid() const
Definition: flyfrm.hxx:186
const Point & ContentPos() const
Definition: flyfrm.hxx:267
virtual void Modify(const SfxPoolItem *, const SfxPoolItem *) override
Definition: notxtfrm.cxx:713
SwFlyFrame * GetPrevLink() const
Definition: flyfrm.hxx:172
virtual Size ChgSize(const Size &aNewSize)
Definition: wsfrm.cxx:721
void Lock()
Definition: flyfrm.hxx:123
virtual bool GetCursorOfst(SwPosition *pPos, Point &aPoint, SwCursorMoveState *=nullptr, bool bTestBackground=false) const override
Definition: notxtfrm.cxx:694
bool IsUpperOf(const SwFlyFrame &_rLower) const
Definition: flyfrm.hxx:206
bool IsFlyInContentFrame() const
Definition: flyfrm.hxx:193
virtual bool SetObjLeft_(const SwTwips _nLeft)=0
virtual void dumpAsXml(xmlTextWriterPtr writer) const override
Dump a bunch of useful data to an XML representation to ease layout understanding, debugging and testing.
Definition: flyfrm.hxx:263
Base class for various Writer styles.
Definition: format.hxx:43
void AppendObj(SwFrame *const pFrame, SwPageFrame *const pPage, SwFrameFormat *const pFormat, const SwFormatAnchor &rAnch)
Definition: frmtool.cxx:978
struct _xmlTextWriter * xmlTextWriterPtr
bool IsMinHeight() const
Definition: flyfrm.hxx:190
Style of a layout element.
Definition: frmfmt.hxx:57
void Validate() const
Definition: flyfrm.hxx:188
FlyAnchors.
Definition: fmtanchr.hxx:34
long CalcRel(const SwFormatFrameSize &rSz) const
Definition: wsfrm.cxx:3533
virtual void PaintSwFrame(vcl::RenderContext &rRenderContext, SwRect const &, SwPrintData const *const pPrintData=nullptr) const override
Definition: notxtfrm.cxx:209
bool m_bValidContentPos
Definition: flyfrm.hxx:117
virtual void InvalidateObjPos()=0
method to invalidate position of the anchored object
#define SW_DLLPUBLIC
Definition: swdllapi.h:28
bool IsNotifyBack() const
Definition: flyfrm.hxx:198
A page of the document layout.
Definition: pagefrm.hxx:40
virtual void CheckDirection(bool bVert)
Definition: wsfrm.cxx:389
virtual bool IsFormatPossible() const
method to determine, if a format on the anchored object is possible
general base class for all free-flowing frames
Definition: flyfrm.hxx:60
virtual SwFrameFormat & GetFrameFormat()=0
bool IsLocked() const
Definition: flyfrm.hxx:191
unsigned char sal_uInt8
bool IsFlyFreeFrame() const
Definition: flyfrm.hxx:194
virtual const IDocumentDrawModelAccess & getIDocumentDrawModelAccess()
Definition: wsfrm.cxx:325
bool IsClipped() const
Definition: flyfrm.hxx:202
bool IsHeightClipped() const
Definition: flyfrm.hxx:203
SwFlyFrame * GetNextLink() const
Definition: flyfrm.hxx:173
Point m_aContentPos
Definition: flyfrm.hxx:116
virtual void RegisterAtCorrectPage()=0
method to assure that anchored object is registered at the correct page frame
virtual void Cut() override
Definition: wsfrm.cxx:1116
virtual bool GetInfo(SfxPoolItem &) const
Definition: calbck.hxx:164
const SwContentFrame * FindAnchor(const SwFrame *pOldAnch, const Point &rNew, const bool bBody=false)
search an anchor for paragraph bound frames starting from pOldAnch
Definition: flycnt.cxx:1022
virtual void DestroyImpl() override
Definition: notxtfrm.cxx:153
A layout frame is a frame that contains other frames (m_pLower), e.g. SwPageFrame or SwTabFrame...
Definition: layfrm.hxx:35
void ResetNotifyBack()
Definition: flyfrm.hxx:200
bool IsAutoPos() const
Definition: flyfrm.hxx:192
virtual const SwFrameFormat * GetFormat() const
Definition: ssfrm.cxx:393