Correct processEvents documentation

The documentation of processEvents states that it processes all
pending events. However, this is not true for the glib backend
and probably was not true for at least a decade.
QEventDispatcherGlib::processEvents(ProcessEventsFlags)
calls "g_main_context_iteration" which is documented
to only process events of highest priority:
https://developer.gnome.org/glib/2.66/glib-The-Main-Event-Loop.html#g-main-context-iteration

Fixes: QTBUG-87307
Task-number: QTBUG-84291
Pick-to: 5.15
Change-Id: I82c6f9dba865bb07f981ad648a128316749682ca
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
This commit is contained in:
Andreas Buhr 2020-10-06 15:07:06 +02:00
parent b14b1c99f8
commit 98f4c97768
2 changed files with 4 additions and 4 deletions

View File

@ -1228,8 +1228,8 @@ bool QCoreApplication::closingDown()
/*! /*!
Processes all pending events for the calling thread according to Processes some pending events for the calling thread according to
the specified \a flags until there are no more events to process. the specified \a flags.
You can call this function occasionally when your program is busy You can call this function occasionally when your program is busy
performing a long operation (e.g. copying a file). performing a long operation (e.g. copying a file).

View File

@ -118,8 +118,8 @@ QEventLoop::~QEventLoop()
/*! /*!
Processes pending events that match \a flags until there are no Processes some pending events that match \a flags.
more events to process. Returns \c true if pending events were handled; Returns \c true if pending events were handled;
otherwise returns \c false. otherwise returns \c false.
This function is especially useful if you have a long running This function is especially useful if you have a long running