QTimerEvent Class

The QTimerEvent class contains parameters that describe a timer event. More...

Header: #include <QTimerEvent>
CMake: find_package(Qt6 REQUIRED COMPONENTS Core)
target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core
Inherits: QEvent

Public Functions

(since 6.8) QTimerEvent(Qt::TimerId timerId)
QTimerEvent(int timerId)
(since 6.8) Qt::TimerId id() const
(since 6.9) bool matches(const QBasicTimer &timer) const
int timerId() const

Detailed Description

Timer events are sent at regular intervals to objects that have started one or more timers. Each timer has a unique identifier. A timer is started with QObject::startTimer().

The QChronoTimer class provides a high-level programming interface that uses signals instead of events.

The event handler QObject::timerEvent() receives timer events.

See also QChronoTimer, QObject::timerEvent(), QObject::startTimer(), and QObject::killTimer().

Member Function Documentation

[explicit, since 6.8] QTimerEvent::QTimerEvent(Qt::TimerId timerId)

Constructs a timer event object with the timer identifier set to timerId.

This function was introduced in Qt 6.8.

[explicit] QTimerEvent::QTimerEvent(int timerId)

Constructs a timer event object with the timer identifier set to timerId.

[since 6.8] Qt::TimerId QTimerEvent::id() const

Returns the Qt::TimerId of the timer associated with this event, which is the same identifier returned by QObject::startTimer() cast to Qt::TimerId.

This function was introduced in Qt 6.8.

[noexcept, since 6.9] bool QTimerEvent::matches(const QBasicTimer &timer) const

Returns true if this timer event and timer have the same ID, otherwise returns false.

This function was introduced in Qt 6.9.

int QTimerEvent::timerId() const

Returns the unique timer identifier, which is the same identifier as returned from QObject::startTimer().

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.