1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef IDOCUMENTOUTLINENODES_HXX_INCLUDED
29 #define IDOCUMENTOUTLINENODES_HXX_INCLUDED
30 
31 #include <sal/types.h>
32 #include <tools/string.hxx>
33 #include <vector>
34 class SwTxtNode;
35 
36 /** Provides outline nodes of a document.
37 */
38 class IDocumentOutlineNodes
39 {
40 public:
41     typedef ::std::vector< const SwTxtNode* > tSortedOutlineNodeList;
42 
43     virtual sal_Int32 getOutlineNodesCount() const = 0;
44 
45     virtual int getOutlineLevel( const sal_Int32 nIdx ) const = 0;
46     virtual String getOutlineText( const sal_Int32 nIdx,
47                                    const bool bWithNumber = true,
48                                    const bool bWithSpacesForLevel = false ) const = 0;
49     virtual SwTxtNode* getOutlineNode( const sal_Int32 nIdx ) const = 0;
50 
51     virtual void getOutlineNodes( IDocumentOutlineNodes::tSortedOutlineNodeList& orOutlineNodeList ) const = 0;
52 
53 protected:
54     virtual ~IDocumentOutlineNodes() {};
55 };
56 
57  #endif // IDOCUMENTOUTLINENODES_HXX_INCLUDED
58