include/wx/timer.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/timer.h
   3 // Purpose:     wxTimer, wxStopWatch and global time-related functions
   4 // Author:      Julian Smart (wxTimer), Sylvain Bougnoux (wxStopWatch)
   5 // Modified by: Vadim Zeitlin (wxTimerBase)
   6 //              Guillermo Rodriguez (global clean up)
   7 // Created:     04/01/98
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) wxWindows team
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_TIMER_H_BASE_
  14 #define _WX_TIMER_H_BASE_
  15
  16 #ifdef __GNUG__
  17     #pragma interface "timerbase.h"
  18 #endif
  19
  20 #include "wx/setup.h"
  21 #include "wx/object.h"
  22 #include "wx/longlong.h"
  23 #include "wx/event.h"
  24
  25 #if wxUSE_GUI
  26
  27 // ----------------------------------------------------------------------------
  28 // wxTimer
  29 // ----------------------------------------------------------------------------
  30
  31 // the interface of wxTimer class
  32 class WXDLLEXPORT wxTimerBase : public wxObject
  33 {
  34 public:
  35     // ctors and initializers
  36     // ----------------------
  37
  38     // default: if you don't call SetOwner(), your only chance to get timer
  39     // notifications is to override Notify() in the derived class
  40     wxTimerBase() { Init(); SetOwner(NULL); }
  41
  42     // ctor which allows to avoid having to override Notify() in the derived
  43     // class: the owner will get timer notifications which can be handled with
  44     // EVT_TIMER
  45     wxTimerBase(wxEvtHandler *owner, int id = -1)
  46         { Init(); SetOwner(owner, id); }
  47
  48     // same as ctor above
  49     void SetOwner(wxEvtHandler *owner, int id = -1)
  50         { m_owner = owner; m_idTimer = id; }
  51
  52     // working with the timer
  53     // ----------------------
  54
  55     // start the timer: if milliseconds == -1, use the same value as for the
  56     // last Start()
  57     //
  58     // it is now valid to call Start() multiple times: this just restarts the
  59     // timer if it is already running
  60     virtual bool Start(int milliseconds = -1, bool oneShot = FALSE);
  61
  62     // stop the timer
  63     virtual void Stop() = 0;
  64
  65     // override this in your wxTimer-derived class if you want to process timer
  66     // messages in it, use non default ctor or SetOwner() otherwise
  67     virtual void Notify();
  68
  69     // getting info
  70     // ------------
  71
  72     // return TRUE if the timer is running
  73     virtual bool IsRunning() const = 0;
  74
  75     // get the (last) timer interval in the milliseconds
  76     int GetInterval() const { return m_milli; }
  77
  78     // return TRUE if the timer is one shot
  79     bool IsOneShot() const { return m_oneShot; }
  80
  81 #if WXWIN_COMPATIBILITY_2
  82     // deprecated functions
  83     int Interval() const { return GetInterval(); };
  84     bool OneShot() const { return IsOneShot(); }
  85 #endif // WXWIN_COMPATIBILITY_2
  86
  87 protected:
  88     // common part of all ctors
  89     void Init() { m_oneShot = FALSE; m_milli = 0; }
  90
  91     wxEvtHandler *m_owner;
  92     int     m_idTimer;
  93
  94     int     m_milli;        // the timer interval
  95     bool    m_oneShot;      // TRUE if one shot
  96 };
  97
  98 // ----------------------------------------------------------------------------
  99 // wxTimer itself
 100 // ----------------------------------------------------------------------------
 101
 102 #if defined(__WXMSW__)
 103     #include "wx/msw/timer.h"
 104 #elif defined(__WXMOTIF__)
 105     #include "wx/motif/timer.h"
 106 #elif defined(__WXGTK__)
 107     #include "wx/gtk/timer.h"
 108 #elif defined(__WXQT__)
 109     #include "wx/qt/timer.h"
 110 #elif defined(__WXMAC__)
 111     #include "wx/mac/timer.h"
 112 #elif defined(__WXPM__)
 113     #include "wx/os2/timer.h"
 114 #elif defined(__WXSTUBS__)
 115     #include "wx/stubs/timer.h"
 116 #endif
 117
 118 // ----------------------------------------------------------------------------
 119 // wxTimerRunner: starts the timer in its ctor, stops in the dtor
 120 // ----------------------------------------------------------------------------
 121
 122 class WXDLLEXPORT wxTimerRunner
 123 {
 124 public:
 125     wxTimerRunner(wxTimer& timer) : m_timer(timer) { }
 126     wxTimerRunner(wxTimer& timer, int milli, bool oneShot = FALSE)
 127         : m_timer(timer)
 128     {
 129         m_timer.Start(milli, oneShot);
 130     }
 131
 132     void Start(int milli, bool oneShot = FALSE)
 133     {
 134         m_timer.Start(milli, oneShot);
 135     }
 136
 137     ~wxTimerRunner()
 138     {
 139         if ( m_timer.IsRunning() )
 140         {
 141             m_timer.Stop();
 142         }
 143     }
 144
 145 private:
 146     wxTimer& m_timer;
 147 };
 148
 149 // ----------------------------------------------------------------------------
 150 // wxTimerEvent
 151 // ----------------------------------------------------------------------------
 152
 153 class WXDLLEXPORT wxTimerEvent : public wxEvent
 154 {
 155 public:
 156     wxTimerEvent(int id = 0, int interval = 0) : wxEvent(id)
 157     {
 158         m_eventType = wxEVT_TIMER;
 159
 160         m_interval = interval;
 161     }
 162
 163     // accessors
 164     int GetInterval() const { return m_interval; }
 165
 166 private:
 167     int m_interval;
 168
 169     DECLARE_DYNAMIC_CLASS(wxTimerEvent)
 170 };
 171
 172 typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
 173
 174 #define EVT_TIMER(id, func) \
 175     wxEventTableEntry( wxEVT_TIMER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTimerEventFunction) & func, NULL),
 176
 177 #endif // wxUSE_GUI
 178
 179 // ----------------------------------------------------------------------------
 180 // wxStopWatch: measure time intervals with up to 1ms resolution
 181 // ----------------------------------------------------------------------------
 182
 183 class WXDLLEXPORT wxStopWatch
 184 {
 185 public:
 186     // ctor starts the stop watch
 187     wxStopWatch()        { Start(); }
 188     void Start(long t = 0);
 189     void Pause()  { m_pause = GetElapsedTime(); }
 190     void Resume() { Start(m_pause); }
 191
 192     // get elapsed time since the last Start() or Pause() in milliseconds
 193     long Time() const;
 194
 195 protected:
 196     // returns the elapsed time since t0
 197     long GetElapsedTime() const;
 198
 199 private:
 200     wxLongLong m_t0;      // the time of the last Start()
 201     long m_pause;         // the time of the last Pause() or 0
 202 };
 203
 204
 205 // Starts a global timer
 206 // -- DEPRECATED: use wxStopWatch instead
 207 void WXDLLEXPORT wxStartTimer();
 208
 209 // Gets elapsed milliseconds since last wxStartTimer or wxGetElapsedTime
 210 // -- DEPRECATED: use wxStopWatch instead
 211 long WXDLLEXPORT wxGetElapsedTime(bool resetTimer = TRUE);
 212
 213 // ----------------------------------------------------------------------------
 214 // global time functions
 215 // ----------------------------------------------------------------------------
 216
 217 // Get number of seconds since local time 00:00:00 Jan 1st 1970.
 218 extern long WXDLLEXPORT wxGetLocalTime();
 219
 220 // Get number of seconds since GMT 00:00:00, Jan 1st 1970.
 221 extern long WXDLLEXPORT wxGetUTCTime();
 222
 223 // Get number of milliseconds since local time 00:00:00 Jan 1st 1970
 224 extern wxLongLong WXDLLEXPORT wxGetLocalTimeMillis();
 225
 226 #define wxGetCurrentTime() wxGetLocalTime()
 227
 228 #endif
 229     // _WX_TIMER_H_BASE_