QQuickWebEngineProfile Class

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

頭：	#include <QQuickWebEngineProfile>
Since:	Qt 5.6
實例化：	WebEngineProfile
繼承：	QObject

該類在 Qt 5.6 引入。

公共類型

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

特性

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

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

公共函數

	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
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 & 語言 )
void	setStorageName (const QString & name )
void	setUrlRequestInterceptor (QWebEngineUrlRequestInterceptor * interceptor )
QStringList	spellCheckLanguages () const
QString	storageName () const
const QWebEngineUrlSchemeHandler *	urlSchemeHandler (const QByteArray & scheme ) const
QQmlListProperty<QQuickWebEngineScript>	userScripts ()

信號

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 ()

靜態公共成員

QQuickWebEngineProfile *

defaultProfile ()

詳細描述

Web 引擎 Profile (配置文件) 包含設置、腳本、持久性 Cookie 策略及屬於 Profile 由所有 Web 引擎頁麵共享的拜訪鏈接列錶。

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 對於 隱私瀏覽 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 特性。

成員類型文檔編製

enum QQuickWebEngineProfile:: HttpCacheType

此枚舉描述 HTTP 緩存類型：

常量	值	描述
`QQuickWebEngineProfile::MemoryHttpCache`	`0`	使用內存中的緩存。這是默認設置若 `off-the-record` 有設置。
`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` 有設置。
`QQuickWebEngineProfile::NoCache`	`2`	禁用內存和磁盤緩存。(在 Qt 5.7 添加)

enum QQuickWebEngineProfile:: PersistentCookiesPolicy

此枚舉描述 Cookie 持久性策略：

常量	值	描述
`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`	會話和持久 Cookie 均保存到磁盤並從中還原。

特性文檔編製

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 .

訪問函數：

QString	cachePath () const
void	setCachePath (const QString & path )

通知程序信號：

void	cachePathChanged ()

downloadPath : QString

下載文件存儲位置的路徑。

覆蓋用於下載位置的默認路徑，將其設為 path .

If set to an empty string, the default path is restored.

注意： 默認情況下，下載路徑為 QStandardPaths::DownloadLocation .

This property was introduced in QtWebEngine 1.9.

訪問函數：

QString	downloadPath () const
void	setDownloadPath (const QString & path )

通知程序信號：

void	downloadPathChanged ()

httpAcceptLanguage : QString

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

訪問函數：

QString	httpAcceptLanguage () const
void	setHttpAcceptLanguage (const QString & httpAcceptLanguage )

通知程序信號：

void	httpAcceptLanguageChanged ()

httpCacheMaximumSize : int

The maximum size of the HTTP cache. If 0 , the size will be controlled automatically by QtWebEngine 。默認值為 0 .

訪問函數：

int	httpCacheMaximumSize () const
void	setHttpCacheMaximumSize (int maxSize )

通知程序信號：

void	httpCacheMaximumSizeChanged ()

另請參閱 httpCacheType .

httpCacheType : HttpCacheType

This enumeration describes the type of the HTTP cache.

若 Profile (配置文件) 為 off-the-record， MemoryHttpCache 被返迴。

訪問函數：

QQuickWebEngineProfile::HttpCacheType	httpCacheType () const
void	setHttpCacheType ( QQuickWebEngineProfile::HttpCacheType )

通知程序信號：

void	httpCacheTypeChanged ()

httpUserAgent : QString

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

訪問函數：

QString	httpUserAgent () const
void	setHttpUserAgent (const QString & userAgent )

通知程序信號：

void	httpUserAgentChanged ()

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.

訪問函數：

bool	isOffTheRecord () const
void	setOffTheRecord (bool offTheRecord )

通知程序信號：

void	offTheRecordChanged ()

persistentCookiesPolicy : PersistentCookiesPolicy

This enumeration describes the policy of cookie persistency. If the profile is off-the-record, NoPersistentCookies 被返迴。

訪問函數：

QQuickWebEngineProfile::PersistentCookiesPolicy	persistentCookiesPolicy () const
void	setPersistentCookiesPolicy ( QQuickWebEngineProfile::PersistentCookiesPolicy )

通知程序信號：

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::DataLocation ) in a directory named using storageName .

訪問函數：

QString	persistentStoragePath () const
void	setPersistentStoragePath (const QString & path )

通知程序信號：

void	persistentStoragePathChanged ()

spellCheckEnabled : bool

This property holds whether the web engine spell checker is enabled.

This property was introduced in QtWebEngine 1.4.

訪問函數：

bool	isSpellCheckEnabled () const
void	setSpellCheckEnabled (bool enabled )

通知程序信號：

void	spellCheckEnabledChanged ()

spellCheckLanguages : QStringList

This property holds the languages used by the spell checker.

This property was introduced in QtWebEngine 1.4.

訪問函數：

QStringList	spellCheckLanguages () const
void	setSpellCheckLanguages (const QStringList & 語言 )

通知程序信號：

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.

訪問函數：

QString	storageName () const
void	setStorageName (const QString & name )

通知程序信號：

void	storageNameChanged ()

另請參閱 persistentStoragePath and cachePath .

userScripts : const QQmlListProperty < QQuickWebEngineScript >

This property holds the collection of scripts that are injected into all pages that share this profile.

該特性在 Qt 5.9 引入。

訪問函數：

QQmlListProperty<QQuickWebEngineScript>

userScripts ()

另請參閱 QQuickWebEngineScript and QQmlListReference .

成員函數文檔編製

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 )

此信號被發射每當下載已被觸發。 download 自變量保持下載的狀態。下載必須被明確接受采用 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.

另請參閱 WebEngineProfile::presentNotification .

void QQuickWebEngineProfile:: clearHttpCache ()

移除 Profile 的緩存條目。

注意： 此函數可以被援引，通過元對象係統和從 QML。見 Q_INVOKABLE .

該函數在 Qt 5.7 引入。

另請參閱 WebEngineProfile::clearHttpCache .

QWebEngineClientCertificateStore *QQuickWebEngineProfile:: clientCertificateStore ()

返迴 Profile (配置文件) 的客戶端證書存儲。

該函數在 Qt 5.13 引入。

QWebEngineCookieStore *QQuickWebEngineProfile:: cookieStore () const

返迴用於此 Profile (配置文件) 的 Cookie 存儲。

`[static]` QQuickWebEngineProfile *QQuickWebEngineProfile:: defaultProfile ()

返迴默認 Profile (配置文件)。

默認 Profile (配置文件) 使用 Default 存儲名稱。

另請參閱 storageName ().

void QQuickWebEngineProfile:: installUrlSchemeHandler (const QByteArray & scheme , QWebEngineUrlSchemeHandler * handler )

注冊處理程序 handler 為自定義 URL 方案 scheme 在 Profile (配置文件) 中。

它是必要的，首先注冊方案采用 QWebEngineUrlScheme::registerScheme 在應用程序啓動時。

void QQuickWebEngineProfile:: removeAllUrlSchemeHandlers ()

移除 Profile (配置文件) 中安裝的所有自定義 URL 方案處理程序。

void QQuickWebEngineProfile:: removeUrlScheme (const QByteArray & scheme )

稱除自定義 URL 方案 scheme 從 Profile (配置文件)。

另請參閱 removeUrlSchemeHandler ().

void QQuickWebEngineProfile:: removeUrlSchemeHandler ( QWebEngineUrlSchemeHandler * handler )

移除自定義 URL 方案處理程序 handler 從 Profile (配置文件)。

另請參閱 removeUrlScheme ().

void QQuickWebEngineProfile:: setUrlRequestInterceptor ( QWebEngineUrlRequestInterceptor * interceptor )

注冊請求攔截器單例 interceptor 到攔截 URL 請求。

Profile (配置文件) 不擁有指針的所有權。

另請參閱 QWebEngineUrlRequestInfo and QWebEngineUrlRequestInterceptor .

QStringList QQuickWebEngineProfile:: spellCheckLanguages () const

返迴拼寫檢查器所用的語言列錶。

注意： Getter function for property spellCheckLanguages.

該函數在 Qt 5.8 引入。

另請參閱 setSpellCheckLanguages ().

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

返迴自定義 URL 方案的處理程序寄存器，對於 URL 方案 scheme .

QQuickWebEngineProfile Class

公共類型

特性

公共函數

信號

靜態公共成員

詳細描述

成員類型文檔編製

enum QQuickWebEngineProfile:: HttpCacheType

enum QQuickWebEngineProfile:: PersistentCookiesPolicy

特性文檔編製

cachePath : QString

downloadPath : QString

httpAcceptLanguage : QString

httpCacheMaximumSize : int

httpCacheType : HttpCacheType

httpUserAgent : QString

offTheRecord : bool

persistentCookiesPolicy : PersistentCookiesPolicy

persistentStoragePath : QString

spellCheckEnabled : bool

spellCheckLanguages : QStringList

storageName : QString

userScripts : const QQmlListProperty < QQuickWebEngineScript >

成員函數文檔編製

QQuickWebEngineProfile:: QQuickWebEngineProfile ( QObject * parent = Q_NULLPTR)

[signal] void QQuickWebEngineProfile:: downloadFinished ( QQuickWebEngineDownloadItem * download )

[signal] void QQuickWebEngineProfile:: downloadRequested ( QQuickWebEngineDownloadItem * download )

[signal] void QQuickWebEngineProfile:: presentNotification ( QWebEngineNotification * notification )

void QQuickWebEngineProfile:: clearHttpCache ()

QWebEngineClientCertificateStore *QQuickWebEngineProfile:: clientCertificateStore ()

QWebEngineCookieStore *QQuickWebEngineProfile:: cookieStore () const

[static] QQuickWebEngineProfile *QQuickWebEngineProfile:: defaultProfile ()

void QQuickWebEngineProfile:: installUrlSchemeHandler (const QByteArray & scheme , QWebEngineUrlSchemeHandler * handler )

void QQuickWebEngineProfile:: removeAllUrlSchemeHandlers ()

void QQuickWebEngineProfile:: removeUrlScheme (const QByteArray & scheme )

void QQuickWebEngineProfile:: removeUrlSchemeHandler ( QWebEngineUrlSchemeHandler * handler )

void QQuickWebEngineProfile:: setUrlRequestInterceptor ( QWebEngineUrlRequestInterceptor * interceptor )

QStringList QQuickWebEngineProfile:: spellCheckLanguages () const

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

內容

`[signal]` void QQuickWebEngineProfile:: downloadFinished ( QQuickWebEngineDownloadItem * download )

`[signal]` void QQuickWebEngineProfile:: downloadRequested ( QQuickWebEngineDownloadItem * download )

`[signal]` void QQuickWebEngineProfile:: presentNotification ( QWebEngineNotification * notification )

`[static]` QQuickWebEngineProfile *QQuickWebEngineProfile:: defaultProfile ()

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