|author||Aaron McCarthy <firstname.lastname@example.org>||2015-03-10 15:16:30 +1000|
|committer||Aaron McCarthy <email@example.com>||2015-03-17 04:57:40 +0000|
Add note clarifying return value of QDesktopServices::openUrl()
On some platforms (notably wayland and xcb) the openUrl() call returns as soon as the request is passed to the underlying system. The call may still fail, but this status is not reported to the application. Change-Id: Iea554e9d5e7e371a5ce11454aef6f5c66ba36ca0 Reviewed-by: Valerio Valerio <firstname.lastname@example.org> Reviewed-by: Topi Reiniö <email@example.com>
Diffstat (limited to 'src/gui/util')
1 files changed, 5 insertions, 0 deletions
diff --git a/src/gui/util/qdesktopservices.cpp b/src/gui/util/qdesktopservices.cpp
index cf1096a251..9d90aaf25c 100644
@@ -166,6 +166,11 @@ void QOpenUrlHandlerRegistry::handlerDestroyed(QObject *handler)
Unicode-aware, the user may have configured their client without these features.
Also, certain e-mail clients (e.g., Lotus Notes) have problems with long URLs.
+ \warning A return value of \c true indicates that the application has successfully requested
+ the operating system to open the URL in an external application. The external application may
+ still fail to launch or fail to open the requested URL. This result will not be reported back
+ to the application.
bool QDesktopServices::openUrl(const QUrl &url)