QWebEngineProfile 类

成员函数文档

[显式] QWebEngineProfile::QWebEngineProfile(QObject *parent = nullptr)

使用父级parent构造一个新的离线配置文件。

一个离线配置文件不会在本地机器上留下记录，也没有持久数据或缓存。因此，HTTP缓存只能位于内存中，Cookies只能是不可持久化的。尝试更改这些设置将没有效果。

另请参阅isOffTheRecord。

[显式] 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()。

[信号，自 6.7 版起] void QWebEngineProfile::clearHttpCacheCompleted()

当 clearHttpCache() 操作完成时，会发出此信号。

此函数是在 Qt 6.7 中引入的。

另请参阅QWebEngineProfile::clearHttpCache()。

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

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

另请参阅clearAllVisitedLinks()。

QWebEngineClientCertificateStore *QWebEngineProfile::clientCertificateStore()

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

QWebEngineCookieStore *QWebEngineProfile::cookieStore()

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

[静态] QWebEngineProfile *QWebEngineProfile::defaultProfile()

返回默认配置文件。

默认配置文件是离线状态。

另请参阅storageName()。

QString QWebEngineProfile::downloadPath() const

存储下载文件的路径。

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

[信号] void QWebEngineProfile::downloadRequested(QWebEngineDownloadRequest *download)

每当启动下载时都会发出此信号。绑定到参数 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缓存在内存中，但也强制将所有其他通常持久的数据存储在内存中。

[自6.5起] bool QWebEngineProfile::isPushServiceEnabled() const

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

此功能是在Qt 6.5中引入的。

另请参阅：setPushServiceEnabled。

bool QWebEngineProfile::isSpellCheckEnabled() const

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

另请参阅：setSpellCheckEnabled。

QWebEngineProfile::PersistentCookiesPolicy QWebEngineProfile::persistentCookiesPolicy() const

返回当前持久cookies的策略。

如果配置文件是离线模式，返回NoPersistentCookies。

另请参阅：setPersistentCookiesPolicy。

QString QWebEngineProfile::persistentStoragePath() const

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

持久数据包括持久cookies、HTML5本地存储和已访问链接。

默认情况下，此路径在QtWebengine/StorageName特定子目录下的QStandardPaths::DataLocation下方。

另请参阅：setPersistentStoragePath、storageName和QStandardPaths::writableLocation。

void QWebEngineProfile::removeAllUrlSchemeHandlers()

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

void QWebEngineProfile::removeUrlScheme(const QByteArray &scheme)

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

另请参阅：removeUrlSchemeHandler。

void QWebEngineProfile::removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler)

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

另请参阅：removeUrlScheme。

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

从数据库请求具有指定url的图标。每个配置文件都有自己的图标数据库，并且它存储在持久存储中，因此即使没有网络连接也可以访问存储的图标。图标必须先加载才能存储在数据库中。

url指定了图标的URL。如果存在多个可用的图标，则返回与desiredSizeInPixel最接近的图标。结果图标会调整到desiredSizeInPixel大小。如果desiredSizeInPixel为0，则返回最大的可用图标。

这个函数是异步的，结果通过iconAvailableCallback返回。如果在请求图标时进行调用，则回调会被调用。如果请求的图标可用，第一个参数（类型为QIcon）是结果。否则，它为null。

第二个参数存储请求图标的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最接近的图标。结果图标会调整到desiredSizeInPixel大小。如果desiredSizeInPixel为0，则返回最大的可用图标。

这个函数是异步的，结果通过iconAvailableCallback返回。如果在请求图标时进行调用，则回调会被调用。如果请求的图标可用，第一个参数（类型为QIcon）是结果。否则，它为null。

第二个参数存储请求图标的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)

将持久性Cookies的策略设置为 newPersistentCookiesPolicy。

另请参阅 persistentCookiesPolicy。

void QWebEngineProfile::setPersistentStoragePath(const QString &path)

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

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

另请参阅 persistentStoragePath。

[自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)

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

有关词典文件搜索方式的详细信息，请参阅拼写检查器功能文档。

有关编译.bdic词典的更多信息，请参阅拼写检查器示例。

另请参阅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。