QQuickWebEngineProfile Class
The QQuickWebEngineProfile class provides a web engine profile shared by multiple pages. More...
| Header: | #include <QQuickWebEngineProfile> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS WebEngineQuick) target_link_libraries(mytarget PRIVATE Qt6::WebEngineQuick) |
| qmake: | QT += webenginequick |
| Instantiated By: | WebEngineProfile |
| Inherits: | QObject |
Public Types
| enum | HttpCacheType { MemoryHttpCache, DiskHttpCache, NoCache } |
| enum | PersistentCookiesPolicy { NoPersistentCookies, AllowPersistentCookies, ForcePersistentCookies } |
Properties
|
|
Public Functions
| QQuickWebEngineProfile(QObject *parent = nullptr) | |
| QString | cachePath() const |
| void | clearHttpCache() |
| QWebEngineClientCertificateStore * | clientCertificateStore() |
| QWebEngineCookieStore * | cookieStore() const |
| QString | downloadPath() const |
| QString | httpAcceptLanguage() const |
| int | httpCacheMaximumSize() const |
| QQuickWebEngineProfile::HttpCacheType | httpCacheType() const |
| QString | httpUserAgent() const |
| void | installUrlSchemeHandler(const QByteArray &scheme, QWebEngineUrlSchemeHandler *handler) |
| bool | isOffTheRecord() const |
| bool | isPushServiceEnabled() const |
| bool | isSpellCheckEnabled() const |
| QQuickWebEngineProfile::PersistentCookiesPolicy | persistentCookiesPolicy() const |
| QString | persistentStoragePath() const |
| void | removeAllUrlSchemeHandlers() |
| void | removeUrlScheme(const QByteArray &scheme) |
| void | removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler) |
| void | setCachePath(const QString &path) |
| void | setDownloadPath(const QString &path) |
| void | setHttpAcceptLanguage(const QString &httpAcceptLanguage) |
| void | setHttpCacheMaximumSize(int maxSize) |
| void | setHttpCacheType(QQuickWebEngineProfile::HttpCacheType) |
| void | setHttpUserAgent(const QString &userAgent) |
| void | setOffTheRecord(bool offTheRecord) |
| void | setPersistentCookiesPolicy(QQuickWebEngineProfile::PersistentCookiesPolicy) |
| void | setPersistentStoragePath(const QString &path) |
| void | setPushServiceEnabled(bool enable) |
| void | setSpellCheckEnabled(bool enabled) |
| void | setSpellCheckLanguages(const QStringList &languages) |
| void | setStorageName(const QString &name) |
| void | setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor) |
| QStringList | spellCheckLanguages() const |
| QString | storageName() const |
| const QWebEngineUrlSchemeHandler * | urlSchemeHandler(const QByteArray &scheme) const |
| QQuickWebEngineScriptCollection * | userScripts() const |
Signals
| void | cachePathChanged() |
(since 6.7) void | clearHttpCacheCompleted() |
| void | downloadFinished(QQuickWebEngineDownloadRequest *download) |
| void | downloadPathChanged() |
| void | downloadRequested(QQuickWebEngineDownloadRequest *download) |
| void | httpAcceptLanguageChanged() |
| void | httpCacheMaximumSizeChanged() |
| void | httpCacheTypeChanged() |
| void | httpUserAgentChanged() |
| void | offTheRecordChanged() |
| void | persistentCookiesPolicyChanged() |
| void | persistentStoragePathChanged() |
| void | presentNotification(QWebEngineNotification *notification) |
| void | pushServiceEnabledChanged() |
| void | spellCheckEnabledChanged() |
| void | spellCheckLanguagesChanged() |
| void | storageNameChanged() |
Static Public Members
| QQuickWebEngineProfile * | defaultProfile() |
Detailed Description
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: in-memory or 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 off-the-record profile for a 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.
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).
Spellchecking HTML form fields can be enabled per profile by setting the spellCheckEnabled property and the current languages used for spellchecking can be set by using the spellCheckLanguages property.
Member Type Documentation
enum QQuickWebEngineProfile::HttpCacheType
This enum describes the HTTP cache type:
| Constant | Value | Description |
|---|---|---|
QQuickWebEngineProfile::MemoryHttpCache | 0 | Use an in-memory cache. This is the default if off-the-record is set. |
QQuickWebEngineProfile::DiskHttpCache | 1 | Use a disk cache. This is the default if off-the-record is not set. Falls back to MemoryHttpCache if off-the-record is set. |
QQuickWebEngineProfile::NoCache | 2 | Disable both in-memory and disk caching. (Added in Qt 5.7) |
enum QQuickWebEngineProfile::PersistentCookiesPolicy
This enum describes policy for cookie persistency:
| Constant | Value | Description |
|---|---|---|
QQuickWebEngineProfile::NoPersistentCookies | 0 | Both session and persistent cookies are stored in memory. This is the only setting possible if off-the-record is set or no persistent data path is available. |
QQuickWebEngineProfile::AllowPersistentCookies | 1 | Cookies marked persistent are saved to and restored from disk, whereas session cookies are only stored to disk for crash recovery. This is the default setting. |
QQuickWebEngineProfile::ForcePersistentCookies | 2 | Both session and persistent cookies are saved to and restored from disk. |
Property Documentation
cachePath : QString
The path to the location where the profile's caches are stored, in particular the HTTP cache.
By default, the caches are stored below QStandardPaths::writableLocation(QStandardPaths::CacheLocation) in a directory named using storageName.
Access functions:
| QString | cachePath() const |
| void | setCachePath(const QString &path) |
Notifier signal:
| void | cachePathChanged() |
[since QtWebEngine 1.9] downloadPath : QString
The path to the location where the downloaded files are stored.
Overrides the default path used for download location, setting it to path.
If set to an empty string, the default path is restored.
Note: By default, the download path is QStandardPaths::DownloadLocation.
This property was introduced in QtWebEngine 1.9.
Access functions:
| QString | downloadPath() const |
| void | setDownloadPath(const QString &path) |
Notifier signal:
| void | downloadPathChanged() |
httpAcceptLanguage : QString
The value of the Accept-Language HTTP request-header field.
Access functions:
| QString | httpAcceptLanguage() const |
| void | setHttpAcceptLanguage(const QString &httpAcceptLanguage) |
Notifier signal:
| void | httpAcceptLanguageChanged() |
httpCacheMaximumSize : int
The maximum size of the HTTP cache. If 0, the size will be controlled automatically by QtWebEngine. The default value is 0.
Access functions:
| int | httpCacheMaximumSize() const |
| void | setHttpCacheMaximumSize(int maxSize) |
Notifier signal:
| void | httpCacheMaximumSizeChanged() |
See also httpCacheType.
httpCacheType : HttpCacheType
This enumeration describes the type of the HTTP cache.
If the profile is off-the-record or has no storageName set, MemoryHttpCache is returned.
Access functions:
| QQuickWebEngineProfile::HttpCacheType | httpCacheType() const |
| void | setHttpCacheType(QQuickWebEngineProfile::HttpCacheType) |
Notifier signal:
| void | httpCacheTypeChanged() |
httpUserAgent : QString
The user-agent string sent with HTTP to identify the browser.
Access functions:
| QString | httpUserAgent() const |
| void | setHttpUserAgent(const QString &userAgent) |
Notifier signal:
| void | httpUserAgentChanged() |
[since QtWebEngine 6.5] isPushServiceEnabled : bool
Whether the push messaging service is enabled.
Note: By default the push messaging service is disabled.
Note: Qt WebEngine uses the Firebase Cloud Messaging (FCM) as a browser push service. Therefore, all push messages will go through the Google push service and its respective servers.
This property was introduced in QtWebEngine 6.5.
Access functions:
| bool | isPushServiceEnabled() const |
| void | setPushServiceEnabled(bool enable) |
Notifier signal:
| void | pushServiceEnabledChanged() |
offTheRecord : bool
Whether the web engine profile is off-the-record. An off-the-record profile forces cookies, the HTTP cache, and other normally persistent data to be stored only in memory. Profile is off-the-record by default.
Access functions:
| bool | isOffTheRecord() const |
| void | setOffTheRecord(bool offTheRecord) |
Notifier signal:
| void | offTheRecordChanged() |
persistentCookiesPolicy : PersistentCookiesPolicy
This enumeration describes the policy of cookie persistency. If the profile is off-the-record, NoPersistentCookies is returned.
Access functions:
| QQuickWebEngineProfile::PersistentCookiesPolicy | persistentCookiesPolicy() const |
| void | setPersistentCookiesPolicy(QQuickWebEngineProfile::PersistentCookiesPolicy) |
Notifier signal:
| void | persistentCookiesPolicyChanged() |
persistentStoragePath : QString
The path to the location where the persistent data for the browser and web content are stored. Persistent data includes persistent cookies, HTML5 local storage, and visited links.
By default, the storage is located below QStandardPaths::writableLocation(QStandardPaths::AppDataLocation) in a directory named using storageName.
Access functions:
| QString | persistentStoragePath() const |
| void | setPersistentStoragePath(const QString &path) |
Notifier signal:
| void | persistentStoragePathChanged() |
[since QtWebEngine 1.4] spellCheckEnabled : bool
This property holds whether the web engine spell checker is enabled.
This property was introduced in QtWebEngine 1.4.
Access functions:
| bool | isSpellCheckEnabled() const |
| void | setSpellCheckEnabled(bool enabled) |
Notifier signal:
| void | spellCheckEnabledChanged() |
[since QtWebEngine 1.4] spellCheckLanguages : QStringList
This property holds the languages used by the spell checker.
This property was introduced in QtWebEngine 1.4.
Access functions:
| QStringList | spellCheckLanguages() const |
| void | setSpellCheckLanguages(const QStringList &languages) |
Notifier signal:
| void | spellCheckLanguagesChanged() |
storageName : QString
The storage name that is used to create separate subdirectories for each profile that uses the disk for storing persistent data and cache.
Access functions:
| QString | storageName() const |
| void | setStorageName(const QString &name) |
Notifier signal:
| void | storageNameChanged() |
See also persistentStoragePath and cachePath.
Member Function Documentation
QQuickWebEngineProfile::QQuickWebEngineProfile(QObject *parent = nullptr)
Constructs a new profile with the parent parent.
[invokable] void QQuickWebEngineProfile::clearHttpCache()
Removes the profile's cache entries.
Note: Make sure that you do not start new navigation or any operation on the profile while the clear operation is in progress. The clearHttpCacheCompleted() signal notifies about the completion.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
See also WebEngineProfile::clearHttpCache() and clearHttpCacheCompleted().
[signal, since 6.7] void QQuickWebEngineProfile::clearHttpCacheCompleted()
This signal is emitted when the clearHttpCache() operation is completed.
This function was introduced in Qt 6.7.
See also clearHttpCache().
QWebEngineClientCertificateStore *QQuickWebEngineProfile::clientCertificateStore()
Returns the profile's client certificate store.
QWebEngineCookieStore *QQuickWebEngineProfile::cookieStore() const
Returns the cookie store for this profile.
[static] QQuickWebEngineProfile *QQuickWebEngineProfile::defaultProfile()
Returns the default profile.
The default profile is off-the-record.
See also storageName().
[signal] void QQuickWebEngineProfile::downloadFinished(QQuickWebEngineDownloadRequest *download)
This signal is emitted whenever downloading stops, because it finished successfully, was cancelled, or was interrupted (for example, because connectivity was lost). The download argument holds the state of the finished download instance.
Note: To use from C++ static_cast download to QWebEngineDownloadRequest
[signal] void QQuickWebEngineProfile::downloadRequested(QQuickWebEngineDownloadRequest *download)
This signal is emitted whenever a download has been triggered. The download argument holds the state of the download. The download has to be explicitly accepted with QWebEngineDownloadRequest::accept() or it will be cancelled by default. The download item is parented by the profile. If it is not accepted, it will be deleted immediately after the signal emission. This signal cannot be used with a queued connection.
Note: To use from C++ static_cast download to QWebEngineDownloadRequest
void QQuickWebEngineProfile::installUrlSchemeHandler(const QByteArray &scheme, QWebEngineUrlSchemeHandler *handler)
Registers a handler handler for custom URL scheme scheme in the profile.
It is necessary to first register the scheme with QWebEngineUrlScheme::registerScheme at application startup.
[signal] void QQuickWebEngineProfile::presentNotification(QWebEngineNotification *notification)
This signal is emitted whenever there is a newly created user notification. The notification argument holds the QWebEngineNotification instance to query data and interact with.
See also WebEngineProfile::presentNotification.
void QQuickWebEngineProfile::removeAllUrlSchemeHandlers()
Removes all custom URL scheme handlers installed in the profile.
void QQuickWebEngineProfile::removeUrlScheme(const QByteArray &scheme)
Removes the custom URL scheme scheme from the profile.
See also removeUrlSchemeHandler().
void QQuickWebEngineProfile::removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler)
Removes the custom URL scheme handler handler from the profile.
See also removeUrlScheme().
void QQuickWebEngineProfile::setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)
Registers a request interceptor singleton interceptor to intercept URL requests.
The profile does not take ownership of the pointer.
See also QWebEngineUrlRequestInfo and QWebEngineUrlRequestInterceptor.
QStringList QQuickWebEngineProfile::spellCheckLanguages() const
Returns the list of languages used by the spell checker.
Note: Getter function for property spellCheckLanguages.
See also setSpellCheckLanguages().
const QWebEngineUrlSchemeHandler *QQuickWebEngineProfile::urlSchemeHandler(const QByteArray &scheme) const
Returns the custom URL scheme handler register for the URL scheme scheme.