PySide6.QtWebEngineCore.QWebEngineSettings

class QWebEngineSettings

QWebEngineSettings 类提供了一个对象来存储 QWebEnginePage 使用的设置。更多…

概要

方法

注意

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

详细描述

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

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

另请参阅

settings() settings()

class FontFamily

此枚举描述了由CSS 2定义的通用字体系列。更多信息请参见CSS标准。

常量

描述

QWebEngineSettings.StandardFont

QWebEngineSettings.FixedFont

QWebEngineSettings.SerifFont

QWebEngineSettings.SansSerifFont

QWebEngineSettings.CursiveFont

QWebEngineSettings.FantasyFont

QWebEngineSettings.PictographFont

(在 Qt 5.7 中添加，在 Qt 6.4 中弃用)
class WebAttribute

此枚举类型指定网页的设置：

常量

描述

QWebEngineSettings.AutoLoadImages

自动下载网页的图片。当此设置被禁用时，图片将从缓存中加载。默认情况下是启用的。

QWebEngineSettings.JavascriptEnabled

启用MainWorld中的JavaScript程序运行。默认启用。

QWebEngineSettings.JavascriptCanOpenWindows

允许JavaScript程序在没有用户交互的情况下打开弹出窗口。默认启用。

QWebEngineSettings.JavascriptCanAccessClipboard

允许JavaScript程序将经过清理的内容写入（复制）到剪贴板。清理后的写入是通过write和writeText JavaScript剪贴板API调用完成的，并且必须伴随用户操作。未经清理的写入和从剪贴板读取由JavascriptCanPaste启用。在Chromium 81版本之前，此设置启用了所有剪贴板写入。由于不受限制的剪贴板访问可能带来安全风险，建议应用程序保持此设置禁用，并响应ClipboardReadWrite功能权限请求。默认情况下禁用。

QWebEngineSettings.LinksIncludedInFocusChain

在键盘焦点链中包含超链接。默认启用。

QWebEngineSettings.LocalStorageEnabled

启用对HTML 5本地存储功能的支持。默认情况下已启用。

QWebEngineSettings.LocalContentCanAccessRemoteUrls

允许本地源文档访问通常会被阻止的远程资源。默认情况下禁用。请注意，下面的DnsPrefetchEnabled独立于此设置运行，如果启用，可能会导致本地内容访问远程资源。

QWebEngineSettings.XSSAuditingEnabled

已过时且无效。

QWebEngineSettings.SpatialNavigationEnabled

启用空间导航功能，这意味着能够通过使用左、右、上、下箭头键在网页上的可聚焦元素（如超链接和表单控件）之间导航。例如，如果用户按下右键，启发式算法会确定右侧是否有他们可能想要到达的元素以及他们可能想要的元素。默认情况下禁用。

QWebEngineSettings.LocalContentCanAccessFileUrls

允许本地加载的文档访问其他本地URL。禁用此功能会使QtWebEngine的行为更像Chrome和Firefox的默认行为。默认情况下启用。

QWebEngineSettings.HyperlinkAuditingEnabled

启用对超链接的ping属性的支持。默认情况下禁用。

QWebEngineSettings.ScrollAnimatorEnabled

启用动画滚动。默认情况下禁用。

QWebEngineSettings.ErrorPageEnabled

启用显示Chromium的内置错误页面。默认启用。

QWebEngineSettings.PluginsEnabled

启用对Pepper插件的支持，例如Flash播放器。默认情况下禁用。

QWebEngineSettings.FullScreenSupportEnabled

在应用程序中启用全屏支持。默认情况下是禁用的。（在Qt 5.6中添加）

QWebEngineSettings.ScreenCaptureEnabled

在应用程序中启用屏幕捕获。默认情况下是禁用的。（在Qt 5.7中添加）

QWebEngineSettings.WebGLEnabled

启用对HTML 5 WebGL的支持。如果可用，默认启用。（在Qt 5.7中添加）

QWebEngineSettings.Accelerated2dCanvasEnabled

指定HTML5 2D画布是否应为OpenGL帧缓冲区。这使得许多绘画操作更快，但会减慢像素访问速度。如果可用，默认启用。（在Qt 5.7中添加）

QWebEngineSettings.AutoLoadIconsForPage

自动下载网页的图标。默认启用。（在Qt 5.7中添加）

QWebEngineSettings.TouchIconsEnabled

启用对触摸图标和预合成触摸图标的支持，默认情况下禁用。（在Qt 5.7中添加）

QWebEngineSettings.FocusOnNavigationEnabled

每当发生导航操作时（加载、停止、重新加载、重新加载并绕过缓存、前进、后退、设置内容等），将焦点给予与页面关联的视图。默认情况下禁用。（在Qt 5.8中添加）

QWebEngineSettings.PrintElementBackgrounds

在打印网页时启用CSS背景的打印。默认情况下是启用的。（在Qt 5.8中添加）

QWebEngineSettings.AllowRunningInsecureContent

默认情况下，HTTPS页面无法从HTTP URL运行JavaScript、CSS、插件或Web套接字。这提供了一个覆盖选项以恢复旧的不安全行为。默认情况下禁用。（在Qt 5.8中添加）

QWebEngineSettings.AllowGeolocationOnInsecureOrigins

自 Qt 5.7 起，只有安全的来源（如 HTTPS）才能请求地理位置功能。这提供了一个覆盖选项，允许非安全的来源再次访问地理位置。默认情况下是禁用的。（在 Qt 5.9 中添加）

QWebEngineSettings.AllowWindowActivationFromJavaScript

允许通过使用 window.focus() JavaScript 方法激活窗口。默认情况下禁用。（在 Qt 5.10 中添加）

QWebEngineSettings.ShowScrollBars

显示滚动条。默认启用。（在 Qt 5.10 中添加）

QWebEngineSettings.PlaybackRequiresUserGesture

在用户与页面交互之前，禁止播放媒体内容。默认情况下，WebEngine使用Chromium设置，如自动播放策略更改中所述。这与Android上的Chrome行为类似，而禁用时的默认行为类似于桌面上的Chrome。要覆盖默认行为，请禁用此设置。（在Qt 5.11中添加）

QWebEngineSettings.JavascriptCanPaste

允许JavaScript程序从剪贴板读取（粘贴）并写入未经过清理的内容。经过清理的写入是通过write和writeText JavaScript剪贴板API调用完成的，并且必须伴随用户操作；未经过清理的写入是指不符合这些标准的任何写入。要使此设置生效，还必须启用JavascriptCanAccessClipboard。由于不受限制的剪贴板访问可能带来安全隐患，建议应用程序保持此功能禁用，并响应ClipboardReadWrite功能权限请求。默认情况下禁用。（在Qt 5.11中添加）

QWebEngineSettings.WebRTCPublicInterfacesOnly

限制WebRTC仅使用公共IP地址。当禁用时，WebRTC也可能使用本地网络IP地址，但远程主机也可以看到您的本地网络IP地址。默认情况下禁用。（在Qt 5.11中添加）

QWebEngineSettings.DnsPrefetchEnabled

指定WebEngine是否会尝试预取DNS条目以加快浏览速度。默认情况下禁用。（在Qt 5.12中添加）

QWebEngineSettings.PdfViewerEnabled

指定PDF文档将在内部PDF查看器中打开，而不是被下载。默认启用。（在Qt 5.13中添加）

QWebEngineSettings.NavigateOnDropEnabled

指定可以通过在视图上拖放URL来触发导航。默认启用。（在Qt 6.4中添加）

QWebEngineSettings.ReadingFromCanvasEnabled

指定启用从所有画布元素读取数据。此设置将影响所有HTML5画布元素，无论其来源如何，并且可以禁用以防止画布指纹识别。默认启用。（在Qt 6.6中添加）

QWebEngineSettings.ForceDarkMode

指定所有网页内容将使用暗色主题渲染。更多信息，请参见自动暗色主题。默认禁用。（在Qt 6.7中添加）
class FontSize

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

常量

描述

QWebEngineSettings.MinimumFontSize

硬性最小字体大小。

QWebEngineSettings.MinimumLogicalFontSize

缩小时的最小逻辑字体大小。

QWebEngineSettings.DefaultFontSize

常规文本的默认字体大小。

QWebEngineSettings.DefaultFixedFontSize

固定间距文本的默认字体大小。
class UnknownUrlSchemePolicy

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

常量

描述

QWebEngineSettings.DisallowUnknownUrlSchemes

禁止所有对未知URL方案的导航请求。

QWebEngineSettings.AllowUnknownUrlSchemesFromUserInteraction

允许从用户交互（如鼠标点击）发出的对未知方案的URL的导航请求，而其他导航请求（例如来自JavaScript的）则被阻止。

QWebEngineSettings.AllowAllUnknownUrlSchemes

允许所有导航请求到具有未知方案的URL。

另请参阅

unknownUrlSchemePolicy setUnknownUrlSchemePolicy resetUnknownUrlSchemePolicy

class ImageAnimationPolicy

此枚举描述了在渲染图像帧以进行动画时，应如何处理图像动画。

常量

描述

QWebEngineSettings.ImageAnimationPolicy.Allow

当图像帧被渲染时，允许图像动画。

QWebEngineSettings.ImageAnimationPolicy.AnimateOnce

当图像帧被渲染时，动画图像一次。

QWebEngineSettings.ImageAnimationPolicy.Disallow

当图像帧被渲染时，禁止图像动画。

另请参阅

imageAnimationPolicy setImageAnimationPolicy resetImageAnimationPolicy

在版本6.8中添加。

defaultTextEncoding()
Return type:

字符串

返回默认的文本编码。

fontFamily(which)
Parameters:

哪个 – FontFamily

Return type:

字符串

返回指定通用字体系列的实际字体系列，which。

fontSize(type)
Parameters:

类型 – FontSize

Return type:

整数

返回type的默认字体大小（以像素为单位）。

另请参阅

setFontSize()

imageAnimationPolicy()
Return type:

ImageAnimationPolicy

返回当前选择的处理图像动画的策略，当图像帧被渲染时。默认是Allow。

resetAttribute(attr)
Parameters:

attr – WebAttribute

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

resetFontFamily(which)
Parameters:

哪个 – FontFamily

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

resetFontSize(type)
Parameters:

类型 – FontSize

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

resetImageAnimationPolicy()

移除处理图像动画的策略。

resetUnknownUrlSchemePolicy()

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

setAttribute(attr, on)
Parameters:

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

setDefaultTextEncoding(encoding)
Parameters:

encoding – str

指定默认的文本编码系统。

encoding 的值必须是一个描述编码的字符串，例如“utf-8”或“iso-8859-1”。如果留空，将使用默认值。有关更广泛的编码名称列表，请参阅 QTextCodec。

另请参阅

defaultTextEncoding()

setFontFamily(which, family)
Parameters:
setFontSize(type, size)
Parameters:

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

另请参阅

fontSize()

setImageAnimationPolicy(policy)
Parameters:

策略 – ImageAnimationPolicy

设置当图像帧渲染到policy时处理图像动画的策略。默认是Allow。

setUnknownUrlSchemePolicy(policy)
Parameters:

policy – UnknownUrlSchemePolicy

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

testAttribute(attr)
Parameters:

attr – WebAttribute

Return type:

布尔

如果 attribute 已启用，则返回 true；否则返回 false。

unknownUrlSchemePolicy()
Return type:

UnknownUrlSchemePolicy

返回当前用于处理导航请求到未知方案URL的策略。默认是AllowUnknownUrlSchemesFromUserInteraction。