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