sdext/source/presenter/PresenterTimer.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PresenterTimer.hxx,v $
  10  *
  11  * $Revision: 1.2 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef SDEXT_PRESENTER_TIMER_HXX
  33 #define SDEXT_PRESENTER_TIMER_HXX
  34
  35 #include <com/sun/star/awt/XCallback.hpp>
  36 #include <com/sun/star/awt/XRequestCallback.hpp>
  37 #include <cppuhelper/basemutex.hxx>
  38 #include <cppuhelper/compbase1.hxx>
  39 #include <osl/mutex.hxx>
  40 #include <osl/time.h>
  41 #include <rtl/ref.hxx>
  42 #include <sal/types.h>
  43 #include <boost/enable_shared_from_this.hpp>
  44 #include <boost/function.hpp>
  45 #include <vector>
  46
  47 namespace css = ::com::sun::star;
  48
  49 namespace sdext { namespace presenter {
  50
  51 class PresenterClockInternalTimer;
  52
  53 /** The timer allows tasks to be scheduled for execution at a specified time
  54     in the future.
  55 */
  56 class PresenterTimer
  57 {
  58 public:
  59     /** A task is called with the current time.
  60     */
  61     typedef ::boost::function<void(const TimeValue&)> Task;
  62
  63     static const sal_Int32 NotAValidTaskId = 0;
  64
  65     static sal_Int32 ScheduleSingleTaskRelative (
  66         const Task& rTask,
  67         const sal_Int64 nDelay);
  68
  69     static sal_Int32 ScheduleSingleTaskAbsolute (
  70         const Task& rTask,
  71         const TimeValue& rDueTime);
  72
  73     /** Schedule a task to be executed repeatedly.  The task is executed the
  74         first time after nFirst nano-seconds (1000000000 corresponds to one
  75         second).  After that task is executed in intervalls that are
  76         nIntervall ns long until CancelTask is called.
  77     */
  78     static sal_Int32 ScheduleRepeatedTask (
  79         const Task& rTask,
  80         const sal_Int64 nFirst,
  81         const sal_Int64 nIntervall);
  82
  83     static void CancelTask (const sal_Int32 nTaskId);
  84 };
  85
  86
  87
  88 typedef cppu::WeakComponentImplHelper1<
  89     css::awt::XCallback
  90     > PresenterClockTimerInterfaceBase;
  91
  92 /** A timer that calls its listeners, typically clocks, every second to
  93     update their current time value.
  94 */
  95 class PresenterClockTimer
  96     : protected ::cppu::BaseMutex,
  97       public PresenterClockTimerInterfaceBase
  98 {
  99 public:
 100     class Listener { public:
 101         virtual void TimeHasChanged (const oslDateTime& rCurrentTime) = 0;
 102     };
 103     typedef ::boost::shared_ptr<Listener> SharedListener;
 104
 105     static ::rtl::Reference<PresenterClockTimer> Instance (
 106         const css::uno::Reference<css::uno::XComponentContext>& rxContext);
 107
 108     void AddListener (const SharedListener& rListener);
 109     void RemoveListener (const SharedListener& rListener);
 110
 111     static oslDateTime GetCurrentTime (void);
 112
 113     /** Return the difference between the two different times in
 114         nanoseconds.
 115     */
 116     static sal_Int64 GetTimeDifference (const oslDateTime& rNow, const oslDateTime& rThen);
 117
 118     // XCallback
 119
 120     virtual void SAL_CALL notify (const css::uno::Any& rUserData)
 121         throw (css::uno::RuntimeException);
 122
 123 private:
 124     static ::rtl::Reference<PresenterClockTimer> mpInstance;
 125
 126     ::osl::Mutex maMutex;
 127     typedef ::std::vector<SharedListener> ListenerContainer;
 128     ListenerContainer maListeners;
 129     oslDateTime maDateTime;
 130     sal_Int32 mnTimerTaskId;
 131     bool mbIsCallbackPending;
 132     css::uno::Reference<css::awt::XRequestCallback> mxRequestCallback;
 133
 134     PresenterClockTimer (
 135         const css::uno::Reference<css::uno::XComponentContext>& rxContext);
 136     ~PresenterClockTimer (void);
 137
 138     void CheckCurrentTime (const TimeValue& rCurrentTime);
 139 };
 140
 141
 142
 143
 144
 145 } } // end of namespace ::sdext::presenter
 146
 147 #endif