diff options
Diffstat (limited to 'slideshow/source/inc/doctreenode.hxx')
-rw-r--r-- | slideshow/source/inc/doctreenode.hxx | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/slideshow/source/inc/doctreenode.hxx b/slideshow/source/inc/doctreenode.hxx new file mode 100644 index 000000000..45bbf77b0 --- /dev/null +++ b/slideshow/source/inc/doctreenode.hxx @@ -0,0 +1,111 @@ +/* -*- 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_SLIDESHOW_SOURCE_INC_DOCTREENODE_HXX +#define INCLUDED_SLIDESHOW_SOURCE_INC_DOCTREENODE_HXX + +#include <sal/types.h> +#include <vector> + + +/* Definition of DocTreeNode class */ + +namespace slideshow::internal + { + + /** This class represents kind of a DOM tree node for shape + text + + In order to animate subsets of shape text, we need + information about the logical and formatting structure of + that text (lines, paragraphs, words etc.). This is + represented in a tree structure, with DocTreeNodes as the + nodes. Instances of this class can be queried from the + DocTreeNodeSupplier interface. + + This class has nothing to do with the Draw document tree. + */ + class DocTreeNode + { + public: + /// Type of shape entity represented by this node + enum class NodeType + { + /// This node represents a paragraph + LogicalParagraph=129, + /// This node represents a word + LogicalWord=131, + /// This node represents a character + LogicalCharacterCell=132 + }; + + /** Create empty tree node + */ + DocTreeNode() : + mnStartIndex(-1), + mnEndIndex(-1) + { + } + + /** Create tree node from start and end index. + + Create a tree node for the given range and type. + + @param nStartIndex + Start index + + @param nEndIndex + End index (exclusive) + + @param eType + Node type + */ + DocTreeNode( sal_Int32 nStartIndex, + sal_Int32 nEndIndex ) : + mnStartIndex(nStartIndex), + mnEndIndex(nEndIndex) + { + } + + bool isEmpty() const { return mnStartIndex == mnEndIndex; } + + sal_Int32 getStartIndex() const { return mnStartIndex; } + void setStartIndex( sal_Int32 nIndex ) { mnStartIndex = nIndex; } + sal_Int32 getEndIndex() const { return mnEndIndex; } + void setEndIndex( sal_Int32 nIndex ) { mnEndIndex = nIndex; } + + void reset() + { + mnStartIndex = -1; + mnEndIndex = -1; + } + + private: + sal_Int32 mnStartIndex; + sal_Int32 mnEndIndex; + + }; + + typedef ::std::vector< DocTreeNode > VectorOfDocTreeNodes; + +} + +#endif // INCLUDED_SLIDESHOW_SOURCE_INC_DOCTREENODE_HXX + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |