1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: boolanimation.hxx,v $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
31 #ifndef INCLUDED_SLIDESHOW_BOOLANIMATION_HXX
32 #define INCLUDED_SLIDESHOW_BOOLANIMATION_HXX
34 #include "animation.hxx"
37 /* Definition of BoolAnimation interface */
43 /** Interface defining a bool animation.
45 This interface is a specialization of the Animation
46 interface, and is used to animate attributes that have
47 only two discrete values (on and off, or true and false,
50 class BoolAnimation
: public Animation
53 typedef bool ValueType
;
55 /** Set the animation to the given value
58 Current animation value.
60 virtual bool operator()( ValueType bValue
) = 0;
62 /** Request the underlying value for this animation.
64 This is necessary for pure To or By animations, as the
65 Activity cannot determine a sensible start value
68 @attention Note that you are only permitted to query
69 for the underlying value, if the animation has actually
70 been started (via start() call).
72 virtual ValueType
getUnderlyingValue() const = 0;
75 typedef ::boost::shared_ptr
< BoolAnimation
> BoolAnimationSharedPtr
;
80 #endif /* INCLUDED_SLIDESHOW_BOOLANIMATION_HXX */