Implement monitoring of file descriptors in wxMotif event loop.

[wxWidgets.git] / include / wx / timer.h

diff --git a/include/wx/timer.h b/include/wx/timer.h
index 346b98deeeca8a47cd5ef2a67edef698c5ceaf54..035b2993591b0c9c9e7de396b7bdc6520410d8b8 100644 (file)
--- a/include/wx/timer.h
+++ b/include/wx/timer.h
@@ -32,7 +32,11 @@
 // only send the notification once and then stop the timer
 #define wxTIMER_ONE_SHOT true
 
-class WXDLLIMPEXP_BASE wxTimerImpl;
+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 WXDLLIMPEXP_BASE wxTimer : public wxEvtHandler
@@ -77,6 +81,10 @@ public:
     // timer if it is already running
     virtual bool Start(int milliseconds = -1, bool oneShot = false);
 
+    // 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();
 
@@ -109,14 +117,14 @@ protected:
 
     wxTimerImpl *m_impl;
 
-    DECLARE_NO_COPY_CLASS(wxTimer)
+    wxDECLARE_NO_COPY_CLASS(wxTimer);
 };
 
 // ----------------------------------------------------------------------------
 // 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) { }
@@ -142,7 +150,7 @@ public:
 private:
     wxTimer& m_timer;
 
-    DECLARE_NO_COPY_CLASS(wxTimerRunner)
+    wxDECLARE_NO_COPY_CLASS(wxTimerRunner);
 };
 
 // ----------------------------------------------------------------------------
@@ -152,21 +160,26 @@ private:
 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)
 };
@@ -174,7 +187,7 @@ 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))