xref: /AOO41X/main/slideshow/source/inc/wakeupevent.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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 #ifndef INCLUDED_SLIDESHOW_WAKEUPEVENT_HXX
28*cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_WAKEUPEVENT_HXX
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir #include <canvas/elapsedtime.hxx>
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir #include "event.hxx"
33*cdf0e10cSrcweir #include "activitiesqueue.hxx"
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir #include <boost/bind.hpp>
36*cdf0e10cSrcweir #include <boost/noncopyable.hpp>
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir namespace slideshow {
39*cdf0e10cSrcweir namespace internal {
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir /** Little helper class, used to set Activities active again
42*cdf0e10cSrcweir     after some sleep period.
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir     Clients can use this class to schedule wakeup events at
45*cdf0e10cSrcweir     the EventQueue, to avoid busy-waiting for the next
46*cdf0e10cSrcweir     discrete time instant.
47*cdf0e10cSrcweir */
48*cdf0e10cSrcweir class WakeupEvent : public Event,
49*cdf0e10cSrcweir                     private ::boost::noncopyable
50*cdf0e10cSrcweir {
51*cdf0e10cSrcweir public:
52*cdf0e10cSrcweir     WakeupEvent(
53*cdf0e10cSrcweir         ::boost::shared_ptr< ::canvas::tools::ElapsedTime > const& pTimeBase,
54*cdf0e10cSrcweir         ActivitiesQueue & rActivityQueue );
55*cdf0e10cSrcweir 
56*cdf0e10cSrcweir     virtual void dispose();
57*cdf0e10cSrcweir     virtual bool fire();
58*cdf0e10cSrcweir     virtual bool isCharged() const;
59*cdf0e10cSrcweir     virtual double getActivationTime( double nCurrentTime ) const;
60*cdf0e10cSrcweir 
61*cdf0e10cSrcweir     /// Start the internal timer
62*cdf0e10cSrcweir     void start();
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir     /** Set the next timeout this object should generate.
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir         @param nextTime
67*cdf0e10cSrcweir         Absolute time, measured from the last start() call,
68*cdf0e10cSrcweir         when this event should wakeup the Activity again. If
69*cdf0e10cSrcweir         your time is relative, simply call start() just before
70*cdf0e10cSrcweir         every setNextTimeout() call.
71*cdf0e10cSrcweir     */
72*cdf0e10cSrcweir     void setNextTimeout( double nextTime );
73*cdf0e10cSrcweir 
74*cdf0e10cSrcweir     /** Set activity to wakeup.
75*cdf0e10cSrcweir 
76*cdf0e10cSrcweir         The activity given here will be reinserted into the
77*cdf0e10cSrcweir         ActivitiesQueue, once the timeout is reached.
78*cdf0e10cSrcweir     */
79*cdf0e10cSrcweir     void setActivity( const ActivitySharedPtr& rActivity );
80*cdf0e10cSrcweir 
81*cdf0e10cSrcweir private:
82*cdf0e10cSrcweir     ::canvas::tools::ElapsedTime    maTimer;
83*cdf0e10cSrcweir     double                          mnNextTime;
84*cdf0e10cSrcweir     ActivitySharedPtr               mpActivity;
85*cdf0e10cSrcweir     ActivitiesQueue&                mrActivityQueue;
86*cdf0e10cSrcweir };
87*cdf0e10cSrcweir 
88*cdf0e10cSrcweir typedef ::boost::shared_ptr< WakeupEvent > WakeupEventSharedPtr;
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir } // namespace internal
91*cdf0e10cSrcweir } // namespace presentation
92*cdf0e10cSrcweir 
93*cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_WAKEUPEVENT_HXX */
94