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 IDOCUMENTOUTLINENODES_HXX_INCLUDED 25 #define IDOCUMENTOUTLINENODES_HXX_INCLUDED 26 27 #include <sal/types.h> 28 #include <tools/string.hxx> 29 #include <vector> 30 class SwTxtNode; 31 32 /** Provides outline nodes of a document. 33 */ 34 class IDocumentOutlineNodes 35 { 36 public: 37 typedef ::std::vector< const SwTxtNode* > tSortedOutlineNodeList; 38 39 virtual sal_Int32 getOutlineNodesCount() const = 0; 40 41 virtual int getOutlineLevel( const sal_Int32 nIdx ) const = 0; 42 virtual String getOutlineText( const sal_Int32 nIdx, 43 const bool bWithNumber = true, 44 const bool bWithSpacesForLevel = false ) const = 0; 45 virtual SwTxtNode* getOutlineNode( const sal_Int32 nIdx ) const = 0; 46 47 virtual void getOutlineNodes( IDocumentOutlineNodes::tSortedOutlineNodeList& orOutlineNodeList ) const = 0; 48 49 protected: ~IDocumentOutlineNodes()50 virtual ~IDocumentOutlineNodes() {}; 51 }; 52 53 #endif // IDOCUMENTOUTLINENODES_HXX_INCLUDED 54