xref: /trunk/main/sw/inc/IDocumentListItems.hxx (revision 1d2dbeb0)
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 IDOCUMENTLISTITEMS_HXX_INCLUDED
25 #define IDOCUMENTLISTITEMS_HXX_INCLUDED
26 
27 #include <vector>
28 #include <tools/string.hxx>
29 class SwNodeNum;
30 
31 /** Provides numbered items of a document.
32 */
33 class IDocumentListItems
34 {
35 public:
36     typedef ::std::vector< const SwNodeNum* > tSortedNodeNumList;
37 
38     virtual void addListItem( const SwNodeNum& rNodeNum ) = 0;
39     virtual void removeListItem( const SwNodeNum& rNodeNum ) = 0;
40 
41     virtual String getListItemText( const SwNodeNum& rNodeNum,
42                                     const bool bWithNumber = true,
43                                     const bool bWithSpacesForLevel = false ) const = 0;
44 
45     /** get vector of all list items
46     */
47     virtual void getListItems( IDocumentListItems::tSortedNodeNumList& orNodeNumList ) const = 0;
48 
49     /** get vector of all list items, which are numbered
50     */
51     virtual void getNumItems( IDocumentListItems::tSortedNodeNumList& orNodeNumList ) const = 0;
52 
53 protected:
~IDocumentListItems()54     virtual ~IDocumentListItems() {};
55 };
56 
57  #endif // IDOCUMENTLISTITEMS_HXX_INCLUDED
58