wx.Timer

The wx.Timer 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 wx.Timer and override the wx.Timer.Notify member to perform the required action.

• You may redirect the notifications to any wx.EvtHandler derived object by using the non-default constructor or wx.Timer.SetOwner . Then use the EVT_TIMER macro to connect it to the event handler which will receive wx.TimerEvent notifications.

• 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 wx.EvtHandler.

In any case, you must start the timer with wx.Timer.Start after constructing it before it actually starts sending notifications. It can be stopped later with wx.Timer.Stop .

Note

A timer can only be used from the main thread.

See also

wx.StopWatch

Class Hierarchy

Inheritance diagram for class Timer:

Methods Summary

__init__	Default constructor.
GetId	Returns the ID of the events generated by this timer.
GetInterval	Returns the current interval for the timer (in milliseconds).
GetOwner	Returns the current owner of the timer.
IsOneShot	Returns True if the timer is one shot, i.e. if it will stop after firing the first notification automatically.
IsRunning	Returns True if the timer is running, False if it is stopped.
Notify	This member should be overridden by the user if the default constructor was used and SetOwner wasn’t called.
SetOwner	Associates the timer with the given owner object.
Start	(Re)starts the timer.
StartOnce	Starts the timer for a once-only notification.
Stop	Stops the timer.

Properties Summary

Id	See GetId
Interval	See GetInterval
Owner	See GetOwner and SetOwner

Class API

class wx.Timer(EvtHandler)

Possible constructors:

Timer() -> None

Timer(owner, id=-1) -> None

The Timer class allows you to execute code at specified intervals.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

If you use it to construct the object and don’t call SetOwner later, you must override Notify method to process the notifications.

Return type:

None

---

__init__ (self, owner, id=-1)

Creates a timer and associates it with owner.

Please see SetOwner for the description of parameters.

Parameters:

• owner (wx.EvtHandler)

• id (int)

Return type:

None

---

---

GetId(self)

Returns the ID of the events generated by this timer.

Return type:

int

---

GetInterval(self)

Returns the current interval for the timer (in milliseconds).

Return type:

int

---

GetOwner(self)

Returns the current owner of the timer.

If not None this is the event handler which will receive the timer events (see wx.TimerEvent) when the timer is running.

Return type:

wx.EvtHandler

---

IsOneShot(self)

Returns True if the timer is one shot, i.e. if it will stop after firing the first notification automatically.

Return type:

bool

---

IsRunning(self)

Returns True if the timer is running, False if it is stopped.

Return type:

bool

---

Notify(self)

This member should be overridden by the user if the default constructor was used and SetOwner wasn’t called.

Perform whatever action which is to be taken periodically here.

Notice that throwing exceptions from this method is currently not supported, use event-based timer handling approach if an exception can be thrown while handling timer notifications.

Return type:

None

---

SetOwner(self, owner, id=-1)

Associates the timer with the given owner object.

When the timer is running, the owner will receive timer events (see wx.TimerEvent) with id equal to id specified here.

Parameters:

• owner (wx.EvtHandler)

• id (int)

Return type:

None

---

Start(self, milliseconds=-1, oneShot=TIMER_CONTINUOUS)

(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).

If oneShot is False (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:

• wx.TIMER_CONTINUOUS: Start a normal, continuously running, timer

• wx.TIMER_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.

Parameters:

• milliseconds (int)

• oneShot (bool)

Return type:

bool

---

StartOnce(self, milliseconds=-1)

Starts the timer for a once-only notification.

This is a simple wrapper for Start with TIMER_ONE_SHOT parameter.

Parameters:

milliseconds (int)

Return type:

bool

Added in version 2.9.5.

---

Stop(self)

Stops the timer.

Return type:

None

Properties

Id

See GetId

---

Interval

See GetInterval

---

Owner

See GetOwner and SetOwner