X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7d4911333fc8fedcb8d02974394f30e4286b5a56..4c86168d9aaa36cffc74afbc6abd1ff5b270db64:/interface/wx/timer.h diff --git a/interface/wx/timer.h b/interface/wx/timer.h index 997422d447..ba5e2394a9 100644 --- a/interface/wx/timer.h +++ b/interface/wx/timer.h @@ -3,9 +3,18 @@ // Purpose: interface of wxTimer // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +// 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 + +wxEventType wxEVT_TIMER; + + /** @class wxTimer @@ -77,7 +86,7 @@ public: wxEvtHandler* GetOwner() const; /** - Returns @true if the timer is one shot, i.e. if it will stop after firing + Returns @true if the timer is one shot, i.e.\ if it will stop after firing the first notification automatically. */ bool IsOneShot() const; @@ -131,6 +140,19 @@ public: }; +/** + @class wxTimerRunner + + Starts the timer in its ctor, stops in the dtor. +*/ +class wxTimerRunner +{ +public: + wxTimerRunner(wxTimer& timer); + wxTimerRunner(wxTimer& timer, int milli, bool oneShot = false); + void Start(int milli, bool oneShot = false); + ~wxTimerRunner(); +}; /** @class wxTimerEvent @@ -149,11 +171,12 @@ public: private: wxTimer m_timer; + wxDECLARE_EVENT_TABLE(); }; - BEGIN_EVENT_TABLE(MyFrame, wxFrame) + wxBEGIN_EVENT_TABLE(MyFrame, wxFrame) EVT_TIMER(TIMER_ID, MyFrame::OnTimer) - END_EVENT_TABLE() + wxEND_EVENT_TABLE() MyFrame::MyFrame() : m_timer(this, TIMER_ID) @@ -175,6 +198,9 @@ public: class wxTimerEvent : public wxEvent { public: + wxTimerEvent(); + wxTimerEvent(wxTimer& timer); + /** Returns the interval of the timer which generated this event. */