LibreOffice Module sw (master)  1
annotationmark.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 <annotationmark.hxx>
21 
22 #include <doc.hxx>
24 #include <IDocumentState.hxx>
25 #include <fldbas.hxx>
26 #include <calbck.hxx>
27 #include <fmtfld.hxx>
28 #include <docufld.hxx>
29 #include <IDocumentUndoRedo.hxx>
30 #include <UndoBookmark.hxx>
31 #include <ndtxt.hxx>
32 #include <txtfld.hxx>
33 
34 namespace sw { namespace mark
35 {
37  const SwPaM& rPaM,
38  const OUString& rName )
39  : MarkBase( rPaM, rName )
40  {
41  if ( rName.getLength() == 0 )
42  {
43  SetName( MarkBase::GenerateNewName("__Annotation__") );
44  }
45  }
46 
48  {
49  }
50 
52  {
53  SwTextNode *pTextNode = GetMarkEnd().nNode.GetNode().GetTextNode();
54  assert(pTextNode);
55  SwTextField *const pTextField = pTextNode->GetFieldTextAttrAt(
56  GetMarkEnd().nContent.GetIndex()-1, true);
57  assert(pTextField != nullptr);
58  auto pPostItField
59  = dynamic_cast<const SwPostItField*>(pTextField->GetFormatField().GetField());
60  assert(pPostItField);
61  // use the annotation mark's name as the annotation name, if
62  // - the annotation field has an empty annotation name or
63  // - the annotation mark's name differs (on mark creation a name clash had been detected)
64  if ( pPostItField->GetName().isEmpty()
65  || pPostItField->GetName() != GetName() )
66  {
67  const_cast<SwPostItField*>(pPostItField)->SetName( GetName() );
68  }
69 
70  if (io_pDoc->GetIDocumentUndoRedo().DoesUndo())
71  {
72  io_pDoc->GetIDocumentUndoRedo().AppendUndo( std::make_unique<SwUndoInsBookmark>(*this) );
73  }
74  io_pDoc->getIDocumentState().SetModified();
75  }
76 
78  {
79  SwDoc* pDoc = GetMarkPos().GetDoc();
80  assert(pDoc != nullptr);
81 
82  SwFormatField* pAnnotationFormatField = nullptr;
83 
84  SwFieldType* pType = pDoc->getIDocumentFieldsAccess().GetFieldType( SwFieldIds::Postit, OUString(), false );
86  for( SwFormatField* pFormatField = aIter.First(); pFormatField != nullptr; pFormatField = aIter.Next() )
87  {
88  if ( pFormatField->IsFieldInDoc() )
89  {
90  const SwPostItField* pPostItField = dynamic_cast< const SwPostItField* >(pFormatField->GetField());
91  if (pPostItField != nullptr && pPostItField->GetName() == GetName())
92  {
93  pAnnotationFormatField = pFormatField;
94  break;
95  }
96  }
97  }
98 
99  return pAnnotationFormatField;
100  }
101 }}
102 
103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
static OUString GenerateNewName(const OUString &rPrefix)
Definition: bookmrk.cxx:213
Instances of SwFields and those derived from it occur 0 to n times.
Definition: fldbas.hxx:233
virtual void InitDoc(SwDoc *const io_Doc, sw::mark::InsertMode eMode) override
const SwField * GetField() const
Definition: fmtfld.hxx:71
virtual SwFieldType * GetFieldType(SwFieldIds nResId, const OUString &rName, bool bDbFieldMatching) const =0
SwNodeIndex nNode
Definition: pam.hxx:37
virtual void SetModified()=0
Must be called manually at changes of format.
Definition: doc.hxx:185
TElementType * Next()
Definition: calbck.hxx:376
SwNode & GetNode() const
Definition: ndindex.hxx:118
Dialog to specify the properties of date form field.
Definition: accfrmobj.cxx:38
IDocumentUndoRedo & GetIDocumentUndoRedo()
Definition: doc.cxx:176
IDocumentFieldsAccess const & getIDocumentFieldsAccess() const
Definition: doc.cxx:389
virtual SwPosition & GetMarkEnd() const override
Definition: bookmrk.hxx:73
virtual const OUString & GetName() const override
Definition: bookmrk.hxx:58
SwDoc * GetDoc() const
Returns the document this position is in.
Definition: pam.cxx:176
const SwFormatField & GetFormatField() const
Definition: txatbase.hxx:191
virtual bool DoesUndo() const =0
Is Undo enabled?
AnnotationMark(const SwPaM &rPaM, const OUString &rName)
PaM is Point and Mark: a selection of the document model.
Definition: pam.hxx:136
virtual void AppendUndo(std::unique_ptr< SwUndo > pUndo)=0
Add new Undo action.
void SetName(const OUString &rName)
Definition: bookmrk.hxx:86
TElementType * First()
Definition: calbck.hxx:345
IDocumentState const & getIDocumentState() const
Definition: doc.cxx:426
SwTextField * GetFieldTextAttrAt(const sal_Int32 nIndex, const bool bIncludeInputFieldAtStart=false) const
Definition: ndtxt.cxx:1771
virtual ~AnnotationMark() override
const OUString & GetName() const
Definition: docufld.hxx:488
SwTextNode is a paragraph in the document model.
Definition: ndtxt.hxx:79
virtual SwPosition & GetMarkPos() const override
Definition: bookmrk.hxx:56
InsertMode
Definition: IMark.hxx:31
const SwFormatField * GetAnnotationFormatField() const
SwTextNode * GetTextNode()
Inline methods from Node.hxx.
Definition: ndtxt.hxx:843