LibreOffice Module sw (master)  1
MarkManager.hxx
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 #ifndef INCLUDED_SW_SOURCE_CORE_INC_MARKMANAGER_HXX
21 #define INCLUDED_SW_SOURCE_CORE_INC_MARKMANAGER_HXX
22 
23 #include <IMark.hxx>
24 #include <IDocumentMarkAccess.hxx>
25 #include <unordered_map>
26 #include <memory>
27 
28 class SwCursorShell;
29 class SfxViewShell;
30 
31 namespace sw::mark {
32  typedef std::unordered_map<OUString, sal_Int32> MarkBasenameMapUniqueOffset_t;
33 
35 
36  class MarkManager final
37  : virtual public IDocumentMarkAccess
38  {
39  public:
40  MarkManager(/*[in/out]*/ SwDoc& rDoc);
41  // IDocumentMarkAccess
42  virtual ::sw::mark::IMark* makeMark(const SwPaM& rPaM,
43  const OUString& rName, IDocumentMarkAccess::MarkType eMark,
45  SwPosition const* pSepPos = nullptr) override;
46 
47  virtual sw::mark::IFieldmark* makeFieldBookmark( const SwPaM& rPaM,
48  const OUString& rName,
49  const OUString& rType,
50  SwPosition const* pSepPos = nullptr) override;
52  const OUString& rName,
53  const OUString& rType) override;
54 
55  virtual ::sw::mark::IMark* getMarkForTextNode(const SwTextNode& rTextNode, IDocumentMarkAccess::MarkType eMark) override;
56 
58  const SwPaM& rPaM,
59  const OUString& rName ) override;
60 
61  virtual void repositionMark(::sw::mark::IMark* io_pMark, const SwPaM& rPaM) override;
62  virtual bool renameMark(::sw::mark::IMark* io_pMark, const OUString& rNewName) override;
63  virtual void correctMarksAbsolute(const SwNodeIndex& rOldNode, const SwPosition& rNewPos, const sal_Int32 nOffset) override;
64  virtual void correctMarksRelative(const SwNodeIndex& rOldNode, const SwPosition& rNewPos, const sal_Int32 nOffset) override;
65 
66  virtual void deleteMarks(const SwNodeIndex& rStt, const SwNodeIndex& rEnd, std::vector< ::sw::mark::SaveBookmark>* pSaveBkmk, const SwIndex* pSttIdx, const SwIndex* pEndIdx) override;
67 
68  // deleters
69  virtual std::unique_ptr<ILazyDeleter>
70  deleteMark(const const_iterator_t& ppMark) override;
71  virtual void deleteMark(const ::sw::mark::IMark* const pMark) override;
72  virtual void clearAllMarks() override;
73 
74  // marks
75  virtual const_iterator_t getAllMarksBegin() const override;
76  virtual const_iterator_t getAllMarksEnd() const override;
77  virtual sal_Int32 getAllMarksCount() const override;
78  virtual const_iterator_t findMark(const OUString& rName) const override;
79 
80  // bookmarks
81  virtual bool isBookmarkDeleted(SwPaM const& rPaM) const override;
82  virtual const_iterator_t getBookmarksBegin() const override;
83  virtual const_iterator_t getBookmarksEnd() const override;
84  virtual sal_Int32 getBookmarksCount() const override;
85  virtual const_iterator_t findBookmark(const OUString& rName) const override;
86  virtual const_iterator_t findFirstBookmarkStartsAfter(const SwPosition& rPos) const override;
87 
88  // Fieldmarks
89  virtual const_iterator_t getFieldmarksBegin() const override;
90  virtual const_iterator_t getFieldmarksEnd() const override;
91  virtual ::sw::mark::IFieldmark* getFieldmarkAt(const SwPosition& rPos) const override;
92  virtual ::sw::mark::IFieldmark* getFieldmarkFor(const SwPosition& rPos) const override;
93  virtual ::sw::mark::IFieldmark* getFieldmarkBefore(const SwPosition& rPos) const override;
94  virtual ::sw::mark::IFieldmark* getFieldmarkAfter(const SwPosition& rPos) const override;
95 
96  virtual ::sw::mark::IFieldmark* getDropDownFor(const SwPosition &rPos) const override;
97  virtual std::vector< ::sw::mark::IFieldmark* > getDropDownsFor(const SwPaM &rPaM) const override;
98 
99  virtual void deleteFieldmarkAt(const SwPosition& rPos) override;
100  virtual ::sw::mark::IFieldmark* changeFormFieldmarkType(::sw::mark::IFieldmark* pFieldmark, const OUString& rNewType) override;
101 
102  virtual void NotifyCursorUpdate(const SwCursorShell& rCursorShell) override;
103  virtual void ClearFieldActivation() override;
104  void LOKUpdateActiveField(const SfxViewShell* pViewShell);
105 
106  void dumpAsXml(xmlTextWriterPtr pWriter) const;
107 
108  // Annotation Marks
109  virtual const_iterator_t getAnnotationMarksBegin() const override;
110  virtual const_iterator_t getAnnotationMarksEnd() const override;
111  virtual sal_Int32 getAnnotationMarksCount() const override;
112  virtual const_iterator_t findAnnotationMark( const OUString& rName ) const override;
113  virtual sw::mark::IMark* getAnnotationMarkFor(const SwPosition& rPos) const override;
114  virtual const_iterator_t findFirstAnnotationStartsAfter(const SwPosition& rPos) const override;
115 
116  virtual void assureSortedMarkContainers() const override;
117 
118  typedef std::vector<sw::mark::MarkBase*> container_t;
119 
120  // helper bookmark to store annotation range of redlines
121  virtual ::sw::mark::IMark* makeAnnotationBookmark(const SwPaM& rPaM,
122  const OUString& rName, IDocumentMarkAccess::MarkType eMark,
123  sw::mark::InsertMode eMode,
124  SwPosition const* pSepPos = nullptr) override;
125  virtual const_iterator_t findAnnotationBookmark( const OUString& rName ) const override;
126  virtual void restoreAnnotationMarks(bool bDelete = true) override;
127 
128  private:
129 
130  MarkManager(MarkManager const&) = delete;
131  MarkManager& operator=(MarkManager const&) = delete;
132 
133  // make names
134  OUString getUniqueMarkName(const OUString& rName) const;
135 
136  void sortSubsetMarks();
137  void sortMarks();
138 
139  // container for all marks, this container owns the objects it points to
140  container_t m_vAllMarks;
141 
142  // additional container for bookmarks
143  container_t m_vBookmarks;
144  // additional container for fieldmarks
145  container_t m_vFieldmarks;
146 
147  mutable MarkBasenameMapUniqueOffset_t m_aMarkBasenameMapUniqueOffset;
148 
149  // container for annotation marks
150  container_t m_vAnnotationMarks;
151 
153 
155  };
156 
157 }
158 
159 #endif
160 
161 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual sw::mark::IMark * getAnnotationMarkFor(const SwPosition &rPos) const override
Definition: docbm.cxx:1621
virtual const_iterator_t findFirstAnnotationStartsAfter(const SwPosition &rPos) const override
Finds the first mark that is starting after.
Definition: docbm.cxx:1633
virtual sal_Int32 getAllMarksCount() const override
returns the number of marks.
Definition: docbm.cxx:1352
Marks a position in the document model.
Definition: pam.hxx:35
sw::mark::FieldmarkWithDropDownButton * m_pLastActiveFieldmark
virtual const_iterator_t findFirstBookmarkStartsAfter(const SwPosition &rPos) const override
Finds the first mark that is starting after.
Definition: docbm.cxx:1372
wrapper iterator: wraps iterator of implementation while hiding MarkBase class; only IMark instances ...
container_t m_vFieldmarks
OUString getUniqueMarkName(const OUString &rName) const
Definition: docbm.cxx:1693
Provides access to the marks of a document.
Definition: doc.hxx:188
virtual ::sw::mark::IFieldmark * getFieldmarkAfter(const SwPosition &rPos) const override
Definition: docbm.cxx:1594
virtual const_iterator_t getAllMarksBegin() const override
returns a STL-like random access iterator to the begin of the sequence of marks.
Definition: docbm.cxx:1346
void LOKUpdateActiveField(const SfxViewShell *pViewShell)
Definition: docbm.cxx:1531
virtual const_iterator_t getAnnotationMarksBegin() const override
Definition: docbm.cxx:1600
virtual const_iterator_t findAnnotationBookmark(const OUString &rName) const override
Definition: docbm.cxx:1654
virtual const_iterator_t getFieldmarksBegin() const override
returns a STL-like random access iterator to the begin of the sequence of fieldmarks.
Definition: docbm.cxx:1364
virtual ::sw::mark::IFieldmark * getFieldmarkFor(const SwPosition &rPos) const override
Definition: docbm.cxx:1397
Fieldmark with a drop down button (e.g. this button opens the date picker for a date field) ...
Definition: bookmrk.hxx:269
virtual sw::mark::IFieldmark * makeNoTextFieldBookmark(const SwPaM &rPaM, const OUString &rName, const OUString &rType) override
Definition: docbm.cxx:755
virtual const_iterator_t getBookmarksEnd() const override
returns a STL-like random access iterator to the end of the sequence of IBookmarks.
Definition: docbm.cxx:1358
virtual void clearAllMarks() override
Clear (deletes) all marks.
Definition: docbm.cxx:1323
container_t m_vBookmarks
virtual ::sw::mark::IFieldmark * getFieldmarkAt(const SwPosition &rPos) const override
get Fieldmark for CH_TXT_ATR_FIELDSTART/CH_TXT_ATR_FIELDEND at rPos
Definition: docbm.cxx:1381
void dumpAsXml(xmlTextWriterPtr pWriter) const
Definition: docbm.cxx:1750
Mode eMode
virtual ::sw::mark::IMark * getMarkForTextNode(const SwTextNode &rTextNode, IDocumentMarkAccess::MarkType eMark) override
Returns a mark in the document for a paragraph.
Definition: docbm.cxx:804
virtual void deleteMarks(const SwNodeIndex &rStt, const SwNodeIndex &rEnd, std::vector< ::sw::mark::SaveBookmark > *pSaveBkmk, const SwIndex *pSttIdx, const SwIndex *pEndIdx) override
Deletes marks in a range.
Definition: docbm.cxx:1068
PaM is Point and Mark: a selection of the document model.
Definition: pam.hxx:136
struct _xmlTextWriter * xmlTextWriterPtr
virtual sal_Int32 getAnnotationMarksCount() const override
Definition: docbm.cxx:1610
virtual ::sw::mark::IMark * makeMark(const SwPaM &rPaM, const OUString &rName, IDocumentMarkAccess::MarkType eMark, sw::mark::InsertMode eMode, SwPosition const *pSepPos=nullptr) override
Definition: docbm.cxx:544
container_t m_vAnnotationMarks
virtual ::sw::mark::IMark * makeAnnotationBookmark(const SwPaM &rPaM, const OUString &rName, IDocumentMarkAccess::MarkType eMark, sw::mark::InsertMode eMode, SwPosition const *pSepPos=nullptr) override
Definition: docbm.cxx:1643
virtual const_iterator_t getFieldmarksEnd() const override
returns a STL-like random access iterator to the end of the sequence of fieldmarks.
Definition: docbm.cxx:1367
virtual const_iterator_t getAnnotationMarksEnd() const override
Definition: docbm.cxx:1605
std::vector< sw::mark::MarkBase * > container_t
virtual void assureSortedMarkContainers() const override
Definition: docbm.cxx:1732
MarkBasenameMapUniqueOffset_t m_aMarkBasenameMapUniqueOffset
virtual const_iterator_t findMark(const OUString &rName) const override
Finds a mark by name.
Definition: docbm.cxx:1334
virtual std::unique_ptr< ILazyDeleter > deleteMark(const const_iterator_t &ppMark) override
Deletes a mark.
Definition: docbm.cxx:1223
virtual bool renameMark(::sw::mark::IMark *io_pMark, const OUString &rNewName) override
Renames an existing Mark, if possible.
Definition: docbm.cxx:852
Marks a character position inside a document model node.
Definition: index.hxx:33
std::unordered_map< OUString, sal_Int32 > MarkBasenameMapUniqueOffset_t
Definition: MarkManager.hxx:32
Marks a node in the document model.
Definition: ndindex.hxx:31
virtual const_iterator_t getAllMarksEnd() const override
returns a STL-like random access iterator to the end of the sequence of marks.
Definition: docbm.cxx:1349
virtual const_iterator_t findAnnotationMark(const OUString &rName) const override
Definition: docbm.cxx:1615
virtual sw::mark::IMark * makeAnnotationMark(const SwPaM &rPaM, const OUString &rName) override
Definition: docbm.cxx:817
SwTextNode is a paragraph in the document model.
Definition: ndtxt.hxx:79
virtual sal_Int32 getBookmarksCount() const override
returns the number of IBookmarks.
Definition: docbm.cxx:1361
virtual bool isBookmarkDeleted(SwPaM const &rPaM) const override
check if the selection would delete a BOOKMARK
Definition: docbm.cxx:1046
virtual void correctMarksAbsolute(const SwNodeIndex &rOldNode, const SwPosition &rNewPos, const sal_Int32 nOffset) override
Corrects marks (absolute) This method ignores the previous position of the mark in the paragraph...
Definition: docbm.cxx:881
virtual void NotifyCursorUpdate(const SwCursorShell &rCursorShell) override
Definition: docbm.cxx:1481
virtual sw::mark::IFieldmark * makeFieldBookmark(const SwPaM &rPaM, const OUString &rName, const OUString &rType, SwPosition const *pSepPos=nullptr) override
Definition: docbm.cxx:715
MarkManager & operator=(MarkManager const &)=delete
virtual const_iterator_t findBookmark(const OUString &rName) const override
Finds a bookmark by name.
Definition: docbm.cxx:1340
virtual void correctMarksRelative(const SwNodeIndex &rOldNode, const SwPosition &rNewPos, const sal_Int32 nOffset) override
Corrects marks (relative) This method uses the previous position of the mark in the paragraph as offs...
Definition: docbm.cxx:927
virtual void restoreAnnotationMarks(bool bDelete=true) override
Definition: docbm.cxx:1662
virtual ::sw::mark::IFieldmark * getFieldmarkBefore(const SwPosition &rPos) const override
Definition: docbm.cxx:1597
virtual ::sw::mark::IFieldmark * getDropDownFor(const SwPosition &rPos) const override
Definition: docbm.cxx:1564
virtual void deleteFieldmarkAt(const SwPosition &rPos) override
Definition: docbm.cxx:1419
virtual std::vector< ::sw::mark::IFieldmark * > getDropDownsFor(const SwPaM &rPaM) const override
Definition: docbm.cxx:1572
virtual ::sw::mark::IFieldmark * changeFormFieldmarkType(::sw::mark::IFieldmark *pFieldmark, const OUString &rNewType) override
Definition: docbm.cxx:1428
virtual void ClearFieldActivation() override
Definition: docbm.cxx:1523
InsertMode
Definition: IMark.hxx:31
MarkManager(SwDoc &rDoc)
Definition: docbm.cxx:539
virtual const_iterator_t getBookmarksBegin() const override
returns a STL-like random access iterator to the begin of the sequence the IBookmarks.
Definition: docbm.cxx:1355
virtual void repositionMark(::sw::mark::IMark *io_pMark, const SwPaM &rPaM) override
Moves an existing mark to a new selection and performs needed updates.
Definition: docbm.cxx:825