QWebEngineProfile Class

Member Function Documentation

[explicit] QWebEngineProfile::QWebEngineProfile(QObject *parent = nullptr)

Constructs a new off-the-record profile with the parent parent.

An off-the-record profile leaves no record on the local machine, and has no persistent data or cache. Thus, the HTTP cache can only be in memory and the cookies can only be non-persistent. Trying to change these settings will have no effect.

See also isOffTheRecord().

[explicit] QWebEngineProfile::QWebEngineProfile(const QString &storageName, QObject *parent = nullptr)

Constructs a new profile with the storage name storageName and parent parent.

The storage name must be unique.

A disk-based QWebEngineProfile should be destroyed on or before application exit, otherwise the cache and persistent data may not be fully flushed to disk.

See also storageName().

QString QWebEngineProfile::cachePath() const

Returns the path used for caches.

By default, this is below StandardPaths::CacheLocation in a QtWebengine/StorageName specific subdirectory.

See also setCachePath(), storageName(), and QStandardPaths::writableLocation().

void QWebEngineProfile::clearAllVisitedLinks()

Clears all links from the visited links database.

See also clearVisitedLinks().

void QWebEngineProfile::clearHttpCache()

Removes the profile's cache entries.

See also QWebEngineProfile::clearHttpCacheCompleted().

[signal, since 6.7] void QWebEngineProfile::clearHttpCacheCompleted()

This signal is emitted when the clearHttpCache() operation is completed.

This function was introduced in Qt 6.7.

See also QWebEngineProfile::clearHttpCache().

void QWebEngineProfile::clearVisitedLinks(const QList<QUrl> &urls)

Clears the links in urls from the visited links database.

See also clearAllVisitedLinks().

QWebEngineClientCertificateStore *QWebEngineProfile::clientCertificateStore()

Returns the profile's client certificate store.

[since 6.8] QWebEngineClientHints *QWebEngineProfile::clientHints() const

Return the Client Hints settings associated with this browsing context.

This function was introduced in Qt 6.8.

See also QWebEngineClientHints.

QWebEngineCookieStore *QWebEngineProfile::cookieStore()

Returns the cookie store for this profile.

[static] QWebEngineProfile *QWebEngineProfile::defaultProfile()

Returns the default profile.

The default profile is off-the-record.

See also storageName().

QString QWebEngineProfile::downloadPath() const

The path to the location where the downloaded files are stored.

See also setDownloadPath() and QStandardPaths::writableLocation().

[signal] void QWebEngineProfile::downloadRequested(QWebEngineDownloadRequest *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.

See also QWebEngineDownloadRequest and QWebEnginePage::download().

QString QWebEngineProfile::httpAcceptLanguage() const

Returns the value of the Accept-Language HTTP request-header field.

See also setHttpAcceptLanguage().

int QWebEngineProfile::httpCacheMaximumSize() const

Returns the maximum size of the HTTP cache in bytes.

Will return 0 if the size is automatically controlled by QtWebEngine.

See also setHttpCacheMaximumSize() and httpCacheType().

QWebEngineProfile::HttpCacheType QWebEngineProfile::httpCacheType() const

Returns the type of HTTP cache used.

If the profile is off-the-record, MemoryHttpCache is returned.

See also setHttpCacheType() and cachePath().

QString QWebEngineProfile::httpUserAgent() const

Returns the user-agent string sent with HTTP to identify the browser.

See also setHttpUserAgent() and Windows Application Manifest.

void QWebEngineProfile::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.

bool QWebEngineProfile::isOffTheRecord() const

Returns true if this is an off-the-record profile that leaves no record on the computer.

This will force cookies and HTTP cache to be in memory, but also force all other normally persistent data to be stored in memory.

[since 6.5] bool QWebEngineProfile::isPushServiceEnabled() const

Returns true if the push messaging service is enabled.

This function was introduced in Qt 6.5.

See also setPushServiceEnabled().

bool QWebEngineProfile::isSpellCheckEnabled() const

Returns true if the spell checker is enabled; otherwise returns false.

See also setSpellCheckEnabled().

[since 6.8] QList<QWebEnginePermission> QWebEngineProfile::listAllPermissions() const

Returns a QList of QWebEnginePermission objects, each one representing a single permission currently present in the permissions store. The returned list contains all previously granted/denied permissions for this profile, provided they are of a persistent type.

This function was introduced in Qt 6.8.

See also queryPermission(), QWebEnginePermission::PermissionType, and QWebEnginePermission::isPersistent().

[since 6.8] QList<QWebEnginePermission> QWebEngineProfile::listPermissionsForOrigin(const QUrl &securityOrigin) const

Returns a QList of QWebEnginePermission objects, each one representing a single permission currently present in the permissions store. The returned list contains all previously granted/denied permissions associated with a specific securityOrigin for this profile, provided they are of a persistent type.

This function was introduced in Qt 6.8.

See also queryPermission(), QWebEnginePermission::PermissionType, and QWebEnginePermission::isPersistent().

[since 6.8] QList<QWebEnginePermission> QWebEngineProfile::listPermissionsForPermissionType(QWebEnginePermission::PermissionType permissionType) const

Returns a QList of QWebEnginePermission objects, each one representing a single permission currently present in the permissions store. The returned list contains all previously granted/denied permissions of the provided permissionType. If the permissionType is non-persistent, the list will be empty.

This function was introduced in Qt 6.8.

See also queryPermission(), QWebEnginePermission::PermissionType, and QWebEnginePermission::isPersistent().

QWebEngineProfile::PersistentCookiesPolicy QWebEngineProfile::persistentCookiesPolicy() const

Returns the current policy for persistent cookies.

If the profile is off-the-record, NoPersistentCookies is returned.

See also setPersistentCookiesPolicy().

[since 6.8] QWebEngineProfile::PersistentPermissionsPolicy QWebEngineProfile::persistentPermissionsPolicy() const

Returns the current policy for persistent permissions.

Off-the-record profiles are not allowed to save data to the disk, so they can only return StoreInMemory or AskEveryTime.

This function was introduced in Qt 6.8.

See also QWebEngineProfile::PersistentPermissionsPolicy and setPersistentPermissionsPolicy().

QString QWebEngineProfile::persistentStoragePath() const

Returns the path used to store persistent data for the browser and web content.

Persistent data includes persistent cookies, HTML5 local storage, and visited links.

By default, this is below QStandardPaths::DataLocation in a QtWebengine/StorageName specific subdirectory.

See also setPersistentStoragePath(), storageName(), and QStandardPaths::writableLocation().

[since 6.8] QWebEnginePermission QWebEngineProfile::queryPermission(const QUrl &securityOrigin, QWebEnginePermission::PermissionType permissionType) const

Returns a QWebEnginePermission object corresponding to a single permission for the provided securityOrigin and permissionType. The object may be used to query for the current state of the permission, or to change it. It is not required for a permission to already exist; the returned object may also be used to pre-grant a permission if a website is known to use it.

You may use this to pre-grant a permission of a non-persistent type. Doing so will keep the permission in the granted (or denied) state until the next time a website with the associated origin requests it. At that point, the permission's lifetime will be tied to that specific web page's lifetime, and navigating away will invalidate the permission.

This function was introduced in Qt 6.8.

See also listAllPermissions(), listPermissionsForOrigin(), listPermissionsForPermissionType(), and QWebEnginePermission::PermissionType.

void QWebEngineProfile::removeAllUrlSchemeHandlers()

Removes all custom URL scheme handlers installed in the profile.

void QWebEngineProfile::removeUrlScheme(const QByteArray &scheme)

Removes the custom URL scheme scheme from the profile.

See also removeUrlSchemeHandler().

void QWebEngineProfile::removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler)

Removes the custom URL scheme handler handler from the profile.

See also removeUrlScheme().

[since 6.2] void QWebEngineProfile::requestIconForIconURL(const QUrl &url, int desiredSizeInPixel, std::function<void (const QIcon &, const QUrl &)> iconAvailableCallback) const

Requests an icon with the specified url from the database. Each profile has its own icon database and it is stored in the persistent storage thus the stored icons can be accessed without network connection too. The icon must be previously loaded to be stored in the database.

url specifies the URL of the icon. In case of more than one available icons the one with the size closest to desiredSizeInPixel will be returned. The result icon is resized to desiredSizeInPixel. If desiredSizeInPixel is 0 the largest available icon is returned.

This function is asynchronous and the result is returned by iconAvailableCallback. The callback is called if a request for an icon is performed. If the requested icon is available, the first parameter (with type QIcon) is the result. Otherwise, it is null.

The second parameter stores the URL of the requested icon. It is empty if the icon can't be fetched.

This function was introduced in Qt 6.2.

See also requestIconForPageURL().

[since 6.2] void QWebEngineProfile::requestIconForPageURL(const QUrl &url, int desiredSizeInPixel, std::function<void (const QIcon &, const QUrl &, const QUrl &)> iconAvailableCallback) const

Requests an icon for a previously loaded page with this profile from the database. Each profile has its own icon database and it is stored in the persistent storage thus the stored icons can be accessed without network connection too. The icon must be previously loaded to be stored in the database.

url specifies the URL of the page what the icon is requested for. In case of more than one available icons the one with the size closest to desiredSizeInPixel will be returned. The result icon is resized to desiredSizeInPixel. If desiredSizeInPixel is 0 the largest available icon is returned.

This function is asynchronous and the result is returned by iconAvailableCallback. The callback is called if a request for an icon is performed. If the requested icon is available, the first parameter (with type QIcon) is the result. Otherwise, it is null.

The second parameter stores the URL of the requested icon. It is empty if the icon can't be fetched.

The third parameter stores the URL of the page which the icon is assigned.

This function was introduced in Qt 6.2.

See also requestIconForIconURL().

QWebEngineScriptCollection *QWebEngineProfile::scripts() const

Returns the collection of scripts that are injected into all pages that share this profile.

See also QWebEngineScriptCollection, QWebEngineScript, QWebEnginePage::scripts(), and Script Injection.

void QWebEngineProfile::setCachePath(const QString &path)

Overrides the default path used for disk caches, setting it to path.

If set to the null string, the default path is restored.

See also cachePath().

void QWebEngineProfile::setDownloadPath(const QString &path)

Overrides the default path used for download location, setting it to path.

If set to the null string, the default path is restored.

See also downloadPath().

void QWebEngineProfile::setHttpAcceptLanguage(const QString &httpAcceptLanguage)

Sets the value of the Accept-Language HTTP request-header field to httpAcceptLanguage.

See also httpAcceptLanguage().

void QWebEngineProfile::setHttpCacheMaximumSize(int maxSize)

Sets the maximum size of the HTTP cache to maxSize bytes.

Setting it to 0 means the size will be controlled automatically by QtWebEngine.

See also httpCacheMaximumSize() and setHttpCacheType().

void QWebEngineProfile::setHttpCacheType(QWebEngineProfile::HttpCacheType httpCacheType)

Sets the HTTP cache type to httpCacheType.

See also httpCacheType(), setCachePath(), and clearHttpCache().

void QWebEngineProfile::setHttpUserAgent(const QString &userAgent)

Overrides the default user-agent string, setting it to userAgent.

See also httpUserAgent().

void QWebEngineProfile::setNotificationPresenter(std::function<void (std::unique_ptr<QWebEngineNotification>)> notificationPresenter)

Sets the function notificationPresenter as responsible for presenting sent notifications.

See also QWebEngineNotification.

void QWebEngineProfile::setPersistentCookiesPolicy(QWebEngineProfile::PersistentCookiesPolicy newPersistentCookiesPolicy)

Sets the policy for persistent cookies to newPersistentCookiesPolicy.

See also persistentCookiesPolicy().

[since 6.8] void QWebEngineProfile::setPersistentPermissionsPolicy(QWebEngineProfile::PersistentPermissionsPolicy newPersistentPermissionsPolicy)

Sets the policy for persistent permissions to newPersistentPermissionsPolicy.

This function was introduced in Qt 6.8.

See also QWebEngineProfile::PersistentPermissionsPolicy and persistentPermissionsPolicy().

void QWebEngineProfile::setPersistentStoragePath(const QString &path)

Overrides the default path used to store persistent web engine data.

If path is set to the null string, the default path is restored.

See also persistentStoragePath().

[since 6.5] void QWebEngineProfile::setPushServiceEnabled(bool enable)

Enables the push messaging service if enable is true, otherwise disables it.

This function was introduced in Qt 6.5.

See also isPushServiceEnabled().

void QWebEngineProfile::setSpellCheckEnabled(bool enable)

Enables spell checker if enable is true, otherwise disables it.

See also isSpellCheckEnabled().

void QWebEngineProfile::setSpellCheckLanguages(const QStringList &languages)

Sets the current list of languages for the spell checker. Each language should match the name of the .bdic dictionary. For example, the language en-US will load the en-US.bdic dictionary file.

See the Spellchecker feature documentation for how dictionary files are searched.

For more information about how to compile .bdic dictionaries, see the Spellchecker Example.

See also spellCheckLanguages().

void QWebEngineProfile::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.

QWebEngineSettings *QWebEngineProfile::settings() const

Returns the default settings for all pages in this profile.

QStringList QWebEngineProfile::spellCheckLanguages() const

Returns the list of languages used by the spell checker.

See also setSpellCheckLanguages().

QString QWebEngineProfile::storageName() const

Returns the storage name for the profile.

The storage name is used to give each profile that uses the disk separate subdirectories for persistent data and cache.

const QWebEngineUrlSchemeHandler *QWebEngineProfile::urlSchemeHandler(const QByteArray &scheme) const

Returns the custom URL scheme handler register for the URL scheme scheme.

bool QWebEngineProfile::visitedLinksContainsUrl(const QUrl &url) const

Returns true if url is considered a visited link by this profile.