QTimer Class

     QTimer *timer = new QTimer(this);
     connect(timer, &QTimer::timeout, this, QOverload<>::of(&AnalogClock::update));
     timer->start(1000);

     QTimer::singleShot(200, this, &Foo::updateCaption);

     QTimer *timer = new QTimer(this);
     connect(timer, &QTimer::timeout, this, &Foo::processOneThing);
     timer->start();

Member Function Documentation

QTimer::QTimer(QObject *parent = nullptr)

Constructs a timer with the given parent.

[slot] void QTimer::start()

This function overloads start().

Starts or restarts the timer with the timeout specified in interval.

If the timer is already running, it will be stopped and restarted.

If singleShot is true, the timer will be activated only once.

[slot] void QTimer::start(int msec)

Starts or restarts the timer with a timeout interval of msec milliseconds.

If the timer is already running, it will be stopped and restarted.

If singleShot is true, the timer will be activated only once.

[slot] void QTimer::stop()

Stops the timer.

See also start().

[signal] void QTimer::timeout()

This signal is emitted when the timer times out.

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

See also interval, start(), and stop().

[virtual] QTimer::~QTimer()

Destroys the timer.

template <typename Functor> QMetaObject::Connection QTimer::callOnTimeout(Functor slot, Qt::ConnectionType connectionType = Qt::AutoConnection)

This is an overloaded function.

Creates a connection of type connectionType from the timeout() signal to slot, and returns a handle to the connection.

This method is provided for convenience. It's equivalent to calling QObject::connect(timer, &QTimer::timeout, timer, slot, connectionType).

This function was introduced in Qt 5.12.

See also QObject::connect() and timeout().

template <typename Functor> QMetaObject::Connection QTimer::callOnTimeout(const QObject *context, Functor slot, Qt::ConnectionType connectionType = Qt::AutoConnection)

This function overloads callOnTimeout().

Creates a connection from the timeout() signal to slot to be placed in a specific event loop of context, and returns a handle to the connection.

This method is provided for convenience. It's equivalent to calling QObject::connect(timer, &QTimer::timeout, context, slot, connectionType).

This function was introduced in Qt 5.12.

See also QObject::connect() and timeout().

template <typename MemberFunction> QMetaObject::Connection QTimer::callOnTimeout(const QObject *receiver, MemberFunction *slot, Qt::ConnectionType connectionType = Qt::AutoConnection)

This function overloads callOnTimeout().

Creates a connection from the timeout() signal to the slot in the receiver object. Returns a handle to the connection.

This method is provided for convenience. It's equivalent to calling QObject::connect(timer, &QTimer::timeout, receiver, slot, connectionType).

This function was introduced in Qt 5.12.

See also QObject::connect() and timeout().

std::chrono::milliseconds QTimer::intervalAsDuration() const

Returns the interval of this timer as a std::chrono::milliseconds object.

This function was introduced in Qt 5.8.

See also interval.

bool QTimer::isActive() const

Returns true if the timer is running (pending); otherwise returns false.

Note: Getter function for property active.

std::chrono::milliseconds QTimer::remainingTimeAsDuration() const

Returns the time remaining in this timer object as a std::chrono::milliseconds object. If this timer is due or overdue, the returned value is std::chrono::milliseconds::zero(). If the remaining time could not be found or the timer is not active, this function returns a negative duration.

This function was introduced in Qt 5.8.

See also remainingTime().

[static] void QTimer::singleShot(int msec, const QObject *receiver, const char *member)

This static function calls a slot after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

Example:

 #include <QApplication>
 #include <QTimer>

 int main(int argc, char *argv[])
 {
     QApplication app(argc, argv);
     QTimer::singleShot(600000, &app, SLOT(quit()));
     ...
     return app.exec();
 }

This sample program automatically terminates after 10 minutes (600,000 milliseconds).

The receiver is the receiving object and the member is the slot. The time interval is msec milliseconds.

Note: This function is reentrant.

See also setSingleShot() and start().

[static] void QTimer::singleShot(int msec, Qt::TimerType timerType, const QObject *receiver, const char *member)

This is an overloaded function.

This static function calls a slot after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The receiver is the receiving object and the member is the slot. The time interval is msec milliseconds. The timerType affects the accuracy of the timer.

Note: This function is reentrant.

See also start().

[static] template <typename PointerToMemberFunction> void QTimer::singleShot(int msec, const QObject *receiver, PointerToMemberFunction method)

This is an overloaded function.

This static function calls a member function of a QObject after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The receiver is the receiving object and the method is the member function. The time interval is msec milliseconds.

If receiver is destroyed before the interval occurs, the method will not be called. The function will be run in the thread of receiver. The receiver's thread must have a running Qt event loop.

Note: This function is reentrant.

This function was introduced in Qt 5.4.

See also start().

[static] template <typename PointerToMemberFunction> void QTimer::singleShot(int msec, Qt::TimerType timerType, const QObject *receiver, PointerToMemberFunction method)

This is an overloaded function.

This static function calls a member function of a QObject after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The receiver is the receiving object and the method is the member function. The time interval is msec milliseconds. The timerType affects the accuracy of the timer.

If receiver is destroyed before the interval occurs, the method will not be called. The function will be run in the thread of receiver. The receiver's thread must have a running Qt event loop.

Note: This function is reentrant.

This function was introduced in Qt 5.4.

See also start().

[static] template <typename Functor> void QTimer::singleShot(int msec, Functor functor)

This is an overloaded function.

This static function calls functor after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The time interval is msec milliseconds.

Note: This function is reentrant.

This function was introduced in Qt 5.4.

See also start().

[static] template <typename Functor> void QTimer::singleShot(int msec, Qt::TimerType timerType, Functor functor)

This is an overloaded function.

This static function calls functor after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The time interval is msec milliseconds. The timerType affects the accuracy of the timer.

Note: This function is reentrant.

This function was introduced in Qt 5.4.

See also start().

[static] template <typename Functor, int> void QTimer::singleShot(int msec, const QObject *context, Functor functor)

This is an overloaded function.

This static function calls functor after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The time interval is msec milliseconds.

If context is destroyed before the interval occurs, the method will not be called. The function will be run in the thread of context. The context's thread must have a running Qt event loop.

Note: This function is reentrant.

This function was introduced in Qt 5.4.

See also start().

[static] template <typename Functor, int> void QTimer::singleShot(int msec, Qt::TimerType timerType, const QObject *context, Functor functor)

This is an overloaded function.

This static function calls functor after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The time interval is msec milliseconds. The timerType affects the accuracy of the timer.

If context is destroyed before the interval occurs, the method will not be called. The function will be run in the thread of context. The context's thread must have a running Qt event loop.

Note: This function is reentrant.

This function was introduced in Qt 5.4.

See also start().

[static] void QTimer::singleShot(std::chrono::milliseconds msec, const QObject *receiver, const char *member)

This is an overloaded function.

This static function calls a slot after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The receiver is the receiving object and the member is the slot. The time interval is given in the duration object msec.

Note: This function is reentrant.

This function was introduced in Qt 5.8.

See also start().

[static] void QTimer::singleShot(std::chrono::milliseconds msec, Qt::TimerType timerType, const QObject *receiver, const char *member)

This is an overloaded function.

This static function calls a slot after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The receiver is the receiving object and the member is the slot. The time interval is given in the duration object msec. The timerType affects the accuracy of the timer.

Note: This function is reentrant.

This function was introduced in Qt 5.8.

See also start().

void QTimer::start(std::chrono::milliseconds msec)

This is an overloaded function.

Starts or restarts the timer with a timeout of duration msec milliseconds.

If the timer is already running, it will be stopped and restarted.

If singleShot is true, the timer will be activated only once.

This function was introduced in Qt 5.8.

[override virtual protected] void QTimer::timerEvent(QTimerEvent *e)

Reimplements: QObject::timerEvent(QTimerEvent *event).

int QTimer::timerId() const

Returns the ID of the timer if the timer is running; otherwise returns -1.