QWebEngineProfile Class

成员函数文档

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

使用父配置文件parent 构建一个新的非记录配置文件。

非记录配置文件不会在本地机器上留下记录，也没有持久数据或缓存。因此，HTTP 缓存只能在内存中，cookie 只能是非持久的。尝试更改这些设置不会有任何效果。

另请参见 isOffTheRecord()。

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

构建一个新的配置文件，存储名称为storageName ，父配置文件为parent 。

存储名称必须是唯一的。

基于磁盘的 QWebEngineProfile 应在应用程序退出时或退出前销毁，否则缓存和持久化数据可能无法完全刷新到磁盘。

另请参阅 storageName() 。

QString QWebEngineProfile::cachePath() const

返回用于缓存的路径。

默认情况下，该路径位于 QtWebengine/StorageName 特定子目录中 StandardPaths::CacheLocation 的下方。

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

void QWebEngineProfile::clearAllVisitedLinks()

清除已访问链接数据库中的所有链接。

另请参阅 clearVisitedLinks().

void QWebEngineProfile::clearHttpCache()

删除配置文件的缓存项。

另请参阅 QWebEngineProfile::clearHttpCacheCompleted().

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

clearHttpCache() 操作完成时发出该信号。

该函数在 Qt 6.7 中引入。

另请参阅 QWebEngineProfile::clearHttpCache()。

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

从已访问链接数据库中清除urls 中的链接。

另请参阅 clearAllVisitedLinks().

QWebEngineClientCertificateStore *QWebEngineProfile::clientCertificateStore()

返回配置文件的客户证书存储。

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

返回与此浏览上下文相关的客户端提示设置。

此函数在 Qt 6.8 中引入。

另请参阅 QWebEngineClientHints 。

QWebEngineCookieStore *QWebEngineProfile::cookieStore()

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

[static] QWebEngineProfile *QWebEngineProfile::defaultProfile()

返回默认配置文件。

默认配置文件为非记录配置文件。

另请参阅 storageName()。

QString QWebEngineProfile::downloadPath() const

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

另请参阅 setDownloadPath() 和QStandardPaths::writableLocation()。

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

每当下载被触发时，就会发出该信号。download 参数包含下载的状态。下载必须通过QWebEngineDownloadRequest::accept() 明确接受，否则将默认取消。下载项目的父级是配置文件。如果下载未被接受，它将在信号发出后立即被删除。该信号不能与队列连接一起使用。

另请参阅 QWebEngineDownloadRequest 和QWebEnginePage::download()。

QString QWebEngineProfile::httpAcceptLanguage() const

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

另请参阅 setHttpAcceptLanguage()。

int QWebEngineProfile::httpCacheMaximumSize() const

以字节为单位返回 HTTP 缓存的最大大小。

如果大小由QtWebEngine 自动控制，则返回0 。

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

QWebEngineProfile::HttpCacheType QWebEngineProfile::httpCacheType() const

返回所使用的 HTTP 缓存类型。

如果配置文件为非记录型，则返回MemoryHttpCache 。

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

QString QWebEngineProfile::httpUserAgent() const

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

另请参阅 setHttpUserAgent() 和Windows 应用程序清单。

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

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

必须在应用程序启动时首先在QWebEngineUrlScheme::registerScheme 注册该方案。

bool QWebEngineProfile::isOffTheRecord() const

如果这是一个不留记录的配置文件，则返回true 。

这将强制 cookie 和 HTTP 缓存存储在内存中，但也会强制所有其他正常的持久性数据存储在内存中。

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

如果推送消息服务已启用，则返回true 。

此函数在 Qt 6.5 中引入。

另请参阅 setPushServiceEnabled()。

bool QWebEngineProfile::isSpellCheckEnabled() const

如果拼写检查器已启用，则返回true ；否则返回false 。

另请参阅 setSpellCheckEnabled() 。

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

返回QList QWebEnginePermission 对象，每个对象代表权限存储中当前存在的一个权限。返回的列表包含此配置文件以前授予/拒绝的所有权限，前提是这些权限属于持久类型。

此函数在 Qt 6.8 中引入。

另请参阅 queryPermission(),QWebEnginePermission::PermissionType, 和QWebEnginePermission::isPersistent().

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

返回QList 的QWebEnginePermission 对象，每个对象代表权限存储中当前存在的一个权限。返回的列表包含与该配置文件的特定securityOrigin 相关联的所有先前授予/拒绝的权限，前提是这些权限属于持久类型。

此函数在 Qt 6.8 中引入。

另请参阅 queryPermission()、QWebEnginePermission::PermissionType 和QWebEnginePermission::isPersistent()。

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

返回QList 的QWebEnginePermission 对象，每个对象代表当前权限存储中的一个权限。返回的列表包含所提供permissionType 的所有先前授予/拒绝的权限。如果权限类型是非持久的，则列表为空。

此函数在 Qt 6.8 中引入。

另请参阅 queryPermission(),QWebEnginePermission::PermissionType, 和QWebEnginePermission::isPersistent().

QWebEngineProfile::PersistentCookiesPolicy QWebEngineProfile::persistentCookiesPolicy() const

返回持久性 cookie 的当前策略。

如果配置文件是非记录的，则返回NoPersistentCookies 。

另请参阅 setPersistentCookiesPolicy().

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

返回持久权限的当前策略。

非记录配置文件不允许将数据保存到磁盘，因此只能返回StoreInMemory 或AskEveryTime 。

此函数在 Qt 6.8 中引入。

另请参阅 QWebEngineProfile::PersistentPermissionsPolicy 和setPersistentPermissionsPolicy()。

QString QWebEngineProfile::persistentStoragePath() const

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

持久数据包括持久 Cookie、HTML5 本地存储和访问过的链接。

默认情况下，该路径位于 QtWebengine/StorageName 特定子目录中的 QStandardPaths::DataLocation 下方。

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

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

返回与所提供的securityOrigin 和permissionType 的单个权限相对应的QWebEnginePermission 对象。该对象可用于查询权限的当前状态或更改权限。该对象可用于查询权限的当前状态，也可用于更改权限。不要求权限已经存在；如果已知某个网站使用该权限，返回的对象也可用于预先授予该权限。

您可以用它来预先授予非持久类型的权限。这样做将使该权限保持已授予（或已拒绝）状态，直到下一次具有相关起源的网站提出请求。此时，该权限的有效期将与该特定网页的有效期绑定，导航离开将使该权限失效。

此函数在 Qt 6.8 中引入。

另请参阅 listAllPermissions(),listPermissionsForOrigin(),listPermissionsForPermissionType() 和QWebEnginePermission::PermissionType 。

void QWebEngineProfile::removeAllUrlSchemeHandlers()

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

void QWebEngineProfile::removeUrlScheme(const QByteArray &scheme)

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

另请参阅 removeUrlSchemeHandler().

void QWebEngineProfile::removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler)

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

另请参阅 removeUrlScheme().

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

从数据库中获取指定url 的图标。每个配置文件都有自己的图标数据库，并存储在持久存储器中，因此无需网络连接也可访问存储的图标。图标必须事先加载过才能存储在数据库中。

url 指定图标的 URL。如果有多个可用图标，将返回尺寸最接近 的图标。如果 desiredSizeInPixel 为 0，将返回最大的可用图标。desiredSizeInPixel desiredSizeInPixel

此函数为异步函数，结果由iconAvailableCallback 返回。如果执行了图标请求，则会调用回调。如果请求的图标可用，第一个参数（类型为QIcon ）就是结果。否则为空。

第二个参数存储所请求图标的 URL。如果无法获取图标，则为空。

此函数在 Qt 6.2 中引入。

另请参阅 requestIconForPageURL()。

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

从数据库中为以前加载过的页面申请图标。每个配置文件都有自己的图标数据库，并存储在持久存储器中，因此无需网络连接也可访问存储的图标。图标必须是以前加载过的，才能存储在数据库中。

url 指定需要图标的页面的 URL。如果有多个可用图标，将返回大小最接近 的图标。如果 desiredSizeInPixel 为 0，将返回最大的可用图标。desiredSizeInPixel desiredSizeInPixel

此函数为异步函数，结果由iconAvailableCallback 返回。如果执行了图标请求，则会调用回调。如果请求的图标可用，第一个参数（类型为QIcon ）就是结果。否则为空。

第二个参数存储所请求图标的 URL。如果无法获取图标，则为空。

第三个参数存储分配图标的页面的 URL。

此函数在 Qt 6.2 中引入。

另请参阅 requestIconForIconURL()。

QWebEngineScriptCollection *QWebEngineProfile::scripts() const

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

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

void QWebEngineProfile::setCachePath(const QString &path)

覆盖磁盘缓存使用的默认路径，将其设置为path 。

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

另请参见 cachePath().

void QWebEngineProfile::setDownloadPath(const QString &path)

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

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

另请参阅 downloadPath().

void QWebEngineProfile::setHttpAcceptLanguage(const QString &httpAcceptLanguage)

将 Accept-Language HTTP 请求头字段的值设置为httpAcceptLanguage 。

另请参阅 httpAcceptLanguage().

void QWebEngineProfile::setHttpCacheMaximumSize(int maxSize)

将 HTTP 缓存的最大大小设置为maxSize 字节。

将其设置为0 意味着大小将由QtWebEngine 自动控制。

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

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

将 HTTP 缓存类型设置为httpCacheType 。

另请参阅 httpCacheType()、setCachePath() 和clearHttpCache()。

void QWebEngineProfile::setHttpUserAgent(const QString &userAgent)

覆盖默认的用户代理字符串，将其设置为userAgent 。

另请参阅 httpUserAgent() 。

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

设置负责显示已发送通知的函数notificationPresenter 。

另请参阅 QWebEngineNotification 。

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

将持久性 cookie 的政策设置为newPersistentCookiesPolicy 。

另请参阅 persistentCookiesPolicy().

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

将持久权限策略设置为newPersistentPermissionsPolicy 。

此函数在 Qt 6.8 中引入。

另请参阅 QWebEngineProfile::PersistentPermissionsPolicy 和persistentPermissionsPolicy()。

void QWebEngineProfile::setPersistentStoragePath(const QString &path)

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

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

另请参见 persistentStoragePath()。

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

如果enable 是true ，则启用推送消息服务，否则禁用。

此函数在 Qt 6.5 中引入。

另请参阅 isPushServiceEnabled()。

void QWebEngineProfile::setSpellCheckEnabled(bool enable)

如果enable 是true ，则启用拼写检查程序，否则禁用。

另请参阅 isSpellCheckEnabled().

void QWebEngineProfile::setSpellCheckLanguages(const QStringList &languages)

设置拼写检查程序当前的languages 列表。每种语言都应与.bdic 字典的名称相匹配。例如，语言en-US 将加载en-US.bdic 字典文件。

有关如何搜索词典文件，请参阅拼写检查程序功能文档。

有关如何编译.bdic 词典的详细信息，请参阅Spellchecker 示例。

另请参阅 spellCheckLanguages()。

void QWebEngineProfile::setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)

注册请求拦截器单例interceptor ，以拦截 URL 请求。

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

另请参阅 QWebEngineUrlRequestInfo 和QWebEngineUrlRequestInterceptor 。

QWebEngineSettings *QWebEngineProfile::settings() const

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

QStringList QWebEngineProfile::spellCheckLanguages() const

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

另请参阅 setSpellCheckLanguages()。

QString QWebEngineProfile::storageName() const

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

存储名称用于为使用磁盘的每个配置文件提供单独的子目录，用于持久数据和缓存。

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

返回 URL 方案scheme 的自定义 URL 方案处理程序注册信息。

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

如果url 被此配置文件视为已访问链接，则返回true 。