1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef INCLUDED_SLIDESHOW_ANIMATIONEVENTHANDLER_HXX
29 #define INCLUDED_SLIDESHOW_ANIMATIONEVENTHANDLER_HXX
30 
31 #include <boost/shared_ptr.hpp>
32 #include "animationnode.hxx"
33 
34 
35 /* Definition of AnimationEventHandler interface */
36 
37 namespace slideshow
38 {
39     namespace internal
40     {
41 
42         /** Interface for handling animation events.
43 
44         	Classes implementing this interface can be added to an
45         	EventMultiplexer object, and are called from there to
46         	handle animation state change events.
47          */
48         class AnimationEventHandler
49         {
50         public:
51             virtual ~AnimationEventHandler() {}
52 
53             /** Handle the event.
54 
55             	@param rNode
56                 Animation node which caused this event to fire
57 
58             	@return true, if this handler has successfully
59             	processed the animation event. When this method
60             	returns false, possibly other, less prioritized
61             	handlers are called, too.
62              */
63             virtual bool handleAnimationEvent( const AnimationNodeSharedPtr& rNode ) = 0;
64         };
65 
66         typedef ::boost::shared_ptr< AnimationEventHandler > AnimationEventHandlerSharedPtr;
67 
68     }
69 }
70 
71 #endif /* INCLUDED_SLIDESHOW_ANIMATIONEVENTHANDLER_HXX */
72