diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /sw/inc/IDocumentOutlineNodes.hxx | |
parent | Initial commit. (diff) | |
download | libreoffice-upstream/4%7.4.7.tar.xz libreoffice-upstream/4%7.4.7.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'sw/inc/IDocumentOutlineNodes.hxx')
-rw-r--r-- | sw/inc/IDocumentOutlineNodes.hxx | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/sw/inc/IDocumentOutlineNodes.hxx b/sw/inc/IDocumentOutlineNodes.hxx new file mode 100644 index 000000000..f76276835 --- /dev/null +++ b/sw/inc/IDocumentOutlineNodes.hxx @@ -0,0 +1,57 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef INCLUDED_SW_INC_IDOCUMENTOUTLINENODES_HXX +#define INCLUDED_SW_INC_IDOCUMENTOUTLINENODES_HXX + +#include <rtl/ustring.hxx> +#include <vector> + +class SwTextNode; +class SwRootFrame; + +/** Provides outline nodes of a document. +*/ +class IDocumentOutlineNodes +{ +public: + typedef std::vector< const SwTextNode* > tSortedOutlineNodeList; + + virtual tSortedOutlineNodeList::size_type getOutlineNodesCount() const = 0; + + virtual int getOutlineLevel( const tSortedOutlineNodeList::size_type nIdx ) const = 0; + 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; + virtual SwTextNode* getOutlineNode( const tSortedOutlineNodeList::size_type nIdx ) const = 0; + + virtual bool isOutlineInLayout(tSortedOutlineNodeList::size_type nIdx, + SwRootFrame const& rLayout) const = 0; + + virtual void getOutlineNodes( IDocumentOutlineNodes::tSortedOutlineNodeList& orOutlineNodeList ) const = 0; + +protected: + virtual ~IDocumentOutlineNodes() {}; +}; + + #endif // INCLUDED_SW_INC_IDOCUMENTOUTLINENODES_HXX + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |