X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc7a2a602b4bd9308be21bc07e40a680f483438e..09d8cc190df922a72d7dc9f9fdc3a51c037a3ca2:/include/wx/timer.h diff --git a/include/wx/timer.h b/include/wx/timer.h index cc33886ea1..409f88dc53 100644 --- a/include/wx/timer.h +++ b/include/wx/timer.h @@ -6,14 +6,14 @@ // Guillermo Rodriguez (global clean up) // Created: 04/01/98 // RCS-ID: $Id$ -// Copyright: (c) wxWindows team +// Copyright: (c) wxWidgets team // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_TIMER_H_BASE_ #define _WX_TIMER_H_BASE_ -#if defined(__GNUG__) && !defined(__APPLE__) +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "timerbase.h" #endif @@ -33,10 +33,10 @@ // more readable flags for Start(): // generate notifications periodically until the timer is stopped (default) -#define wxTIMER_CONTINUOUS FALSE +#define wxTIMER_CONTINUOUS false // only send the notification once and then stop the timer -#define wxTIMER_ONE_SHOT TRUE +#define wxTIMER_ONE_SHOT true // the interface of wxTimer class class WXDLLEXPORT wxTimerBase : public wxEvtHandler @@ -52,12 +52,13 @@ public: // 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 - wxTimerBase(wxEvtHandler *owner, int id = -1) - { Init(); SetOwner(owner, id); } + wxTimerBase(wxEvtHandler *owner, int timerid = wxID_ANY) + { Init(); SetOwner(owner, timerid); } // same as ctor above - void SetOwner(wxEvtHandler *owner, int id = -1) - { m_owner = owner; m_idTimer = id; } + void SetOwner(wxEvtHandler *owner, int timerid = wxID_ANY) + { m_owner = owner; m_idTimer = timerid; } + wxEvtHandler* GetOwner() const { return m_owner; } virtual ~wxTimerBase(); @@ -69,7 +70,7 @@ public: // // 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); + virtual bool Start(int milliseconds = -1, bool oneShot = false); // stop the timer virtual void Stop() = 0; @@ -81,30 +82,28 @@ public: // getting info // ------------ - // return TRUE if the timer is running + // return true if the timer is running virtual bool IsRunning() const = 0; // get the (last) timer interval in the milliseconds int GetInterval() const { return m_milli; } - // return TRUE if the timer is one shot + // return true if the timer is one shot bool IsOneShot() const { return m_oneShot; } -#if WXWIN_COMPATIBILITY_2 - // deprecated functions - int Interval() const { return GetInterval(); }; - bool OneShot() const { return IsOneShot(); } -#endif // WXWIN_COMPATIBILITY_2 + // return the timer ID + int GetId() const { return m_idTimer; } + protected: // common part of all ctors - void Init() { m_oneShot = FALSE; m_milli = 0; } + void Init() { m_oneShot = false; m_milli = 0; } wxEvtHandler *m_owner; int m_idTimer; int m_milli; // the timer interval - bool m_oneShot; // TRUE if one shot + bool m_oneShot; // true if one shot DECLARE_NO_COPY_CLASS(wxTimerBase) }; @@ -119,8 +118,10 @@ protected: #include "wx/motif/timer.h" #elif defined(__WXGTK__) #include "wx/gtk/timer.h" -#elif defined(__WXX11__) || defined(__WXMGL__) || defined(__WXCOCOA__) +#elif defined(__WXX11__) || defined(__WXMGL__) #include "wx/generic/timer.h" +#elif defined (__WXCOCOA__) + #include "wx/cocoa/timer.h" #elif defined(__WXMAC__) #include "wx/mac/timer.h" #elif defined(__WXPM__) @@ -135,13 +136,13 @@ class WXDLLEXPORT wxTimerRunner { public: wxTimerRunner(wxTimer& timer) : m_timer(timer) { } - wxTimerRunner(wxTimer& timer, int milli, bool oneShot = FALSE) + wxTimerRunner(wxTimer& timer, int milli, bool oneShot = false) : m_timer(timer) { m_timer.Start(milli, oneShot); } - void Start(int milli, bool oneShot = FALSE) + void Start(int milli, bool oneShot = false) { m_timer.Start(milli, oneShot); } @@ -167,7 +168,7 @@ private: class WXDLLEXPORT wxTimerEvent : public wxEvent { public: - wxTimerEvent(int id = 0, int interval = 0) : wxEvent(id) + wxTimerEvent(int timerid = 0, int interval = 0) : wxEvent(timerid) { m_eventType = wxEVT_TIMER; @@ -188,8 +189,11 @@ private: typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&); -#define EVT_TIMER(id, func) \ - DECLARE_EVENT_TABLE_ENTRY( wxEVT_TIMER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTimerEventFunction) & func, NULL), +#define wxTimerEventHandler(func) \ + (wxObjectEventFunction)wxStaticCastEvent(wxTimerEventFunction, &func) + +#define EVT_TIMER(timerid, func) \ + wx__DECLARE_EVT1(wxEVT_TIMER, timerid, wxTimerEventHandler(func)) #endif // wxUSE_GUI && wxUSE_TIMER