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 <redline.hxx>
33 #include <scriptinfo.hxx>
34 #include <calbck.hxx>
35 #include <IMark.hxx>
36 #include <sortedobjs.hxx>
37 #include <anchoredobject.hxx>
38 #include <fmtanchr.hxx>
39 
40 class Point;
41 
42 namespace
43 {
45 bool AnnotationMarkCoversCommentAnchor(const sw::mark::IMark* pAnnotationMark,
46  const SwPosition& rAnchorPos)
47 {
48  if (!pAnnotationMark)
49  {
50  return false;
51  }
52 
53  const SwPosition& rMarkStart = pAnnotationMark->GetMarkStart();
54  const SwPosition& rMarkEnd = pAnnotationMark->GetMarkEnd();
55 
56  if (rMarkStart != rAnchorPos)
57  {
58  // This can be the as-char case: the comment placeholder character is exactly between the
59  // annotation mark start and end.
60  SwPosition aPosition(rMarkStart);
61  ++aPosition.nContent;
62  if (aPosition != rAnchorPos)
63  {
64  return false;
65  }
66 
67  ++aPosition.nContent;
68  if (aPosition != rMarkEnd)
69  {
70  return false;
71  }
72 
73  return true;
74  }
75 
76  if (rMarkStart.nNode != rMarkEnd.nNode)
77  {
78  return false;
79  }
80 
81  return rMarkEnd.nContent.GetIndex() == rMarkStart.nContent.GetIndex() + 1;
82 }
83 
88 SwAnchoredObject* GetAnchoredObjectOfAnnotationMark(const sw::mark::IMark& rAnnotationMark,
89  const SwTextFrame& rTextFrame)
90 {
91  const SwSortedObjs* pAnchored = rTextFrame.GetDrawObjs();
92  if (!pAnchored)
93  {
94  return nullptr;
95  }
96 
97  for (SwAnchoredObject* pObject : *pAnchored)
98  {
99  SwFrameFormat& rFrameFormat = pObject->GetFrameFormat();
100  const SwPosition* pFrameAnchor = rFrameFormat.GetAnchor().GetContentAnchor();
101  if (!pFrameAnchor)
102  {
103  continue;
104  }
105 
106  if (rAnnotationMark.GetMarkStart() == *pFrameAnchor)
107  {
108  return pObject;
109  }
110  }
111 
112  return nullptr;
113 }
114 }
115 
117  SwLayoutInfo& o_rInfo,
118  const SwPosition& rAnchorPos,
119  const sw::mark::IMark* pAnnotationMark )
120 {
121  SwLayoutStatus aRet = INVISIBLE;
122  SwTextNode* pTextNode = rAnchorPos.nNode.GetNode().GetTextNode();
123  if ( pTextNode == nullptr )
124  return aRet;
125 
127  for( SwTextFrame* pTextFrame = aIter.First(); pTextFrame != nullptr; pTextFrame = aIter.Next() )
128  {
129  if( !pTextFrame->IsFollow() )
130  {
131  pTextFrame = pTextFrame->GetFrameAtPos( rAnchorPos );
132  SwPageFrame *pPage = pTextFrame ? pTextFrame->FindPageFrame() : nullptr;
133  if ( pPage != nullptr && !pPage->IsInvalid() && !pPage->IsInvalidFly() )
134  {
135  aRet = VISIBLE;
136 
137  o_rInfo.mpAnchorFrame = pTextFrame;
138  {
139  DisableCallbackAction a(*pTextFrame->getRootFrame());
140  bool bPositionFromCommentAnchor = true;
141  if (AnnotationMarkCoversCommentAnchor(pAnnotationMark, rAnchorPos))
142  {
143  SwAnchoredObject* pFrame
144  = GetAnchoredObjectOfAnnotationMark(*pAnnotationMark, *pTextFrame);
145  if (pFrame)
146  {
147  o_rInfo.mPosition = pFrame->GetObjRect();
148  bPositionFromCommentAnchor = false;
149  }
150  }
151  if (bPositionFromCommentAnchor)
152  {
153  pTextFrame->GetCharRect(o_rInfo.mPosition, rAnchorPos, nullptr, false);
154  }
155  o_rInfo.mPositionFromCommentAnchor = bPositionFromCommentAnchor;
156  }
157  if (pAnnotationMark != nullptr)
158  {
159  const SwPosition& rAnnotationStartPos = pAnnotationMark->GetMarkStart();
160  o_rInfo.mnStartNodeIdx = rAnnotationStartPos.nNode.GetIndex();
161  o_rInfo.mnStartContent = rAnnotationStartPos.nContent.GetIndex();
162  }
163  else
164  {
165  o_rInfo.mnStartNodeIdx = 0;
166  o_rInfo.mnStartContent = -1;
167  }
168  o_rInfo.mPageFrame = pPage->getFrameArea();
169  o_rInfo.mPagePrtArea = pPage->getFramePrintArea();
170  o_rInfo.mPagePrtArea.Pos() += o_rInfo.mPageFrame.Pos();
171  o_rInfo.mnPageNumber = pPage->GetPhyPageNum();
172  o_rInfo.meSidebarPosition = pPage->SidebarPosition();
173  o_rInfo.mRedlineAuthor = 0;
174 
175  const IDocumentRedlineAccess& rIDRA = pTextNode->getIDocumentRedlineAccess();
177  {
178  const SwRangeRedline* pRedline = rIDRA.GetRedline( rAnchorPos, nullptr );
179  if( pRedline )
180  {
181  if( RedlineType::Insert == pRedline->GetType() )
182  aRet = INSERTED;
183  else if( RedlineType::Delete == pRedline->GetType() )
184  aRet = DELETED;
185  o_rInfo.mRedlineAuthor = pRedline->GetAuthor();
186  }
187  }
188  }
189  }
190  }
191 
192  return ( (aRet==VISIBLE) && SwScriptInfo::IsInHiddenRange( *pTextNode , rAnchorPos.nContent.GetIndex()) )
193  ? HIDDEN
194  : aRet;
195 }
196 
198 {
199  long nRet = pRoot ? pRoot->getFrameArea().Height() : 0;
200  return nRet;
201 }
202 
203 void SwPostItHelper::setSidebarChanged( SwRootFrame* pRoot, bool bBrowseMode )
204 {
205  if( pRoot )
206  {
207  pRoot->SetSidebarChanged();
208  if( bBrowseMode )
209  pRoot->InvalidateBrowseWidth();
210  }
211 }
212 
213 unsigned long SwPostItHelper::getPageInfo( SwRect& rPageFrame, const SwRootFrame* pRoot, const Point& rPoint )
214 {
215  unsigned long nRet = 0;
216  const SwFrame* pPage = pRoot->GetPageAtPos( rPoint, nullptr, true );
217  if( pPage )
218  {
219  nRet = pPage->GetPhyPageNum();
220  rPageFrame = pPage->getFrameArea();
221  }
222  return nRet;
223 }
224 
226 {
227  SwTextField* pTextField = mrFormatField.GetTextField();
228  SwTextNode* pTextNode = pTextField->GetpTextNode();
229 
230  SwPosition aPos( *pTextNode );
231  aPos.nContent.Assign( pTextNode, pTextField->GetStart() );
232  return aPos;
233 }
234 
236  IDocumentRedlineAccess const& rIDRA)
237 {
238  return mrFormatField.IsFieldInDoc()
239  && (!rLayout.IsHideRedlines()
241 }
242 
244  SwEditWin& rEditWin,
245  SwPostItMgr& aMgr)
246 {
248  aMgr,
249  *this,
250  &mrFormatField );
251 }
252 
253 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Base class of the Writer layout elements.
Definition: frame.hxx:295
Represents the visualization of a paragraph.
Definition: txtfrm.hxx:149
virtual SwRect GetObjRect() const =0
const SwSortedObjs * GetDrawObjs() const
Definition: frame.hxx:543
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:572
const SwFrame * mpAnchorFrame
SwNodeIndex nNode
Definition: pam.hxx:37
const SwRect & getFramePrintArea() const
Definition: frame.hxx:176
std::size_t mRedlineAuthor
TElementType * Next()
Definition: calbck.hxx:373
helper class to disable creation of an action by a callback event in particular, change event from a ...
Definition: rootfrm.hxx:440
void Height(long nNew)
Definition: swrect.hxx:189
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:1372
SwNode & GetNode() const
Definition: ndindex.hxx:119
SwTextNode * GetpTextNode() const
Definition: txtfld.hxx:49
void Pos(const Point &rNew)
Definition: swrect.hxx:167
bool mPositionFromCommentAnchor
If true, the overlay arrow points to the comment anchor, otherwise it points to the commented frame...
Of course Writer needs its own rectangles.
Definition: swrect.hxx:34
The root element of a Writer document layout.
Definition: rootfrm.hxx:79
virtual SwPosition GetAnchorPosition() const override
static bool IsShowChanges(const RedlineFlags eM)
SwFormatField & mrFormatField
sal_uInt16 GetPhyPageNum() const
Definition: pagefrm.hxx:190
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:175
const SwTextField * GetTextField() const
Definition: fmtfld.hxx:88
sal_uLong GetIndex() const
Definition: ndindex.hxx:152
sal_Int32 GetStart() const
Definition: txatbase.hxx:82
void SetSidebarChanged()
Definition: rootfrm.hxx:405
void InvalidateBrowseWidth()
Definition: rootfrm.hxx:427
virtual bool UseElement(SwRootFrame const &, IDocumentRedlineAccess const &) override
bool IsInvalidFly() const
Definition: pagefrm.hxx:426
Style of a layout element.
Definition: frmfmt.hxx:57
const IDocumentRedlineAccess & getIDocumentRedlineAccess() const
Provides access to the document redline interface.
Definition: node.cxx:2054
const SwFormatAnchor & GetAnchor(bool=true) const
Definition: fmtanchr.hxx:81
SwRect mPageFrame
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:198
const SwPosition * GetContentAnchor() const
Definition: fmtanchr.hxx:67
SwPageFrame * FindPageFrame()
Definition: frame.hxx:658
SwRect mPagePrtArea
TElementType * First()
Definition: calbck.hxx:342
long getLayoutHeight(const SwRootFrame *pRoot)
sal_uLong mnStartNodeIdx
unsigned long mnPageNumber
A page of the document layout.
Definition: pagefrm.hxx:40
virtual const SwRangeRedline * GetRedline(const SwPosition &rPos, SwRedlineTable::size_type *pFndPos) const =0
bool IsFieldInDoc() const
Definition: atrfld.cxx:329
SwTextNode is a paragraph in the document model.
Definition: ndtxt.hxx:79
bool IsFieldDeletedInModel(IDocumentRedlineAccess const &rIDRA, SwTextField const &rTextField)
std::size_t GetAuthor(sal_uInt16 nPos=0) const
Definition: docredln.cxx:1713
sw::sidebarwindows::SidebarPosition meSidebarPosition
sal_uInt16 GetPhyPageNum() const
Definition: trvlfrm.cxx:1688
sal_Int32 GetIndex() const
Definition: index.hxx:95
static VclPtr< reference_type > Create(Arg &&...arg)
RedlineType GetType(sal_uInt16 nPos=0) const
Definition: docredln.cxx:1728
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:416
void setSidebarChanged(SwRootFrame *pRoot, bool bBrowseMode)
virtual const SwPosition & GetMarkEnd() const =0
static bool IsInHiddenRange(const SwTextNode &rNode, sal_Int32 nPos)
Definition: porlay.cxx:1660
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:422
class for collecting anchored objects
Definition: sortedobjs.hxx:48
SwLayoutStatus getLayoutInfos(SwLayoutInfo &o_rInfo, const SwPosition &rAnchorPos, const sw::mark::IMark *pAnnotationMark=nullptr)
unsigned long getPageInfo(SwRect &rPageFrame, const SwRootFrame *, const Point &)
SwRect mPosition
SwTextNode * GetTextNode()
Inline methods from Node.hxx.
Definition: ndtxt.hxx:842