Add wxTimer::StartOnce().

This is a simple wrapper for wxTimer::Start(timeout, wxTIMER_ONE_SHOT) but is
often more readable and is definitely better than Start(timeout, true) which
many people still use in spite of wxTIMER_ONE_SHOT existence.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74330 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/changes.txt b/docs/changes.txt
index 5c06bad248277cea45076530d81195315ba9111d..4a4e8018fb0f2fb87792aa14f58bc109f3d15c59 100644 (file)
--- a/docs/changes.txt
+++ b/docs/changes.txt
@@ -597,6 +597,7 @@ All:
 - Add IEEE 754 single/double precision support to wxDataStream classes (net147).
 - Add wxVector<>::const_reverse_iterator (troelsk).
 - Fix thread-safety issue in wxSharedPtr<> (plorkyeran).
 - Add IEEE 754 single/double precision support to wxDataStream classes (net147).
 - Add wxVector<>::const_reverse_iterator (troelsk).
 - Fix thread-safety issue in wxSharedPtr<> (plorkyeran).

+- Add wxTimer::StartOnce().

 - Add Nepali translation (Him Prasad Gautam).
 
 All (GUI):
 - Add Nepali translation (Him Prasad Gautam).
 
 All (GUI):

diff --git a/include/wx/timer.h b/include/wx/timer.h
index 0b9a63b0825b9a0596a065d76ef059bea93af8af..035b2993591b0c9c9e7de396b7bdc6520410d8b8 100644 (file)
--- a/include/wx/timer.h
+++ b/include/wx/timer.h
@@ -81,6 +81,10 @@ public:
     // timer if it is already running
     virtual bool Start(int milliseconds = -1, bool oneShot = false);
 
     // 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();
 
     // stop the timer, does nothing if the timer is not running
     virtual void Stop();
 

diff --git a/interface/wx/timer.h b/interface/wx/timer.h
index ba5e2394a9b64d16c0193fc21b8d26a70f8a9dd5..123c626fd6bb9acb7ad054a11cfbbeca3a3af41c 100644 (file)
--- a/interface/wx/timer.h
+++ b/interface/wx/timer.h
@@ -128,10 +128,21 @@ public:
         To make your code more readable you may also use the following symbolic constants:
         - wxTIMER_CONTINUOUS: Start a normal, continuously running, timer
         - wxTIMER_ONE_SHOT: Start a one shot timer
         To make your code more readable you may also use the following symbolic constants:
         - wxTIMER_CONTINUOUS: Start a normal, continuously running, timer
         - wxTIMER_ONE_SHOT: Start a one shot timer

+        Alternatively, use StartOnce().
+

         If the timer was already running, it will be stopped by this method before
         restarting it.
     */
         If the timer was already running, it will be stopped by this method before
         restarting it.
     */

-    virtual bool Start(int milliseconds = -1, bool oneShot = false);
+    virtual bool Start(int milliseconds = -1, bool oneShot = wxTIMER_CONTINUOUS);
+
+    /**
+        Starts the timer for a once-only notification.
+
+        This is a simple wrapper for Start() with @c wxTIMER_ONE_SHOT parameter.
+
+        @since 2.9.5
+     */
+    bool StartOnce(int milliseconds = -1);

 
     /**
         Stops the timer.
 
     /**
         Stops the timer.