|
LibreOffice Module slideshow (master) 1
|
Interface to retrieve DocTreeNodes from subsettable shapes. More...
#include <doctreenodesupplier.hxx>
Public Member Functions | |
| virtual sal_Int32 | getNumberOfTreeNodes (DocTreeNode::NodeType eNodeType) const =0 |
| Query number of tree nodes of the given type this shape contains. More... | |
| virtual DocTreeNode | getTreeNode (sal_Int32 nNodeIndex, DocTreeNode::NodeType eNodeType) const =0 |
| Create DocTreeNode from shape. More... | |
| virtual sal_Int32 | getNumberOfSubsetTreeNodes (const DocTreeNode &rParentNode, DocTreeNode::NodeType eNodeType) const =0 |
| Query number of tree nodes of the given type this subset contains. More... | |
| virtual DocTreeNode | getSubsetTreeNode (const DocTreeNode &rParentNode, sal_Int32 nNodeIndex, DocTreeNode::NodeType eNodeType) const =0 |
| Create DocTreeNode from shape subset. More... | |
Protected Member Functions | |
| ~DocTreeNodeSupplier () | |
Interface to retrieve DocTreeNodes from subsettable shapes.
Shapes which implement the AttributableShape interface also provides this interface, providing methods to retrieve specific DocTreeNode objects from the shape. The methods mainly distinguish various ways on how to specify the actual DocTreeNode to return.
If a requested DocTreeNode is not available when one of the methods below is called, an empty DocTreeNode will be returned (the predicate DocTreeNode::isEmpty() will return true). If, on the other hand, the shape cannot determine, for internal reasons, the internal tree node structure, all those methods will throw an ShapeLoadFailedException. This is, in fact, a delayed error that could also have been reported during shape construction, but might be postponed until the missing information is actually requested.
Definition at line 50 of file doctreenodesupplier.hxx.
|
inlineprotected |
Definition at line 138 of file doctreenodesupplier.hxx.
|
pure virtual |
Query number of tree nodes of the given type this subset contains.
The value returned by this method minus one is the maximum value permissible at the getSubsetTreeNode() method, for the given node type.
| rParentNode | The parent node, below which the number of tree nodes of the given type shall be counted. |
| eNodeType | Node type to count. |
| ShapeLoadFailedException,if | tree node structure cannot be determined. |
Implemented in slideshow::internal::DrawShape.
|
pure virtual |
Query number of tree nodes of the given type this shape contains.
The value returned by this method minus one is the maximum value permissible at the getTreeNode() method, for the given node type.
| ShapeLoadFailedException,if | tree node structure cannot be determined. |
Implemented in slideshow::internal::DrawShape.
|
pure virtual |
Create DocTreeNode from shape subset.
This method creates a DocTreeNode from a shape, a parent tree node, a given node type and a running index into the shape's DocTreeNodes of the given type.
| rParentNode | Parent node, below which the tree node with the given type shall be selected. |
| nNodeIndex | Starting with 0, every DocTreeNode of the shape that has type eNodeType is indexed. The DocTreeNode whose index equals nNodeIndex will be returned. |
| eNodeType | Type of the node to return |
| ShapeLoadFailedException,if | tree node structure cannot be determined. |
Implemented in slideshow::internal::DrawShape.
|
pure virtual |
Create DocTreeNode from shape.
This method creates a DocTreeNode from a shape, a given node type and a running index into the shape's DocTreeNodes of the given type.
| nNodeIndex | Starting with 0, every DocTreeNode of the shape that has type eNodeType is indexed. The DocTreeNode whose index equals nNodeIndex will be returned. |
| eNodeType | Type of the node to return |
| ShapeLoadFailedException,if | tree node structure cannot be determined. |
Implemented in slideshow::internal::DrawShape.
1.9.3