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_ANIMATABLESHAPE_HXX
29 #define INCLUDED_SLIDESHOW_ANIMATABLESHAPE_HXX
30 
31 #include <boost/shared_ptr.hpp>
32 
33 #include "shape.hxx"
34 
35 
36 namespace slideshow
37 {
38     namespace internal
39     {
40         /** Represents an animatable shape.
41 
42             This interface adds animation handling methods to a
43             shape. It allows transparent switching between
44             sprite-based viewing and static painting, depending on
45             whether animations are currently running.
46          */
47         class AnimatableShape : public Shape
48         {
49         public:
50             // Animation methods
51             //------------------------------------------------------------------
52 
53             /** Notify the Shape that an animation starts now
54 
55 				This method enters animation mode on all registered
56 				views.
57 
58                 @attention This method is supposed to be called only
59                 from the LayerManager, since it might involve shifting
60                 shapes between different layers (and removing this
61                 shape from the background layer in the first place)
62              */
63             virtual void enterAnimationMode() = 0;
64 
65             /** Notify the Shape that it is no longer animated
66 
67 				This methods requests the Shape to end animation mode
68 				on all registered views, if called more or equal the
69 				times enterAnimationMode() was called. That is, the
70 				Shape only leaves animation mode, if all requested
71 				enterAnimationMode() call sites have issued their
72 				matching leaveAnimationMode().
73 
74                 @attention This method is supposed to be called only
75                 from the LayerManager, since it might involve shifting
76                 shapes between different layers (and adding this
77                 shape to the background layer again)
78              */
79             virtual void leaveAnimationMode() = 0;
80 
81         };
82 
83         typedef ::boost::shared_ptr< AnimatableShape > AnimatableShapeSharedPtr;
84 
85     }
86 }
87 
88 #endif /* INCLUDED_SLIDESHOW_ANIMATABLESHAPE_HXX */
89