X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2dc3af505833b43101accca6966513739a4b4839..9c34a216817028bc533e07873d047208a96b05a2:/include/wx/timer.h?ds=inline diff --git a/include/wx/timer.h b/include/wx/timer.h index 38a746ffa9..035b299359 100644 --- a/include/wx/timer.h +++ b/include/wx/timer.h @@ -15,12 +15,13 @@ #include "wx/defs.h" -#if wxUSE_GUI && wxUSE_TIMER +#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" // more readable flags for Start(): @@ -31,8 +32,14 @@ // only send the notification once and then stop the timer #define wxTIMER_ONE_SHOT true +class WXDLLIMPEXP_FWD_BASE wxTimerImpl; +class WXDLLIMPEXP_FWD_BASE wxTimerEvent; + +// timer event type +wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE, wxEVT_TIMER, wxTimerEvent); + // the interface of wxTimer class -class WXDLLEXPORT wxTimerBase : public wxEvtHandler +class WXDLLIMPEXP_BASE wxTimer : public wxEvtHandler { public: // ctors and initializers @@ -40,25 +47,33 @@ public: // default: if you don't call SetOwner(), your only chance to get timer // notifications is to override Notify() in the derived class - wxTimerBase() - { Init(); SetOwner(this); } + 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 - wxTimerBase(wxEvtHandler *owner, int timerid = wxID_ANY) - { Init(); SetOwner(owner, timerid); } + wxTimer(wxEvtHandler *owner, int timerid = wxID_ANY) + { + Init(); + SetOwner(owner, timerid); + } // same as ctor above - void SetOwner(wxEvtHandler *owner, int timerid = wxID_ANY) - { m_owner = owner; m_idTimer = timerid == wxID_ANY ? wxNewId() : timerid; } - wxEvtHandler * GetOwner() const { return m_owner; } + void SetOwner(wxEvtHandler *owner, int timerid = wxID_ANY); + + virtual ~wxTimer(); - virtual ~wxTimerBase(); // 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() // @@ -66,68 +81,50 @@ public: // timer if it is already running virtual bool Start(int milliseconds = -1, bool oneShot = false); - // stop the timer - virtual void Stop() = 0; + // start the timer for one iteration only, this is just a simple wrapper + // for Start() + bool StartOnce(int milliseconds = -1) { return Start(milliseconds, 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(); - // getting info - // ------------ + + // accessors + // --------- + + // get the object notified about the timer events + wxEvtHandler *GetOwner() const; // return true if the timer is running - virtual bool IsRunning() const = 0; + bool IsRunning() const; // return the timer ID - int GetId() const { return m_idTimer; } + int GetId() const; // get the (last) timer interval in milliseconds - int GetInterval() const { return m_milli; } + int GetInterval() const; // return true if the timer is one shot - bool IsOneShot() const { return m_oneShot; } + bool IsOneShot() const; protected: // common part of all ctors - void Init() - { m_owner = NULL; m_idTimer = wxID_ANY; m_milli = 0; m_oneShot = false; } + void Init(); - wxEvtHandler *m_owner; - int m_idTimer; - int m_milli; // the timer interval - bool m_oneShot; // true if one shot + wxTimerImpl *m_impl; - DECLARE_NO_COPY_CLASS(wxTimerBase) + wxDECLARE_NO_COPY_CLASS(wxTimer); }; -// ---------------------------------------------------------------------------- -// wxTimer itself -// ---------------------------------------------------------------------------- - -#if defined(__WXMSW__) - #include "wx/msw/timer.h" -#elif defined(__WXMOTIF__) - #include "wx/motif/timer.h" -#elif defined(__WXGTK20__) - #include "wx/gtk/timer.h" -#elif defined(__WXGTK__) - #include "wx/gtk1/timer.h" -#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__) - #include "wx/os2/timer.h" -#endif - // ---------------------------------------------------------------------------- // wxTimerRunner: starts the timer in its ctor, stops in the dtor // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxTimerRunner +class WXDLLIMPEXP_BASE wxTimerRunner { public: wxTimerRunner(wxTimer& timer) : m_timer(timer) { } @@ -153,31 +150,36 @@ public: private: wxTimer& m_timer; - DECLARE_NO_COPY_CLASS(wxTimerRunner) + wxDECLARE_NO_COPY_CLASS(wxTimerRunner); }; // ---------------------------------------------------------------------------- // wxTimerEvent // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxTimerEvent : public wxEvent +class WXDLLIMPEXP_BASE wxTimerEvent : public wxEvent { public: - wxTimerEvent(int timerid = 0, int interval = 0) : wxEvent(timerid) - { - m_eventType = wxEVT_TIMER; + wxTimerEvent() + : wxEvent(wxID_ANY, wxEVT_TIMER) { m_timer=NULL; } - m_interval = interval; + wxTimerEvent(wxTimer& timer) + : wxEvent(timer.GetId(), wxEVT_TIMER), + m_timer(&timer) + { + SetEventObject(timer.GetOwner()); } // accessors - int GetInterval() const { return m_interval; } + int GetInterval() const { return m_timer->GetInterval(); } + wxTimer& GetTimer() const { return *m_timer; } // implement the base class pure virtual virtual wxEvent *Clone() const { return new wxTimerEvent(*this); } + virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_TIMER; } private: - int m_interval; + wxTimer* m_timer; DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxTimerEvent) }; @@ -185,12 +187,11 @@ private: typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&); #define wxTimerEventHandler(func) \ - (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTimerEventFunction, &func) + wxEVENT_HANDLER_CAST(wxTimerEventFunction, func) #define EVT_TIMER(timerid, func) \ wx__DECLARE_EVT1(wxEVT_TIMER, timerid, wxTimerEventHandler(func)) -#endif // wxUSE_GUI && wxUSE_TIMER +#endif // wxUSE_TIMER -#endif - // _WX_TIMER_H_BASE_ +#endif // _WX_TIMER_H_BASE_