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     virtual bool Start(int milliseconds = -1, bool oneShot = FALSE)
  58     {
  59         if ( milliseconds != -1 )
  60         {
  61             m_milli = milliseconds;
  62         }
  63
  64         m_oneShot = oneShot;
  65
  66         return TRUE;
  67     }
  68
  69
  70     // stop the timer
  71     virtual void Stop() = 0;
  72
  73     // override this in your wxTimer-derived class if you want to process timer
  74     // messages in it, use non default ctor or SetOwner() otherwise
  75     virtual void Notify();
  76
  77     // getting info
  78     // ------------
  79
  80     // return TRUE if the timer is running
  81     virtual bool IsRunning() const = 0;
  82
  83     // get the (last) timer interval in the milliseconds
  84     int GetInterval() const { return m_milli; }
  85
  86     // return TRUE if the timer is one shot
  87     bool IsOneShot() const { return m_oneShot; }
  88
  89 #if WXWIN_COMPATIBILITY_2
  90     // deprecated functions
  91     int Interval() const { return GetInterval(); };
  92     bool OneShot() const { return IsOneShot(); }
  93 #endif // WXWIN_COMPATIBILITY_2
  94
  95 protected:
  96     // common part of all ctors
  97     void Init() { m_oneShot = FALSE; m_milli = 0; }
  98
  99     wxEvtHandler *m_owner;
 100     int     m_idTimer;
 101
 102     int     m_milli;        // the timer interval
 103     bool    m_oneShot;      // TRUE if one shot
 104 };
 105
 106 // ----------------------------------------------------------------------------
 107 // wxTimer itself
 108 // ----------------------------------------------------------------------------
 109
 110 #if defined(__WXMSW__)
 111     #include "wx/msw/timer.h"
 112 #elif defined(__WXMOTIF__)
 113     #include "wx/motif/timer.h"
 114 #elif defined(__WXGTK__)
 115     #include "wx/gtk/timer.h"
 116 #elif defined(__WXQT__)
 117     #include "wx/qt/timer.h"
 118 #elif defined(__WXMAC__)
 119     #include "wx/mac/timer.h"
 120 #elif defined(__WXPM__)
 121     #include "wx/os2/timer.h"
 122 #elif defined(__WXSTUBS__)
 123     #include "wx/stubs/timer.h"
 124 #endif
 125
 126 // ----------------------------------------------------------------------------
 127 // wxTimerRunner: starts the timer in its ctor, stops in the dtor
 128 // ----------------------------------------------------------------------------
 129
 130 class WXDLLEXPORT wxTimerRunner
 131 {
 132 public:
 133     wxTimerRunner(wxTimer& timer) : m_timer(timer) { }
 134     wxTimerRunner(wxTimer& timer, int milli, bool oneShot = FALSE)
 135         : m_timer(timer)
 136     {
 137         m_timer.Start(milli, oneShot);
 138     }
 139
 140     void Start(int milli, bool oneShot = FALSE)
 141     {
 142         m_timer.Start(milli, oneShot);
 143     }
 144
 145     ~wxTimerRunner()
 146     {
 147         if ( m_timer.IsRunning() )
 148         {
 149             m_timer.Stop();
 150         }
 151     }
 152
 153 private:
 154     wxTimer& m_timer;
 155 };
 156
 157 // ----------------------------------------------------------------------------
 158 // wxTimerEvent
 159 // ----------------------------------------------------------------------------
 160
 161 class WXDLLEXPORT wxTimerEvent : public wxEvent
 162 {
 163 public:
 164     wxTimerEvent(int id = 0, int interval = 0) : wxEvent(id)
 165     {
 166         m_eventType = wxEVT_TIMER;
 167
 168         m_interval = interval;
 169     }
 170
 171     // accessors
 172     int GetInterval() const { return m_interval; }
 173
 174 private:
 175     int m_interval;
 176
 177     DECLARE_DYNAMIC_CLASS(wxTimerEvent)
 178 };
 179
 180 typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
 181
 182 #define EVT_TIMER(id, func) { wxEVT_TIMER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTimerEventFunction) & func, NULL},
 183
 184 #endif // wxUSE_GUI
 185
 186 // ----------------------------------------------------------------------------
 187 // wxStopWatch: measure time intervals with up to 1ms resolution
 188 // ----------------------------------------------------------------------------
 189
 190 class WXDLLEXPORT wxStopWatch
 191 {
 192 public:
 193     // ctor starts the stop watch
 194     wxStopWatch()        { Start(); }
 195     void Start(long t = 0);
 196     void Pause()  { m_pause = GetElapsedTime(); }
 197     void Resume() { Start(m_pause); }
 198
 199     // get elapsed time since the last Start() or Pause() in milliseconds
 200     long Time() const;
 201
 202 protected:
 203     // returns the elapsed time since t0
 204     long GetElapsedTime() const;
 205
 206 private:
 207     wxLongLong m_t0;      // the time of the last Start()
 208     long m_pause;         // the time of the last Pause() or 0
 209 };
 210
 211
 212 // Starts a global timer
 213 // -- DEPRECATED: use wxStopWatch instead
 214 void WXDLLEXPORT wxStartTimer();
 215
 216 // Gets elapsed milliseconds since last wxStartTimer or wxGetElapsedTime
 217 // -- DEPRECATED: use wxStopWatch instead
 218 long WXDLLEXPORT wxGetElapsedTime(bool resetTimer = TRUE);
 219
 220 // ----------------------------------------------------------------------------
 221 // global time functions
 222 // ----------------------------------------------------------------------------
 223
 224 // Get number of seconds since local time 00:00:00 Jan 1st 1970.
 225 extern long WXDLLEXPORT wxGetLocalTime();
 226
 227 // Get number of seconds since GMT 00:00:00, Jan 1st 1970.
 228 extern long WXDLLEXPORT wxGetUTCTime();
 229
 230 // Get number of milliseconds since local time 00:00:00 Jan 1st 1970
 231 extern wxLongLong WXDLLEXPORT wxGetLocalTimeMillis();
 232
 233 #define wxGetCurrentTime() wxGetLocalTime()
 234
 235 #endif
 236     // _WX_TIMER_H_BASE_