1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef IDOCUMENTMARKACCESS_HXX_INCLUDED
#define IDOCUMENTMARKACCESS_HXX_INCLUDED
#include <sal/types.h>
#include <IMark.hxx>
#include <boost/shared_ptr.hpp>
class SwPaM;
class KeyCode;
class String;
struct SwPosition;
class SwTxtNode;
namespace sw { namespace mark {
class SaveBookmark; // FIXME: Ugly: SaveBookmark is a core-internal class, and should not be used in the interface
}}
/** Provides access to the marks of a document.
*/
class IDocumentMarkAccess
{
public:
enum MarkType
{
UNO_BOOKMARK,
DDE_BOOKMARK,
BOOKMARK,
CROSSREF_HEADING_BOOKMARK,
CROSSREF_NUMITEM_BOOKMARK,
TEXT_FIELDMARK,
CHECKBOX_FIELDMARK,
NAVIGATOR_REMINDER
};
typedef ::boost::shared_ptr< ::sw::mark::IMark> pMark_t;
typedef ::std::vector< pMark_t > container_t;
typedef container_t::iterator iterator_t;
typedef container_t::const_iterator const_iterator_t;
typedef container_t::const_reverse_iterator const_reverse_iterator_t;
/** Generates a new mark in the document for a certain selection.
@param rPaM
[in] the selection being marked.
@param rProposedName
[in] the proposed name of the new mark.
@param eMark
[in] the type of the new mark.
@returns
a pointer to the new mark (name might have changed).
*/
virtual ::sw::mark::IMark* makeMark(const SwPaM& rPaM,
const ::rtl::OUString& rProposedName,
MarkType eMark) =0;
virtual sw::mark::IFieldmark* makeFieldBookmark( const SwPaM& rPaM,
const rtl::OUString& rName,
const rtl::OUString& rType) = 0;
virtual sw::mark::IFieldmark* makeNoTextFieldBookmark( const SwPaM& rPaM,
const rtl::OUString& rName,
const rtl::OUString& rType) = 0;
/** Returns a mark in the document for a paragraph.
If there is none, a mark will be created.
@param rTxtNode
[in] the paragraph being marked (a selection over the paragraph is marked)
@param eMark
[in] the type of the new mark.
@returns
a pointer to the new mark (name might have changed).
*/
virtual ::sw::mark::IMark* getMarkForTxtNode(const SwTxtNode& rTxtNode,
MarkType eMark) =0;
/** Moves an existing mark to a new selection and performs needed updates.
@param io_pMark
[in/out] the mark to be moved
@param rPaM
[in] new selection to be marked
*/
virtual void repositionMark(::sw::mark::IMark* io_pMark,
const SwPaM& rPaM) =0;
/** Renames an existing Mark, if possible.
@param io_pMark
[in/out] the mark to be renamed
@param rNewName
[in] new name for the mark
@returns false, if renaming failed (because the name is already in use)
*/
virtual bool renameMark(::sw::mark::IMark* io_pMark,
const ::rtl::OUString& rNewName) =0;
/** Corrects marks (absolute)
This method ignores the previous position of the mark in the paragraph
@param rOldNode
[in] the node from which nodes should be moved
@param rNewPos
[in] new position to which marks will be moved, if nOffset == 0
@param nOffset
[in] the offset by which the mark gets positioned of rNewPos
*/
virtual void correctMarksAbsolute(const SwNodeIndex& rOldNode,
const SwPosition& rNewPos,
const xub_StrLen nOffset) =0;
/** Corrects marks (relative)
This method uses the previous position of the mark in the paragraph as offset
@param rOldNode
[in] the node from which nodes should be moved
@param rNewPos
[in] new position to which marks from the start of the paragraph will be
moved, if nOffset == 0
@param nOffset
[in] the offset by which the mark gets positioned of rNewPos in addition to
its old position in the paragraph
*/
virtual void correctMarksRelative(const SwNodeIndex& rOldNode,
const SwPosition& rNewPos,
const xub_StrLen nOffset) =0;
/** Deletes marks in a range
*/
virtual void deleteMarks(
const SwNodeIndex& rStt,
const SwNodeIndex& rEnd,
::std::vector< ::sw::mark::SaveBookmark>* pSaveBkmk, // Ugly: SaveBookmark is core-internal
const SwIndex* pSttIdx,
const SwIndex* pEndIdx) =0;
/** Deletes a mark.
@param ppMark
[in] an iterator pointing to the Mark to be deleted.
*/
virtual void deleteMark(const IDocumentMarkAccess::const_iterator_t ppMark) =0;
/** Deletes a mark.
@param ppMark
[in] the name of the mark to be deleted.
*/
virtual void deleteMark(const ::sw::mark::IMark* const pMark) =0;
/** Clear (deletes) all marks.
*/
virtual void clearAllMarks() =0;
/** returns a STL-like random access iterator to the begin of the sequence of marks.
*/
virtual const_iterator_t getMarksBegin() const =0;
/** returns a STL-like random access iterator to the end of the sequence of marks.
*/
virtual const_iterator_t getMarksEnd() const =0;
/** returns the number of marks.
*/
virtual sal_Int32 getMarksCount() const =0;
/** Finds a mark by name.
@param rName
[in] the name of the mark to find.
@returns
an iterator pointing to the mark, or pointing to getMarksEnd() if nothing was found.
*/
virtual const_iterator_t findMark(const ::rtl::OUString& rMark) const =0;
// interface IBookmarks (BOOKMARK, CROSSREF_NUMITEM_BOOKMARK, CROSSREF_HEADING_BOOKMARK)
/** returns a STL-like random access iterator to the begin of the sequence the IBookmarks.
*/
virtual const_iterator_t getBookmarksBegin() const =0;
/** returns a STL-like random access iterator to the end of the sequence of IBookmarks.
*/
virtual const_iterator_t getBookmarksEnd() const =0;
/** returns the number of IBookmarks.
*/
virtual sal_Int32 getBookmarksCount() const =0;
/** Finds a bookmark by name.
@param rName
[in] the name of the bookmark to find.
@returns
an iterator pointing to the bookmark, or getBookmarksEnd() if nothing was found.
*/
virtual const_iterator_t findBookmark(const ::rtl::OUString& rMark) const =0;
// Fieldmarks
virtual ::sw::mark::IFieldmark* getFieldmarkFor(const SwPosition& pos) const =0;
virtual ::sw::mark::IFieldmark* getFieldmarkBefore(const SwPosition& pos) const =0;
virtual ::sw::mark::IFieldmark* getFieldmarkAfter(const SwPosition& pos) const =0;
// Returns the MarkType used to create the mark
static MarkType SAL_DLLPUBLIC_EXPORT GetType(const ::sw::mark::IMark& rMark);
protected:
virtual ~IDocumentMarkAccess() {};
};
#endif // IDOCUMENTBOOKMARKACCESS_HXX_INCLUDED
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
