slideshow::internal::DocTreeNode Class Reference

This class represents kind of a DOM tree node for shape text. More...

#include <doctreenode.hxx>

Public Types
enum class	NodeType {   LogicalParagraph =129 ,   LogicalWord =131 ,   LogicalCharacterCell =132 }
	Type of shape entity represented by this node. More...

Public Member Functions
	DocTreeNode ()
	Create empty tree node. More...
	DocTreeNode (sal_Int32 nStartIndex, sal_Int32 nEndIndex)
	Create tree node from start and end index. More...
bool	isEmpty () const
sal_Int32	getStartIndex () const
void	setStartIndex (sal_Int32 nIndex)
sal_Int32	getEndIndex () const
void	setEndIndex (sal_Int32 nIndex)
void	reset ()

Private Attributes
sal_Int32	mnStartIndex
sal_Int32	mnEndIndex

Detailed Description

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.

Definition at line 44 of file doctreenode.hxx.

Member Enumeration Documentation

NodeType

enum class slideshow::internal::DocTreeNode::NodeType

strong

Type of shape entity represented by this node.

Enumerator
LogicalParagraph	This node represents a paragraph.
LogicalWord	This node represents a word.
LogicalCharacterCell	This node represents a character.

Definition at line 48 of file doctreenode.hxx.

Constructor & Destructor Documentation

DocTreeNode() [1/2]

slideshow::internal::DocTreeNode::DocTreeNode ( )

inline

Create empty tree node.

Definition at line 60 of file doctreenode.hxx.

DocTreeNode() [2/2]

slideshow::internal::DocTreeNode::DocTreeNode ( sal_Int32  nStartIndex, sal_Int32  nEndIndex  )

inline

Create tree node from start and end index.

Create a tree node for the given range and type.

Parameters

nStartIndex	Start index
nEndIndex	End index (exclusive)
eType	Node type

Definition at line 79 of file doctreenode.hxx.

Member Function Documentation

getEndIndex()

sal_Int32 slideshow::internal::DocTreeNode::getEndIndex ( ) const

inline

Definition at line 90 of file doctreenode.hxx.

References mnEndIndex.

Referenced by slideshow::internal::DrawShapeSubsetting::addSubsetShape(), slideshow::internal::DrawShapeSubsetting::excludeSubset(), slideshow::internal::DrawShapeSubsetting::getNumberOfSubsetTreeNodes(), slideshow::internal::DrawShapeSubsetting::getSubsetShape(), slideshow::internal::DrawShapeSubsetting::getSubsetTreeNode(), slideshow::internal::DrawShapeSubsetting::revokeSubsetShape(), and slideshow::internal::ShapeSubset::ShapeSubset().

getStartIndex()

sal_Int32 slideshow::internal::DocTreeNode::getStartIndex ( ) const

inline

Definition at line 88 of file doctreenode.hxx.

References mnStartIndex.

Referenced by slideshow::internal::DrawShapeSubsetting::addSubsetShape(), slideshow::internal::DrawShape::createSubset(), slideshow::internal::DrawShapeSubsetting::excludeSubset(), slideshow::internal::DrawShapeSubsetting::getNumberOfSubsetTreeNodes(), slideshow::internal::DrawShapeSubsetting::getSubsetShape(), slideshow::internal::DrawShapeSubsetting::getSubsetTreeNode(), slideshow::internal::DrawShapeSubsetting::revokeSubsetShape(), and slideshow::internal::ShapeSubset::ShapeSubset().

isEmpty()

bool slideshow::internal::DocTreeNode::isEmpty ( ) const

inline

Definition at line 86 of file doctreenode.hxx.

References mnEndIndex, and mnStartIndex.

Referenced by slideshow::internal::ShapeSubset::enableSubsetShape(), slideshow::internal::DrawShapeSubsetting::excludeSubset(), slideshow::internal::DrawShapeSubsetting::initCurrentSubsets(), and slideshow::internal::ShapeSubset::isFullSet().

reset()

void slideshow::internal::DocTreeNode::reset ( )

inline

Definition at line 93 of file doctreenode.hxx.

References mnEndIndex, and mnStartIndex.

Referenced by slideshow::internal::DrawShapeSubsetting::reset().

setEndIndex()

void slideshow::internal::DocTreeNode::setEndIndex ( sal_Int32  nIndex )

inline

Definition at line 91 of file doctreenode.hxx.

References mnEndIndex, and nIndex.

setStartIndex()

void slideshow::internal::DocTreeNode::setStartIndex ( sal_Int32  nIndex )

inline

Definition at line 89 of file doctreenode.hxx.

References mnStartIndex, and nIndex.

Member Data Documentation

mnEndIndex

sal_Int32 slideshow::internal::DocTreeNode::mnEndIndex

private

Definition at line 101 of file doctreenode.hxx.

Referenced by getEndIndex(), isEmpty(), reset(), and setEndIndex().

mnStartIndex

sal_Int32 slideshow::internal::DocTreeNode::mnStartIndex

private

Definition at line 100 of file doctreenode.hxx.

Referenced by getStartIndex(), isEmpty(), reset(), and setStartIndex().

---

The documentation for this class was generated from the following file:

• doctreenode.hxx