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
|
/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: IDocumentBookmarkAccess.hxx,v $
*
* $Revision: 1.3 $
*
* last change: $Author: obo $ $Date: 2006-10-11 08:41:22 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef IDOCUMENTBOOKMARKACCESS_HXX_INCLUDED
#define IDOCUMENTBOOKMARKACCESS_HXX_INCLUDED
#ifndef _SAL_TYPES_H_
#include <sal/types.h>
#endif
class SwBookmark;
class SwBookmarks;
class SwPaM;
class KeyCode;
class String;
/** Provides access to the bookmarks of a document.
*/
class IDocumentBookmarkAccess
{
public:
enum BookmarkType
{
BOOKMARK,
MARK,
DDE_BOOKMARK,
UNO_BOOKMARK,
HIDDEN_BOOKMARK
};
public:
/** Returns all bookmarks set at the document.
@returns
the bookmarks set at the document.
*/
virtual const SwBookmarks& getBookmarks() const = 0;
/** Generates a new bookmark in the document.
@param rPaM
[in] the location of the new bookmark.
@param rKC
[in] ???
@param rName
[in] the name of the new bookmark.
@param rShortName
[in] the short name of the new bookmark.
@param eMark
[in] the type of the new bookmark.
@returns
a pointer to the new bookmark.
*/
virtual SwBookmark* makeBookmark( /*[in]*/const SwPaM& rPaM, /*[in]*/const KeyCode& rKC,
/*[in]*/const String& rName, /*[in]*/const String& rShortName,
/*[in]*/BookmarkType eMark ) = 0;
/** Deletes a bookmark.
@param nPos
[in] the position of the bookmark to be deleted.
*/
virtual void deleteBookmark( /*[in]*/sal_uInt16 nPos ) = 0;
/** Deletes a bookmark.
@param rName
[in] the name of the bookmark to be deleted.
*/
virtual void deleteBookmark( /*[in]*/const String& rName ) = 0;
/** Find a bookmark.
@param rName
[in] the name of the bookmark to be found.
@returns
the position of the bookmark in the bookmark container.
*/
virtual sal_uInt16 findBookmark( /*[in]*/const String& rName ) = 0;
/** Generates a unique bookmark name. The name has to be passed to the
function, a number will be added to the name if the name is already
used.
@param rName
[in/out] the name of the bookmark.
*/
virtual void makeUniqueBookmarkName( /*[in/out]*/String& rName ) = 0;
/** Get the number of ::com::sun::star::text::Bookmarks.
@param bBkmrk
[in] if set, only "real" bookmarks are considered.
@returns
the number of bookmarks.
*/
virtual sal_uInt16 getBookmarkCount( /*[in]*/bool bBkmrk) const = 0;
/** Get a bookmark.
@param nPos
[in] the position of the bookmark in the bookmark container.
@param bBkmrk
[in] if set, only "real" bookmarks are considered.
@returns
the bookmark.
*/
virtual SwBookmark& getBookmark( /*[in]*/sal_uInt16 nPos, /*[in]*/bool bBkmrk) = 0;
protected:
virtual ~IDocumentBookmarkAccess() {};
};
#endif // IDOCUMENTBOOKMARKACCESS_HXX_INCLUDED
|
