]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/timer.h
Document wxKill(wxSIGTERM) reliance on having an open window in wxMSW.
[wxWidgets.git] / include / wx / timer.h
index 2677cab68462d12755bdb535a301e9e1f5ba4c5b..035b2993591b0c9c9e7de396b7bdc6520410d8b8 100644 (file)
@@ -36,7 +36,7 @@ class WXDLLIMPEXP_FWD_BASE wxTimerImpl;
 class WXDLLIMPEXP_FWD_BASE wxTimerEvent;
 
 // timer event type
-wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE, wxEVT_TIMER, wxTimerEvent)
+wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE, wxEVT_TIMER, wxTimerEvent);
 
 // the interface of wxTimer class
 class WXDLLIMPEXP_BASE wxTimer : public wxEvtHandler
@@ -81,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();
 
@@ -113,7 +117,7 @@ protected:
 
     wxTimerImpl *m_impl;
 
-    DECLARE_NO_COPY_CLASS(wxTimer)
+    wxDECLARE_NO_COPY_CLASS(wxTimer);
 };
 
 // ----------------------------------------------------------------------------
@@ -146,7 +150,7 @@ public:
 private:
     wxTimer& m_timer;
 
-    DECLARE_NO_COPY_CLASS(wxTimerRunner)
+    wxDECLARE_NO_COPY_CLASS(wxTimerRunner);
 };
 
 // ----------------------------------------------------------------------------