QWebEngineSettings 类

QWebEngineSettings 类提供对象以存储设置,用于 QWebEnginePage . 更多...

头: #include <QWebEngineSettings>
qmake: QT += webenginewidgets
Since: Qt 5.4

该类在 Qt 5.4 引入。

公共类型

enum FontFamily { StandardFont, FixedFont, SerifFont, SansSerifFont, CursiveFont, …, PictographFont }
enum FontSize { MinimumFontSize, MinimumLogicalFontSize, DefaultFontSize, DefaultFixedFontSize }
enum UnknownUrlSchemePolicy { DisallowUnknownUrlSchemes, AllowUnknownUrlSchemesFromUserInteraction, AllowAllUnknownUrlSchemes }
enum WebAttribute { AutoLoadImages, JavascriptEnabled, JavascriptCanOpenWindows, JavascriptCanAccessClipboard, LinksIncludedInFocusChain, …, PdfViewerEnabled }

公共函数

QString defaultTextEncoding () const
QString fontFamily (QWebEngineSettings::FontFamily which ) const
int fontSize (QWebEngineSettings::FontSize type ) const
void resetAttribute (QWebEngineSettings::WebAttribute 属性 )
void resetFontFamily (QWebEngineSettings::FontFamily which )
void resetFontSize (QWebEngineSettings::FontSize type )
void resetUnknownUrlSchemePolicy ()
void setAttribute (QWebEngineSettings::WebAttribute 属性 , bool on )
void setDefaultTextEncoding (const QString & encoding )
void setFontFamily (QWebEngineSettings::FontFamily which , const QString & family )
void setFontSize (QWebEngineSettings::FontSize type , int size )
void setUnknownUrlSchemePolicy (QWebEngineSettings::UnknownUrlSchemePolicy policy )
bool testAttribute (QWebEngineSettings::WebAttribute 属性 ) const
QWebEngineSettings::UnknownUrlSchemePolicy unknownUrlSchemePolicy () const

静态公共成员

QWebEngineSettings * defaultSettings ()

详细描述

QWebEngineSettings 允许配置浏览器特性,譬如字体大小和系列、自定义样式表的位置及一般属性 (譬如 JavaScript 支持)。单个属性的设置使用 setAttribute () 函数。 WebAttribute 枚举进一步描述各属性。

每个 QWebEnginePage 对象有它自己的 qwebengineessettings 对象 (为该页面配置设置)。若尚未为 Web 引擎页面配置设置,将在页面所属 Profile (配置文件) 设置中查找它。

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

成员类型文档编制

enum QWebEngineSettings:: FontFamily

此枚举描述由 CSS 2 定义的一般字体系列。更多信息见 CSS 标准 .

常量 描述
QWebEngineSettings::StandardFont 0
QWebEngineSettings::FixedFont 1
QWebEngineSettings::SerifFont 2
QWebEngineSettings::SansSerifFont 3
QWebEngineSettings::CursiveFont 4
QWebEngineSettings::FantasyFont 5
QWebEngineSettings::PictographFont 6 (在 Qt 5.7 添加)

enum QWebEngineSettings:: FontSize

此枚举描述字体大小, 可配置透过 QWebEngineSettings :

常量 描述
QWebEngineSettings::MinimumFontSize 0 硬最小字体大小。
QWebEngineSettings::MinimumLogicalFontSize 1 当缩小时应用的最小逻辑字体大小。
QWebEngineSettings::DefaultFontSize 2 用于常规文本的默认字体大小。
QWebEngineSettings::DefaultFixedFontSize 3 用于固定间距文本的默认字体大小。

enum QWebEngineSettings:: UnknownUrlSchemePolicy

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

常量 描述
QWebEngineSettings::DisallowUnknownUrlSchemes 1 禁止所有具有未知方案的 URL 导航请求。
QWebEngineSettings::AllowUnknownUrlSchemesFromUserInteraction 2 Allows navigation requests to URLs with unknown schemes that are issued from user-interaction (like a mouse-click), whereas other navigation requests (for example from JavaScript) are suppressed.
QWebEngineSettings::AllowAllUnknownUrlSchemes 3 Allows all navigation requests to URLs with unknown schemes.

该枚举在 Qt 5.11 引入 (或被修改)。

另请参阅 unknownUrlSchemePolicy , setUnknownUrlSchemePolicy ,和 resetUnknownUrlSchemePolicy .

enum QWebEngineSettings:: WebAttribute

此枚举类型指定网页设置:

常量 描述
QWebEngineSettings::AutoLoadImages 0 自动下载网页图像。当禁用此设置时,将从缓存加载图像。默认启用。
QWebEngineSettings::JavascriptEnabled 1 使 JavaScript 程序能够运行在 MainWorld 。默认启用。
QWebEngineSettings::JavascriptCanOpenWindows 2 允许 JavaScript 程序打开弹出窗口 (无需用户交互)。默认启用。
QWebEngineSettings::JavascriptCanAccessClipboard 3 允许 JavaScript 程序读取自和写入到剪贴板。写入到剪贴板始终允许,若用户有具体请求。见 JavascriptCanPaste 还允许从 JavaScript 粘贴剪贴板内容。默认禁用。
QWebEngineSettings::LinksIncludedInFocusChain 4 包括键盘聚焦链中的超链接。默认启用。
QWebEngineSettings::LocalStorageEnabled 5 启用支持 HTML 5 本地存储特征。默认启用。
QWebEngineSettings::LocalContentCanAccessRemoteUrls 6 Allows locally loaded documents to ignore cross-origin rules so that they can access remote resources that would normally be blocked, since remote resources are considered cross-origin for a local document. Remote access that would not be blocked by cross-origin rules is still possible when this setting is disabled (default). Note that disabling this setting does not prevent media elements in local files from accessing remote content. Disabled by default.
QWebEngineSettings::XSSAuditingEnabled 7 过时且不起作用。
QWebEngineSettings::SpatialNavigationEnabled 8 启用空间导航特征,这意味着能够通过使用左、右、上、下箭头键在网页可聚焦元素 (譬如:超链接和表单控件) 之间导航。例如,若用户按下右箭头键,试探确定是否试着朝右有可能到达的元素,及它们可能想要到达哪个元素。默认禁用。
QWebEngineSettings::LocalContentCanAccessFileUrls 9 Allows locally loaded documents to access other local URLs. Disabling this makes QtWebEngine behave more like Chrome and Firefox does by default. Enabled by default.
QWebEngineSettings::HyperlinkAuditingEnabled 10 启用支持 ping 属性为超链接。默认禁用。
QWebEngineSettings::ScrollAnimatorEnabled 11 启用动画卷动。默认禁用。
QWebEngineSettings::ErrorPageEnabled 12 启用显示 Chromium 的内置错误页面。默认启用。
QWebEngineSettings::PluginsEnabled 13 启用支持 Pepper 插件 (譬如:Flash 播放器)。默认禁用。另请参阅 Pepper 插件 API (在 Qt 5.6 添加)。
QWebEngineSettings::FullScreenSupportEnabled 14 在应用程序中启用全屏支持。默认禁用 (在 Qt 5.6 添加)。
QWebEngineSettings::ScreenCaptureEnabled 15 在应用程序中启用屏幕捕获。默认禁用 (在 Qt 5.7 添加)。
QWebEngineSettings::WebGLEnabled 16 启用支持 HTML 5 WebGL。默认启用,若可用 (在 Qt 5.7 添加)。
QWebEngineSettings::Accelerated2dCanvasEnabled 17 指定 HTML5 2D 画布是否应该是 OpenGL 帧缓冲。这使很多描绘操作变得更快,但会减慢像素访问。默认启用,若可用 (在 Qt 5.7 添加)。
QWebEngineSettings::AutoLoadIconsForPage 18 自动下载网页图标。默认启用 (在 Qt 5.7 添加)。
QWebEngineSettings::TouchIconsEnabled 19 启用支持触摸图标和预合成触摸图标。默认禁用 (在 Qt 5.7 添加)。
QWebEngineSettings::FocusOnNavigationEnabled 20 将聚焦赋予页面关联的视图,每当发生导航操作时 (加载、停止、重新加载、重新加载和绕过缓存、前进、后退、设置内容、等)。默认禁用 (在 Qt 5.8 添加)。
QWebEngineSettings::PrintElementBackgrounds 21 打开 CSS 背景的打印,当打印网页时。默认启用 (在 Qt 5.8 添加)。
QWebEngineSettings::AllowRunningInsecureContent 22 默认情况下,HTTPS 页面无法从 HTTP URL 运行 JavaScript、CSS、插件或 Web 套接字。这提供覆写以获得旧的不安全行为。默认禁用 (在 Qt 5.8 添加)。
QWebEngineSettings::AllowGeolocationOnInsecureOrigins 23 从 Qt 5.7 起,仅安全源 (譬如 HTTPS) 能够请求地理位置特征。这提供覆写以允许非安全源能再次访问地理位置。默认禁用 (在 Qt 5.9 添加)。
QWebEngineSettings::AllowWindowActivationFromJavaScript 24 允许通过使用 window.focus() JavaScript 方法激活窗口。默认禁用 (在 Qt 5.10 添加)。
QWebEngineSettings::ShowScrollBars 25 展示滚动条。默认启用 (在 Qt 5.10 添加)。
QWebEngineSettings::PlaybackRequiresUserGesture 26 禁止媒体内容回放,直到用户与页面交互。默认情况下, WebEngine 使用 Chromium 设置,作为描述在 自动播放策略变化 。这与 Chrome 在 Android 中的行为类似,而禁用它时的默认行为与桌面 Chrome 类似。要覆写默认行为,禁用此设置 (在 Qt 5.11 添加)。
QWebEngineSettings::JavascriptCanPaste 28 启用 JavaScript execCommand("paste") 。这还要求启用 JavascriptCanAccessClipboard。默认禁用 (在 Qt 5.11 添加)。
QWebEngineSettings::WebRTCPublicInterfacesOnly 27 限制 WebRTC 到仅公共 IP 地址。当禁用 WebRTC 还可以使用本地网络 IP 地址,但远程主机也可以看到您的本地网络 IP 地址。默认禁用 (在 Qt 5.11 添加)。
QWebEngineSettings::DnsPrefetchEnabled 29 指定是否 WebEngine 将试着预抓取 DNS 条目以加速浏览。默认禁用 (在 Qt 5.12 添加)。
QWebEngineSettings::PdfViewerEnabled 30 指定 PDF 文档将在内部 PDF 查看器中打开而不是下载。默认启用 (在 Qt 5.13 添加)。

成员函数文档编制

[static] QWebEngineSettings *QWebEngineSettings:: defaultSettings ()

Returns the settings for a web engine page that belongs to the default profile. All web pages not specifically created with another profile belong to the default profile.

QString QWebEngineSettings:: defaultTextEncoding () const

返回默认文本编码。

另请参阅 setDefaultTextEncoding ().

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

Returns the actual font family for the specified generic font family, which .

另请参阅 setFontFamily ().

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

返回默认字体大小对于 type (以像素为单位)。

另请参阅 setFontSize ().

void QWebEngineSettings:: resetAttribute ( QWebEngineSettings::WebAttribute 属性 )

Resets the setting of 属性 to the value specified in the profile that the page belongs to.

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

Resets the actual font family specified by which to the one specified in the profile that the page belongs to.

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

Resets the font size for type to the size specified in the profile that the page belongs to.

void QWebEngineSettings:: resetUnknownUrlSchemePolicy ()

Removes the policy for handling navigation requests to URLs with unknown schemes.

该函数在 Qt 5.11 引入。

另请参阅 unknownUrlSchemePolicy and setUnknownUrlSchemePolicy .

void QWebEngineSettings:: setAttribute ( QWebEngineSettings::WebAttribute 属性 , bool on )

启用或禁用指定 属性 特征从属值对于 on .

void QWebEngineSettings:: setDefaultTextEncoding (const QString & encoding )

指定默认文本编码系统。

encoding must be a string describing an encoding such as "utf-8" or "iso-8859-1". If left empty, a default value will be used. For a more extensive list of encoding names see QTextCodec .

另请参阅 defaultTextEncoding ().

void QWebEngineSettings:: setFontFamily ( QWebEngineSettings::FontFamily which , const QString & family )

将实际字体系列设为 family 为指定一般系列, which .

另请参阅 fontFamily ().

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

设置字体大小对于 type to size (以像素为单位)。

另请参阅 fontSize ().

void QWebEngineSettings:: setUnknownUrlSchemePolicy ( QWebEngineSettings::UnknownUrlSchemePolicy policy )

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

该函数在 Qt 5.11 引入。

另请参阅 unknownUrlSchemePolicy and resetUnknownUrlSchemePolicy .

bool QWebEngineSettings:: testAttribute ( QWebEngineSettings::WebAttribute 属性 ) const

返回 true if 属性 被启用;否则返回 false .

QWebEngineSettings::UnknownUrlSchemePolicy QWebEngineSettings:: unknownUrlSchemePolicy () const

Returns the currently selected policy for handling navigation requests to URLs with unknown schemes. Default is QWebEngineSettings::AllowUnknownUrlSchemesFromUserInteraction .

该函数在 Qt 5.11 引入。

另请参阅 setUnknownUrlSchemePolicy and resetUnknownUrlSchemePolicy .