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