sw/inc/IDocumentOutlineNodes.hxx

   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 #pragma once
  21
  22 #include <rtl/ustring.hxx>
  23 #include <vector>
  24
  25 class SwTextNode;
  26 class SwRootFrame;
  27
  28 /** Provides outline nodes of a document.
  29 */
  30 class IDocumentOutlineNodes
  31 {
  32 public:
  33     typedef std::vector< const SwTextNode* > tSortedOutlineNodeList;
  34
  35     virtual tSortedOutlineNodeList::size_type getOutlineNodesCount() const = 0;
  36
  37     virtual int getOutlineLevel( const tSortedOutlineNodeList::size_type nIdx ) const = 0;
  38     virtual OUString getOutlineText( const tSortedOutlineNodeList::size_type nIdx,
  39                                    SwRootFrame const* pLayout,
  40                                    const bool bWithNumber = true,
  41                                    const bool bWithSpacesForLevel = false,
  42                                    const bool bWithFootnote = true ) const = 0;
  43     virtual SwTextNode* getOutlineNode( const tSortedOutlineNodeList::size_type nIdx ) const = 0;
  44
  45     virtual bool isOutlineInLayout(tSortedOutlineNodeList::size_type nIdx,
  46             SwRootFrame const& rLayout) const = 0;
  47
  48     virtual void getOutlineNodes( IDocumentOutlineNodes::tSortedOutlineNodeList& orOutlineNodeList ) const = 0;
  49
  50 protected:
  51     virtual ~IDocumentOutlineNodes() {};
  52 };
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */