LibreOffice Module sw (master)  1
IDocumentOutlineNodes.hxx
Go to the documentation of this file.
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 <vector>
25 
26 class SwTextNode;
27 class SwRootFrame;
28 
32 {
33 public:
34  typedef std::vector< const SwTextNode* > tSortedOutlineNodeList;
35 
36  virtual tSortedOutlineNodeList::size_type getOutlineNodesCount() const = 0;
37 
38  virtual int getOutlineLevel( const tSortedOutlineNodeList::size_type nIdx ) const = 0;
39  virtual OUString getOutlineText( const tSortedOutlineNodeList::size_type nIdx,
40  SwRootFrame const* pLayout,
41  const bool bWithNumber = true,
42  const bool bWithSpacesForLevel = false,
43  const bool bWithFootnote = true ) const = 0;
44  virtual SwTextNode* getOutlineNode( const tSortedOutlineNodeList::size_type nIdx ) const = 0;
45 
46  virtual bool isOutlineInLayout(tSortedOutlineNodeList::size_type nIdx,
47  SwRootFrame const& rLayout) const = 0;
48 
49  virtual void getOutlineNodes( IDocumentOutlineNodes::tSortedOutlineNodeList& orOutlineNodeList ) const = 0;
50 
51 protected:
52  virtual ~IDocumentOutlineNodes() {};
53 };
54 
55  #endif // INCLUDED_SW_INC_IDOCUMENTOUTLINENODES_HXX
56 
57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual OUString getOutlineText(const tSortedOutlineNodeList::size_type nIdx, SwRootFrame const *pLayout, const bool bWithNumber=true, const bool bWithSpacesForLevel=false, const bool bWithFootnote=true) const =0
The root element of a Writer document layout.
Definition: rootfrm.hxx:79
virtual void getOutlineNodes(IDocumentOutlineNodes::tSortedOutlineNodeList &orOutlineNodeList) const =0
virtual SwTextNode * getOutlineNode(const tSortedOutlineNodeList::size_type nIdx) const =0
virtual int getOutlineLevel(const tSortedOutlineNodeList::size_type nIdx) const =0
virtual tSortedOutlineNodeList::size_type getOutlineNodesCount() const =0
virtual bool isOutlineInLayout(tSortedOutlineNodeList::size_type nIdx, SwRootFrame const &rLayout) const =0
SwTextNode is a paragraph in the document model.
Definition: ndtxt.hxx:79
Provides outline nodes of a document.
std::vector< const SwTextNode * > tSortedOutlineNodeList