1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24 #ifndef IDOCUMENTMARKACCESS_HXX_INCLUDED 25 #define IDOCUMENTMARKACCESS_HXX_INCLUDED 26 27 #include <sal/types.h> 28 #include <IMark.hxx> 29 #include <boost/shared_ptr.hpp> 30 31 class SwPaM; 32 class KeyCode; 33 class String; 34 struct SwPosition; 35 class SwTxtNode; 36 37 namespace sw { namespace mark { 38 class SaveBookmark; // FIXME: Ugly: SaveBookmark is a core-internal class, and should not be used in the interface 39 }} 40 41 /** Provides access to the marks of a document. 42 */ 43 class IDocumentMarkAccess 44 { 45 public: 46 enum MarkType 47 { 48 UNO_BOOKMARK, 49 DDE_BOOKMARK, 50 BOOKMARK, 51 CROSSREF_HEADING_BOOKMARK, 52 CROSSREF_NUMITEM_BOOKMARK, 53 ANNOTATIONMARK, 54 TEXT_FIELDMARK, 55 CHECKBOX_FIELDMARK, 56 NAVIGATOR_REMINDER 57 }; 58 59 typedef ::boost::shared_ptr< ::sw::mark::IMark> pMark_t; 60 typedef ::std::vector< pMark_t > container_t; 61 typedef container_t::iterator iterator_t; 62 typedef container_t::const_iterator const_iterator_t; 63 typedef container_t::const_reverse_iterator const_reverse_iterator_t; 64 65 /** Generates a new mark in the document for a certain selection. 66 67 @param rPaM 68 [in] the selection being marked. 69 70 @param rProposedName 71 [in] the proposed name of the new mark. 72 73 @param eMark 74 [in] the type of the new mark. 75 76 @returns 77 a pointer to the new mark (name might have changed). 78 */ 79 virtual ::sw::mark::IMark* makeMark(const SwPaM& rPaM, 80 const ::rtl::OUString& rProposedName, 81 MarkType eMark) =0; 82 83 virtual sw::mark::IFieldmark* makeFieldBookmark( const SwPaM& rPaM, 84 const rtl::OUString& rName, 85 const rtl::OUString& rType) = 0; 86 virtual sw::mark::IFieldmark* makeNoTextFieldBookmark( const SwPaM& rPaM, 87 const rtl::OUString& rName, 88 const rtl::OUString& rType) = 0; 89 90 virtual sw::mark::IMark* makeAnnotationMark( 91 const SwPaM& rPaM, 92 const ::rtl::OUString& rName ) = 0; 93 94 /** Returns a mark in the document for a paragraph. 95 If there is none, a mark will be created. 96 97 @param rTxtNode 98 [in] the paragraph being marked (a selection over the paragraph is marked) 99 100 @param eMark 101 [in] the type of the new mark. 102 103 @returns 104 a pointer to the new mark (name might have changed). 105 */ 106 virtual ::sw::mark::IMark* getMarkForTxtNode(const SwTxtNode& rTxtNode, 107 MarkType eMark) =0; 108 109 /** Moves an existing mark to a new selection and performs needed updates. 110 @param io_pMark 111 [in/out] the mark to be moved 112 113 @param rPaM 114 [in] new selection to be marked 115 */ 116 117 virtual void repositionMark(::sw::mark::IMark* io_pMark, 118 const SwPaM& rPaM) =0; 119 120 /** Renames an existing Mark, if possible. 121 @param io_pMark 122 [in/out] the mark to be renamed 123 124 @param rNewName 125 [in] new name for the mark 126 127 @returns false, if renaming failed (because the name is already in use) 128 */ 129 virtual bool renameMark(::sw::mark::IMark* io_pMark, 130 const ::rtl::OUString& rNewName) =0; 131 132 /** Corrects marks (absolute) 133 This method ignores the previous position of the mark in the paragraph 134 135 @param rOldNode 136 [in] the node from which nodes should be moved 137 138 @param rNewPos 139 [in] new position to which marks will be moved, if nOffset == 0 140 141 @param nOffset 142 [in] the offset by which the mark gets positioned of rNewPos 143 */ 144 virtual void correctMarksAbsolute(const SwNodeIndex& rOldNode, 145 const SwPosition& rNewPos, 146 const xub_StrLen nOffset) =0; 147 148 /** Corrects marks (relative) 149 This method uses the previous position of the mark in the paragraph as offset 150 151 @param rOldNode 152 [in] the node from which nodes should be moved 153 154 @param rNewPos 155 [in] new position to which marks from the start of the paragraph will be 156 moved, if nOffset == 0 157 158 @param nOffset 159 [in] the offset by which the mark gets positioned of rNewPos in addition to 160 its old position in the paragraph 161 */ 162 virtual void correctMarksRelative(const SwNodeIndex& rOldNode, 163 const SwPosition& rNewPos, 164 const xub_StrLen nOffset) =0; 165 166 /** Deletes marks in a range 167 168 Note: navigator reminders are excluded 169 170 */ 171 virtual void deleteMarks( 172 const SwNodeIndex& rStt, 173 const SwNodeIndex& rEnd, 174 ::std::vector< ::sw::mark::SaveBookmark>* pSaveBkmk, // Ugly: SaveBookmark is core-internal 175 const SwIndex* pSttIdx, 176 const SwIndex* pEndIdx) =0; 177 178 /** Deletes a mark. 179 180 @param ppMark 181 [in] an iterator pointing to the Mark to be deleted. 182 */ 183 virtual void deleteMark(const IDocumentMarkAccess::const_iterator_t ppMark) =0; 184 185 /** Deletes a mark. 186 187 @param ppMark 188 [in] the name of the mark to be deleted. 189 */ 190 virtual void deleteMark(const ::sw::mark::IMark* const pMark) =0; 191 192 /** Clear (deletes) all marks. 193 */ 194 virtual void clearAllMarks() =0; 195 196 /** returns a STL-like random access iterator to the begin of the sequence of marks. 197 */ 198 virtual const_iterator_t getAllMarksBegin() const =0; 199 200 /** returns a STL-like random access iterator to the end of the sequence of marks. 201 */ 202 virtual const_iterator_t getAllMarksEnd() const =0; 203 204 /** returns the number of marks. 205 206 Note: annotation marks are excluded 207 */ 208 virtual sal_Int32 getAllMarksCount() const =0; 209 210 /** Finds a mark by name. 211 212 @param rName 213 [in] the name of the mark to find. 214 215 @returns 216 an iterator pointing to the mark, or pointing to getAllMarksEnd() if nothing was found. 217 */ 218 virtual const_iterator_t findMark(const ::rtl::OUString& rMark) const =0; 219 220 221 // interface IBookmarks (BOOKMARK, CROSSREF_NUMITEM_BOOKMARK, CROSSREF_HEADING_BOOKMARK ) 222 223 /** returns a STL-like random access iterator to the begin of the sequence the IBookmarks. 224 */ 225 virtual const_iterator_t getBookmarksBegin() const =0; 226 227 /** returns a STL-like random access iterator to the end of the sequence of IBookmarks. 228 */ 229 virtual const_iterator_t getBookmarksEnd() const =0; 230 231 /** returns the number of IBookmarks. 232 */ 233 virtual sal_Int32 getBookmarksCount() const =0; 234 235 /** Finds a bookmark by name. 236 237 @param rName 238 [in] the name of the bookmark to find. 239 240 @returns 241 an iterator pointing to the bookmark, or getBookmarksEnd() if nothing was found. 242 */ 243 virtual const_iterator_t findBookmark(const ::rtl::OUString& rMark) const =0; 244 245 246 // Fieldmarks 247 virtual ::sw::mark::IFieldmark* getFieldmarkFor(const SwPosition& pos) const =0; 248 virtual ::sw::mark::IFieldmark* getFieldmarkBefore(const SwPosition& pos) const =0; 249 virtual ::sw::mark::IFieldmark* getFieldmarkAfter(const SwPosition& pos) const =0; 250 251 // Marks exclusive annotation marks 252 virtual const_iterator_t getCommonMarksBegin() const = 0; 253 virtual const_iterator_t getCommonMarksEnd() const = 0; 254 virtual sal_Int32 getCommonMarksCount() const = 0; 255 256 // Annotation Marks 257 virtual const_iterator_t getAnnotationMarksBegin() const = 0; 258 virtual const_iterator_t getAnnotationMarksEnd() const = 0; 259 virtual sal_Int32 getAnnotationMarksCount() const = 0; 260 virtual const_iterator_t findAnnotationMark( const ::rtl::OUString& rName ) const = 0; 261 262 // Returns the MarkType used to create the mark 263 static MarkType SAL_DLLPUBLIC_EXPORT GetType(const ::sw::mark::IMark& rMark); 264 265 static SAL_DLLPUBLIC_EXPORT const ::rtl::OUString& GetCrossRefHeadingBookmarkNamePrefix(); 266 static SAL_DLLPUBLIC_EXPORT bool IsLegalPaMForCrossRefHeadingBookmark( const SwPaM& ); 267 protected: 268 virtual ~IDocumentMarkAccess() {}; 269 }; 270 271 #endif // IDOCUMENTBOOKMARKACCESS_HXX_INCLUDED 272