/////////////////////////////////////////////////////////////////////////////
// Name: wx/timer.h
-// Purpose: wxTimer class and global time-related functions
+// Purpose: wxTimer, wxStopWatch and global time-related functions
// Author: Julian Smart
-// Modified by:
+// Modified by: Vadim Zeitlin (wxTimerBase)
+// Guillermo Rodriguez (global clean up)
// Created: 04/01/98
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Copyright: (c) Julian Smart
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_TIMER_H_BASE_
#define _WX_TIMER_H_BASE_
-#ifdef __GNUG__
- #pragma interface "timerbase.h"
-#endif
+#include "wx/defs.h"
+
+#if wxUSE_TIMER
#include "wx/object.h"
+#include "wx/longlong.h"
+#include "wx/event.h"
+#include "wx/stopwatch.h" // for backwards compatibility
+#include "wx/utils.h"
-// ----------------------------------------------------------------------------
-// wxTimer
-// ----------------------------------------------------------------------------
+
+// more readable flags for Start():
+
+// generate notifications periodically until the timer is stopped (default)
+#define wxTIMER_CONTINUOUS false
+
+// only send the notification once and then stop the timer
+#define wxTIMER_ONE_SHOT true
+
+class WXDLLIMPEXP_FWD_BASE wxTimerImpl;
// the interface of wxTimer class
-class WXDLLEXPORT wxTimerBase : public wxObject
+class WXDLLIMPEXP_BASE wxTimer : public wxEvtHandler
{
public:
- wxTimerBase() { m_oneShot = FALSE; m_milli = 0; }
+ // ctors and initializers
+ // ----------------------
+
+ // default: if you don't call SetOwner(), your only chance to get timer
+ // notifications is to override Notify() in the derived class
+ wxTimer()
+ {
+ Init();
+ SetOwner(this);
+ }
+
+ // ctor which allows to avoid having to override Notify() in the derived
+ // class: the owner will get timer notifications which can be handled with
+ // EVT_TIMER
+ wxTimer(wxEvtHandler *owner, int timerid = wxID_ANY)
+ {
+ Init();
+ SetOwner(owner, timerid);
+ }
+
+ // same as ctor above
+ void SetOwner(wxEvtHandler *owner, int timerid = wxID_ANY);
+
+ virtual ~wxTimer();
+
// working with the timer
// ----------------------
+ // NB: Start() and Stop() are not supposed to be overridden, they are only
+ // virtual for historical reasons, only Notify() can be overridden
+
// start the timer: if milliseconds == -1, use the same value as for the
// last Start()
- virtual bool Start(int milliseconds = -1, bool oneShot = FALSE)
- {
- if ( milliseconds != -1 )
- {
- m_milli = milliseconds;
- }
-
- m_oneShot = oneShot;
+ //
+ // it is now valid to call Start() multiple times: this just restarts the
+ // timer if it is already running
+ virtual bool Start(int milliseconds = -1, bool oneShot = false);
- return TRUE;
- }
+ // stop the timer, does nothing if the timer is not running
+ virtual void Stop();
+ // override this in your wxTimer-derived class if you want to process timer
+ // messages in it, use non default ctor or SetOwner() otherwise
+ virtual void Notify();
- // stop the timer
- virtual void Stop() = 0;
- // override this in your wxTimer-derived class
- virtual void Notify() = 0;
+ // accessors
+ // ---------
- // getting info
- // ------------
+ // get the object notified about the timer events
+ wxEvtHandler *GetOwner() const;
- // return TRUE if the timer is running
- virtual bool IsRunning() const = 0;
+ // return true if the timer is running
+ bool IsRunning() const;
- // get the (last) timer interval in the milliseconds
- int GetInterval() const { return m_milli; }
+ // return the timer ID
+ int GetId() const;
- // return TRUE if the timer is one shot
- bool IsOneShot() const { return m_oneShot; }
+ // get the (last) timer interval in milliseconds
+ int GetInterval() const;
-#if WXWIN_COMPATIBILITY_2
- // deprecated functions
- int Interval() const { return GetInterval(); };
- bool OneShot() const { return IsOneShot(); }
-#endif // WXWIN_COMPATIBILITY_2
+ // return true if the timer is one shot
+ bool IsOneShot() const;
protected:
- int m_milli; // the timer interval
- bool m_oneShot; // TRUE if one shot
-};
+ // common part of all ctors
+ void Init();
-#if defined(__WXMSW__)
- #include "wx/msw/timer.h"
-#elif defined(__WXMOTIF__)
- #include "wx/motif/timer.h"
-#elif defined(__WXGTK__)
- #include "wx/gtk/timer.h"
-#elif defined(__WXQT__)
- #include "wx/qt/timer.h"
-#elif defined(__WXMAC__)
- #include "wx/mac/timer.h"
-#elif defined(__WXPM__)
- #include "wx/os2/timer.h"
-#elif defined(__WXSTUBS__)
- #include "wx/stubs/timer.h"
-#endif
+ wxTimerImpl *m_impl;
+
+ DECLARE_NO_COPY_CLASS(wxTimer)
+};
// ----------------------------------------------------------------------------
-// wxStopWatch
+// wxTimerRunner: starts the timer in its ctor, stops in the dtor
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxStopWatch
+class WXDLLEXPORT wxTimerRunner
{
-public:
- // ctor starts the stop watch
- wxStopWatch() { Start(); }
+public:
+ wxTimerRunner(wxTimer& timer) : m_timer(timer) { }
+ wxTimerRunner(wxTimer& timer, int milli, bool oneShot = false)
+ : m_timer(timer)
+ {
+ m_timer.Start(milli, oneShot);
+ }
- void Start(long t = 0); // (re)start it t milliseconds ago
- inline void Pause();
- void Resume() { Start(m_pause); }
+ void Start(int milli, bool oneShot = false)
+ {
+ m_timer.Start(milli, oneShot);
+ }
- // get the elapsed time since the last Start() or Pause() in milliseconds
- long Time() const;
+ ~wxTimerRunner()
+ {
+ if ( m_timer.IsRunning() )
+ {
+ m_timer.Stop();
+ }
+ }
-protected:
- // returns the elapsed time since t0
- inline long GetElapsedTime() const;
-
private:
- long m_t0; // the time of the last Start()
- long m_pause; // the time of the last Pause() or 0
-};
+ wxTimer& m_timer;
-// the old name
-#ifdef WXWIN_COMPATIBILITY_2
- typedef wxStopWatch wxChrono;
-#endif // WXWIN_COMPATIBILITY_2
+ DECLARE_NO_COPY_CLASS(wxTimerRunner)
+};
// ----------------------------------------------------------------------------
-// global time functions
+// wxTimerEvent
// ----------------------------------------------------------------------------
-// Timer functions (milliseconds) -- use wxStopWatch instead
-void WXDLLEXPORT wxStartTimer();
+class WXDLLIMPEXP_BASE wxTimerEvent : public wxEvent
+{
+public:
+ wxTimerEvent(wxTimer& timer)
+ : wxEvent(timer.GetId(), wxEVT_TIMER),
+ m_timer(timer)
+ {
+ SetEventObject(timer.GetOwner());
+ }
+
+ // accessors
+ int GetInterval() const { return m_timer.GetInterval(); }
+ wxTimer& GetTimer() const { return m_timer; }
-// Gets time since last wxStartTimer or wxGetElapsedTime -- use wxStopWatch
-// instead
-long WXDLLEXPORT wxGetElapsedTime(bool resetTimer = TRUE);
+ // implement the base class pure virtual
+ virtual wxEvent *Clone() const { return new wxTimerEvent(*this); }
-// Get the local time
-bool WXDLLEXPORT wxGetLocalTime(long *timeZone, int *dstObserved);
+private:
+ wxTimer& m_timer;
-// Get number of seconds since 00:00:00 GMT, Jan 1st 1970.
-long WXDLLEXPORT wxGetCurrentTime();
+ DECLARE_ABSTRACT_CLASS(wxTimerEvent)
+ DECLARE_NO_ASSIGN_CLASS(wxTimerEvent)
+};
-// Get number of milliseconds since 00:00:00 GMT, Jan 1st 1970.
-long WXDLLEXPORT wxGetCurrentMTime();
+typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
-// ----------------------------------------------------------------------------
-// inline functions
-// ----------------------------------------------------------------------------
+#define wxTimerEventHandler(func) \
+ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTimerEventFunction, &func)
-inline long wxStopWatch::GetElapsedTime() const
-{
- return wxGetCurrentMTime() - m_t0;
-}
+#define EVT_TIMER(timerid, func) \
+ wx__DECLARE_EVT1(wxEVT_TIMER, timerid, wxTimerEventHandler(func))
-inline void wxStopWatch::Pause()
-{
- m_pause = GetElapsedTime();
-}
+#endif // wxUSE_TIMER
-#endif
- // _WX_TIMER_H_BASE_
+#endif // _WX_TIMER_H_BASE_
projects / wxWidgets.git / blobdiff