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_ANIMATABLESHAPE_HXX 29*cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_ANIMATABLESHAPE_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include <boost/shared_ptr.hpp> 32*cdf0e10cSrcweir 33*cdf0e10cSrcweir #include "shape.hxx" 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir 36*cdf0e10cSrcweir namespace slideshow 37*cdf0e10cSrcweir { 38*cdf0e10cSrcweir namespace internal 39*cdf0e10cSrcweir { 40*cdf0e10cSrcweir /** Represents an animatable shape. 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir This interface adds animation handling methods to a 43*cdf0e10cSrcweir shape. It allows transparent switching between 44*cdf0e10cSrcweir sprite-based viewing and static painting, depending on 45*cdf0e10cSrcweir whether animations are currently running. 46*cdf0e10cSrcweir */ 47*cdf0e10cSrcweir class AnimatableShape : public Shape 48*cdf0e10cSrcweir { 49*cdf0e10cSrcweir public: 50*cdf0e10cSrcweir // Animation methods 51*cdf0e10cSrcweir //------------------------------------------------------------------ 52*cdf0e10cSrcweir 53*cdf0e10cSrcweir /** Notify the Shape that an animation starts now 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir This method enters animation mode on all registered 56*cdf0e10cSrcweir views. 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir @attention This method is supposed to be called only 59*cdf0e10cSrcweir from the LayerManager, since it might involve shifting 60*cdf0e10cSrcweir shapes between different layers (and removing this 61*cdf0e10cSrcweir shape from the background layer in the first place) 62*cdf0e10cSrcweir */ 63*cdf0e10cSrcweir virtual void enterAnimationMode() = 0; 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir /** Notify the Shape that it is no longer animated 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir This methods requests the Shape to end animation mode 68*cdf0e10cSrcweir on all registered views, if called more or equal the 69*cdf0e10cSrcweir times enterAnimationMode() was called. That is, the 70*cdf0e10cSrcweir Shape only leaves animation mode, if all requested 71*cdf0e10cSrcweir enterAnimationMode() call sites have issued their 72*cdf0e10cSrcweir matching leaveAnimationMode(). 73*cdf0e10cSrcweir 74*cdf0e10cSrcweir @attention This method is supposed to be called only 75*cdf0e10cSrcweir from the LayerManager, since it might involve shifting 76*cdf0e10cSrcweir shapes between different layers (and adding this 77*cdf0e10cSrcweir shape to the background layer again) 78*cdf0e10cSrcweir */ 79*cdf0e10cSrcweir virtual void leaveAnimationMode() = 0; 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir }; 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir typedef ::boost::shared_ptr< AnimatableShape > AnimatableShapeSharedPtr; 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir } 86*cdf0e10cSrcweir } 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_ANIMATABLESHAPE_HXX */ 89