summaryrefslogtreecommitdiffstats
path: root/src/webengine/doc
diff options
context:
space:
mode:
authorAllan Sandfeld Jensen <allan.jensen@qt.io>2019-05-09 15:22:24 +0200
committerAllan Sandfeld Jensen <allan.jensen@qt.io>2019-05-09 15:22:24 +0200
commit0eac492b5c66b1774118c387dd527ad419e51be7 (patch)
tree37324fdefd615e433dd65073390d7b9996d660d3 /src/webengine/doc
parent5d6086d1b97461b35c143839a8a6ba1b990bb87c (diff)
parent99d46a8a918dee7323bc3d4f1624c47c097f9a3a (diff)
Merge remote-tracking branch 'origin/5.13' into dev
Diffstat (limited to 'src/webengine/doc')
-rw-r--r--src/webengine/doc/qtwebengine.qdocconf3
-rw-r--r--src/webengine/doc/src/external-resources.qdoc12
-rw-r--r--src/webengine/doc/src/qtwebengine-debugging.qdoc12
-rw-r--r--src/webengine/doc/src/qtwebengine-deploying.qdoc28
-rw-r--r--src/webengine/doc/src/qtwebengine-examples.qdoc2
-rw-r--r--src/webengine/doc/src/qtwebengine-features.qdoc54
-rw-r--r--src/webengine/doc/src/qtwebengine-index.qdoc4
-rw-r--r--src/webengine/doc/src/qtwebengine-module.qdoc2
-rw-r--r--src/webengine/doc/src/qtwebengine-overview.qdoc54
-rw-r--r--src/webengine/doc/src/qtwebengine-platform-notes.qdoc32
-rw-r--r--src/webengine/doc/src/qwebengine-licensing.qdoc2
-rw-r--r--src/webengine/doc/src/webengineview_lgpl.qdoc6
12 files changed, 101 insertions, 110 deletions
diff --git a/src/webengine/doc/qtwebengine.qdocconf b/src/webengine/doc/qtwebengine.qdocconf
index b1e3a2ded..50f2e2ceb 100644
--- a/src/webengine/doc/qtwebengine.qdocconf
+++ b/src/webengine/doc/qtwebengine.qdocconf
@@ -81,4 +81,7 @@ navigation.landingpage = "Qt WebEngine"
navigation.cppclassespage = "Qt WebEngine C++ Classes and Namespaces"
navigation.qmltypespage = "Qt WebEngine QML Types"
+# \QWE macro expands to 'Qt WebEngine' without auto-linking anywhere.
+macro.QWE = "Qt \\WebEngine"
+
Cpp.ignoretokens += Q_WEBENGINE_EXPORT QWEBENGINEWIDGETS_EXPORT
diff --git a/src/webengine/doc/src/external-resources.qdoc b/src/webengine/doc/src/external-resources.qdoc
index e4fe9bba6..55f6a68a3 100644
--- a/src/webengine/doc/src/external-resources.qdoc
+++ b/src/webengine/doc/src/external-resources.qdoc
@@ -95,18 +95,6 @@
\title Hunspell Project
*/
-/*
- This prevents autolinking of each occurrence of 'WebEngine'
- To link to the WebEngine QML type, use explicit linking:
- \l [QML] WebEngine
- \sa {QtWebEngine::}{WebEngine}
-*/
-/*!
- \externalpage nolink
- \title WebEngine
- \internal
-*/
-
/*!
\externalpage https://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1
\title RFC 2616 section 19.5.1
diff --git a/src/webengine/doc/src/qtwebengine-debugging.qdoc b/src/webengine/doc/src/qtwebengine-debugging.qdoc
index b8b004095..088db5f87 100644
--- a/src/webengine/doc/src/qtwebengine-debugging.qdoc
+++ b/src/webengine/doc/src/qtwebengine-debugging.qdoc
@@ -31,7 +31,7 @@
\section1 Console Logging
- JavaScript executed inside Qt WebEngine can use the
+ JavaScript executed inside \QWE can use the
\l{Chrome console API} to log information to a console. The logging messages
are forwarded to Qt's logging facilities inside a \c js
\l{QLoggingCategory}{logging category}. However, only warning and fatal
@@ -40,19 +40,19 @@
by reimplementing \l{QWebEnginePage::javaScriptConsoleMessage()}, or
connecting to \l{WebEngineView::javaScriptConsoleMessage()}.
- All messages can also be accessed through the Qt WebEngine developer
+ All messages can also be accessed through the \QWE developer
tools.
\section1 Qt WebEngine Developer Tools
- The Qt WebEngine module provides web developer tools that make it easy
+ The \QWE module provides web developer tools that make it easy
to inspect and debug layout and performance issues of any web content.
The developer tools are accessed as a local web page using a Chromium or
- Qt WebEngine based browser, such as the Chrome browser.
+ \QWE based browser, such as the Chrome browser.
- To activate the developer tools, start an application that uses Qt
- WebEngine with the command-line arguments:
+ To activate the developer tools, start an application that uses \QWE
+ with the command-line arguments:
\badcode
--remote-debugging-port=<port_number>
diff --git a/src/webengine/doc/src/qtwebengine-deploying.qdoc b/src/webengine/doc/src/qtwebengine-deploying.qdoc
index c9f0f3580..7b9f3fd4a 100644
--- a/src/webengine/doc/src/qtwebengine-deploying.qdoc
+++ b/src/webengine/doc/src/qtwebengine-deploying.qdoc
@@ -34,7 +34,7 @@
\l{Deploying Applications on macOS}{macdeployqt} automate the steps to
generate a stand-alone application package.
- When manually deploying applications that depend on Qt WebEngine, all the
+ When manually deploying applications that depend on \QWE, all the
files that are required to run the application have to be included:
libraries, QML imports, plugins, and translations.
@@ -42,27 +42,27 @@
\section1 Target Platforms
- Qt WebEngine does try to support all \l{Supported Platforms} of Qt. However,
+ \QWE does try to support all \l{Supported Platforms} of Qt. However,
due to different requirements of Chromium this is not always possible. Known
limitations are:
\list
- \li Qt WebEngine currently supports only Windows, Linux, and \macos.
+ \li \QWE currently supports only Windows, Linux, and \macos.
- \li On Windows, Qt WebEngine only supports Windows Vista or newer as
+ \li On Windows, \QWE only supports Windows Vista or newer as
target platform. Due to use of newer API in Chromium, Windows XP is
not supported. WinRT is not supported, either.
\endlist
\section1 Deploying Applications Manually
- When manually deploying applications that depend on Qt WebEngine, the
+ When manually deploying applications that depend on \QWE, the
following files might have to be deployed:
\list
\li Libraries
\li QML imports
- \li Qt WebEngine process
+ \li \QWE process
\li Resources
\li Translations
\li Audio and video codecs
@@ -71,7 +71,7 @@
\section2 Deploying Libraries
The following libraries must be deployed with applications that depend on
- Qt WebEngine:
+ \QWE:
\list
\li QtWebEngineCore library
@@ -84,10 +84,10 @@
If Qt Quick integration is used in the application, the QtWebEngine import
directory needs to be deployed.
- \section2 Deploying Qt WebEngine Processes
+ \section2 Deploying \QWE Processes
- Qt WebEngine takes advantage of the multi-process model that the Chromium
- project offers. The multi-process model requires that the Qt WebEngine
+ \QWE takes advantage of the multi-process model that the Chromium
+ project offers. The multi-process model requires that the \QWE
Process executable be deployed alongside your application.
The WebEngine process is executed for each QWebEngineView or WebEngineView
@@ -96,18 +96,18 @@
running. This is a common approach used by most modern web engines to
provide a stable browsing experience.
- At runtime, Qt WebEngine looks for the \c QtWebEngineProcess executable in
+ At runtime, \QWE looks for the \c QtWebEngineProcess executable in
the directory that
QLibraryInfo::location(QLibraryInfo::LibraryExecutablesPath) returns.
For Qt installations, this is \c QTDIR/libexec (Linux) or \c QTDIR\bin
(Windows). The path can be changed by defining a \c qt.conf file, for
example. Alternatively, an executable path can be set as a value of the
- \c QTWEBENGINEPROCESS_PATH environment variable. On \macos, Qt WebEngine
+ \c QTWEBENGINEPROCESS_PATH environment variable. On \macos, \QWE
looks for the executable in \c .app/Helpers/QtWebEngineProcess.
\section2 Deploying Resources
- Qt WebEngine requires the following resource files:
+ \QWE requires the following resource files:
\list
\li \c qtwebengine_resources.pak contains the resources needed by
@@ -120,7 +120,7 @@
DPI displays.
\li \c icudtl.dat provides support for International Components for
Unicode (ICU). It is the Chromium version of ICU, which is not
- needed if Qt WebEngine was configured to use the system ICU.
+ needed if \QWE was configured to use the system ICU.
\endlist
Resources are searched from the following locations:
diff --git a/src/webengine/doc/src/qtwebengine-examples.qdoc b/src/webengine/doc/src/qtwebengine-examples.qdoc
index 24604e3dd..d31895078 100644
--- a/src/webengine/doc/src/qtwebengine-examples.qdoc
+++ b/src/webengine/doc/src/qtwebengine-examples.qdoc
@@ -28,7 +28,7 @@
/*!
\group webengine-examples
\title Qt WebEngine Examples
- \brief Examples demonstrating the Qt WebEngine usage.
+ \brief Examples demonstrating the \QWE usage.
\ingroup all-examples
These examples and demonstrations show a range of different uses for \l{Qt WebEngine},
diff --git a/src/webengine/doc/src/qtwebengine-features.qdoc b/src/webengine/doc/src/qtwebengine-features.qdoc
index f53c118a8..5c6bdda5d 100644
--- a/src/webengine/doc/src/qtwebengine-features.qdoc
+++ b/src/webengine/doc/src/qtwebengine-features.qdoc
@@ -29,9 +29,9 @@
\page qtwebengine-features.html
\title Qt WebEngine Features
- \brief Summarizes Qt WebEngine features.
+ \brief Summarizes \QWE features.
- Qt WebEngine supports the following features:
+ \QWE supports the following features:
\list
\li \l{Audio and Video Codecs}
@@ -55,7 +55,7 @@
\section1 Audio and Video Codecs
- Qt WebEngine supports the MPEG-4 Part 14 (MP4) file format only if the
+ \QWE supports the MPEG-4 Part 14 (MP4) file format only if the
required proprietary audio and video codecs, such as H.264 and MPEG layer-3
(MP3), have been enabled. Proprietary codecs can be enabled by passing the
following option to the \c configure tool when configuring Qt:
@@ -73,8 +73,8 @@
For more information, see \l{Qt Configure Options}.
- When using qmake to build just the Qt WebEngine module, the following
- command can be used (in this example, the Qt WebEngine source code is
+ When using qmake to build just the \QWE module, the following
+ command can be used (in this example, the \QWE source code is
located in \c {C:\qt\qtwebengine}):
\code
@@ -95,7 +95,7 @@
The Chromium DevTools provide the ability to inspect and debug layout and
performance issues of any web content.
- This feature can be tested by launching a Qt WebEngine application with the
+ This feature can be tested by launching a \QWE application with the
command line option \c {--remote-debugging-port=[your-port]} or by setting
the environment variable \c QTWEBENGINE_REMOTE_DEBUGGING, and then using a
Chromium based browser (such as \l{WebEngine Widgets Simple Browser Example}
@@ -116,12 +116,12 @@
\section1 Client Certificates
Some web servers, in particular many intranet sites, require the client to
- authenticate itself with a certificate, called a \e {client certificate}. Qt WebEngine
+ authenticate itself with a certificate, called a \e {client certificate}. \QWE
will read the client certificates installed in the system settings in macOS and
Windows, and on Linux those installed into the NSS database. Certificates can
be installed into the NSS database using the \c pk12util tool.
- By default, QtWebEngine will not offer any client certificates to servers, as doing
+ By default, \QWE will not offer any client certificates to servers, as doing
so uniquely identifies the user and might violate privacy expectations.
To activate support for client certificates, an application needs to listen to
@@ -132,7 +132,7 @@
\section1 Custom Schemes
- Qt WebEngine makes it possible for the application to define its own custom
+ \QWE makes it possible for the application to define its own custom
URL schemes with specialized security policies and transport mechanisms.
Custom schemes can be used to implement alternative network protocols with
@@ -145,7 +145,7 @@
\section1 Drag and Drop
- Qt WebEngine supports HTML5 drag and drop.
+ \QWE supports HTML5 drag and drop.
This feature can be tested by opening an HTML5 drag and drop demo, such as
\l{HTML5 Demos - Drag and Drop}, \l{HTML5 Demos - Simple Drag and Drop}, or
@@ -160,7 +160,7 @@
\section1 Fullscreen
- Qt WebEngine supports viewing web content in fullscreen mode. For more
+ \QWE supports viewing web content in fullscreen mode. For more
information, see \l{WebEngineSettings::fullscreenSupportEnabled}
{WebEngineSettings.fullscreenSupportEnabled},
\l{WebEngineView::fullScreenRequested}{WebEngineView.fullScreenRequested},
@@ -176,7 +176,7 @@
\section1 HTML5 DRM
- Qt WebEngine supports viewing DRM protected videos if the \l{Widevine DRM}
+ \QWE supports viewing DRM protected videos if the \l{Widevine DRM}
plugin has been installed.
The video format most commonly used by DRM services, H.264, requires
@@ -191,12 +191,12 @@
\section1 HTML5 Geolocation
- Qt WebEngine supports JavaScript Geolocation API with \l {Qt Location} as a
+ \QWE supports JavaScript Geolocation API with \l {Qt Location} as a
backend. The application has to explicitly allow the feature by using
QWebEnginePage::Geolocation or \l{WebEngineView::Feature}
{WebEngineView.Feature}.
- If Qt Location has been built before Qt WebEngine then this feature can be
+ If Qt Location has been built before \QWE then this feature can be
tested by using \l{WebEngine Widgets Maps Example}{Maps} and allowing it to
find the current position of the user. Note that on Windows an external GPS
receiver must be connected to the application. For more information, see
@@ -206,7 +206,7 @@
\section1 HTTP/2 Protocol
- Qt WebEngine supports the Chromium implementation of the \l{HTTP/2}
+ \QWE supports the Chromium implementation of the \l{HTTP/2}
protocol.
This feature can be tested by opening an HTTP/2 demo, such as the
@@ -225,7 +225,7 @@
\li Displaying form validation messages
\endlist
- Qt WebEngine provides standard dialogs for these functions. In widget-based
+ \QWE 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.
@@ -234,7 +234,7 @@
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
+ \QWE Widgets dialogs can be customized by reimplementing the
QWebEnginePage::chooseFiles(), QWebEnginePage::javaScriptAlert(),
QWebEnginePage::javaScriptConfirm(), and QWebEnginePage::javaScriptPrompt()
functions.
@@ -249,7 +249,7 @@
\section1 Pepper Plugin API
- Qt WebEngine supports loading Pepper Plugin API (PPAPI) plugins if
+ \QWE supports loading Pepper Plugin API (PPAPI) plugins if
WebEngineSettings::pluginsEnabled or QWebEngineSettings::PluginsEnabled
is set.
@@ -321,7 +321,7 @@
\section1 Print to PDF
- Qt WebEngine supports printing a web page to a PDF file. For more
+ \QWE supports printing a web page to a PDF file. For more
information, see QWebEnginePage::printToPdf() and
\l{WebEngineView::printToPdf}{WebEngineView.printToPdf}.
@@ -332,7 +332,7 @@
\section1 Process Models
- Qt WebEngine uses multiple OS processes to isolate web sites from each other
+ \QWE uses multiple OS processes to isolate web sites from each other
and from the client application, improving security and robustness. The
following process models, or ways to divide web sites between OS processes,
are supported:
@@ -355,7 +355,7 @@
and \c{https://de.wikipedia.org/} would belong to the same site.
A site instance is a collection of web pages belonging to the same site.
- When the application explicitly loads a URL into Qt WebEngine (via \l
+ When the application explicitly loads a URL into \QWE (via \l
QWebEnginePage::setUrl, for example), a new site instance is created for the
page. However, when the user clicks same-site links on the page, the
existing site instance is merely extended with more pages.
@@ -388,7 +388,7 @@
\section1 Spellchecker
- Qt WebEngine supports integrating spellchecking support into HTML forms to
+ \QWE supports integrating spellchecking support into HTML forms to
enable users to submit spellchecked messages. When the user clicks on
an underlined misspelled word, the default context menu displays up to four
suggestions. Selecting one will replace the misspelled word.
@@ -408,7 +408,7 @@
These two files can be converted into the \c bdic format by using the
\c qwebengine_convert_dict tool that is shipped together with Qt.
- When the Qt WebEngine spellchecker initializes, it will try to load the
+ When the \QWE spellchecker initializes, it will try to load the
\c bdict dictionaries and to check them for consistency.
If \c QTWEBENGINE_DICTIONARIES_PATH is set, the spellchecker uses the
@@ -417,7 +417,7 @@
executable if it exists. If it does not exist, it will look in \c
QT_INSTALL_PREFIX/qtwebengine_dictionaries.
- On macOS, depending on how Qt WebEngine is configured at build time, there
+ On macOS, depending on how \QWE is configured at build time, there
are two possibilities how spellchecking data is found:
\list
@@ -427,7 +427,7 @@
means the results will depend on the installed OS dictionaries)
\endlist
- Thus, in the macOS Hunspell case, Qt WebEngine will look in the \e
+ Thus, in the macOS Hunspell case, \QWE will look in the \e
qtwebengine_dictionaries subdirectory located inside the application bundle
\c Resources directory, and also in the \c Resources directory located
inside the Qt framework bundle.
@@ -461,7 +461,7 @@
\section1 Touch
- Qt WebEngine supports touch devices for navigating and interacting with web pages.
+ \QWE supports touch devices for navigating and interacting with web pages.
Applications can prohibit the use of touch events in the following ways:
@@ -477,7 +477,7 @@
\section1 View Source
- Qt WebEngine supports viewing the HTML source of a web page.
+ \QWE 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::WebAction, and QWebEnginePage::WebAction.
diff --git a/src/webengine/doc/src/qtwebengine-index.qdoc b/src/webengine/doc/src/qtwebengine-index.qdoc
index bd6cc9a32..f668cf87b 100644
--- a/src/webengine/doc/src/qtwebengine-index.qdoc
+++ b/src/webengine/doc/src/qtwebengine-index.qdoc
@@ -31,9 +31,9 @@
\brief Provides functionality for rendering regions of dynamic web content.
- \e {Qt WebEngine} provides functionality for rendering regions of dynamic web content.
+ \QWE provides functionality for rendering regions of dynamic web content.
- The functionality in Qt WebEngine is divided into the following modules:
+ The functionality in \QWE is divided into the following modules:
\annotatedlist qtwebengine-modules
diff --git a/src/webengine/doc/src/qtwebengine-module.qdoc b/src/webengine/doc/src/qtwebengine-module.qdoc
index 2d4d1b8da..5554bd519 100644
--- a/src/webengine/doc/src/qtwebengine-module.qdoc
+++ b/src/webengine/doc/src/qtwebengine-module.qdoc
@@ -31,7 +31,7 @@
\brief Exposes C++ functionality to Qt Quick.
\ingroup modules
- The Qt WebEngine module exposes C++ functionality to Qt Quick.
+ The \QWE module exposes C++ functionality to Qt Quick.
To include the definitions of the module's classes, use the
following directive:
diff --git a/src/webengine/doc/src/qtwebengine-overview.qdoc b/src/webengine/doc/src/qtwebengine-overview.qdoc
index 58c0708cc..6aa1af89e 100644
--- a/src/webengine/doc/src/qtwebengine-overview.qdoc
+++ b/src/webengine/doc/src/qtwebengine-overview.qdoc
@@ -29,10 +29,10 @@
\page qtwebengine-overview.html
\title Qt WebEngine Overview
- The Qt WebEngine module provides a web browser engine that makes it easy to embed content from
+ The \QWE module provides a web browser engine that makes it easy to embed content from
the World Wide Web into your Qt application on platforms that do not have a native web engine.
- Qt WebEngine provides C++ classes and QML types for rendering HTML, XHTML, and SVG documents,
+ \QWE provides C++ classes and QML types for rendering HTML, XHTML, and SVG documents,
styled using Cascading Style Sheets (CSS) and scripted with JavaScript. HTML documents can be
made fully editable by the user through the use of the \c{contenteditable} attribute on HTML
elements.
@@ -41,7 +41,7 @@
\image qtwebengine-architecture.png
- The functionality in Qt WebEngine is divided into the following modules:
+ The functionality in \QWE is divided into the following modules:
\list
\li \l{Qt WebEngine Widgets Module} for creating widget-based web applications
@@ -49,7 +49,7 @@
\li \l{Qt WebEngine Core Module} for interacting with Chromium
\endlist
- Page rendering and JavaScript execution are separated from the GUI process into the Qt WebEngine
+ Page rendering and JavaScript execution are separated from the GUI process into the \QWE
Process. It is a library that must be shipped with the application if the Qt libraries are
bundled into the application.
@@ -57,7 +57,7 @@
\image qtwebenginewidgets-model.png
- A \e {web engine view} is the main widget component of the Qt WebEngine module. It can be used
+ A \e {web engine view} is the main widget component of the \QWE module. It can be used
in various applications to load web content. Within a view, a \e {web engine page} holds a main
frame that is responsible for web content, the \e history of navigated links, and \e actions.
The view and page are quite similar, as they provide a set of common functions.
@@ -66,7 +66,7 @@
\e cookies. Profiles can be used to isolate pages from each other. A typical use case is a
dedicated profile for a \e {private browsing} mode, where no information is permanently saved.
- \note The Qt WebEngine Widgets module uses the \l{Qt Quick Scene Graph}{Qt Quick scene graph}
+ \note The \QWE Widgets module uses the \l{Qt Quick Scene Graph}{Qt Quick scene graph}
to compose the elements of a web page into one view. This means that the UI process
requires OpenGL ES 2.0 or OpenGL 2.0 for its rendering.
@@ -74,27 +74,27 @@
\image qtwebengine-model.png
- The Qt WebEngine QML implementation contains the same elements as the Qt WebEngine Widgets
+ The \QWE QML implementation contains the same elements as the \QWE Widgets
implementation, except that there is no separately accessible web engine page.
The supported page functionality is integrated into the web engine view.
\section2 Qt WebEngine Core Module
- The Qt WebEngine core is based on the \l {Chromium Project}. Chromium provides its own network
+ The \QWE core is based on the \l {Chromium Project}. Chromium provides its own network
and painting engines and is developed tightly together with its dependent modules.
- \note Qt WebEngine is based on Chromium, but does not contain or use any services
+ \note \QWE is based on Chromium, but does not contain or use any services
or add-ons that might be part of the Chrome browser that is built and delivered by Google.
You can find more detailed information about the differences between Chromium and Chrome in this
\l{https://chromium.googlesource.com/chromium/src/+/master/docs/chromium_browser_vs_google_chrome.md}{overview}
that is part of the documentation in the \l {Chromium Project} upstream source tree.
- This version of Qt WebEngine is based on Chromium version 69.0.3497.128, with
- additional security fixes from newer versions.
+ This version of \QWE is based on Chromium version 73.0.3683, with additional security
+ fixes from newer versions.
\section2 Qt WebEngine Process
- The Qt WebEngine Process is a separate executable that is used to render web pages and
+ The \QWE Process is a separate executable that is used to render web pages and
execute JavaScript. This mitigates security issues and isolates crashes caused by specific
content.
@@ -177,7 +177,7 @@
\section1 Script Injection
- Qt WebEngine does not allow direct access to the document object model (DOM) of a page.
+ \QWE does not allow direct access to the document object model (DOM) of a page.
However, the DOM can be inspected and adapted by injecting scripts.
The DOM of a page is constructed when the document is ready, typically
@@ -191,7 +191,7 @@
script to run, the injection point, and the world where the script is run. This enables
accessing the DOM to manipulate it within a world.
- Since Qt 5.8, Qt WebEngine supports augmenting a script by using the
+ Since Qt 5.8, \QWE supports augmenting a script by using the
following \l{Metadata Block}{Greasemonkey-like attributes}:
\list
@@ -221,8 +221,8 @@
\section1 Managing Certificates
- Qt WebEngine uses its own network stack, and therefore QSslConfiguration is not used to
- open SSL connections. Instead, Qt WebEngine uses the root CA certificates from the operating
+ \QWE uses its own network stack, and therefore QSslConfiguration is not used to
+ open SSL connections. Instead, \QWE uses the root CA certificates from the operating
system to validate the peer's certificate.
The \l{WebEngineCertificateError::error} and \l{QWebEngineCertificateError::Error} enumerations
@@ -232,9 +232,9 @@
\section1 Proxy Support
- Qt WebEngine uses the proxy settings from \l{Qt Network}, and forwards them to Chromium's
- networking stack. If QNetworkProxy::applicationProxy is set, it will also be used for Qt
- WebEngine. If QNetworkProxyFactory::usesSystemConfiguration() is enabled, the proxy settings
+ \QWE uses the proxy settings from \l{Qt Network}, and forwards them to Chromium's
+ networking stack. If QNetworkProxy::applicationProxy is set, it will also be used for \QWE.
+ If QNetworkProxyFactory::usesSystemConfiguration() is enabled, the proxy settings
are automatically retrieved from the system. Settings from an installed QNetworkProxyFactory
will be ignored, though.
@@ -246,7 +246,7 @@
QWebEnginePage::proxyAuthenticationRequired is emitted.
For Qt Quick, a dialog is shown.
- Not all properties of QNetworkProxy are supported by Qt WebEngine. That is,
+ Not all properties of QNetworkProxy are supported by \QWE. That is,
QNetworkProxy::type(), QNetworkProxy::hostName() and QNetworkProxy::port() are taken into
account. All other proxy settings such as QNetworkProxy::rawHeader() are ignored.
@@ -254,7 +254,7 @@
To support High DPI devices, it is recommended that the application attribute
Qt::AA_EnableHighDpiScaling is set to enable automatic scaling based on the
- pixel density of the monitor. In Qt WebEngine applications, the scaling
+ pixel density of the monitor. In \QWE applications, the scaling
affects the default zooming factor and scrollbar size.
For example:
@@ -268,7 +268,7 @@
}
\endcode
- Qt WebEngine bundles images for normal and high-dpi resolutions into
+ \QWE bundles images for normal and high-dpi resolutions into
\e qtwebengine_resources_100p.pak and \e qtwebengine_resources_200p.pak
files. Depending on the target resolutions, one or both of these files need
to be deployed.
@@ -277,7 +277,7 @@
\section1 Using WebEngine Core
- Qt WebEngine Core provides an API shared by Qt WebEngine and Qt WebEngine Widgets for handling
+ \QWE Core provides an API shared by \QWE and \QWE Widgets for handling
URL requests issued for the networking stack of Chromium and for accessing its HTTP cookies.
Implementing the QWebEngineUrlRequestInterceptor interface and installing the interceptor on a
@@ -294,17 +294,17 @@
\section1 Platform Notes
- Qt WebEngine currently supports only Windows, Linux, and \macos. Due to Chromium build
+ \QWE currently supports only Windows, Linux, and \macos. Due to Chromium build
requirements it also often requires a newer compiler than the rest of Qt. See
\l{Qt WebEngine Platform Notes} for further details.
\section1 Related Modules
- Qt WebEngine supersedes the \l{http://doc.qt.io/archives/qt-5.3/qtwebkit-index.html}{Qt WebKit}
+ \QWE supersedes the \l{http://doc.qt.io/archives/qt-5.3/qtwebkit-index.html}{Qt WebKit}
module, which is based on the
WebKit project, but has not been actively synchronized with the upstream WebKit code since
- Qt 5.2 and has been deprecated in Qt 5.5. For tips on how to change a Qt WebKit widgets
- application to use Qt WebEngine widgets, see \l{Porting from Qt WebKit to Qt WebEngine}.
+ Qt 5.2 and has been deprecated in Qt 5.5. For tips on how to change a Qt \WebKit widgets
+ application to use \QWE widgets, see \l{Porting from Qt WebKit to Qt WebEngine}.
The \l{Qt WebView} module allows to use a native web browser on platforms where one is
available.
diff --git a/src/webengine/doc/src/qtwebengine-platform-notes.qdoc b/src/webengine/doc/src/qtwebengine-platform-notes.qdoc
index 0b2aebfce..fefb47795 100644
--- a/src/webengine/doc/src/qtwebengine-platform-notes.qdoc
+++ b/src/webengine/doc/src/qtwebengine-platform-notes.qdoc
@@ -29,9 +29,9 @@
\page qtwebengine-platform-notes.html
\title Qt WebEngine Platform Notes
- \brief Contains information about issues that are specific to the Qt WebEngine module.
+ \brief Contains information about issues that are specific to the \QWE module.
- \section1 Building Qt WebEngine from Source
+ \section1 Building \QWE from Source
Static builds are not supported.
@@ -53,7 +53,7 @@
\li \l {macOS}
\endlist
- The tests for skipping the Qt WebEngine build are located in the
+ The tests for skipping the \QWE build are located in the
\c qtwebengine repository, in the \c tools\qmake\mkspecs subdirectory.
They can be found by searching for \c skipBuild.
@@ -71,8 +71,8 @@
On Windows, Visual Studio 2017 and Windows 10 SDK are required.
- Qt WebEngine can only be built on 64-bit Windows, with a x64-bit toolchain.
- For building Qt WebEngine for x86 applications, you need to configure
+ \QWE can only be built on 64-bit Windows, with a x64-bit toolchain.
+ For building \QWE for x86 applications, you need to configure
and compile Qt with the Visual Studio 2017 x64 to x86 cross-compile
toolchain. This toolchain can be set up on the command line by running
\c{vcvarsall.bat amd64_x86}.
@@ -82,7 +82,7 @@
On Linux, Clang or GCC version 5 or later is required.
Supported configurations are \c linux-g++ and \c{linux-clang}.
- Qt WebEngine requires \c pkg-config to detect most of its dependencies. The
+ \QWE requires \c pkg-config to detect most of its dependencies. The
following \c pkg-config files are required:
\list
@@ -115,13 +115,13 @@
\li \macos 10.12 SDK or later
\endlist
- \note Qt WebEngine cannot be built for the 32-bit mode of \macos (using the
+ \note \QWE cannot be built for the 32-bit mode of \macos (using the
\c macx-clang-32 \c mkspec).
- \section1 Using Earlier Qt Versions to Build Qt WebEngine
+ \section1 Using Earlier Qt Versions to Build \QWE
- Building Qt WebEngine with earlier Qt versions (down to the last LTS
- version) is supported. It means that Qt WebEngine 5.11 can be built with
+ Building \QWE with earlier Qt versions (down to the last LTS
+ version) is supported. It means that \QWE 5.11 can be built with
Qt 5.9.x, Qt 5.10.x, and Qt 5.11.
To use an earlier Qt version to build Qt Webengine:
@@ -134,7 +134,7 @@
\section1 Mac App Store Compatibility
- Applications using Qt WebEngine are not compatible with the Mac App Store, because:
+ Applications using \QWE are not compatible with the Mac App Store, because:
\list
\li The Chromium part of the code uses several private API methods, which are prohibited by
@@ -150,7 +150,7 @@
\section1 macOS Airplay Support on MacBooks with Dual GPUs
- To make Qt WebEngine work correctly when streaming to an AppleTV from a MacBook that supports
+ To make \QWE work correctly when streaming to an AppleTV from a MacBook that supports
GPU switching, it is important to add the \c NSSupportsAutomaticGraphicsSwitching option to the
application Info.plist file, with the value set to \c YES. Otherwise rendering issues might
occur when creating new web engine view instances after Airplay is switched on or off.
@@ -167,9 +167,9 @@
\section1 Sandboxing Support
- Qt WebEngine provides out-of-the-box sandboxing support for Chromium render processes on Linux
+ \QWE provides out-of-the-box sandboxing support for Chromium render processes on Linux
and \macos. Sandboxing is currently not supported on Windows due to a limitation in how
- the sandbox is set up and how it interacts with the host process provided by the Qt WebEngine
+ the sandbox is set up and how it interacts with the host process provided by the \QWE
libraries.
On \macos, there are no special requirements for enabling sandbox support.
@@ -184,7 +184,7 @@
\section1 Accessibility and Performance
- Qt WebEngine enables accessibility support for web pages when the following conditions
+ \QWE enables accessibility support for web pages when the following conditions
are met:
\list
@@ -197,7 +197,7 @@
Due to some limitations, the Linux QPA plugin almost always reports that accessibility should
be activated. On big HTML pages, this can cause a significant slowdown in rendering speed.
- Because of that, from Qt 5.9 onwards, Qt WebEngine accessibility support is disabled by default
+ Because of that, from Qt 5.9 onwards, \QWE accessibility support is disabled by default
on Linux.
It can be re-enabled by setting the \c QTWEBENGINE_ENABLE_LINUX_ACCESSIBILITY environment
variable to a non-empty value.
diff --git a/src/webengine/doc/src/qwebengine-licensing.qdoc b/src/webengine/doc/src/qwebengine-licensing.qdoc
index fa5d656d0..8795ca44c 100644
--- a/src/webengine/doc/src/qwebengine-licensing.qdoc
+++ b/src/webengine/doc/src/qwebengine-licensing.qdoc
@@ -30,7 +30,7 @@
\group qtwebengine-licensing
\title Qt WebEngine Licensing
-The Qt specific parts of the Qt WebEngine module are dual-licensed
+The Qt specific parts of the \QWE module are dual-licensed
under Commercial and GNU Lesser General Public License (LGPLv3).
In addition, the module contains code licensed under LGPLv2.
diff --git a/src/webengine/doc/src/webengineview_lgpl.qdoc b/src/webengine/doc/src/webengineview_lgpl.qdoc
index 3b375c532..9095fac65 100644
--- a/src/webengine/doc/src/webengineview_lgpl.qdoc
+++ b/src/webengine/doc/src/webengineview_lgpl.qdoc
@@ -213,7 +213,7 @@
An internal URL for accessing the currently displayed web site icon,
also known as favicon or shortcut icon. The icon is already downloaded
- and stored by the Qt WebEngine's favicon manager.
+ and stored by the \QWE's favicon manager.
This read-only URL corresponds to the image used within a mobile browser
application to represent a bookmarked page on the device's home screen.
@@ -230,7 +230,7 @@
\endqml
Specifying the \c{sourceSize} property of the \c{Image} element informs
- the Qt WebEngine's favicon provider about the requested size. The
+ the \QWE's favicon provider about the requested size. The
favicon provider tries to find the best fit among the web page candidate
icons. If \c{sourceSize} property is not specified, the provider provides
the icon with the largest resolution.
@@ -629,7 +629,7 @@
\value WebEngineView.NoErrorDomain
\value WebEngineView.InternalErrorDomain
- Content fails to be interpreted by Qt WebEngine.
+ Content fails to be interpreted by \QWE.
\value WebEngineView.ConnectionErrorDomain
Error results from faulty network connection.
\value WebEngineView.CertificateErrorDomain