update dev300-m58
[ooovba.git] / slideshow / source / inc / pairanimation.hxx
blob5cf4119d56920e24836975995a97eedc67630dd7
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: pairanimation.hxx,v $
10 * $Revision: 1.6 $
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_PAIRANIMATION_HXX
32 #define INCLUDED_SLIDESHOW_PAIRANIMATION_HXX
34 #include "animation.hxx"
35 #include <basegfx/tuple/b2dtuple.hxx>
38 /* Definition of PairAnimation interface */
40 namespace slideshow
42 namespace internal
44 /** Interface defining a pair of numbers animation.
46 This interface is a specialization of the Animation
47 interface, and is used to animate attributes representable
48 by a pair of floating point values (e.g. a position or a
49 size).
51 class PairAnimation : public Animation
53 public:
54 typedef ::basegfx::B2DTuple ValueType;
56 /** Set the animation to the given value
58 @param rValue
59 Current animation value.
61 virtual bool operator()( const ValueType& rValue ) = 0;
63 /** Request the underlying value for this animation.
65 This is necessary for pure To or By animations, as the
66 Activity cannot determine a sensible start value
67 otherwise.
69 @attention Note that you are only permitted to query
70 for the underlying value, if the animation has actually
71 been started (via start() call).
73 virtual ValueType getUnderlyingValue() const = 0;
76 typedef ::boost::shared_ptr< PairAnimation > PairAnimationSharedPtr;
81 #endif /* INCLUDED_SLIDESHOW_PAIRANIMATION_HXX */