X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0824e369691b4a23a484e1d258b6e4ea021b022a..9e9574fe45b176ee74bba8fad7574cf9906145d1:/interface/wx/timer.h diff --git a/interface/wx/timer.h b/interface/wx/timer.h index ba5e2394a9..6753e2dd12 100644 --- a/interface/wx/timer.h +++ b/interface/wx/timer.h @@ -2,7 +2,6 @@ // Name: timer.h // Purpose: interface of wxTimer // Author: wxWidgets team -// RCS-ID: $Id$ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -128,10 +127,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.