diff --git a/docs/changes.txt b/docs/changes.txt index 5c06bad248..4a4e8018fb 100644 --- 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 wxTimer::StartOnce(). - Add Nepali translation (Him Prasad Gautam). All (GUI): diff --git a/include/wx/timer.h b/include/wx/timer.h index 0b9a63b082..035b299359 100644 --- 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); + // 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(); diff --git a/interface/wx/timer.h b/interface/wx/timer.h index ba5e2394a9..123c626fd6 100644 --- 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 + Alternatively, use StartOnce(). + 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.