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 <docufld.hxx>
27 #include <ndtxt.hxx>
28 #include <cntfrm.hxx>
29 #include <pagefrm.hxx>
30 #include <rootfrm.hxx>
31 #include <txtfrm.hxx>
32 #include <tabfrm.hxx>
35 #include <redline.hxx>
36 #include <scriptinfo.hxx>
38 #include <calbck.hxx>
39 #include <IMark.hxx>
40 #include <sortedobjs.hxx>
41 #include <anchoredobject.hxx>
42 #include <fmtanchr.hxx>
43 #include <tools/solar.h>
44 
45 class Point;
46 
47 namespace
48 {
50 bool AnnotationMarkCoversCommentAnchor(const sw::mark::IMark* pAnnotationMark,
51  const SwPosition& rAnchorPos)
52 {
53  if (!pAnnotationMark)
54  {
55  return false;
56  }
57 
58  const SwPosition& rMarkStart = pAnnotationMark->GetMarkStart();
59  const SwPosition& rMarkEnd = pAnnotationMark->GetMarkEnd();
60 
61  if (rMarkStart != rAnchorPos)
62  {
63  return false;
64  }
65 
66  if (rMarkStart.nNode != rMarkEnd.nNode)
67  {
68  return false;
69  }
70 
71  return rMarkEnd.nContent.GetIndex() == rMarkStart.nContent.GetIndex() + 1;
72 }
73 
78 SwAnchoredObject* GetAnchoredObjectOfAnnotationMark(const sw::mark::IMark& rAnnotationMark,
79  const SwTextFrame& rTextFrame)
80 {
81  const SwSortedObjs* pAnchored = rTextFrame.GetDrawObjs();
82  if (!pAnchored)
83  {
84  return nullptr;
85  }
86 
87  for (SwAnchoredObject* pObject : *pAnchored)
88  {
89  SwFrameFormat& rFrameFormat = pObject->GetFrameFormat();
90  const SwPosition* pFrameAnchor = rFrameFormat.GetAnchor().GetContentAnchor();
91  if (!pFrameAnchor)
92  {
93  continue;
94  }
95 
96  if (rAnnotationMark.GetMarkStart() == *pFrameAnchor)
97  {
98  return pObject;
99  }
100  }
101 
102  return nullptr;
103 }
104 }
105 
107  SwLayoutInfo& o_rInfo,
108  const SwPosition& rAnchorPos,
109  const sw::mark::IMark* pAnnotationMark )
110 {
111  SwLayoutStatus aRet = INVISIBLE;
112  SwTextNode* pTextNode = rAnchorPos.nNode.GetNode().GetTextNode();
113  if ( pTextNode == nullptr )
114  return aRet;
115 
117  for( SwTextFrame* pTextFrame = aIter.First(); pTextFrame != nullptr; pTextFrame = aIter.Next() )
118  {
119  if( !pTextFrame->IsFollow() )
120  {
121  pTextFrame = pTextFrame->GetFrameAtPos( rAnchorPos );
122  SwPageFrame *pPage = pTextFrame ? pTextFrame->FindPageFrame() : nullptr;
123  if ( pPage != nullptr && !pPage->IsInvalid() && !pPage->IsInvalidFly() )
124  {
125  aRet = VISIBLE;
126 
127  o_rInfo.mpAnchorFrame = pTextFrame;
128  {
129  DisableCallbackAction a(*pTextFrame->getRootFrame());
130  bool bPositionFromCommentAnchor = true;
131  if (AnnotationMarkCoversCommentAnchor(pAnnotationMark, rAnchorPos))
132  {
133  SwAnchoredObject* pFrame
134  = GetAnchoredObjectOfAnnotationMark(*pAnnotationMark, *pTextFrame);
135  if (pFrame)
136  {
137  o_rInfo.mPosition = pFrame->GetObjRect();
138  bPositionFromCommentAnchor = false;
139  }
140  }
141  if (bPositionFromCommentAnchor)
142  {
143  pTextFrame->GetCharRect(o_rInfo.mPosition, rAnchorPos, nullptr, false);
144  }
145  }
146  if (pAnnotationMark != nullptr)
147  {
148  const SwPosition& rAnnotationStartPos = pAnnotationMark->GetMarkStart();
149  o_rInfo.mnStartNodeIdx = rAnnotationStartPos.nNode.GetIndex();
150  o_rInfo.mnStartContent = rAnnotationStartPos.nContent.GetIndex();
151  }
152  else
153  {
154  o_rInfo.mnStartNodeIdx = 0;
155  o_rInfo.mnStartContent = -1;
156  }
157  o_rInfo.mPageFrame = pPage->getFrameArea();
158  o_rInfo.mPagePrtArea = pPage->getFramePrintArea();
159  o_rInfo.mPagePrtArea.Pos() += o_rInfo.mPageFrame.Pos();
160  o_rInfo.mnPageNumber = pPage->GetPhyPageNum();
161  o_rInfo.meSidebarPosition = pPage->SidebarPosition();
162  o_rInfo.mRedlineAuthor = 0;
163 
164  const IDocumentRedlineAccess& rIDRA = pTextNode->getIDocumentRedlineAccess();
166  {
167  const SwRangeRedline* pRedline = rIDRA.GetRedline( rAnchorPos, nullptr );
168  if( pRedline )
169  {
170  if( RedlineType::Insert == pRedline->GetType() )
171  aRet = INSERTED;
172  else if( RedlineType::Delete == pRedline->GetType() )
173  aRet = DELETED;
174  o_rInfo.mRedlineAuthor = pRedline->GetAuthor();
175  }
176  }
177  }
178  }
179  }
180 
181  return ( (aRet==VISIBLE) && SwScriptInfo::IsInHiddenRange( *pTextNode , rAnchorPos.nContent.GetIndex()) )
182  ? HIDDEN
183  : aRet;
184 }
185 
187 {
188  long nRet = pRoot ? pRoot->getFrameArea().Height() : 0;
189  return nRet;
190 }
191 
192 void SwPostItHelper::setSidebarChanged( SwRootFrame* pRoot, bool bBrowseMode )
193 {
194  if( pRoot )
195  {
196  pRoot->SetSidebarChanged();
197  if( bBrowseMode )
198  pRoot->InvalidateBrowseWidth();
199  }
200 }
201 
202 unsigned long SwPostItHelper::getPageInfo( SwRect& rPageFrame, const SwRootFrame* pRoot, const Point& rPoint )
203 {
204  unsigned long nRet = 0;
205  const SwFrame* pPage = pRoot->GetPageAtPos( rPoint, nullptr, true );
206  if( pPage )
207  {
208  nRet = pPage->GetPhyPageNum();
209  rPageFrame = pPage->getFrameArea();
210  }
211  return nRet;
212 }
213 
215 {
216  SwTextField* pTextField = mrFormatField.GetTextField();
217  SwTextNode* pTextNode = pTextField->GetpTextNode();
218 
219  SwPosition aPos( *pTextNode );
220  aPos.nContent.Assign( pTextNode, pTextField->GetStart() );
221  return aPos;
222 }
223 
225  IDocumentRedlineAccess const& rIDRA)
226 {
227  return mrFormatField.IsFieldInDoc()
228  && (!rLayout.IsHideRedlines()
230 }
231 
233  SwEditWin& rEditWin,
234  SwPostItMgr& aMgr)
235 {
237  aMgr,
238  *this,
239  &mrFormatField );
240 }
241 
242 /* 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
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:376
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:1374
SwNode & GetNode() const
Definition: ndindex.hxx:118
SwTextNode * GetpTextNode() const
Definition: txtfld.hxx:49
void Pos(const Point &rNew)
Definition: swrect.hxx:167
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:189
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:89
sal_uLong GetIndex() const
Definition: ndindex.hxx:151
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
virtual const SwRect GetObjRect() const =0
bool IsInvalidFly() const
Definition: pagefrm.hxx:425
Style of a layout element.
Definition: frmfmt.hxx:57
const IDocumentRedlineAccess & getIDocumentRedlineAccess() const
Provides access to the document redline interface.
Definition: node.cxx:2041
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:59
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:345
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:1765
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:1780
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:421
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:843