1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef INCLUDED_SLIDESHOW_ENUMANIMATION_HXX
25 #define INCLUDED_SLIDESHOW_ENUMANIMATION_HXX
26 
27 #include "animation.hxx"
28 
29 
30 /* Definition of EnumAnimation interface */
31 
32 namespace slideshow
33 {
34     namespace internal
35     {
36         /** Interface defining an enum animation.
37 
38         	This interface is a specialization of the Animation
39         	interface, and is used to animate attributes representable
40         	by a set of constant values, such as UNO constantsm, or enums.
41          */
42         class EnumAnimation : public Animation
43         {
44         public:
45             typedef sal_Int16 ValueType;
46 
47             /** Set the animation to value k
48 
49                 @param k
50                 Current animation value (must be in an
51                 attribute-specific permissible range). Overflowing
52                 values will be clipped to the permissible range
53                 internally.
54              */
55             virtual bool operator()( ValueType k ) = 0;
56 
57             /** Request the underlying value for this animation.
58 
59             	This is necessary for pure To or By animations, as the
60             	Activity cannot determine a sensible start value
61             	otherwise.
62 
63                 @attention Note that you are only permitted to query
64                 for the underlying value, if the animation has actually
65                 been started (via start() call).
66              */
67             virtual ValueType getUnderlyingValue() const = 0;
68         };
69 
70         typedef ::boost::shared_ptr< EnumAnimation > EnumAnimationSharedPtr;
71 
72     }
73 }
74 
75 #endif /* INCLUDED_SLIDESHOW_ENUMANIMATION_HXX */
76