1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Clarify setInterval() and start() for active timer

Browse Source 
Despite using different code paths, both stop and then
re-start an already active timer, which invalidates
the id().

While at it, port the occurrences of timerId() to the
modern function id(), which exists in both QTimer and
QChronoTimer

Pick-to: 6.8
Change-Id: I5db099b198b1c11e1cdbd0fbb30ecece5d0135c8
Reviewed-by: Ahmad Samir <a.samirh78@gmail.com>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Andre Hartmann 2024-07-31 17:31:16 +02:00
parent d9346c9610
commit ea0f8cee55
2 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/corelib/kernel/qchronotimer.cpp
View File

@ -183,7 +183,8 @@ Qt::TimerId QChronoTimer::id() const
//! [stop-restart-timer] //! [stop-restart-timer]
If the timer is already running, it will be If the timer is already running, it will be
\l{QChronoTimer::stop()}{stopped} and restarted. \l{QChronoTimer::stop()}{stopped} and restarted. This will also change its
id().
//! [stop-restart-timer] //! [stop-restart-timer]
If \l singleShot is true, the timer will be activated only once. If \l singleShot is true, the timer will be activated only once.
@ -279,8 +280,9 @@ QBindable<bool> QChronoTimer::bindableSingleShot()
A QChronoTimer with a timeout of \c 0ns will time out as soon as all A QChronoTimer with a timeout of \c 0ns will time out as soon as all
the events in the window system's event queue have been processed. the events in the window system's event queue have been processed.
Setting the interval of an active timer changes the interval and acquires Setting the interval of an active timer will change the interval,
a new id(). If the timer is not active, only the interval is changed. stop() and then start() the timer, and acquire a new id().
If the timer is not active, only the interval is changed.
\sa singleShot \sa singleShot
*/ */

6
src/corelib/kernel/qtimer.cpp
View File

@ -204,7 +204,7 @@ Qt::TimerId QTimer::id() const
//! [stop-restart-timer] //! [stop-restart-timer]
If the timer is already running, it will be If the timer is already running, it will be
\l{QTimer::stop()}{stopped} and restarted. \l{QTimer::stop()}{stopped} and restarted. This will also change its id().
//! [stop-restart-timer] //! [stop-restart-timer]
//! [singleshot-activation] //! [singleshot-activation]
@ -591,7 +591,9 @@ QBindable<bool> QTimer::bindableSingleShot()
interval of 0 will time out as soon as all the events in the window interval of 0 will time out as soon as all the events in the window
system's event queue have been processed. system's event queue have been processed.
Setting the interval of an active timer changes its timerId(). Setting the interval of an active timer will change the interval,
stop() and then start() the timer, and acquire a new id().
If the timer is not active, only the interval is changed.
\sa singleShot \sa singleShot
*/ */