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