1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef INCLUDED_SLIDESHOW_SHAPESUBSET_HXX 25*b1cdbd2cSJim Jagielski #define INCLUDED_SLIDESHOW_SHAPESUBSET_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "attributableshape.hxx" 28*b1cdbd2cSJim Jagielski #include "subsettableshapemanager.hxx" 29*b1cdbd2cSJim Jagielski #include "doctreenode.hxx" 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski #include <boost/shared_ptr.hpp> 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski namespace slideshow 34*b1cdbd2cSJim Jagielski { 35*b1cdbd2cSJim Jagielski namespace internal 36*b1cdbd2cSJim Jagielski { 37*b1cdbd2cSJim Jagielski class ShapeSubset; 38*b1cdbd2cSJim Jagielski typedef ::boost::shared_ptr< ShapeSubset > ShapeSubsetSharedPtr; 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski /* Definition of ShapeSubset class */ 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski /** Subset RAII wrapper for shapes. 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski This class wraps the plain Shape with a wrapper for subset 45*b1cdbd2cSJim Jagielski functionality. Subsetting can be turned on and off. Note 46*b1cdbd2cSJim Jagielski that the reason to have shape subsetting RAII implemented 47*b1cdbd2cSJim Jagielski separately (i.e. not within the DrawShape) was that 48*b1cdbd2cSJim Jagielski subsetting (and de-subsetting) needs the 49*b1cdbd2cSJim Jagielski SubsettableShapeManager. And holding that at the DrawShape 50*b1cdbd2cSJim Jagielski creates one heck of a circular reference. 51*b1cdbd2cSJim Jagielski */ 52*b1cdbd2cSJim Jagielski class ShapeSubset 53*b1cdbd2cSJim Jagielski { 54*b1cdbd2cSJim Jagielski public: 55*b1cdbd2cSJim Jagielski /** Create a subset directly from a Shape. 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski @param rOriginalShape 58*b1cdbd2cSJim Jagielski Original shape to subset 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski @param rTreeNode 61*b1cdbd2cSJim Jagielski Subset this object should represent 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski @param rShapeManager 64*b1cdbd2cSJim Jagielski Manager object, where subsets are 65*b1cdbd2cSJim Jagielski registered/unregistered 66*b1cdbd2cSJim Jagielski */ 67*b1cdbd2cSJim Jagielski ShapeSubset( const AttributableShapeSharedPtr& rOriginalShape, 68*b1cdbd2cSJim Jagielski const DocTreeNode& rTreeNode, 69*b1cdbd2cSJim Jagielski const SubsettableShapeManagerSharedPtr& rSubsetManager ); 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski /** Create a subset from another subset. 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski Note: if you want this subset to subtract from the 74*b1cdbd2cSJim Jagielski passed subset reference (and not from the original, 75*b1cdbd2cSJim Jagielski unsubsetted shape), the passed subset must be enabled 76*b1cdbd2cSJim Jagielski (enableSubsetShape() must have been called) 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski @param rOriginalSubset 79*b1cdbd2cSJim Jagielski Original subset, which to subset again. 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski @param rTreeNode 82*b1cdbd2cSJim Jagielski Subset of the original subset 83*b1cdbd2cSJim Jagielski */ 84*b1cdbd2cSJim Jagielski ShapeSubset( const ShapeSubsetSharedPtr& rOriginalSubset, 85*b1cdbd2cSJim Jagielski const DocTreeNode& rTreeNode ); 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski /** Create full set for the given shape. 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski @param rOriginalShape 90*b1cdbd2cSJim Jagielski Original shape, which will be represented as a whole 91*b1cdbd2cSJim Jagielski by this object 92*b1cdbd2cSJim Jagielski */ 93*b1cdbd2cSJim Jagielski ShapeSubset( const AttributableShapeSharedPtr& rOriginalShape, 94*b1cdbd2cSJim Jagielski const SubsettableShapeManagerSharedPtr& rShapeManager ); 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski ~ShapeSubset(); 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski /** Get the actual subset shape. 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski If the subset is currently revoked, this method 101*b1cdbd2cSJim Jagielski returns the original shape. 102*b1cdbd2cSJim Jagielski */ 103*b1cdbd2cSJim Jagielski AttributableShapeSharedPtr getSubsetShape() const; 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski /** Enable the subset shape. 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski This method enables the subset. That means, on 108*b1cdbd2cSJim Jagielski successful completion of this method, the original 109*b1cdbd2cSJim Jagielski shape will cease to show the subset range, and 110*b1cdbd2cSJim Jagielski getSubsetShape() will return a valid shape. 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski @return true, if subsetting was successfully enabled. 113*b1cdbd2cSJim Jagielski */ 114*b1cdbd2cSJim Jagielski bool enableSubsetShape(); 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski /** Disable the subset shape. 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski This method revokes the subset from the original 119*b1cdbd2cSJim Jagielski shape. That means, the original shape will again show 120*b1cdbd2cSJim Jagielski the hidden range. 121*b1cdbd2cSJim Jagielski */ 122*b1cdbd2cSJim Jagielski void disableSubsetShape(); 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski /** Query whether this subset actually is none, but 125*b1cdbd2cSJim Jagielski contains the whole original shape's content 126*b1cdbd2cSJim Jagielski */ 127*b1cdbd2cSJim Jagielski bool isFullSet() const; 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski /** Query subset this object represents 130*b1cdbd2cSJim Jagielski */ 131*b1cdbd2cSJim Jagielski DocTreeNode getSubset() const; 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski private: 134*b1cdbd2cSJim Jagielski // default copy/assignment are okay 135*b1cdbd2cSJim Jagielski //ShapeSubset(const ShapeSubset&); 136*b1cdbd2cSJim Jagielski //ShapeSubset& operator=( const ShapeSubset& ); 137*b1cdbd2cSJim Jagielski 138*b1cdbd2cSJim Jagielski AttributableShapeSharedPtr mpOriginalShape; 139*b1cdbd2cSJim Jagielski AttributableShapeSharedPtr mpSubsetShape; 140*b1cdbd2cSJim Jagielski DocTreeNode maTreeNode; 141*b1cdbd2cSJim Jagielski SubsettableShapeManagerSharedPtr mpShapeManager; 142*b1cdbd2cSJim Jagielski }; 143*b1cdbd2cSJim Jagielski } 144*b1cdbd2cSJim Jagielski } 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski #endif /* INCLUDED_SLIDESHOW_SHAPESUBSET_HXX */ 147