sw/source/core/fields/postithelper.cxx

   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>
  30 #include <IDocumentRedlineAccess.hxx>
  31 #include <IDocumentFieldsAccess.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 {
  45 /// Checks if pAnnotationMark covers exactly rAnchorPos (the comment anchor).
  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.AdjustContent(+1);
  63         if (aPosition != rAnchorPos)
  64         {
  65             return false;
  66         }
  67
  68         aPosition.AdjustContent(+1);
  69         if (aPosition != rMarkEnd)
  70         {
  71             return false;
  72         }
  73
  74         return true;
  75     }
  76
  77     if (rMarkStart.GetNode() != rMarkEnd.GetNode())
  78     {
  79         return false;
  80     }
  81
  82     return rMarkEnd.GetContentIndex() == rMarkStart.GetContentIndex() + 1;
  83 }
  84
  85 /**
  86  * Finds the first draw object of rTextFrame which has the same anchor position as the start of
  87  * rAnnotationMark.
  88  */
  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
 117 SwSidebarItem::SwSidebarItem(const bool aFocus)
 118     : mpPostIt(nullptr)
 119     , mbShow(true)
 120     , mbFocus(aFocus)
 121     , mbPendingLayout(false)
 122     , mLayoutStatus(SwPostItHelper::INVISIBLE)
 123 {
 124 }
 125
 126 SwSidebarItem::~SwSidebarItem() {}
 127
 128 SwPostItHelper::SwLayoutStatus SwPostItHelper::getLayoutInfos(
 129     SwLayoutInfo& o_rInfo,
 130     const SwPosition& rAnchorPos,
 131     const sw::mark::IMark* pAnnotationMark )
 132 {
 133     SwLayoutStatus aRet = INVISIBLE;
 134     SwTextNode* pTextNode = rAnchorPos.GetNode().GetTextNode();
 135     if ( pTextNode == nullptr )
 136         return aRet;
 137
 138     SwIterator<SwTextFrame, SwContentNode, sw::IteratorMode::UnwrapMulti> aIter(*pTextNode);
 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.GetNodeIndex();
 173                     o_rInfo.mnStartContent = rAnnotationStartPos.GetContentIndex();
 174                 }
 175                 else
 176                 {
 177                     o_rInfo.mnStartNodeIdx = SwNodeOffset(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();
 188                 if( IDocumentRedlineAccess::IsShowChanges( rIDRA.GetRedlineFlags() ) )
 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.GetContentIndex()) )
 219              ? HIDDEN
 220              : aRet;
 221 }
 222
 223 tools::Long SwPostItHelper::getLayoutHeight( const SwRootFrame* pRoot )
 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
 251 SwPosition SwAnnotationItem::GetAnchorPosition() const
 252 {
 253     SwTextField* pTextField = mrFormatField.GetTextField();
 254     SwTextNode* pTextNode = pTextField->GetpTextNode();
 255
 256     SwPosition aPos( *pTextNode, pTextField->GetStart() );
 257     return aPos;
 258 }
 259
 260 bool SwAnnotationItem::UseElement(SwRootFrame const& rLayout,
 261         IDocumentRedlineAccess const& rIDRA)
 262 {
 263     return mrFormatField.IsFieldInDoc()
 264         && (!rLayout.IsHideRedlines()
 265             || !sw::IsFieldDeletedInModel(rIDRA, *mrFormatField.GetTextField()));
 266 }
 267
 268 VclPtr<sw::annotation::SwAnnotationWin> SwAnnotationItem::GetSidebarWindow(
 269                                                             SwEditWin& rEditWin,
 270                                                             SwPostItMgr& aMgr)
 271 {
 272     return VclPtr<sw::annotation::SwAnnotationWin>::Create( rEditWin,
 273                                                 aMgr,
 274                                                 *this,
 275                                                 &mrFormatField );
 276 }
 277
 278 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */