QTimer Class

成员函数文档

[explicit] QTimer::QTimer(QObject *parent = nullptr)

根据给定的parent 创建一个定时器。

[virtual noexcept] QTimer::~QTimer()

销毁计时器。

template <typename Functor> QMetaObject::Connection QTimer::callOnTimeout(Functor &&slot)

在定时器的timeout()信号与slot 之间建立连接。返回该连接的句柄。

提供此方法是为了方便使用。它等同于调用：

QObject::connect(timer, &QTimer::timeout, timer, slot, Qt::DirectConnection);

另请参阅 QObject::connect() 和timeout()。

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

从timeout()信号创建一条连接至slot ，将其放置在context 的特定事件循环中，并返回该连接的句柄。

提供此方法仅为方便起见。它等同于调用：

QObject::connect(timer, &QTimer::timeout, context, slot, connectionType);

另请参阅 QObject::connect() 和timeout()。

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

如果定时器正在运行，则返回表示该定时器 ID 的 `Qt::TimerId `；否则返回 `Qt::TimerId::Invalid`。

该函数在 Qt 6.8 中引入。

另请参阅 Qt::TimerId 。

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

返回该定时器的间隔，形式为std::chrono::milliseconds 对象。

另请参阅 interval 。

bool QTimer::isActive() const

如果计时器正在运行，则返回true ；否则返回false 。

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

返回此定时器对象的剩余时间，格式为std::chrono::milliseconds 对象。如果该定时器已到期或逾期，则返回值为std::chrono::milliseconds::zero() 。如果无法找到剩余时间，或者定时器未运行，则该函数返回负数时长。

另请参阅 remainingTime()。

该静态函数在调用 `interval` 之后会调用 `functor `。

使用此函数非常方便，因为您无需费心处理 `timerEvent `，也无需创建本地 `QTimer ` 对象。

如果指定了context ，则只有在间隔发生之前context 对象尚未被销毁的情况下，才会调用functor 。然后，该 functor 将在context 的线程上运行。上下文的线程必须有一个正在运行的 Qt 事件循环。

如果functor 是context 的成员函数，则该函数将在该对象上被调用。

interval 参数可以是int （解释为毫秒计数），也可以是std::chrono 类型（该类型会隐式转换为纳秒）。

从 Qt 6.10 开始，设置负间隔将导致运行时警告，并且该值将被重置为 1 毫秒。 在 Qt 6.10 之前，Qt Timer 虽然允许设置负间隔，但行为可能出人意料（例如，如果计时器正在运行则停止，或者根本不启动）。

注意：此函数是可重入的。

另请参阅 start()。

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

该静态函数会在给定时间间隔后调用一个插槽。

使用此函数非常方便，因为您无需处理timerEvent ，也无需创建本地QTimer 对象。

receiver 是接收对象，member 是槽。时间间隔由持续时间对象nsec 指定。

从 Qt 6.10 开始，设置负时间间隔将导致运行时警告，且该值会被重置为 1 毫秒。 在 Qt 6.10 之前，虽然 Qt Timer 允许设置负间隔，但其行为可能出人意料（例如，如果计时器正在运行则停止，或者根本不启动）。

注意：此函数是可重入的。

另请参阅 start()。

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

该静态函数会在给定时间间隔后调用一个插槽。

使用此函数非常方便，因为您无需处理timerEvent ，也无需创建本地QTimer 对象。

receiver 是接收对象，member 是槽。时间间隔由时长对象nsec 指定。timerType 影响计时器的精度。

从 Qt 6.10 开始，设置负间隔将导致运行时警告，且该值会被重置为 1 毫秒。 在 Qt 6.10 之前，Qt Timer 虽然允许设置负间隔，但行为可能出人意料（例如，如果计时器正在运行则会停止，或者根本不会启动）。

注意：此函数是可重入的。

另请参阅 ` start()`。

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

启动或重启计时器，超时间隔为msec 毫秒。

这相当于：

timer.setInterval(msec);
timer.start();

如果计时器已经在运行，它将设置为stopped 并重新启动。这也会更改其id()属性。

如果singleShot 为 true，计时器将仅被触发一次。

从 Qt 6.10 开始，设置负间隔会引发运行时警告，且该值将被重置为 1 毫秒。 在 Qt 6.10 之前，Qt Timer 允许设置负间隔，但行为会出人意料（例如，如果计时器正在运行则停止，或者根本不启动）。

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        timer, qOverload(&QTimer::start));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        timer, [receiver = timer](int msec) { receiver->start(msec); });

[slot] void QTimer::start()

启动或重启计时器，并使用interval 中指定的超时时间。

如果计时器正在运行，则会将其stopped 并重新启动。这也会改变其id()属性。

如果 `singleShot ` 为真，计时器将仅被激活一次。

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        timer, qOverload<>(&QTimer::start));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        timer, [receiver = timer]() { receiver->start(); });

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

启动或重启计时器，超时时间为interval 毫秒。

这相当于：

timer.setInterval(interval);
timer.start();

如果计时器正在运行，它将设置为stopped 并重新启动。这也会改变其id() 属性。

如果singleShot 为 true，则计时器仅会被触发一次。

从 Qt 6.10 开始，设置负间隔会引发运行时警告，且该值将被重置为 1 毫秒。 在 Qt 6.10 之前，Qt 定时器允许您设置负间隔，但行为会出人意料（例如，如果定时器正在运行则停止，或者根本不启动）。

[slot] void QTimer::stop()

停止计时器。

另请参阅 start()。

[private signal] void QTimer::timeout()

当计时器超时，将发出此信号。

另请参阅 interval 、start() 以及stop()。

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

重写了：QObject::timerEvent(QTimerEvent *event)。

int QTimer::timerId() const

如果定时器正在运行，则返回该定时器的 ID；否则返回 -1。