include/wx/timer.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/timer.h
   3 // Purpose:     wxTimer, wxStopWatch and global time-related functions
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin (wxTimerBase)
   6 //              Guillermo Rodriguez (global clean up)
   7 // Created:     04/01/98
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) Julian Smart
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_TIMER_H_BASE_
  14 #define _WX_TIMER_H_BASE_
  15
  16 #include "wx/defs.h"
  17
  18 #if wxUSE_GUI && wxUSE_TIMER
  19
  20 #include "wx/object.h"
  21 #include "wx/longlong.h"
  22 #include "wx/event.h"
  23 #include "wx/stopwatch.h" // for backwards compatibility
  24
  25 // ----------------------------------------------------------------------------
  26 // wxTimer
  27 // ----------------------------------------------------------------------------
  28
  29 // more readable flags for Start():
  30
  31 // generate notifications periodically until the timer is stopped (default)
  32 #define wxTIMER_CONTINUOUS false
  33
  34 // only send the notification once and then stop the timer
  35 #define wxTIMER_ONE_SHOT true
  36
  37 // the interface of wxTimer class
  38 class WXDLLEXPORT wxTimerBase : public wxEvtHandler
  39 {
  40 public:
  41     // ctors and initializers
  42     // ----------------------
  43
  44     // default: if you don't call SetOwner(), your only chance to get timer
  45     // notifications is to override Notify() in the derived class
  46     wxTimerBase() { Init(); SetOwner(this); }
  47
  48     // ctor which allows to avoid having to override Notify() in the derived
  49     // class: the owner will get timer notifications which can be handled with
  50     // EVT_TIMER
  51     wxTimerBase(wxEvtHandler *owner, int timerid = wxID_ANY)
  52         { Init(); SetOwner(owner, timerid); }
  53
  54     // same as ctor above
  55     void SetOwner(wxEvtHandler *owner, int timerid = wxID_ANY)
  56         { m_owner = owner; m_idTimer = timerid; }
  57     wxEvtHandler* GetOwner() const { return m_owner; }
  58
  59     virtual ~wxTimerBase();
  60
  61     // working with the timer
  62     // ----------------------
  63
  64     // start the timer: if milliseconds == -1, use the same value as for the
  65     // last Start()
  66     //
  67     // it is now valid to call Start() multiple times: this just restarts the
  68     // timer if it is already running
  69     virtual bool Start(int milliseconds = -1, bool oneShot = false);
  70
  71     // stop the timer
  72     virtual void Stop() = 0;
  73
  74     // override this in your wxTimer-derived class if you want to process timer
  75     // messages in it, use non default ctor or SetOwner() otherwise
  76     virtual void Notify();
  77
  78     // getting info
  79     // ------------
  80
  81     // return true if the timer is running
  82     virtual bool IsRunning() const = 0;
  83
  84     // get the (last) timer interval in the milliseconds
  85     int GetInterval() const { return m_milli; }
  86
  87     // return true if the timer is one shot
  88     bool IsOneShot() const { return m_oneShot; }
  89
  90     // return the timer ID
  91     int GetId() const { return m_idTimer; }
  92
  93
  94 protected:
  95     // common part of all ctors
  96     void Init() { m_oneShot = false; m_milli = 0; }
  97
  98     wxEvtHandler *m_owner;
  99     int     m_idTimer;
 100
 101     int     m_milli;        // the timer interval
 102     bool    m_oneShot;      // true if one shot
 103
 104     DECLARE_NO_COPY_CLASS(wxTimerBase)
 105 };
 106
 107 // ----------------------------------------------------------------------------
 108 // wxTimer itself
 109 // ----------------------------------------------------------------------------
 110
 111 #if defined(__WXMSW__)
 112     #include "wx/msw/timer.h"
 113 #elif defined(__WXMOTIF__)
 114     #include "wx/motif/timer.h"
 115 #elif defined(__WXGTK20__)
 116     #include "wx/gtk/timer.h"
 117 #elif defined(__WXGTK__)
 118     #include "wx/gtk1/timer.h"
 119 #elif defined(__WXX11__) || defined(__WXMGL__)
 120     #include "wx/generic/timer.h"
 121 #elif defined (__WXCOCOA__)
 122     #include "wx/cocoa/timer.h"
 123 #elif defined(__WXMAC__)
 124     #include "wx/mac/timer.h"
 125 #elif defined(__WXPM__)
 126     #include "wx/os2/timer.h"
 127 #endif
 128
 129 // ----------------------------------------------------------------------------
 130 // wxTimerRunner: starts the timer in its ctor, stops in the dtor
 131 // ----------------------------------------------------------------------------
 132
 133 class WXDLLEXPORT wxTimerRunner
 134 {
 135 public:
 136     wxTimerRunner(wxTimer& timer) : m_timer(timer) { }
 137     wxTimerRunner(wxTimer& timer, int milli, bool oneShot = false)
 138         : m_timer(timer)
 139     {
 140         m_timer.Start(milli, oneShot);
 141     }
 142
 143     void Start(int milli, bool oneShot = false)
 144     {
 145         m_timer.Start(milli, oneShot);
 146     }
 147
 148     ~wxTimerRunner()
 149     {
 150         if ( m_timer.IsRunning() )
 151         {
 152             m_timer.Stop();
 153         }
 154     }
 155
 156 private:
 157     wxTimer& m_timer;
 158
 159     DECLARE_NO_COPY_CLASS(wxTimerRunner)
 160 };
 161
 162 // ----------------------------------------------------------------------------
 163 // wxTimerEvent
 164 // ----------------------------------------------------------------------------
 165
 166 class WXDLLEXPORT wxTimerEvent : public wxEvent
 167 {
 168 public:
 169     wxTimerEvent(int timerid = 0, int interval = 0) : wxEvent(timerid)
 170     {
 171         m_eventType = wxEVT_TIMER;
 172
 173         m_interval = interval;
 174     }
 175
 176     // accessors
 177     int GetInterval() const { return m_interval; }
 178
 179     // implement the base class pure virtual
 180     virtual wxEvent *Clone() const { return new wxTimerEvent(*this); }
 181
 182 private:
 183     int m_interval;
 184
 185     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxTimerEvent)
 186 };
 187
 188 typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
 189
 190 #define wxTimerEventHandler(func) \
 191     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTimerEventFunction, &func)
 192
 193 #define EVT_TIMER(timerid, func) \
 194     wx__DECLARE_EVT1(wxEVT_TIMER, timerid, wxTimerEventHandler(func))
 195
 196 #endif // wxUSE_GUI && wxUSE_TIMER
 197
 198 #endif
 199     // _WX_TIMER_H_BASE_