update dev300-m58
[ooovba.git] / slideshow / source / inc / pauseeventhandler.hxx
blob9c8d49324d93a8ce24a5fb09cadfcc166eef3858
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: pauseeventhandler.hxx,v $
10 * $Revision: 1.6 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
31 #ifndef INCLUDED_SLIDESHOW_PAUSEEVENTHANDLER_HXX
32 #define INCLUDED_SLIDESHOW_PAUSEEVENTHANDLER_HXX
34 #include <boost/shared_ptr.hpp>
37 /* Definition of PauseHandler interface */
39 namespace slideshow
41 namespace internal
44 /** Interface for handling pause events.
46 Classes implementing this interface can be added to an
47 EventMultiplexer object, and are called from there to
48 handle pause events.
50 class PauseEventHandler
52 public:
53 /** Handle the event.
55 @param bPauseShow
56 When true, the show is paused. When false, the show is
57 started again
59 @return true, if this handler has successfully
60 processed the pause event. When this method returns
61 false, possibly other, less prioritized handlers are
62 called, too.
64 virtual bool handlePause( bool bPauseShow ) = 0;
67 typedef ::boost::shared_ptr< PauseEventHandler > PauseEventHandlerSharedPtr;
71 #endif /* INCLUDED_SLIDESHOW_PAUSEEVENTHANDLER_HXX */