summaryrefslogtreecommitdiffstats
path: root/src/webengine/doc/src/qtwebengine-features.qdoc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2016-09-19 14:56:05 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2016-09-20 12:02:18 +0000
commit001ee1d6da4bf6769d702810f8ebcb05978663cc (patch)
treebf32165e57f6ea527e3b4761698ae3abb05b1e1b /src/webengine/doc/src/qtwebengine-features.qdoc
parent019301166c94a546142a7ce886ce9215b099d863 (diff)
Doc: Customizing WebEngine dialogs
WebEngine dialog requests can be used to customize native dialogs for authentication, picking colors, choosing files, and responding to JavaScript alerts, confirmation requests, and prompts, as well as to form validation messages. Task-number: QTBUG-54742 Change-Id: I92f11e5e1075bddfa8e810b02008f7c2ea6b85c2 Reviewed-by: Kai Koehne <kai.koehne@qt.io> Reviewed-by: Michal Klocek <michal.klocek@qt.io>
Diffstat (limited to 'src/webengine/doc/src/qtwebengine-features.qdoc')
-rw-r--r--src/webengine/doc/src/qtwebengine-features.qdoc37
1 files changed, 36 insertions, 1 deletions
diff --git a/src/webengine/doc/src/qtwebengine-features.qdoc b/src/webengine/doc/src/qtwebengine-features.qdoc
index ab022711c..48f1536b4 100644
--- a/src/webengine/doc/src/qtwebengine-features.qdoc
+++ b/src/webengine/doc/src/qtwebengine-features.qdoc
@@ -31,7 +31,7 @@
\brief Summarizes Qt WebEngine features.
- Qt WebEngine supports the following Chromium features:
+ Qt WebEngine supports the following features:
\list
\li \l{Audio and Video Codecs}
@@ -40,6 +40,7 @@
\li \l{Fullscreen}
\li \l{HTML5 DRM}
\li \l{HTML5 Geolocation}
+ \li \l{Native Dialogs}
\li \l{Pepper Plugin API}
\li \l{Print to PDF}
\li \l{Spellchecker}
@@ -142,6 +143,40 @@
Support for this feature was added in Qt 5.5.0.
+ \section1 Native Dialogs
+
+ A web page might request dialogs for the following functions:
+
+ \list
+ \li Entering user credentials for HTTP and proxy authentication
+ \li Displaying JavaScript alerts, confirmation dialogs, and prompts
+ \li Picking colors
+ \li Selecting files
+ \li Displaying form validation messages
+ \endlist
+
+ Qt WebEngine provides standard dialogs for these functions. In widget-based
+ applications, the standard dialogs are based on QDialog, whereas in Qt Quick
+ applications, they can be based either on Qt Quick Controls 1 or Qt Quick
+ Controls 2 (since Qt 5.8). The latter are used only on \c eglfs platforms.
+
+ To explicitly force either dialogs based on Qt Quick Controls 1 or Qt Quick
+ Controls 2, set the \c QTWEBENGINE_DIALOG_SET environment variable to either
+ \c{QtQuickControls1} or \c{QtQuickControls2}.
+
+ Qt WebEngine Widgets dialogs can be customized by reimplementing the
+ QWebEnginePage::chooseFiles(), QWebEnginePage::javaScriptAlert(),
+ QWebEnginePage::javaScriptConfirm(), and QWebEnginePage::javaScriptPrompt()
+ functions.
+
+ Since Qt 5.8, Qt Quick dialogs can be customized by connecting to the
+ WebEngineView::authenticationDialogRequested(),
+ WebEngineView::javaScriptDialogRequested(),
+ WebEngineView::colorDialogRequested(),
+ WebEngineView::fileDialogRequested(), and
+ WebEngineView::formValidationMessageRequested() signals. For an example,
+ see \l{WebEngine Qt Quick Custom Dialogs Example}.
+
\section1 Pepper Plugin API
Qt WebEngine supports loading Pepper Plugin API (PPAPI) plugins if