1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef INCLUDED_SLIDESHOW_DOCTREENODESUPPLIER_HXX 29*cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_DOCTREENODESUPPLIER_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include "doctreenode.hxx" 32*cdf0e10cSrcweir 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir /* Definition of DocTreeNodeSupplier interface */ 35*cdf0e10cSrcweir 36*cdf0e10cSrcweir namespace slideshow 37*cdf0e10cSrcweir { 38*cdf0e10cSrcweir namespace internal 39*cdf0e10cSrcweir { 40*cdf0e10cSrcweir /** Interface to retrieve DocTreeNodes from subsettable 41*cdf0e10cSrcweir shapes. 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir Shapes which implement the AttributableShape interface 44*cdf0e10cSrcweir also provides this interface, providing methods to 45*cdf0e10cSrcweir retrieve specific DocTreeNode objects from the shape. The 46*cdf0e10cSrcweir methods mainly distinguish various ways on how to specify 47*cdf0e10cSrcweir the actual DocTreeNode to return. 48*cdf0e10cSrcweir 49*cdf0e10cSrcweir If a requested DocTreeNode is not available when one of 50*cdf0e10cSrcweir the methods below is called, an empty DocTreeNode will be 51*cdf0e10cSrcweir returned (the predicate DocTreeNode::isEmpty() will return 52*cdf0e10cSrcweir true). If, on the other hand, the shape cannot determine, 53*cdf0e10cSrcweir for internal reasons, the internal tree node structure, 54*cdf0e10cSrcweir all those methods will throw an 55*cdf0e10cSrcweir ShapeLoadFailedException. This is, in fact, a delayed error 56*cdf0e10cSrcweir that could also have been reported during shape 57*cdf0e10cSrcweir construction, but might be postponed until the missing 58*cdf0e10cSrcweir information is actually requested. 59*cdf0e10cSrcweir */ 60*cdf0e10cSrcweir class DocTreeNodeSupplier 61*cdf0e10cSrcweir { 62*cdf0e10cSrcweir public: 63*cdf0e10cSrcweir /** Query number of tree nodes of the given type this 64*cdf0e10cSrcweir shape contains. 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir The value returned by this method minus one is the 67*cdf0e10cSrcweir maximum value permissible at the getTreeNode() 68*cdf0e10cSrcweir method, for the given node type. 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir @throws ShapeLoadFailedException, if tree node structure 71*cdf0e10cSrcweir cannot be determined. 72*cdf0e10cSrcweir */ 73*cdf0e10cSrcweir virtual sal_Int32 getNumberOfTreeNodes( DocTreeNode::NodeType eNodeType ) const = 0; // throw ShapeLoadFailedException; 74*cdf0e10cSrcweir 75*cdf0e10cSrcweir /** Create DocTreeNode from shape. 76*cdf0e10cSrcweir 77*cdf0e10cSrcweir This method creates a DocTreeNode from a shape, a 78*cdf0e10cSrcweir given node type and a running index into the shape's 79*cdf0e10cSrcweir DocTreeNodes of the given type. 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir @param nNodeIndex 82*cdf0e10cSrcweir Starting with 0, every DocTreeNode of the shape that 83*cdf0e10cSrcweir has type eNodeType is indexed. The DocTreeNode whose 84*cdf0e10cSrcweir index equals nNodeIndex will be returned. 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir @param eNodeType 87*cdf0e10cSrcweir Type of the node to return 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir @return the DocTreeNode found, or the empty 90*cdf0e10cSrcweir DocTreeNode, if nothing was found. 91*cdf0e10cSrcweir 92*cdf0e10cSrcweir @throws ShapeLoadFailedException, if tree node structure 93*cdf0e10cSrcweir cannot be determined. 94*cdf0e10cSrcweir */ 95*cdf0e10cSrcweir virtual DocTreeNode getTreeNode( sal_Int32 nNodeIndex, 96*cdf0e10cSrcweir DocTreeNode::NodeType eNodeType ) const = 0; // throw ShapeLoadFailedException; 97*cdf0e10cSrcweir 98*cdf0e10cSrcweir /** Query number of tree nodes of the given type this 99*cdf0e10cSrcweir subset contains. 100*cdf0e10cSrcweir 101*cdf0e10cSrcweir The value returned by this method minus one is the 102*cdf0e10cSrcweir maximum value permissible at the 103*cdf0e10cSrcweir getSubsetTreeNode() method, for the given node 104*cdf0e10cSrcweir type. 105*cdf0e10cSrcweir 106*cdf0e10cSrcweir @param rParentNode 107*cdf0e10cSrcweir The parent node, below which the number of tree nodes 108*cdf0e10cSrcweir of the given type shall be counted. 109*cdf0e10cSrcweir 110*cdf0e10cSrcweir @param eNodeType 111*cdf0e10cSrcweir Node type to count. 112*cdf0e10cSrcweir 113*cdf0e10cSrcweir @throws ShapeLoadFailedException, if tree node structure 114*cdf0e10cSrcweir cannot be determined. 115*cdf0e10cSrcweir */ 116*cdf0e10cSrcweir virtual sal_Int32 getNumberOfSubsetTreeNodes( const DocTreeNode& rParentNode, 117*cdf0e10cSrcweir DocTreeNode::NodeType eNodeType ) const = 0; // throw ShapeLoadFailedException; 118*cdf0e10cSrcweir 119*cdf0e10cSrcweir /** Create DocTreeNode from shape subset. 120*cdf0e10cSrcweir 121*cdf0e10cSrcweir This method creates a DocTreeNode from a shape, a 122*cdf0e10cSrcweir parent tree node, a given node type and a running 123*cdf0e10cSrcweir index into the shape's DocTreeNodes of the given type. 124*cdf0e10cSrcweir 125*cdf0e10cSrcweir @param rParentNode 126*cdf0e10cSrcweir Parent node, below which the tree node with the given 127*cdf0e10cSrcweir type shall be selected. 128*cdf0e10cSrcweir 129*cdf0e10cSrcweir @param nNodeIndex 130*cdf0e10cSrcweir Starting with 0, every DocTreeNode of the shape that 131*cdf0e10cSrcweir has type eNodeType is indexed. The DocTreeNode whose 132*cdf0e10cSrcweir index equals nNodeIndex will be returned. 133*cdf0e10cSrcweir 134*cdf0e10cSrcweir @param eNodeType 135*cdf0e10cSrcweir Type of the node to return 136*cdf0e10cSrcweir 137*cdf0e10cSrcweir @return the DocTreeNode found, or the empty 138*cdf0e10cSrcweir DocTreeNode, if nothing was found. 139*cdf0e10cSrcweir 140*cdf0e10cSrcweir @throws ShapeLoadFailedException, if tree node structure 141*cdf0e10cSrcweir cannot be determined. 142*cdf0e10cSrcweir */ 143*cdf0e10cSrcweir virtual DocTreeNode getSubsetTreeNode( const DocTreeNode& rParentNode, 144*cdf0e10cSrcweir sal_Int32 nNodeIndex, 145*cdf0e10cSrcweir DocTreeNode::NodeType eNodeType ) const = 0; // throw ShapeLoadFailedException; 146*cdf0e10cSrcweir }; 147*cdf0e10cSrcweir 148*cdf0e10cSrcweir } 149*cdf0e10cSrcweir } 150*cdf0e10cSrcweir 151*cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_DOCTREENODESUPPLIER_HXX */ 152