1 /************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28 #ifndef INCLUDED_SLIDESHOW_HSLCOLORANIMATION_HXX 29 #define INCLUDED_SLIDESHOW_HSLCOLORANIMATION_HXX 30 31 #include "animation.hxx" 32 #include "hslcolor.hxx" 33 34 35 /* Definition of HSLColorAnimation interface */ 36 37 namespace slideshow 38 { 39 namespace internal 40 { 41 /** Interface defining a HSL color animation. 42 43 This interface is a specialization of the Animation 44 interface, and is used to animate attributes representable 45 by a HSL color value. 46 */ 47 class HSLColorAnimation : public Animation 48 { 49 public: 50 typedef HSLColor ValueType; 51 52 /** Set the animation to the given color value 53 54 @param rColor 55 Current animation value. 56 */ 57 virtual bool operator()( const ValueType& rColor ) = 0; 58 59 /** Request the underlying value for this animation. 60 61 This is necessary for pure To or By animations, as the 62 Activity cannot determine a sensible start value 63 otherwise. 64 65 @attention Note that you are only permitted to query 66 for the underlying value, if the animation has actually 67 been started (via start() call). 68 */ 69 virtual ValueType getUnderlyingValue() const = 0; 70 }; 71 72 typedef ::boost::shared_ptr< HSLColorAnimation > HSLColorAnimationSharedPtr; 73 74 } 75 } 76 77 #endif /* INCLUDED_SLIDESHOW_HSLCOLORANIMATION_HXX */ 78