summaryrefslogtreecommitdiffstats
path: root/src/webengine/api/qquickwebengineprofile.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/webengine/api/qquickwebengineprofile.cpp')
-rw-r--r--src/webengine/api/qquickwebengineprofile.cpp24
1 files changed, 18 insertions, 6 deletions
diff --git a/src/webengine/api/qquickwebengineprofile.cpp b/src/webengine/api/qquickwebengineprofile.cpp
index 14405251e..0275d8a2a 100644
--- a/src/webengine/api/qquickwebengineprofile.cpp
+++ b/src/webengine/api/qquickwebengineprofile.cpp
@@ -62,17 +62,29 @@ ASSERT_ENUMS_MATCH(QQuickWebEngineDownloadItem::MimeHtmlSaveFormat, QtWebEngineC
/*!
\class QQuickWebEngineProfile
- \brief The QQuickWebEngineProfile class provides a web-engine profile shared by multiple pages.
+ \brief The QQuickWebEngineProfile class provides a web engine profile shared by multiple pages.
\since 5.6
\inmodule QtWebEngine
- QQuickWebEngineProfile contains settings, scripts, and the list of visited links shared by all
- web engine pages that belong to the profile. As such, profiles can be used to isolate pages
- from each other. A typical use case is a dedicated profile for a 'private browsing' mode.
+ A web engine profile contains properties and functionality shared by a group of web engine
+ pages.
+
+ Information about visited links is stored together with persistent cookies and other persistent
+ data in a storage described by the persistentStoragePath property.
+
+ Profiles can be used to isolate pages from each other. A typical use case is a dedicated
+ \e {off-the-record profile} for a \e {private browsing} mode. An off-the-record profile forces
+ cookies, the HTTP cache, and other normally persistent data to be stored only in memory. The
+ offTheRecord property holds whether a profile is off-the-record.
+
+ The default profile can be accessed by defaultProfile(). It is a built-in profile that all
+ web pages not specifically created with another profile belong to.
- The default profile is a built-in profile that all web pages not specifically created with
- another profile belong to.
+ A WebEngineProfile instance can be created and accessed from C++ through the
+ QQuickWebEngineProfile class, which exposes further functionality in C++. This allows Qt Quick
+ applications to intercept URL requests (QQuickWebEngineProfile::setRequestInterceptor), or
+ register custom URL schemes (QQuickWebEngineProfile::installUrlSchemeHandler).
*/
/*!