QWebEngineSettings 类

QWebEngineSettings 类提供了一个对象,用于存储由 QWebEnginePage 使用的设置。 更多信息...

头文件 #include <QWebEngineSettings>
CMakefind_package(Qt6 REQUIRED COMPONENTS WebEngineCore)
target_link_libraries(mytarget PRIVATE Qt6::WebEngineCore)
qmakeQT += webenginecore

公共类型

枚举FontFamily { StandardFont, FixedFont, SerifFont, SansSerifFont, CursiveFont, …, PictographFont }
枚举FontSize { MinimumFontSize, MinimumLogicalFontSize, DefaultFontSize, DefaultFixedFontSize }
(自 Qt 5.11 开始) 枚举UnknownUrlSchemePolicy { DisallowUnknownUrlSchemes, AllowUnknownUrlSchemesFromUserInteraction, AllowAllUnknownUrlSchemes }
枚举WebAttribute { AutoLoadImages, JavascriptEnabled, JavascriptCanOpenWindows, JavascriptCanAccessClipboard, LinksIncludedInFocusChain, …, ForceDarkMode }

公共函数

QStringdefaultTextEncoding() const
QStringfontFamily(QWebEngineSettings::FontFamily which) const
intfontSize(QWebEngineSettings::FontSize type) const
voidresetAttribute(QWebEngineSettings::WebAttribute attribute)
voidresetFontFamily(QWebEngineSettings::FontFamily which)
voidresetFontSize(QWebEngineSettings::FontSize type)
(自 Qt 5.11 开始) voidresetUnknownUrlSchemePolicy()
voidsetAttribute(QWebEngineSettings::WebAttribute attribute, bool on)
voidsetDefaultTextEncoding(const QString &encoding)
voidsetFontSize(QWebEngineSettings::FontSize type, int size)
(自 Qt 5.11 开始) voidsetUnknownUrlSchemePolicy(QWebEngineSettings::UnknownUrlSchemePolicy policy)
booltestAttribute(QWebEngineSettings::WebAttribute attribute) const
(自 Qt 5.11 开始) QWebEngineSettings::UnknownUrlSchemePolicyunknownUrlSchemePolicy() const

详细描述

QWebEngineSettings 允许配置浏览器属性,例如字体大小和家族,以及通用属性,例如 JavaScript 支持。使用 setAttribute() 函数设置各个属性。《WebAttribute》枚举进一步描述了每个属性。

每个QWebEnginePage对象都有一个自己的QWebEngineSettings对象,用于配置该页面的设置。如果未为Web引擎页面配置设置,则会查找页面所属配置文件中的设置。

另请参阅QWebEnginePage::settings() 和 QWebEngineView::settings()。

成员类型文档

枚举 QWebEngineSettings::FontFamily

此枚举描述了CSS 2定义的通用字体族。有关更多信息,请参阅CSS标准

常量描述
QWebEngineSettings::StandardFont0 
QWebEngineSettings::FixedFont1 
QWebEngineSettings::SerifFont2 
QWebEngineSettings::SansSerifFont3 
QWebEngineSettings::CursiveFont4 
QWebEngineSettings::FantasyFont5 
QWebEngineSettings::PictographFont6(自Qt 5.7添加,在Qt 6.4中已弃用)

枚举 QWebEngineSettings::FontSize

此枚举描述了可以通过QWebEngineSettings配置的字体大小

常量描述
QWebEngineSettings::MinimumFontSize0硬最小字体大小。
QWebEngineSettings::MinimumLogicalFontSize1当缩放时应用的最小逻辑字体大小。
QWebEngineSettings::DefaultFontSize2常规文本的默认字体大小。
QWebEngineSettings::DefaultFixedFontSize3固定间距文本的默认字体大小。

[自Qt 5.11起]枚举 QWebEngineSettings::UnknownUrlSchemePolicy

此枚举描述如何处理对具有未知方案的URL的导航请求。

常量描述
QWebEngineSettings::DisallowUnknownUrlSchemes1不允许所有对具有未知方案的URL的导航请求。
QWebEngineSettings::AllowUnknownUrlSchemesFromUserInteraction2允许从用户交互(例如鼠标单击)发出的对具有未知方案的URL的导航请求,而其他导航请求(例如从JavaScript)被抑制。
QWebEngineSettings::AllowAllUnknownUrlSchemes3允许所有对具有未知方案的URL的导航请求。

此枚举是在Qt 5.11中引入的。

另请参阅unknownUrlSchemePolicysetUnknownUrlSchemePolicyresetUnknownUrlSchemePolicy

枚举 QWebEngineSettings::WebAttribute

此枚举类型指定网页设置

常量描述
QWebEngineSettings::AutoLoadImages0自动下载网页图像。当此设置禁用时,图像将从缓存加载。默认启用。
QWebEngineSettings::JavascriptEnabled1启用在主世界中运行JavaScript程序。默认启用。
QWebEngineSettings::JavascriptCanOpenWindows2允许JavaScript程序在无需用户交互的情况下打开弹出窗口。默认启用。
QWebEngineSettings::JavascriptCanAccessClipboard3允许JavaScript程序从剪贴板读取和写入。如果用户具体请求,则始终允许写入剪贴板。有关也允许JavaScript从剪贴板粘贴内容的说明,请参阅JavascriptCanPaste。默认禁用。
QWebEngineSettings::LinksIncludedInFocusChain4将超链接包括在键盘焦点链中。默认启用。
QWebEngineSettings::LocalStorageEnabled5启用对HTML 5本地存储功能的支持。默认启用。
QWebEngineSettings::LocalContentCanAccessRemoteUrls6允许本地源文档访问通常会被阻止的远程资源。默认情况下已禁用。注意:以下 DnsPrefetchEnabled 设置与此设置独立运行,如果启用,可能导致从本地内容进行远程访问。
QWebEngineSettings::XSSAuditingEnabled7已弃用且无效果。
QWebEngineSettings::SpatialNavigationEnabled8启用空间导航功能,这意味着可以通过使用左右、上、下箭头键在网页上导航到可聚焦元素(如超链接和表单控件)。例如,如果用户按下右键,则通过启发式算法判断用户是否试图向右到达某个元素以及他们可能想要哪个元素。默认情况下已禁用。
QWebEngineSettings::LocalContentCanAccessFileUrls9允许本地加载的文档访问其他本地URL。禁用此选项会使QtWebEngine的行为更类似于Chrome和Firefox的默认行为。默认情况下已启用。
QWebEngineSettings::HyperlinkAuditingEnabled10启用对超链接ping属性的支持。默认情况下已禁用。
QWebEngineSettings::ScrollAnimatorEnabled11启用动画滚动。默认情况下已禁用。
QWebEngineSettings::ErrorPageEnabled12启用显示Chromium的内置错误页面。默认情况下已启用。
QWebEngineSettings::PluginsEnabled13启用支持Pepper插件,如Flash播放器。默认情况下已禁用。另请参阅Pepper插件API。(自Qt 5.6起添加)
QWebEngineSettings::FullScreenSupportEnabled14在应用程序中启用全屏支持。默认情况下已禁用。(自Qt 5.6起添加)
QWebEngineSettings::ScreenCaptureEnabled15在应用程序中启用屏幕捕获。默认情况下已禁用。(自Qt 5.7起添加)
QWebEngineSettings::WebGLEnabled16启用对HTML5 WebGL的支持。如果可用,则默认情况下已启用。(自Qt 5.7起添加)
QWebEngineSettings::Accelerated2dCanvasEnabled17指定HTML5 2D画布是否应为OpenGL帧缓冲区。这可以使许多绘图操作更快,但会减慢像素访问速度。如果可用,则默认情况下已启用。(自Qt 5.7起添加)
QWebEngineSettings::AutoLoadIconsForPage18自动下载网页的图标。默认情况下已启用。(自Qt 5.7起添加)
QWebEngineSettings::TouchIconsEnabled19启用对触摸图标和预组合触摸图标的支持。默认情况下已禁用。(自Qt 5.7起添加)
QWebEngineSettings::FocusOnNavigationEnabled20每当发生导航操作(加载、停止、重新加载、绕过缓存后重新加载、前进、后退、设置内容等)时,都会将焦点给予与页面关联的视图。默认情况下已禁用。(自Qt 5.8起添加)
QWebEngineSettings::PrintElementBackgrounds21在打印网页时启用打印CSS背景。默认情况下已启用。(自Qt 5.8起添加)
QWebEngineSettings::AllowRunningInsecureContent22默认情况下,HTTPS页面不能从HTTP URL运行JavaScript、CSS、插件或web-sockets。此选项提供了一种覆盖,以获得旧版的不安全行为。默认情况下已禁用。(自Qt 5.8起添加)
QWebEngineSettings::AllowGeolocationOnInsecureOrigins23自Qt 5.7以来,只有HTTPS等安全源才能请求地理位置功能。此选项提供了一种覆盖,允许非安全源再次访问地理位置。默认情况下已禁用。(自Qt 5.9起添加)
QWebEngineSettings::AllowWindowActivationFromJavaScript24允许使用window.focus() JavaScript方法激活窗口。默认情况下已禁用。(自Qt 5.10起添加)
QWebEngineSettings::ShowScrollBars25显示滚动条。默认情况下已启用。(自Qt 5.10起添加)
QWebEngineSettings::PlaybackRequiresUserGesture26抑制媒体内容的播放,直到用户与页面交互。默认情况下,WebEngine使用Chromium设置,如自动播放策略更改中所述。这类似于Android设备上的Chrome的行为,而禁用此设置时的默认行为类似于桌面上的Chrome。要覆盖默认行为,请禁用此设置。(自Qt 5.11起添加)
QWebEngineSettings::JavascriptCanPaste28启用 JavaScript execCommand("paste")。这也需要启用 JavascriptCanAccessClipboard。默认禁用。(自 Qt 5.11 加入)
QWebEngineSettings::WebRTCPublicInterfacesOnly27将 WebRTC 限制为仅使用公网 IP 地址。当禁用时,WebRTC 也可能使用本地网络 IP 地址,但远程主机也可以看到您的本地网络 IP 地址。默认禁用。(自 Qt 5.11 加入)
QWebEngineSettings::DnsPrefetchEnabled29指定 WebEngine 是否尝试预先获取 DNS 记录以加快浏览速度。默认禁用。(自 Qt 5.12 加入)
QWebEngineSettings::PdfViewerEnabled30指定 PDF 文档将在内置 PDF 查看器中打开,而不是下载。默认启用。(自 Qt 5.13 加入)
QWebEngineSettings::NavigateOnDropEnabled31指定可以通过将 URL 拖放到视图中来触发导航。默认启用。(自 Qt 6.4 加入)
QWebEngineSettings::ReadingFromCanvasEnabled32指定启用从所有画布元素中读取。此设置将影响所有 HTML5 画布元素,无论其来源如何,并且可以禁用以防止画布指纹识别。默认启用。(自 Qt 6.6 加入)
QWebEngineSettings::ForceDarkMode33指定所有网页内容都将使用深色主题渲染。有关更多信息,请参阅 自动深色主题。默认禁用。(自 Qt 6.7 加入)

成员函数文档

QString QWebEngineSettings::defaultTextEncoding() const

返回默认文本编码。

另请参阅 setDefaultTextEncoding

QString QWebEngineSettings::fontFamily(QWebEngineSettings::FontFamily which) const

返回指定的泛型字体族 which 的实际字体族。

int QWebEngineSettings::fontSize(QWebEngineSettings::FontSize type) const

返回在像素中指定 type 的默认字体大小。

另请参阅 setFontSize

void QWebEngineSettings::resetAttribute(QWebEngineSettings::WebAttribute attribute)

attribute 的设置重置为页面所属配置文件中指定的值。

void QWebEngineSettings::resetFontFamily(QWebEngineSettings::FontFamily which)

which 指定的实际字体族重置为页面所属配置文件中指定的字体族。

void QWebEngineSettings::resetFontSize(QWebEngineSettings::FontSize type)

type 的字体大小重置为页面所属配置文件中指定的大小。

[since Qt 5.11] void QWebEngineSettings::resetUnknownUrlSchemePolicy()

移除处理未知方案的导航请求的策略。

此函数自 Qt 5.11 中引入。

另请参阅 unknownUrlSchemePolicysetUnknownUrlSchemePolicy.

void QWebEngineSettings::setAttribute(QWebEngineSettings::WebAttribute attribute, bool on)

根据on的值启用或禁用指定的attribute功能。

void QWebEngineSettings::setDefaultTextEncoding(const QString &encoding)

指定默认文本编码系统。

encoding的值必须是一个描述编码的字符串,例如"utf-8"或"iso-8859-1"。如果为空,将使用默认值。有关编码名称的更完整列表,请参阅QTextCodec

另请参阅 defaultTextEncoding

void QWebEngineSettings::setFontSize(QWebEngineSettings::FontSize type, int size)

type的字体大小设置为size像素。

另请参阅 fontSize

[since Qt 5.11] void QWebEngineSettings::setUnknownUrlSchemePolicy(QWebEngineSettings::UnknownUrlSchemePolicy policy)

将处理未知方案URL导航请求的策略设置为policy。默认为QWebEngineSettings::AllowUnknownUrlSchemesFromUserInteraction

此函数自 Qt 5.11 中引入。

另请参阅 unknownUrlSchemePolicyresetUnknownUrlSchemePolicy

bool QWebEngineSettings::testAttribute(QWebEngineSettings::WebAttribute attribute) const

如果启用attribute,则返回true;否则返回false

[since Qt 5.11] QWebEngineSettings::UnknownUrlSchemePolicy QWebEngineSettings::unknownUrlSchemePolicy() const

返回当前所选用于处理未知方案URL导航请求的策略。默认为QWebEngineSettings::AllowUnknownUrlSchemesFromUserInteraction

此函数自 Qt 5.11 中引入。

另请参阅 setUnknownUrlSchemePolicyresetUnknownUrlSchemePolicy

© 2024 The Qt Company Ltd. 本文档中的文档贡献是各自所有者的版权。本文档提供的内容是根据Free Software Foundation发布的GNU自由文档许可证版本1.3的条款进行许可的。Qt和相应的标志是The Qt Company Ltd.在芬兰及其他全球国家的商标。所有其他商标均为其各自所有者的财产。