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