LibreOffice Module sw (master)  1
postithelper.cxx
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 #include <postithelper.hxx>
21 #include <PostItMgr.hxx>
22 #include <AnnotationWin.hxx>
23 
24 #include <fmtfld.hxx>
25 #include <txtfld.hxx>
26 #include <ndtxt.hxx>
27 #include <pagefrm.hxx>
28 #include <rootfrm.hxx>
29 #include <txtfrm.hxx>
32 #include <IDocumentMarkAccess.hxx>
33 #include <redline.hxx>
34 #include <scriptinfo.hxx>
35 #include <calbck.hxx>
36 #include <IMark.hxx>
37 #include <sortedobjs.hxx>
38 #include <anchoredobject.hxx>
39 #include <fmtanchr.hxx>
40 
41 class Point;
42 
43 namespace
44 {
46 bool AnnotationMarkCoversCommentAnchor(const sw::mark::IMark* pAnnotationMark,
47  const SwPosition& rAnchorPos)
48 {
49  if (!pAnnotationMark)
50  {
51  return false;
52  }
53 
54  const SwPosition& rMarkStart = pAnnotationMark->GetMarkStart();
55  const SwPosition& rMarkEnd = pAnnotationMark->GetMarkEnd();
56 
57  if (rMarkStart != rAnchorPos)
58  {
59  // This can be the as-char case: the comment placeholder character is exactly between the
60  // annotation mark start and end.
61  SwPosition aPosition(rMarkStart);
62  ++aPosition.nContent;
63  if (aPosition != rAnchorPos)
64  {
65  return false;
66  }
67 
68  ++aPosition.nContent;
69  if (aPosition != rMarkEnd)
70  {
71  return false;
72  }
73 
74  return true;
75  }
76 
77  if (rMarkStart.nNode != rMarkEnd.nNode)
78  {
79  return false;
80  }
81 
82  return rMarkEnd.nContent.GetIndex() == rMarkStart.nContent.GetIndex() + 1;
83 }
84 
89 SwAnchoredObject* GetAnchoredObjectOfAnnotationMark(const sw::mark::IMark& rAnnotationMark,
90  const SwTextFrame& rTextFrame)
91 {
92  const SwSortedObjs* pAnchored = rTextFrame.GetDrawObjs();
93  if (!pAnchored)
94  {
95  return nullptr;
96  }
97 
98  for (SwAnchoredObject* pObject : *pAnchored)
99  {
100  SwFrameFormat& rFrameFormat = pObject->GetFrameFormat();
101  const SwPosition* pFrameAnchor = rFrameFormat.GetAnchor().GetContentAnchor();
102  if (!pFrameAnchor)
103  {
104  continue;
105  }
106 
107  if (rAnnotationMark.GetMarkStart() == *pFrameAnchor)
108  {
109  return pObject;
110  }
111  }
112 
113  return nullptr;
114 }
115 }
116 
118  : mpPostIt(nullptr)
119  , mbShow(true)
120  , mbFocus(aFocus)
121  , mbPendingLayout(false)
122  , mLayoutStatus(SwPostItHelper::INVISIBLE)
123 {
124 }
125 
127 
129  SwLayoutInfo& o_rInfo,
130  const SwPosition& rAnchorPos,
131  const sw::mark::IMark* pAnnotationMark )
132 {
133  SwLayoutStatus aRet = INVISIBLE;
134  SwTextNode* pTextNode = rAnchorPos.nNode.GetNode().GetTextNode();
135  if ( pTextNode == nullptr )
136  return aRet;
137 
139  for( SwTextFrame* pTextFrame = aIter.First(); pTextFrame != nullptr; pTextFrame = aIter.Next() )
140  {
141  if( !pTextFrame->IsFollow() )
142  {
143  pTextFrame = pTextFrame->GetFrameAtPos( rAnchorPos );
144  SwPageFrame *pPage = pTextFrame ? pTextFrame->FindPageFrame() : nullptr;
145  if ( pPage != nullptr && !pPage->IsInvalid() && !pPage->IsInvalidFly() )
146  {
147  aRet = VISIBLE;
148 
149  o_rInfo.mpAnchorFrame = pTextFrame;
150  {
151  DisableCallbackAction a(*pTextFrame->getRootFrame());
152  bool bPositionFromCommentAnchor = true;
153  if (AnnotationMarkCoversCommentAnchor(pAnnotationMark, rAnchorPos))
154  {
155  SwAnchoredObject* pFrame
156  = GetAnchoredObjectOfAnnotationMark(*pAnnotationMark, *pTextFrame);
157  if (pFrame)
158  {
159  o_rInfo.mPosition = pFrame->GetObjRect();
160  bPositionFromCommentAnchor = false;
161  }
162  }
163  if (bPositionFromCommentAnchor)
164  {
165  pTextFrame->GetCharRect(o_rInfo.mPosition, rAnchorPos, nullptr, false);
166  }
167  o_rInfo.mPositionFromCommentAnchor = bPositionFromCommentAnchor;
168  }
169  if (pAnnotationMark != nullptr)
170  {
171  const SwPosition& rAnnotationStartPos = pAnnotationMark->GetMarkStart();
172  o_rInfo.mnStartNodeIdx = rAnnotationStartPos.nNode.GetIndex();
173  o_rInfo.mnStartContent = rAnnotationStartPos.nContent.GetIndex();
174  }
175  else
176  {
177  o_rInfo.mnStartNodeIdx = 0;
178  o_rInfo.mnStartContent = -1;
179  }
180  o_rInfo.mPageFrame = pPage->getFrameArea();
181  o_rInfo.mPagePrtArea = pPage->getFramePrintArea();
182  o_rInfo.mPagePrtArea.Pos() += o_rInfo.mPageFrame.Pos();
183  o_rInfo.mnPageNumber = pPage->GetPhyPageNum();
184  o_rInfo.meSidebarPosition = pPage->SidebarPosition();
185  o_rInfo.mRedlineAuthor = 0;
186 
187  const IDocumentRedlineAccess& rIDRA = pTextNode->getIDocumentRedlineAccess();
189  {
190  const SwRangeRedline* pRedline = rIDRA.GetRedline( rAnchorPos, nullptr );
191  if( pRedline )
192  {
193  if( RedlineType::Insert == pRedline->GetType() )
194  aRet = INSERTED;
195  else if( RedlineType::Delete == pRedline->GetType() )
196  {
197  bool bDeleted = pAnnotationMark == nullptr;
198  if( !bDeleted )
199  {
200  IDocumentMarkAccess& rDMA(*pTextNode->GetDoc().getIDocumentMarkAccess());
201  IDocumentMarkAccess::const_iterator_t pAnnotationBookmark =
202  rDMA.findAnnotationBookmark(pAnnotationMark->GetName());
203  // tdf#140980 only really deleted, if there is no helper bookmark
204  // in ChangesInMargin mode
205  if ( pAnnotationBookmark == rDMA.getBookmarksEnd() )
206  bDeleted = true;
207  }
208  if ( bDeleted )
209  aRet = DELETED;
210  }
211  o_rInfo.mRedlineAuthor = pRedline->GetAuthor();
212  }
213  }
214  }
215  }
216  }
217 
218  return ( (aRet==VISIBLE) && SwScriptInfo::IsInHiddenRange( *pTextNode , rAnchorPos.nContent.GetIndex()) )
219  ? HIDDEN
220  : aRet;
221 }
222 
224 {
225  tools::Long nRet = pRoot ? pRoot->getFrameArea().Height() : 0;
226  return nRet;
227 }
228 
229 void SwPostItHelper::setSidebarChanged( SwRootFrame* pRoot, bool bBrowseMode )
230 {
231  if( pRoot )
232  {
233  pRoot->SetSidebarChanged();
234  if( bBrowseMode )
235  pRoot->InvalidateBrowseWidth();
236  }
237 }
238 
239 tools::ULong SwPostItHelper::getPageInfo( SwRect& rPageFrame, const SwRootFrame* pRoot, const Point& rPoint )
240 {
241  tools::ULong nRet = 0;
242  const SwFrame* pPage = pRoot->GetPageAtPos( rPoint, nullptr, true );
243  if( pPage )
244  {
245  nRet = pPage->GetPhyPageNum();
246  rPageFrame = pPage->getFrameArea();
247  }
248  return nRet;
249 }
250 
252 {
253  SwTextField* pTextField = mrFormatField.GetTextField();
254  SwTextNode* pTextNode = pTextField->GetpTextNode();
255 
256  SwPosition aPos( *pTextNode );
257  aPos.nContent.Assign( pTextNode, pTextField->GetStart() );
258  return aPos;
259 }
260 
262  IDocumentRedlineAccess const& rIDRA)
263 {
264  return mrFormatField.IsFieldInDoc()
265  && (!rLayout.IsHideRedlines()
267 }
268 
270  SwEditWin& rEditWin,
271  SwPostItMgr& aMgr)
272 {
274  aMgr,
275  *this,
276  &mrFormatField );
277 }
278 
279 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Base class of the Writer layout elements.
Definition: frame.hxx:315
Represents the visualization of a paragraph.
Definition: txtfrm.hxx:158
virtual SwRect GetObjRect() const =0
const SwSortedObjs * GetDrawObjs() const
Definition: frame.hxx:565
virtual const OUString & GetName() const =0
Marks a position in the document model.
Definition: pam.hxx:35
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)...
Definition: findfrm.cxx:573
const SwFrame * mpAnchorFrame
SwNodeIndex nNode
Definition: pam.hxx:37
wrapper iterator: wraps iterator of implementation while hiding MarkBase class; only IMark instances ...
long Long
const SwRect & getFramePrintArea() const
Definition: frame.hxx:181
std::size_t mRedlineAuthor
Provides access to the marks of a document.
TElementType * Next()
Definition: calbck.hxx:365
tools::ULong getPageInfo(SwRect &rPageFrame, const SwRootFrame *, const Point &)
helper class to disable creation of an action by a callback event in particular, change event from a ...
Definition: rootfrm.hxx:451
sw::sidebarwindows::SidebarPosition SidebarPosition() const
asks the page on which side a margin should be shown, e.g for notes returns true for left side...
Definition: pagechg.cxx:1436
SwNode & GetNode() const
Definition: ndindex.hxx:119
SwTextNode * GetpTextNode() const
Definition: txtfld.hxx:49
tools::Long getLayoutHeight(const SwRootFrame *pRoot)
void Pos(const Point &rNew)
Definition: swrect.hxx:168
bool mPositionFromCommentAnchor
If true, the overlay arrow points to the comment anchor, otherwise it points to the commented frame...
IDocumentMarkAccess * getIDocumentMarkAccess()
Definition: docbm.cxx:1790
Of course Writer needs its own rectangles.
Definition: swrect.hxx:34
EmbeddedObjectRef * pObject
The root element of a Writer document layout.
Definition: rootfrm.hxx:82
virtual SwPosition GetAnchorPosition() const override
static bool IsShowChanges(const RedlineFlags eM)
virtual ~SwSidebarItem()
SwFormatField & mrFormatField
sal_uInt16 GetPhyPageNum() const
Definition: pagefrm.hxx:204
wrapper class for the positioning of Writer fly frames and drawing objects
SwIndex nContent
Definition: pam.hxx:38
const SwRect & getFrameArea() const
Definition: frame.hxx:180
const SwTextField * GetTextField() const
Definition: fmtfld.hxx:128
unsigned long ULong
sal_uLong GetIndex() const
Definition: ndindex.hxx:152
sal_Int32 GetStart() const
Definition: txatbase.hxx:86
void SetSidebarChanged()
Definition: rootfrm.hxx:411
void InvalidateBrowseWidth()
Definition: rootfrm.hxx:438
virtual bool UseElement(SwRootFrame const &, IDocumentRedlineAccess const &) override
bool IsInvalidFly() const
Definition: pagefrm.hxx:443
Style of a layout element.
Definition: frmfmt.hxx:59
const IDocumentRedlineAccess & getIDocumentRedlineAccess() const
Provides access to the document redline interface.
Definition: node.cxx:2099
const SwFormatAnchor & GetAnchor(bool=true) const
Definition: fmtanchr.hxx:81
uno_Any a
SwRect mPageFrame
SwDoc & GetDoc()
Definition: node.hxx:212
Window class for the Writer edit area, this is the one handling mouse and keyboard events and doing t...
Definition: edtwin.hxx:58
SwIndex & Assign(SwIndexReg *, sal_Int32)
Definition: index.cxx:206
const SwPosition * GetContentAnchor() const
Definition: fmtanchr.hxx:67
SwPageFrame * FindPageFrame()
Definition: frame.hxx:681
SwRect mPagePrtArea
TElementType * First()
Definition: calbck.hxx:357
sal_uLong mnStartNodeIdx
A page of the document layout.
Definition: pagefrm.hxx:57
tools::ULong mnPageNumber
virtual const SwRangeRedline * GetRedline(const SwPosition &rPos, SwRedlineTable::size_type *pFndPos) const =0
bool IsFieldInDoc() const
Definition: atrfld.cxx:419
SwTextNode is a paragraph in the document model.
Definition: ndtxt.hxx:79
SwSidebarItem(const bool aFocus)
bool IsFieldDeletedInModel(IDocumentRedlineAccess const &rIDRA, SwTextField const &rTextField)
std::size_t GetAuthor(sal_uInt16 nPos=0) const
Definition: docredln.cxx:1825
sw::sidebarwindows::SidebarPosition meSidebarPosition
sal_uInt16 GetPhyPageNum() const
Definition: trvlfrm.cxx:1695
sal_Int32 GetIndex() const
Definition: index.hxx:91
static VclPtr< reference_type > Create(Arg &&...arg)
RedlineType GetType(sal_uInt16 nPos=0) const
Definition: docredln.cxx:1840
virtual VclPtr< sw::annotation::SwAnnotationWin > GetSidebarWindow(SwEditWin &rEditWin, SwPostItMgr &aMgr) override
bool IsHideRedlines() const
Replacement for sw::DocumentRedlineManager::GetRedlineFlags() (this is layout-level redline hiding)...
Definition: rootfrm.hxx:422
void setSidebarChanged(SwRootFrame *pRoot, bool bBrowseMode)
virtual const SwPosition & GetMarkEnd() const =0
static bool IsInHiddenRange(const SwTextNode &rNode, sal_Int32 nPos)
Definition: porlay.cxx:1992
virtual RedlineFlags GetRedlineFlags() const =0
Query the currently set redline mode.
sal_Int32 mnStartContent
virtual const SwPosition & GetMarkStart() const =0
bool IsInvalid() const
Definition: pagefrm.hxx:439
class for collecting anchored objects
Definition: sortedobjs.hxx:48
SwLayoutStatus getLayoutInfos(SwLayoutInfo &o_rInfo, const SwPosition &rAnchorPos, const sw::mark::IMark *pAnnotationMark=nullptr)
void Height(tools::Long nNew)
Definition: swrect.hxx:190
SwRect mPosition
SwTextNode * GetTextNode()
Inline methods from Node.hxx.
Definition: ndtxt.hxx:850