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_ANIMATIONEVENTHANDLER_HXX
25 #define INCLUDED_SLIDESHOW_ANIMATIONEVENTHANDLER_HXX
26 
27 #include <boost/shared_ptr.hpp>
28 #include "animationnode.hxx"
29 
30 
31 /* Definition of AnimationEventHandler interface */
32 
33 namespace slideshow
34 {
35     namespace internal
36     {
37 
38         /** Interface for handling animation events.
39 
40         	Classes implementing this interface can be added to an
41         	EventMultiplexer object, and are called from there to
42         	handle animation state change events.
43          */
44         class AnimationEventHandler
45         {
46         public:
~AnimationEventHandler()47             virtual ~AnimationEventHandler() {}
48 
49             /** Handle the event.
50 
51             	@param rNode
52                 Animation node which caused this event to fire
53 
54             	@return true, if this handler has successfully
55             	processed the animation event. When this method
56             	returns false, possibly other, less prioritized
57             	handlers are called, too.
58              */
59             virtual bool handleAnimationEvent( const AnimationNodeSharedPtr& rNode ) = 0;
60         };
61 
62         typedef ::boost::shared_ptr< AnimationEventHandler > AnimationEventHandlerSharedPtr;
63 
64     }
65 }
66 
67 #endif /* INCLUDED_SLIDESHOW_ANIMATIONEVENTHANDLER_HXX */
68