summaryrefslogtreecommitdiffstats
path: root/src/webengine
diff options
context:
space:
mode:
authorPeter Varga <pvarga@inf.u-szeged.hu>2016-08-24 14:52:40 +0200
committerAllan Sandfeld Jensen <allan.jensen@qt.io>2016-08-31 07:59:03 +0000
commit322652bc5a5a7971a47d01f1ec8a51cc2fa8f46f (patch)
tree0b422a8d92f5d82b4c70ff5983985d8ed40ffbb2 /src/webengine
parent3b1e7a860a79509205c5fb93bf74b3dd3f56b8d2 (diff)
Doc: Describe View Source feature
Change-Id: Ie486391eba432e930ba7f938d08173dee59eb85b Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'src/webengine')
-rw-r--r--src/webengine/doc/src/external-resources.qdoc5
-rw-r--r--src/webengine/doc/src/qtwebengine-features.qdoc30
2 files changed, 35 insertions, 0 deletions
diff --git a/src/webengine/doc/src/external-resources.qdoc b/src/webengine/doc/src/external-resources.qdoc
index 2ef88e8a4..ced64dff7 100644
--- a/src/webengine/doc/src/external-resources.qdoc
+++ b/src/webengine/doc/src/external-resources.qdoc
@@ -116,3 +116,8 @@
\externalpage http://www.w3schools.com/tags/att_a_download.asp
\title HTML download Attribute
*/
+
+/*!
+ \externalpage https://www.iana.org/assignments/uri-schemes/prov/view-source
+ \title view-source URI scheme
+*/
diff --git a/src/webengine/doc/src/qtwebengine-features.qdoc b/src/webengine/doc/src/qtwebengine-features.qdoc
index 52f7da928..d63e2f4a7 100644
--- a/src/webengine/doc/src/qtwebengine-features.qdoc
+++ b/src/webengine/doc/src/qtwebengine-features.qdoc
@@ -42,6 +42,7 @@
\li \l{HTML5 Geolocation}
\li \l{Pepper Plugin API}
\li \l{Print to PDF}
+ \li \l{View Source}
\li \l{WebRTC}
\endlist
@@ -222,6 +223,35 @@
Support for this feature was added in Qt 5.7.0.
+ \section1 View Source
+
+ Qt WebEngine supports viewing the HTML source of a web page.
+
+ This feature can be used from custom menus or assigned to custom events.
+ For more information, see WebEngineView::viewSource, WebEngineView::canViewSource,
+ QWebEnginePage::viewSource, and QWebEnginePage::canViewSource.
+
+ This feature can be tested by opening a web page in \l{WebEngine Widgets
+ Simple Browser Example}{Simple Browser} or \l{WebEngine Quick Nano Browser}
+ {Nano Browser}, and then selecting \c{Page Source} in the context menu. The
+ \c{Page Source} context menu entry opens the source view in a new tab.
+
+ For opening the source view in the current tab, URLs with \l{view-source URI scheme}
+ are also supported. For example, you can type the following URL to the URL bar
+ to view the HTML source of the qt.io web page:
+ \code
+ view-source:https://www.qt.io/
+ \endcode
+
+ Auto-completion of incomplete URLs with \l{view-source URI scheme} makes the usage of
+ this feature more comfortable. For example, the following incomplete URL also loads
+ the source view of the qt.io web page:
+ \code
+ view-source:qt.io
+ \endcode
+
+ Support for this feature was added in Qt 5.8.0.
+
\section1 WebRTC
WebRTC provides browsers with Real-Time Communications (RTC) capabilities