sw/inc/IDocumentOutlineNodes.hxx

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