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_PAUSEEVENTHANDLER_HXX
25 #define INCLUDED_SLIDESHOW_PAUSEEVENTHANDLER_HXX
26 
27 #include <boost/shared_ptr.hpp>
28 
29 
30 /* Definition of PauseHandler interface */
31 
32 namespace slideshow
33 {
34     namespace internal
35     {
36 
37         /** Interface for handling pause events.
38 
39         	Classes implementing this interface can be added to an
40         	EventMultiplexer object, and are called from there to
41         	handle pause events.
42          */
43         class PauseEventHandler
44         {
45         public:
46             /** Handle the event.
47 
48             	@param bPauseShow
49                 When true, the show is paused. When false, the show is
50                 started again
51 
52             	@return true, if this handler has successfully
53             	processed the pause event. When this method returns
54             	false, possibly other, less prioritized handlers are
55             	called, too.
56              */
57             virtual bool handlePause( bool bPauseShow ) = 0;
58         };
59 
60         typedef ::boost::shared_ptr< PauseEventHandler > PauseEventHandlerSharedPtr;
61     }
62 }
63 
64 #endif /* INCLUDED_SLIDESHOW_PAUSEEVENTHANDLER_HXX */
65