xref: /aoo4110/main/sw/inc/IDocumentListItems.hxx (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef IDOCUMENTLISTITEMS_HXX_INCLUDED
25*b1cdbd2cSJim Jagielski #define IDOCUMENTLISTITEMS_HXX_INCLUDED
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include <vector>
28*b1cdbd2cSJim Jagielski #include <tools/string.hxx>
29*b1cdbd2cSJim Jagielski class SwNodeNum;
30*b1cdbd2cSJim Jagielski 
31*b1cdbd2cSJim Jagielski /** Provides numbered items of a document.
32*b1cdbd2cSJim Jagielski */
33*b1cdbd2cSJim Jagielski class IDocumentListItems
34*b1cdbd2cSJim Jagielski {
35*b1cdbd2cSJim Jagielski public:
36*b1cdbd2cSJim Jagielski     typedef ::std::vector< const SwNodeNum* > tSortedNodeNumList;
37*b1cdbd2cSJim Jagielski 
38*b1cdbd2cSJim Jagielski     virtual void addListItem( const SwNodeNum& rNodeNum ) = 0;
39*b1cdbd2cSJim Jagielski     virtual void removeListItem( const SwNodeNum& rNodeNum ) = 0;
40*b1cdbd2cSJim Jagielski 
41*b1cdbd2cSJim Jagielski     virtual String getListItemText( const SwNodeNum& rNodeNum,
42*b1cdbd2cSJim Jagielski                                     const bool bWithNumber = true,
43*b1cdbd2cSJim Jagielski                                     const bool bWithSpacesForLevel = false ) const = 0;
44*b1cdbd2cSJim Jagielski 
45*b1cdbd2cSJim Jagielski     /** get vector of all list items
46*b1cdbd2cSJim Jagielski     */
47*b1cdbd2cSJim Jagielski     virtual void getListItems( IDocumentListItems::tSortedNodeNumList& orNodeNumList ) const = 0;
48*b1cdbd2cSJim Jagielski 
49*b1cdbd2cSJim Jagielski     /** get vector of all list items, which are numbered
50*b1cdbd2cSJim Jagielski     */
51*b1cdbd2cSJim Jagielski     virtual void getNumItems( IDocumentListItems::tSortedNodeNumList& orNodeNumList ) const = 0;
52*b1cdbd2cSJim Jagielski 
53*b1cdbd2cSJim Jagielski protected:
~IDocumentListItems()54*b1cdbd2cSJim Jagielski     virtual ~IDocumentListItems() {};
55*b1cdbd2cSJim Jagielski };
56*b1cdbd2cSJim Jagielski 
57*b1cdbd2cSJim Jagielski  #endif // IDOCUMENTLISTITEMS_HXX_INCLUDED
58