QBasicTimer#

The QBasicTimer class provides timer events for objects. More

Inheritance diagram of PySide6.QtCore.QBasicTimer

Synopsis#

Functions#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

This is a fast, lightweight, and low-level class used by Qt internally. We recommend using the higher-level QTimer class rather than this class if you want to use timers in your applications. Note that this timer is a repeating timer that will send subsequent timer events unless the stop() function is called.

To use this class, create a QBasicTimer , and call its start() function with a timeout interval and with a pointer to a QObject subclass. When the timer times out it will send a timer event to the QObject subclass. The timer can be stopped at any time using stop() . isActive() returns true for a timer that is running; i.e. it has been started, has not reached the timeout time, and has not been stopped. The timer’s ID can be retrieved using timerId() .

Objects of this class cannot be copied, but can be moved, so you can maintain a list of basic timers by holding them in container that supports move-only types, e.g. std::vector.

The Wiggly example uses QBasicTimer to repaint a widget at regular intervals.

class PySide6.QtCore.QBasicTimer#

Constructs a basic timer.

See also

start()

PySide6.QtCore.QBasicTimer.isActive()#
Return type:

bool

Returns true if the timer is running and has not been stopped; otherwise returns false.

See also

start() stop()

PySide6.QtCore.QBasicTimer.start(msec, obj)#
Parameters:

Starts (or restarts) the timer with a msec milliseconds timeout. The timer will be a CoarseTimer . See TimerType for information on the different timer types.

The given object will receive timer events.

Note

In Qt versions prior to 6.5, msec was int, not qint64.

See also

stop() isActive() timerEvent() CoarseTimer

PySide6.QtCore.QBasicTimer.start(msec, timerType, obj)
Parameters:

This is an overloaded function.

Starts (or restarts) the timer with a msec milliseconds timeout and the given timerType. See TimerType for information on the different timer types.

obj will receive timer events.

Note

In Qt versions prior to 6.5, msec was int, not qint64.

See also

stop() isActive() timerEvent() TimerType

PySide6.QtCore.QBasicTimer.stop()#

Stops the timer.

See also

start() isActive()

PySide6.QtCore.QBasicTimer.swap(other)#
Parameters:

otherPySide6.QtCore.QBasicTimer

PySide6.QtCore.QBasicTimer.timerId()#
Return type:

int

Returns the timer’s ID.

See also

timerId()