QWebEngineProfile 类

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

Header: #include <QWebEngineProfile>
qmake: QT += webenginewidgets
Since: Qt 5.5
继承: QObject

公共类型

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

公共函数

QWebEngineProfile (QObject * parent = Q_NULLPTR)
QWebEngineProfile (const QString & storageName , QObject * parent = Q_NULLPTR)
QString cachePath () const
void clearAllVisitedLinks ()
void clearHttpCache ()
void clearVisitedLinks (const QList<QUrl> & urls )
QWebEngineCookieStore * cookieStore ()
QString httpAcceptLanguage () const
int httpCacheMaximumSize () const
QWebEngineProfile::HttpCacheType httpCacheType () const
QString httpUserAgent () const
void installUrlSchemeHandler (const QByteArray & scheme , QWebEngineUrlSchemeHandler * handler )
bool isOffTheRecord () const
bool isSpellCheckEnabled () const
QWebEngineProfile::PersistentCookiesPolicy persistentCookiesPolicy () const
QString persistentStoragePath () const
void removeAllUrlSchemeHandlers ()
void removeUrlScheme (const QByteArray & scheme )
void removeUrlSchemeHandler (QWebEngineUrlSchemeHandler * handler )
QWebEngineScriptCollection * scripts () const
void setCachePath (const QString & path )
void setHttpAcceptLanguage (const QString & httpAcceptLanguage )
void setHttpCacheMaximumSize (int maxSize )
void setHttpCacheType (QWebEngineProfile::HttpCacheType httpCacheType )
void setHttpUserAgent (const QString & userAgent )
void setPersistentCookiesPolicy (QWebEngineProfile::PersistentCookiesPolicy newPersistentCookiesPolicy )
void setPersistentStoragePath (const QString & path )
void setRequestInterceptor (QWebEngineUrlRequestInterceptor * interceptor )
void setSpellCheckEnabled (bool enable )
void setSpellCheckLanguages (const QStringList & 语言 )
QWebEngineSettings * settings () const
QStringList spellCheckLanguages () const
QString storageName () const
const QWebEngineUrlSchemeHandler * urlSchemeHandler (const QByteArray & scheme ) const
bool visitedLinksContainsUrl (const QUrl & url ) const

信号

void downloadRequested (QWebEngineDownloadItem * download )

静态公共成员

QWebEngineProfile * defaultProfile ()
const QMetaObject staticMetaObject

额外继承成员

详细描述

QWebEngineProfile class provides a web engine profile shared by multiple pages.

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.

All pages that belong to the profile share a common QWebEngineSettings instance, which can be accessed with the settings () method. Likewise, the scripts () method provides access to a common QWebEngineScriptCollection 实例。

Information about visited links is stored together with persistent cookies and other persistent data in a storage returned by storageName (). Persistent data is stored in a subdirectory set by calling setPersistentStoragePath (), and the cache is located in a subdirectory set by calling setCachePath (). The cache type can be set to in-memory or on-disk 通过调用 setHttpCacheType (). If only the storage name is set, the subdirectories are created and named automatically. If you set any of the values manually, you should do it before creating any pages that belong to the profile.

The cache can be cleared of links by calling clearVisitedLinks () 或 clearAllVisitedLinks (). PersistentCookiesPolicy describes whether session and persistent cookies are saved to and restored from memory or disk.

Profiles can be used to isolate pages from each other. A typical use case is a dedicated off-the-record profile for a 隐私浏览 mode. Using QWebEngineProfile () without defining a storage name constructs a new off-the-record profile that leaves no record on the local machine, and has no persistent data or cache. The isOffTheRecord () method can be used to check 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.

实现 QWebEngineUrlRequestInterceptor interface and registering the interceptor on a profile by setRequestInterceptor () enables intercepting, blocking, and modifying URL requests ( QWebEngineUrlRequestInfo ) before they reach the networking stack of Chromium.

QWebEngineUrlSchemeHandler can be registered for a profile by installUrlSchemeHandler () to add support for custom URL schemes. Requests for the scheme are then issued to QWebEngineUrlSchemeHandler::requestStarted () as QWebEngineUrlRequestJob 对象。

Spellchecking HTML form fields can be enabled per profile by using the setSpellCheckEnabled () method and the current languages used for spellchecking can be set by using the setSpellCheckLanguages () 方法。

成员类型文档编制

enum QWebEngineProfile:: HttpCacheType

此枚举描述 HTTP 缓存类型:

常量 描述
QWebEngineProfile::MemoryHttpCache 0 Use an in-memory cache. This is the default if off-the-record is set.
QWebEngineProfile::DiskHttpCache 1 Use a disk cache. This is the default if the profile is not off-the-record . If set on an off-the-record profile will instead set MemoryHttpCache .
QWebEngineProfile::NoCache 2 Disable both in-memory and disk caching. (Added in Qt 5.7)

enum QWebEngineProfile:: PersistentCookiesPolicy

此枚举描述 Cookie 持久性策略:

常量 描述
QWebEngineProfile::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.
QWebEngineProfile::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.
QWebEngineProfile::ForcePersistentCookies 2 Both session and persistent cookies are saved to and restored from disk.

成员函数文档编制

QWebEngineProfile:: QWebEngineProfile ( QObject * parent = Q_NULLPTR)

构造新 off-the-record 配置文件采用父级 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.

另请参阅 isOffTheRecord ().

QWebEngineProfile:: QWebEngineProfile (const QString & storageName , QObject * parent = Q_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.

另请参阅 storageName ().

QString QWebEngineProfile:: cachePath () const

返回用于缓存的路径。

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

注意: 使用 QStandardPaths::writableLocation ( QStandardPaths::CacheLocation ) 以获得 QStandardPaths::CacheLocation 路径。

另请参阅 setCachePath (), storageName (),和 QStandardPaths::writableLocation ().

从拜访链接数据库,清零所有链接。

另请参阅 clearVisitedLinks ().

void QWebEngineProfile:: clearHttpCache ()

移除 Profile 的缓存条目。

This function was introduced in Qt 5.7.

Clears the links in urls from the visited links database.

另请参阅 clearAllVisitedLinks ().

QWebEngineCookieStore *QWebEngineProfile:: cookieStore ()

返回此配置文件的 Cookie 存储。

This function was introduced in Qt 5.6.

[static] QWebEngineProfile *QWebEngineProfile:: defaultProfile ()

返回默认配置文件。

默认配置文件使用存储名称 Default。

另请参阅 storageName ().

[signal] void QWebEngineProfile:: downloadRequested ( QWebEngineDownloadItem * download )

此信号被发射每当下载已被触发。 download 自变量保持下载的状态。下载必须被明确接受采用 QWebEngineDownloadItem::accept (),否则默认情况下,它会被取消。下载项的父级是 Profile。若不接受,在信号发出后它会被立即删除。此信号不可以用于队列连接。

This function was introduced in Qt 5.5.

另请参阅 QWebEngineDownloadItem and QWebEnginePage::download ().

QString QWebEngineProfile:: httpAcceptLanguage () const

返回 Accept-Language HTTP 请求头字段的值。

This function was introduced in Qt 5.6.

另请参阅 setHttpAcceptLanguage ().

int QWebEngineProfile:: httpCacheMaximumSize () const

返回 HTTP 缓存的最大尺寸,以字节为单位。

将返回 0 若尺寸被自动控制由 QtWebEngine .

另请参阅 setHttpCacheMaximumSize () 和 httpCacheType ().

QWebEngineProfile::HttpCacheType QWebEngineProfile:: httpCacheType () const

返回所用 HTTP 缓存类型。

若配置文件为 off-the-record, MemoryHttpCache 被返回。

另请参阅 setHttpCacheType () 和 cachePath ().

QString QWebEngineProfile:: httpUserAgent () const

返回与 HTTP 一起发送,以标识浏览器的用户代理字符串。

注意: On Windows 8.1 and newer, the default user agent will always report "Windows NT 6.2" (Windows 8), unless the application does contain a manifest that declares newer Windows versions as supported.

另请参阅 setHttpUserAgent ().

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

注册处理程序 handler 为自定义 URL 方案 scheme 在配置文件中。

它是必要的,首先注册方案采用 QWebEngineUrlScheme::registerScheme 在应用程序启动时。

This function was introduced in Qt 5.6.

bool QWebEngineProfile:: isOffTheRecord () const

返回 true 若这是 off-the-record 配置文件 (离开计算机无记录)。

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

bool QWebEngineProfile:: isSpellCheckEnabled () const

返回 true 若拼写检查器被启用;否则返回 false .

This function was introduced in Qt 5.8.

另请参阅 setSpellCheckEnabled ().

QWebEngineProfile::PersistentCookiesPolicy QWebEngineProfile:: persistentCookiesPolicy () const

返回持久 Cookie 的当前策略。

若配置文件为 off-the-record, NoPersistentCookies 被返回。

另请参阅 setPersistentCookiesPolicy ().

QString QWebEngineProfile:: persistentStoragePath () const

返回用于存储浏览器和 Web 内容持久数据的路径。

持久数据包括:持久 Cookie、HTML5 本地存储、拜访链接。

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

注意: 使用 QStandardPaths::writableLocation ( QStandardPaths::DataLocation ) 以获得 QStandardPaths::DataLocation 路径。

另请参阅 setPersistentStoragePath (), storageName (),和 QStandardPaths::writableLocation ().

void QWebEngineProfile:: removeAllUrlSchemeHandlers ()

移除配置文件中安装的所有自定义 URL 方案处理程序。

This function was introduced in Qt 5.6.

void QWebEngineProfile:: removeUrlScheme (const QByteArray & scheme )

称除自定义 URL 方案 scheme 从配置文件。

This function was introduced in Qt 5.6.

另请参阅 removeUrlSchemeHandler ().

void QWebEngineProfile:: removeUrlSchemeHandler ( QWebEngineUrlSchemeHandler * handler )

移除自定义 URL 方案处理程序 handler 从配置文件。

This function was introduced in Qt 5.6.

另请参阅 removeUrlScheme ().

QWebEngineScriptCollection *QWebEngineProfile:: scripts () const

返回注入到共享此配置文件的所有页面中的脚本集合。

另请参阅 QWebEngineScriptCollection , QWebEngineScript , QWebEnginePage::scripts (),和 脚本注入 .

void QWebEngineProfile:: setCachePath (const QString & path )

覆盖用于磁盘缓存的默认路径,将其设为 path .

若设为 null 字符串,则还原默认路径。

另请参阅 cachePath ().

void QWebEngineProfile:: setHttpAcceptLanguage (const QString & httpAcceptLanguage )

把 Accept-Language HTTP 请求头字段值设为 httpAcceptLanguage .

This function was introduced in Qt 5.6.

另请参阅 httpAcceptLanguage ().

void QWebEngineProfile:: setHttpCacheMaximumSize ( int maxSize )

把 HTTP 缓存的最大尺寸设为 maxSize 字节。

把它设为 0 意味着尺寸将被自动控制由 QtWebEngine .

另请参阅 httpCacheMaximumSize () 和 setHttpCacheType ().

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

把 HTTP 缓存类型设为 httpCacheType .

另请参阅 httpCacheType () 和 setCachePath ().

void QWebEngineProfile:: setHttpUserAgent (const QString & userAgent )

覆盖默认用户代理字符串,将其设为 userAgent .

另请参阅 httpUserAgent ().

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

把持久 Cookie 策略设为 newPersistentCookiesPolicy .

另请参阅 persistentCookiesPolicy ().

void QWebEngineProfile:: setPersistentStoragePath (const QString & path )

覆盖用于存储持久 Web 引擎数据的默认路径。

path 设为 null 字符串,则还原默认路径。

另请参阅 persistentStoragePath ().

void QWebEngineProfile:: setRequestInterceptor ( QWebEngineUrlRequestInterceptor * interceptor )

Registers a request interceptor singleton interceptor to intercept URL requests.

The profile does not take ownership of the pointer.

This function was introduced in Qt 5.6.

另请参阅 QWebEngineUrlRequestInfo .

void QWebEngineProfile:: setSpellCheckEnabled ( bool enable )

启用拼写检查器,若 enable is true ,否则禁用它。

This function was introduced in Qt 5.8.

另请参阅 isSpellCheckEnabled ().

void QWebEngineProfile:: setSpellCheckLanguages (const QStringList & 语言 )

Sets the current list of 语言 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.

拼写检查器特征文档编制 如何搜索字典文件。

For more information about how to compile .bdic dictionaries, see the 拼写检查器范例 .

This function was introduced in Qt 5.8.

另请参阅 spellCheckLanguages ().

QWebEngineSettings *QWebEngineProfile:: settings () const

返回在此配置文件中,所有页面的默认设置。

QStringList QWebEngineProfile:: spellCheckLanguages () const

返回拼写检查器所用的语言列表。

This function was introduced in Qt 5.8.

另请参阅 setSpellCheckLanguages ().

QString QWebEngineProfile:: storageName () const

返回配置文件的存储名称。

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

返回自定义 URL 方案的处理程序寄存器,对于 URL 方案 scheme .

This function was introduced in Qt 5.6.

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

返回 true if url 被认为通过此配置文件拜访过链接。