The wxTimer class allows you to execute code at specified intervals. Its
precision is platform-dependent, but in general will not be better than 1ms nor
worse than 1s.
There are three different ways to use this class:
You may derive a new class from wxTimer and override the
member to perform the required action.
Or you may redirect the notifications to any
derived object by using the non-default
constructor or SetOwner
. Then use the EVT_TIMER
macro to connect it to the event handler which will receive
Or you may use a derived class and the EVT_TIMER
macro to connect it to an event handler defined in the derived class.
If the default constructor is used, the timer object will be its
own owner object, since it is derived from wxEvtHandler.
In any case, you must start the timer with Start
after constructing it before it actually starts sending notifications. It can
be stopped later with Stop
Note: A timer can only be used from the main thread.
Default constructor. If you use it to construct the object and don't call
later, you must override
method to process the notifications.
Creates a timer and associates it with owner
. Please see
for the description of parameters.
Destructor. Stops the timer if it is running.
int GetInterval() const
Returns the current interval for the timer (in milliseconds).
bool IsOneShot() const
Returns true if the timer is one shot, i.e. if it will stop after firing the
first notification automatically.
bool IsRunning() const
Returns true if the timer is running, false if it is stopped.
This member should be overridden by the user if the default constructor was
used and SetOwner
Perform whatever action which is to be taken periodically here.
Associates the timer with the given owner
object. When the timer is
running, the owner will receive timer events
id equal to id
bool Start(int milliseconds = -1, bool oneShot = false)
(Re)starts the timer. If milliseconds parameter is -1 (value by default),
the previous value is used. Returns false if the timer could not be started,
true otherwise (in MS Windows timers are a limited resource).
(the default), the Notify
function will be called repeatedly until the timer is stopped. If true
it will be called only once and the timer will stop automatically. To make your
code more readable you may also use the following symbolic constants:
Start a normal, continuously running, timer
Start a one shot timer
If the timer was already running, it will be stopped by this method before
Stops the timer.