Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef INCLUDED_SW_INC_IDOCUMENTOUTLINENODES_HXX
      21             : #define INCLUDED_SW_INC_IDOCUMENTOUTLINENODES_HXX
      22             : 
      23             : #include <rtl/ustring.hxx>
      24             : #include <sal/types.h>
      25             : #include <vector>
      26             : class SwTextNode;
      27             : 
      28             : /** Provides outline nodes of a document.
      29             : */
      30        2958 : class IDocumentOutlineNodes
      31             : {
      32             : public:
      33             :     typedef ::std::vector< const SwTextNode* > tSortedOutlineNodeList;
      34             : 
      35             :     virtual sal_Int32 getOutlineNodesCount() const = 0;
      36             : 
      37             :     virtual int getOutlineLevel( const sal_Int32 nIdx ) const = 0;
      38             :     virtual OUString getOutlineText( const sal_Int32 nIdx,
      39             :                                    const bool bWithNumber = true,
      40             :                                    const bool bWithSpacesForLevel = false,
      41             :                                    const bool bWithFootnote = true ) const = 0;
      42             :     virtual SwTextNode* getOutlineNode( const sal_Int32 nIdx ) const = 0;
      43             : 
      44             :     virtual void getOutlineNodes( IDocumentOutlineNodes::tSortedOutlineNodeList& orOutlineNodeList ) const = 0;
      45             : 
      46             : protected:
      47        2949 :     virtual ~IDocumentOutlineNodes() {};
      48             : };
      49             : 
      50             :  #endif // INCLUDED_SW_INC_IDOCUMENTOUTLINENODES_HXX
      51             : 
      52             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */