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

Improve QObject::moveToThread doc

Browse Source 
Change mentions of parameter value being "zero" to nullptr.

Clarify that when nullptr is passed to moveToThread() event processing
is stopped because the object is no longer associated with any thread.

Also, reitarete this fact in the paragraph about processing of new
events.

There's an exception to the rule that QObjects cannot be "pulled" by
moveToThread that is buried in the implementation and not mentioned
in the doc. This information is worth noting explicitly.

Change-Id: I816ff737c48d8057b39e36b566079710aeb8e690
Reviewed-by: André Hartmann <aha_1980@gmx.de>
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
This commit is contained in:
Miłosz Kosobucki 2017-11-11 21:05:39 +01:00
parent c9002ab7ee
commit 13f5e5c6b2
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/corelib/kernel/qobject.cpp
View File

@ -1445,8 +1445,9 @@ QThread *QObject::thread() const
\snippet code/src_corelib_kernel_qobject.cpp 7
If \a targetThread is zero, all event processing for this object
and its children stops.
If \a targetThread is \nullptr, all event processing for this object
and its children stops, as they are no longer associated with any
thread.
Note that all active timers for the object will be reset. The
timers are first stopped in the current thread and restarted (with
@ -1457,13 +1458,18 @@ QThread *QObject::thread() const
A QEvent::ThreadChange event is sent to this object just before
the thread affinity is changed. You can handle this event to
perform any special processing. Note that any new events that are
posted to this object will be handled in the \a targetThread.
posted to this object will be handled in the \a targetThread,
provided it is non-null: when it is \nullptr, no event processing
for this object or its children can happen, as they are no longer
associated with any thread.
\warning This function is \e not thread-safe; the current thread
must be same as the current thread affinity. In other words, this
function can only "push" an object from the current thread to
another thread, it cannot "pull" an object from any arbitrary
thread to the current thread.
thread to the current thread. There is one exception to this rule
however: objects with no thread affinity can be "pulled" to the
current thread.
\sa thread()
*/