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_BOOLANIMATION_HXX 29*cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_BOOLANIMATION_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include "animation.hxx" 32*cdf0e10cSrcweir 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir /* Definition of BoolAnimation interface */ 35*cdf0e10cSrcweir 36*cdf0e10cSrcweir namespace slideshow 37*cdf0e10cSrcweir { 38*cdf0e10cSrcweir namespace internal 39*cdf0e10cSrcweir { 40*cdf0e10cSrcweir /** Interface defining a bool animation. 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir This interface is a specialization of the Animation 43*cdf0e10cSrcweir interface, and is used to animate attributes that have 44*cdf0e10cSrcweir only two discrete values (on and off, or true and false, 45*cdf0e10cSrcweir for example). 46*cdf0e10cSrcweir */ 47*cdf0e10cSrcweir class BoolAnimation : public Animation 48*cdf0e10cSrcweir { 49*cdf0e10cSrcweir public: 50*cdf0e10cSrcweir typedef bool ValueType; 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir /** Set the animation to the given value 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir @param bValue 55*cdf0e10cSrcweir Current animation value. 56*cdf0e10cSrcweir */ 57*cdf0e10cSrcweir virtual bool operator()( ValueType bValue ) = 0; 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir /** Request the underlying value for this animation. 60*cdf0e10cSrcweir 61*cdf0e10cSrcweir This is necessary for pure To or By animations, as the 62*cdf0e10cSrcweir Activity cannot determine a sensible start value 63*cdf0e10cSrcweir otherwise. 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir @attention Note that you are only permitted to query 66*cdf0e10cSrcweir for the underlying value, if the animation has actually 67*cdf0e10cSrcweir been started (via start() call). 68*cdf0e10cSrcweir */ 69*cdf0e10cSrcweir virtual ValueType getUnderlyingValue() const = 0; 70*cdf0e10cSrcweir }; 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir typedef ::boost::shared_ptr< BoolAnimation > BoolAnimationSharedPtr; 73*cdf0e10cSrcweir 74*cdf0e10cSrcweir } 75*cdf0e10cSrcweir } 76*cdf0e10cSrcweir 77*cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_BOOLANIMATION_HXX */ 78