diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-09-11 16:07:48 +0200 |
---|---|---|
committer | Kai Koehne <kai.koehne@qt.io> | 2018-09-24 09:05:16 +0000 |
commit | 464002679a0c620f1c9d579f17b942480bb7fc12 (patch) | |
tree | 668b76604212b9ea3d0c1fd5c6a331568d7488d4 /src/webengine/api | |
parent | feff8635d8a1962d149216750dbc15f5d799c630 (diff) |
Doc: Mention that profile storage paths must be set before use
Task-number: QTBUG-66871
Change-Id: I246d667dfe341a6bfe7a74b24286403bec4dde8b
Reviewed-by: Michal Klocek <michal.klocek@qt.io>
Diffstat (limited to 'src/webengine/api')
-rw-r--r-- | src/webengine/api/qquickwebengineprofile.cpp | 36 |
1 files changed, 29 insertions, 7 deletions
diff --git a/src/webengine/api/qquickwebengineprofile.cpp b/src/webengine/api/qquickwebengineprofile.cpp index c89e4d522..dd405f5d7 100644 --- a/src/webengine/api/qquickwebengineprofile.cpp +++ b/src/webengine/api/qquickwebengineprofile.cpp @@ -69,11 +69,18 @@ ASSERT_ENUMS_MATCH(QQuickWebEngineDownloadItem::MimeHtmlSaveFormat, QtWebEngineC \inmodule QtWebEngine - 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. + A web engine profile contains settings, scripts, persistent cookie policy, and the list of + visited links shared by all web engine pages that belong to the profile. + + Information about visited links is stored together with persistent cookies + and other persistent data in a storage determined by the storageName + property. Persistent data is stored in a subdirectory determined by the + persistentStoragePath property and the cache in a subdirectory determined by + the cachePath property. The httpCacheType property describes the type of the + cache: \e in-memory or \e on-disk. If only the storageName property is set, + the other values are generated automatically based on it. If you specify + any of the values manually, you should do it before creating any pages that + belong to the profile. 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 @@ -278,8 +285,23 @@ void QQuickWebEngineProfilePrivate::userScripts_clear(QQmlListProperty<QQuickWeb \brief Contains settings, scripts, and visited links common to multiple web engine views. WebEngineProfile contains settings, scripts, and the list of visited links shared by all - views that belong to the profile. As such, profiles can be used to isolate views - from each other. A typical use case is a dedicated profile for a 'private browsing' mode. + views that belong to the profile. + + Information about visited links is stored together with persistent cookies + and other persistent data in a storage determined by the storageName + property. Persistent data is stored in a subdirectory determined by the + persistentStoragePath property and the cache in a subdirectory determined by + the cachePath property. The httpCacheType property describes the type of the + cache: \e in-memory or \e on-disk. If only the storageName property is set, + the other values are generated automatically based on it. If you specify + any of the values manually, you should do it before creating any pages that + belong to the profile. + + 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. Each web engine view has an associated profile. Views that do not have a specific profile set share a common default one. |