class QQuickWebEngineProfile#

该 QQuickWebEngineProfile 类提供了由多个页面共享的网页引擎配置文件。更多...

Inheritance diagram of PySide6.QtWebEngineQuick.QQuickWebEngineProfile

摘要#

属性#

方法#

信号#

静态函数#

注意

本文档可能包含自动从C++转换为Python的片段。我们始终欢迎对片段翻译的贡献。如果您发现翻译中的问题，您也可以通过在https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们

详细描述#

Web引擎配置包含设置、脚本、持久cookie策略以及属于配置的所有Web引擎页面共享的已访问链接列表。

关于已访问链接的信息与持久cookie和其他持久性数据一起存储在由storageName属性确定的存储中。持久性数据存储在由persistentStoragePath属性确定的子目录和由cachePath属性确定的子目录中的缓存中。`httpCacheType`属性描述了缓存类型：`内存`或`磁盘`。如果只设置了`storageName`属性，则其他值将根据它自动生成。如果您手动指定任何值，您应该在创建属于配置的任何页面之前完成此操作。

配置可以用来隔离页面。一个典型用例是为`隐私浏览模式`创建一个专门的`离线配置文件`。离线配置文件强制cookie、HTTP缓存和其他通常的持久数据仅存储在内存中。《a class="xref py py-attr docutils literal notranslate">offTheRecord`属性包含配置是否为离线

默认配置文件可以通过 defaultProfile() 访问。它是一个内置的配置文件，所有未特定创建另一个配置文件的网页都属于该配置文件。

可以通过 WebEngineProfile 实例，通过 QQuickWebEngineProfile 类从 C++ 中创建和访问，这进一步在 C++ 中暴露了更多功能。这允许 Qt Quick 应用程序拦截 URL 请求（QQuickWebEngineProfile::setRequestInterceptor），或注册自定义 URL 方案（installUrlSchemeHandler）。

可以使用 spellCheckEnabled 属性按配置文件启用拼写检查，并可以通过使用 spellCheckLanguages 属性设置当前用于拼写检查的语言。

class HttpCacheType#

此枚举描述了 HTTP 缓存类型

常量

描述

QQuickWebEngineProfile.MemoryHttpCache

使用内存缓存。如果设置了 off-the-record，则是默认值。

QQuickWebEngineProfile.DiskHttpCache

使用磁盘缓存。如果没有设置 off-the-record，则是默认值。如果设置了 off-the-record，则回退到 MemoryHttpCache。

QQuickWebEngineProfile.NoCache

禁用内存和磁盘缓存。（从 Qt 5.7 开始添加）
class PersistentCookiesPolicy#

此枚举描述了 cookie 持久性策略

常量

描述

QQuickWebEngineProfile.NoPersistentCookies

会话和持久 cookie 都存储在内存中。如果设置了 off-the-record 或没有可用的持久数据路径，这是唯一可能的设置。

QQuickWebEngineProfile.AllowPersistentCookies

标记为持久的 cookie 将保存到磁盘并从磁盘恢复，而会话 cookie 仅在崩溃恢复时保存在磁盘上。这是默认设置。

QQuickWebEngineProfile.ForcePersistentCookies

会话和持久 cookie 都保存到并从磁盘恢复。

注意

当使用 from __feature__ import true_property 时可以直接使用属性，否则通过访问器函数。

property cachePathᅟ: str#

存储配置文件缓存的路径，特别是 HTTP 缓存。

默认情况下，缓存存储在 QStandardPaths::writableLocation(QStandardPaths::CacheLocation) 下方，目录名称使用 storageName 提供的名字。

访问函数
属性 downloadPath: str#

下载文件存储位置的路径。

覆盖默认的下载位置路径，将其设置为 path。

如果设置为空字符串，则默认路径将被恢复。

注意

默认情况下，下载路径为 QStandardPaths::DownloadLocation。

访问函数
属性 httpAcceptLanguage: str#

Accept-Language HTTP请求头的值。

访问函数
属性 httpCacheMaximumSize: int#

HTTP缓存的最大大小。如果设置为 0，则大小将由 QtWebEngine 自动控制。默认值是 0。

另请参阅

httpCacheType

访问函数
属性 httpCacheType: QQuickWebEngineProfile.HttpCacheType#

这个枚举描述了HTTP缓存的类型。

如果配置文件是脱机配置或未设置 storageName，则返回 MemoryHttpCache。

访问函数
属性 httpUserAgent: str#

随HTTP请求发送的用户代理字符串，以识别浏览器。

访问函数
属性 isPushServiceEnabledᅟ: bool#

是否启用了推送消息服务。

注意

默认情况下，推送消息服务是禁用的。

注意

Qt WebEngine 使用 Firebase Cloud Messaging (FCM) 作为浏览器推送服务。因此，所有推送消息将通过谷歌推送服务及其相应服务器。

访问函数
属性 offTheRecordᅟ: bool#

Web 引擎配置是否为“离线模式”。离线模式配置将使cookie、HTTP缓存和其他通常持久化的数据仅存储在内存中。配置默认为离线模式。

访问函数
属性 persistentCookiesPolicyᅟ: QQuickWebEngineProfile.PersistentCookiesPolicy#

此枚举描述了cookie持久性的策略。如果配置为离线模式，则返回 NoPersistentCookies。

访问函数
属性 persistentStoragePathᅟ: str#

浏览器和网络内容持久数据的存储位置路径。持久数据包括持久cookie、HTML5本地存储和已访问链接。

默认情况下，存储位于 storageName 的目录中，位置在 QStandardPaths::writableLocation(QStandardPaths::AppDataLocation) 以下。

访问函数
属性 spellCheckEnabledᅟ: bool#

此属性表示是否启用了网页引擎的拼写检查器。

访问函数
属性spellCheckLanguages: 字符串列表#

此属性表示拼写检查器使用的语言。

访问函数
属性storageName: 字符串#

用于为每个在磁盘上存储持久数据和缓存的配置文件创建单独子目录的存储名称。

访问函数
__init__([parent=None])#
参数:

parent – QObject

创建一个新的配置文件，并设置为其父对象 parent。

cachePath()#
返回类型:

str

另请参阅

setCachePath()

是属性 cachePathᅟ 的获取器。

cachePathChanged()#

属性 cachePathᅟ 的通知信号。

clearHttpCache()#

删除配置文件的缓存条目。

注意

确保在进行清除操作时不要开始新的导航或对配置文件的任何操作。 clearHttpCacheCompleted() 信号会通知完成。

另请参阅

clearHttpCache() clearHttpCacheCompleted()

clearHttpCacheCompleted()#

此信号在执行clearHttpCache()操作完成后发出。

另请参阅

clearHttpCache()

cookieStore()#
返回类型:

QWebEngineCookieStore

返回此配置文件的网络浏览器的cookie存储。

静态 defaultProfile()#
返回类型:

QQuickWebEngineProfile

返回默认配置文件。

默认配置文件为无痕模式。

另请参阅

storageName()

downloadPath()#
返回类型:

str

另请参阅

setDownloadPath()

获取属性downloadPath的值。

downloadPathChanged()#

属性downloadPath的变更通知信号。

httpAcceptLanguage()#
返回类型:

str

另请参阅

setHttpAcceptLanguage()

获取属性httpAcceptLanguage的值。

httpAcceptLanguageChanged()#

属性httpAcceptLanguage变更的通知信号。

httpCacheMaximumSize()#
返回类型:

int

另请参阅

setHttpCacheMaximumSize()

获取属性httpCacheMaximumSize的值。

httpCacheMaximumSizeChanged()#

属性httpCacheMaximumSize变更的通知信号。

httpCacheType()#
返回类型:

HttpCacheType

另请参阅

setHttpCacheType()

属性 httpCacheType 的获取器。

httpCacheTypeChanged()#

属性 httpCacheType 的通知信号。

httpUserAgent()#
返回类型:

str

另请参阅

setHttpUserAgent()

属性 httpUserAgent 的获取器。

httpUserAgentChanged()#

属性 httpUserAgent 的通知信号。

installUrlSchemeHandler(scheme, arg__2)#
参数:

在配置文件中注册用于自定义 URL 方案的处理器 handler。

必须在应用启动时使用 registerScheme 首先注册方案。

isOffTheRecord()#
返回类型:

bool

属性 offTheRecord 的获取器。

isPushServiceEnabled()#
返回类型:

bool

属性 isPushServiceEnabled 的获取器。

isSpellCheckEnabled()#
返回类型:

bool

属性 spellCheckEnabled 的获取器。

offTheRecordChanged()#

属性 offTheRecord 的通知信号。

persistentCookiesPolicy()#
返回类型:

持久Cookie策略获取器。

另请参阅

setPersistentCookiesPolicy()

属性persistentCookiesPolicy的获取器。

persistentCookiesPolicyChanged()#

属性persistentCookiesPolicy变更的信号。

persistentStoragePath()#
返回类型:

str

另请参阅

setPersistentStoragePath()

属性persistentStoragePath的获取器。

persistentStoragePathChanged()#

属性persistentStoragePath变更的信号。

presentNotification(notification)#
参数:

notification – QWebEngineNotification

每当创建一个新的用户通知时，都会发出此信号。《code class="docutils literal notranslate">notification参数包含要查询数据和与之交互的QWebEngineNotification实例。

另请参阅

presentNotification

pushServiceEnabledChanged()#

属性isPushServiceEnabled变更的信号。

removeAllUrlSchemeHandlers()#

从该配置文件中移除所有已安装的自定义URL方案处理器。

removeUrlScheme(scheme)#
参数:

scheme – QByteArray

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

removeUrlSchemeHandler(arg__1)#
参数:

arg__1 – QWebEngineUrlSchemeHandler

从配置中移除自定义URL方案处理器 handler。

另请参阅

removeUrlScheme()

setCachePath(path)#
参数:

path – 字符串

另请参阅

cachePath()

属性 cachePath 的设置器。

setDownloadPath(path)#
参数:

path – 字符串

另请参阅

downloadPath()

属性 downloadPath 的设置器。

setHttpAcceptLanguage(httpAcceptLanguage)#
参数:

httpAcceptLanguage – 字符串

另请参阅

httpAcceptLanguage()

属性 httpAcceptLanguage 的设置器。

setHttpCacheMaximumSize(maxSize)#
参数:

maxSize – 整数

另请参阅

httpCacheMaximumSize()

属性 httpCacheMaximumSize 的设置器。

setHttpCacheType(arg__1)#
参数:

arg__1 – HttpCacheType

另请参阅

httpCacheType()

属性 httpCacheType 的设置器。

setHttpUserAgent(userAgent)#
参数:

userAgent – 字符串

另请参阅

httpUserAgent()

属性 httpUserAgent 的设置器。

setOffTheRecord(offTheRecord)#
参数:

offTheRecord – 布尔值

另请参阅

isOffTheRecord()

属性 offTheRecord 的设置器。

setPersistentCookiesPolicy(arg__1)#
参数:

arg__1 – PersistentCookiesPolicy

另请参阅

persistentCookiesPolicy()

设置属性 persistentCookiesPolicy 的值。

setPersistentStoragePath(path)#
参数:

path – 字符串

另请参阅

persistentStoragePath()

设置属性 persistentStoragePath 的值。

setPushServiceEnabled(enable)#
参数:

enable – bool

另请参阅

isPushServiceEnabled()

设置属性 isPushServiceEnabled 的值。

setSpellCheckEnabled(enabled)#
参数:

enabled – bool

另请参阅

isSpellCheckEnabled()

设置属性 spellCheckEnabled 的值。

setSpellCheckLanguages(languages)#
参数:

languages – 字符串列表

另请参阅

spellCheckLanguages()

设置属性 spellCheckLanguages 的值。

setStorageName(name)#
参数:

name – str

另请参阅

storageName()

设置属性 storageName 的值。

setUrlRequestInterceptor(interceptor)#
参数:

interceptor – QWebEngineUrlRequestInterceptor

注册一个请求拦截器单例 interceptor 用于拦截URL请求。

配置文件不拥有该指针的所有权。

spellCheckEnabledChanged()#

属性 spellCheckEnabled 的通知信号。

spellCheckLanguages()#
返回类型:

字符串列表

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

属性 spellCheckLanguages 的获取器。

spellCheckLanguagesChanged()#

属性 spellCheckLanguages 的通知信号。

storageName()#
返回类型:

str

另请参阅

setStorageName()

属性 storageName 的获取器。

storageNameChanged()#

属性 storageName 的通知信号。

urlSchemeHandler(arg__1)#
参数:

arg__1 – QByteArray

返回类型:

QWebEngineUrlSchemeHandler

返回为 URL 方案 scheme 注册的自定义 URL 方案处理器。