X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/78e87bf7b8fb25529f77881834c75ae1614e6552..86381d4297f0225448823369a0df73ba67664078:/interface/wx/timer.h diff --git a/interface/wx/timer.h b/interface/wx/timer.h index 6d11c2484c..e74e836b92 100644 --- a/interface/wx/timer.h +++ b/interface/wx/timer.h @@ -3,7 +3,7 @@ // Purpose: interface of wxTimer // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -74,7 +74,7 @@ public: If non-@NULL this is the event handler which will receive the timer events (see wxTimerEvent) when the timer is running. */ - wxEvtHandler GetOwner() const; + wxEvtHandler* GetOwner() const; /** Returns @true if the timer is one shot, i.e. if it will stop after firing @@ -92,6 +92,10 @@ public: used and SetOwner() wasn't called. Perform whatever action which is to be taken periodically here. + + Notice that throwing exceptions from this method is currently not + supported, use event-based timer handling approach if an exception can + be thrown while handling timer notifications. */ virtual void Notify(); @@ -131,7 +135,8 @@ public: /** @class wxTimerEvent - wxTimerEvent object is passed to the event handler of timer events. + wxTimerEvent object is passed to the event handler of timer events + (see wxTimer::SetOwner). For example: @@ -144,11 +149,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) @@ -178,6 +184,6 @@ public: /** Returns the timer object which generated this event. */ - wxTimer GetTimer() const; + wxTimer& GetTimer() const; };