QQuickWebEngineProfile Class

The QQuickWebEngineProfile class provides a web engine profile shared by multiple pages. More...

Header:	#include <QQuickWebEngineProfile>
Since:	Qt 5.6
Instantiated By:	WebEngineProfile
Inherits:	QObject

This class was introduced in Qt 5.6.

• List of all members, including inherited members
• Obsolete members

Public Types

enum	HttpCacheType { MemoryHttpCache, DiskHttpCache, NoCache }
enum	PersistentCookiesPolicy { NoPersistentCookies, AllowPersistentCookies, ForcePersistentCookies }

Properties

cachePath : QString downloadPath : QString httpAcceptLanguage : QString httpCacheMaximumSize : int httpCacheType : HttpCacheType httpUserAgent : QString offTheRecord : bool

persistentCookiesPolicy : PersistentCookiesPolicy persistentStoragePath : QString spellCheckEnabled : bool spellCheckLanguages : QStringList storageName : QString useForGlobalCertificateVerification : bool userScripts : const QQmlListProperty<QQuickWebEngineScript>

Public Functions

	QQuickWebEngineProfile(QObject *parent = Q_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	isSpellCheckEnabled() const
bool	isUsedForGlobalCertificateVerification() 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	setSpellCheckEnabled(bool enabled)
void	setSpellCheckLanguages(const QStringList &languages)
void	setStorageName(const QString &name)
void	setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)
void	setUseForGlobalCertificateVerification(bool b)
QStringList	spellCheckLanguages() const
QString	storageName() const
const QWebEngineUrlSchemeHandler *	urlSchemeHandler(const QByteArray &scheme) const
QQmlListProperty<QQuickWebEngineScript>	userScripts()

Signals

void	cachePathChanged()
void	downloadFinished(QQuickWebEngineDownloadItem *download)
void	downloadPathChanged()
void	downloadRequested(QQuickWebEngineDownloadItem *download)
void	httpAcceptLanguageChanged()
void	httpCacheMaximumSizeChanged()
void	httpCacheTypeChanged()
void	httpUserAgentChanged()
void	offTheRecordChanged()
void	persistentCookiesPolicyChanged()
void	persistentStoragePathChanged()
void	presentNotification(QWebEngineNotification *notification)
void	spellCheckEnabledChanged()
void	spellCheckLanguagesChanged()
void	storageNameChanged()
void	useForGlobalCertificateVerificationChanged()

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.

Member Function Documentation

QQuickWebEngineProfile::QQuickWebEngineProfile(QObject *parent = Q_NULLPTR)

Constructs a new profile with the parent parent.

[signal] void QQuickWebEngineProfile::downloadFinished(QQuickWebEngineDownloadItem *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.

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

[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::clearHttpCache()

Removes the profile's cache entries.

This function was introduced in Qt 5.7.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

See also WebEngineProfile::clearHttpCache.

QWebEngineClientCertificateStore *QQuickWebEngineProfile::clientCertificateStore()

Returns the profile's client certificate store.

This function was introduced in Qt 5.13.

QWebEngineCookieStore *QQuickWebEngineProfile::cookieStore() const

Returns the cookie store for this profile.

[static] QQuickWebEngineProfile *QQuickWebEngineProfile::defaultProfile()

Returns the default profile.

The default profile uses the storage name "Default".

See also storageName().

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.

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.

This function was introduced in Qt 5.8.

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.