1*aaef562fSAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*aaef562fSAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*aaef562fSAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*aaef562fSAndrew Rist  * distributed with this work for additional information
6*aaef562fSAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*aaef562fSAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*aaef562fSAndrew Rist  * "License"); you may not use this file except in compliance
9*aaef562fSAndrew Rist  * with the License.  You may obtain a copy of the License at
10*aaef562fSAndrew Rist  *
11*aaef562fSAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*aaef562fSAndrew Rist  *
13*aaef562fSAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*aaef562fSAndrew Rist  * software distributed under the License is distributed on an
15*aaef562fSAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*aaef562fSAndrew Rist  * KIND, either express or implied.  See the License for the
17*aaef562fSAndrew Rist  * specific language governing permissions and limitations
18*aaef562fSAndrew Rist  * under the License.
19*aaef562fSAndrew Rist  *
20*aaef562fSAndrew Rist  *************************************************************/
21*aaef562fSAndrew Rist 
22*aaef562fSAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef INCLUDED_SLIDESHOW_PAUSEEVENTHANDLER_HXX
25cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_PAUSEEVENTHANDLER_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir #include <boost/shared_ptr.hpp>
28cdf0e10cSrcweir 
29cdf0e10cSrcweir 
30cdf0e10cSrcweir /* Definition of PauseHandler interface */
31cdf0e10cSrcweir 
32cdf0e10cSrcweir namespace slideshow
33cdf0e10cSrcweir {
34cdf0e10cSrcweir     namespace internal
35cdf0e10cSrcweir     {
36cdf0e10cSrcweir 
37cdf0e10cSrcweir         /** Interface for handling pause events.
38cdf0e10cSrcweir 
39cdf0e10cSrcweir         	Classes implementing this interface can be added to an
40cdf0e10cSrcweir         	EventMultiplexer object, and are called from there to
41cdf0e10cSrcweir         	handle pause events.
42cdf0e10cSrcweir          */
43cdf0e10cSrcweir         class PauseEventHandler
44cdf0e10cSrcweir         {
45cdf0e10cSrcweir         public:
46cdf0e10cSrcweir             /** Handle the event.
47cdf0e10cSrcweir 
48cdf0e10cSrcweir             	@param bPauseShow
49cdf0e10cSrcweir                 When true, the show is paused. When false, the show is
50cdf0e10cSrcweir                 started again
51cdf0e10cSrcweir 
52cdf0e10cSrcweir             	@return true, if this handler has successfully
53cdf0e10cSrcweir             	processed the pause event. When this method returns
54cdf0e10cSrcweir             	false, possibly other, less prioritized handlers are
55cdf0e10cSrcweir             	called, too.
56cdf0e10cSrcweir              */
57cdf0e10cSrcweir             virtual bool handlePause( bool bPauseShow ) = 0;
58cdf0e10cSrcweir         };
59cdf0e10cSrcweir 
60cdf0e10cSrcweir         typedef ::boost::shared_ptr< PauseEventHandler > PauseEventHandlerSharedPtr;
61cdf0e10cSrcweir     }
62cdf0e10cSrcweir }
63cdf0e10cSrcweir 
64cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_PAUSEEVENTHANDLER_HXX */
65