1*1d2dbeb0SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*1d2dbeb0SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*1d2dbeb0SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*1d2dbeb0SAndrew Rist  * distributed with this work for additional information
6*1d2dbeb0SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*1d2dbeb0SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*1d2dbeb0SAndrew Rist  * "License"); you may not use this file except in compliance
9*1d2dbeb0SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*1d2dbeb0SAndrew Rist  *
11*1d2dbeb0SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*1d2dbeb0SAndrew Rist  *
13*1d2dbeb0SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*1d2dbeb0SAndrew Rist  * software distributed under the License is distributed on an
15*1d2dbeb0SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*1d2dbeb0SAndrew Rist  * KIND, either express or implied.  See the License for the
17*1d2dbeb0SAndrew Rist  * specific language governing permissions and limitations
18*1d2dbeb0SAndrew Rist  * under the License.
19*1d2dbeb0SAndrew Rist  *
20*1d2dbeb0SAndrew Rist  *************************************************************/
21*1d2dbeb0SAndrew Rist 
22*1d2dbeb0SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef IDOCUMENTOUTLINENODES_HXX_INCLUDED
25cdf0e10cSrcweir #define IDOCUMENTOUTLINENODES_HXX_INCLUDED
26cdf0e10cSrcweir 
27cdf0e10cSrcweir #include <sal/types.h>
28cdf0e10cSrcweir #include <tools/string.hxx>
29cdf0e10cSrcweir #include <vector>
30cdf0e10cSrcweir class SwTxtNode;
31cdf0e10cSrcweir 
32cdf0e10cSrcweir /** Provides outline nodes of a document.
33cdf0e10cSrcweir */
34cdf0e10cSrcweir class IDocumentOutlineNodes
35cdf0e10cSrcweir {
36cdf0e10cSrcweir public:
37cdf0e10cSrcweir     typedef ::std::vector< const SwTxtNode* > tSortedOutlineNodeList;
38cdf0e10cSrcweir 
39cdf0e10cSrcweir     virtual sal_Int32 getOutlineNodesCount() const = 0;
40cdf0e10cSrcweir 
41cdf0e10cSrcweir     virtual int getOutlineLevel( const sal_Int32 nIdx ) const = 0;
42cdf0e10cSrcweir     virtual String getOutlineText( const sal_Int32 nIdx,
43cdf0e10cSrcweir                                    const bool bWithNumber = true,
44cdf0e10cSrcweir                                    const bool bWithSpacesForLevel = false ) const = 0;
45cdf0e10cSrcweir     virtual SwTxtNode* getOutlineNode( const sal_Int32 nIdx ) const = 0;
46cdf0e10cSrcweir 
47cdf0e10cSrcweir     virtual void getOutlineNodes( IDocumentOutlineNodes::tSortedOutlineNodeList& orOutlineNodeList ) const = 0;
48cdf0e10cSrcweir 
49cdf0e10cSrcweir protected:
~IDocumentOutlineNodes()50cdf0e10cSrcweir     virtual ~IDocumentOutlineNodes() {};
51cdf0e10cSrcweir };
52cdf0e10cSrcweir 
53cdf0e10cSrcweir  #endif // IDOCUMENTOUTLINENODES_HXX_INCLUDED
54