WebEngineView QML 类型

描述各种高级错误类型

描述用户可能被要求授予或拒绝访问的平台功能访问类别

另请参阅featurePermissionRequested() 和 grantFeaturePermission。

描述了可用于 findText() 函数的选项。这些选项可以是从以下列表中选择并 OR 联合的

另请参阅findText。

指示JavaScript控制台消息的严重性

该枚举描述了页面的生命周期状态。

此属性自 QtWebEngine 1.10 开始引入。

另请参阅lifecycleState、页面生命周期API和WebEngine生命周期示例。

反映页面的加载状态

描述由WebEngineView的文档内容创建的PDF文档的朝向。枚举值映射自并必须匹配QPageLayout::Orientation。

此属性自 QtWebEngine 1.3 开始引入。

另请参阅WebEngineView::printToPdf()。

此枚举类型列出由Postscript PPD标准定义的可用页面大小。

枚举值映射自并必须匹配QPageSize::PageSizeId。它们还存在于QPagedPaintDevice和QPrinter中。

定义的大小包括：

此属性自 QtWebEngine 1.3 开始引入。

另请参阅WebEngineView::printToPdf()。

描述了渲染进程结束的状态

此属性自QtWebEngine 1.2起引入。

描述可以对网页执行的操作类型

此属性自QtWebEngine 1.2起引入。

指定在按击时视图是否应获得激活焦点。默认值是true。

此属性自QtWebEngine 1.2起引入。

当前页面音频是否被静音的状态。

此属性自 QtWebEngine 1.3 开始引入。

另请参阅 recentlyAudible。

更改WebEngineView背景颜色，在文档主体之后。可以设置为"transparent"或半透明颜色，以便透视文档或匹配混合应用中的网络内容，防止加载期间出现白色闪烁。

默认值是白色。

此属性自QtWebEngine 1.2起引入。

如果存在以前的会话历史记录条目，则返回true，否则返回false。

如果存在后续会话历史记录条目，则返回true，否则返回false。

页面内容的大小。

此属性自 QtWebEngine 1.3 开始引入。

与此页面相关联的开发者工具宿主的ID。

如果启用了远程调试（见Qt WebEngine开发者工具），则可以使用ID来构建连接到开发者工具websocket的URL：ws://localhost:<debugggin-port>/devtools/page/<id>。可以使用websocket与页面进行交互，使用的是DevTools协议。

此属性是在QtWebEngine 6.6中引入的。

当前托管此视图开发工具的视图。将其设置为新的视图将导航到包含开发工具的内部URL，并将其绑定到此视图。

此属性是在 QtWebEngine 1.7 中引入的。

参见inspectedView。

当前视图的导航历史。

此属性是在 QtWebEngine 1.1 中引入的。

参见WebEngineHistory。

访问当前显示的网站图标的内部URL，也称为favicon或快捷图标。此只读URL对应于在移动浏览器应用程序中用于在设备主屏幕上表示书签页的图像。

以下示例使用 icon 属性构建一个 Image 组件

Image {
    id: appIcon
    sourceSize: Qt.size(32, 32)
    source: webView.icon != "" ? webView.icon : "fallbackFavicon.png";
    // ...
}

指定 Image::sourceSize 属性会通知 Qt WebEngine 的 favicon 提供程序所需的尺寸，并将图标调整到该尺寸。如果未指定 Image::sourceSize 属性，则提供程序提供具有最大可用分辨率的图标。

当前视图正在检查的视图，如果有。设置它将导航到包含设置视图的开发工具的内部URL。

建议在开发工具不可见时取消设置此属性；否则，检查的某些 debug 信息可能会出现在 WebEngineView 中。

此属性是在 QtWebEngine 1.7 中引入的。

参见devToolsView。

如果 web 视图处于全屏模式，则返回 true，否则返回 false。

此属性是在 QtWebEngine 1.1 中引入的。

参见fullScreenRequested() 和 fullScreenCancelled。

页面当前的周期状态。

设置器强制执行以下限制

• 必须保持可见页处于 Active 状态。
• 如果页面正在通过 devToolsView 进行检查，则两个页面都必须保持 Active 状态。
• 处于 Discarded 状态的页面只能转换到 Active 状态。这将导致页面重新加载。

这些是周期状态的唯一硬限制，但还可参阅 recommendedState 以了解建议的软限制。

此属性自 QtWebEngine 1.10 开始引入。

参见recommendedState、页面生命周期 API 和 WebEngine 生命周期示例。

已加载的页面的数据量，以 0 到 100 的整数值表示的百分比。

如果当前HTML页面正在加载，则返回 true，否则返回 false。

当前用于视图的配置文件。

此属性是在 QtWebEngine 1.1 中引入的。

另请参阅WebEngineProfile。

返回当前页面的音频状态（是否近期播放过音频）。

此属性自 QtWebEngine 1.3 开始引入。

另请参阅audioMuted 和 recentlyAudibleChanged。

页面生命周期状态的推荐限制。

将生命周期状态设置为低于推荐状态可能会导致副作用，例如停止背景音频播放或丢失HTML表单输入。但将生命周期状态设置为更高的资源状态是完全安全的。

此属性自 QtWebEngine 1.10 开始引入。

另请参阅lifecycleState、页面生命周期API和WebEngine生命周期示例。

返回当前页面主框架分配的渲染进程的进程ID（PID）。

如果没有可用的渲染进程，则返回 0。

此属性自QtWebEngine 1.11版本开始引入。

另请参阅renderProcessPidChanged。

页面内容的滚动位置。

此属性自 QtWebEngine 1.3 开始引入。

此视图使用的设置。

此属性是在 QtWebEngine 1.1 中引入的。

另请参阅WebEngineSettings。

当前显示的HTML页面的标题。这是一个只读值，反映<title>标签的内容。

touchHandleDelegate 提供一个模板，定义视图在需要触摸选择处理时实例化的视觉触摸句柄。

句柄的位置、不透明度和可见性将自动更新。代理应该是一个 QML Item 或者任何继承它的 QML 类型。

以下代码使用自定义触摸句柄代理

WebEngineView {
// ...
    touchHandleDelegate: Rectangle {
        color: "red"
    }
    // ...
}

触摸句柄也可以动态切换

 Component {
    id: circleTouchHandle
    Rectangle {
        color: "blue"
        radius: 50
    }
}
function showDefaultHandle(isDefault) {
    if (isDefault)
        webEngineView.touchHandleDelegate = circleTouchHandle
    else
        webEngineView.touchHandleDelegate = null
}

此属性自QtWebEngine 6.4版本开始引入。

当前显示的HTML页面的位置。此可写属性提供了将页面加载到网页中的主要接口。它与window.location DOM属性的功能相同。

另请参阅loadHtml。

与视图相关联的用户脚本集合。

此属性是在 QtWebEngine 1.1 中引入的。

另请参阅WebEngineScriptCollection。

该视图使用的Web通道实例。此通道在Chromium IPC上自动使用内部QtWebEngine传输机制，并在它渲染的页面的JavaScript上下文中公开为qt.webChannelTransport。此传输对象在用Qt WebChannel JavaScript API实例化QWebChannel的JavaScript对应物时使用。

此属性是在 QtWebEngine 1.1 中引入的。

该视图使用的Web通道实例安装的JavaScript世界。该世界必须是介于0和256之间的数字。

此属性自 QtWebEngine 1.3 开始引入。

视图的缩放因子。有效值在从0.25到5.0的范围内。默认因子是1.0。

此属性是在 QtWebEngine 1.1 中引入的。

当activeFocusOnPress的值改变时，会发出此信号。它指定视图在按下时是否应获得活动焦点。

此信号在QtWebEngine 1.2中引入。

另请参阅：activeFocusOnPress和setActiveFocusOnPress。

当muted的值改变时，会发出此信号。此值使用audioMuted属性指定。

此信号在QtWebEngine 1.3中引入。

另请参阅audioMuted 和 recentlyAudibleChanged。

请求认证对话框时，会发出此信号。

request可以通过使用AuthenticationDialogRequest类型的AuthenticationDialogRequest处理方法。

此信号在QtWebEngine 1.4中引入。

当Web引擎视图的背景色改变时，会发出此信号。

此信号在QtWebEngine 1.2中引入。

当加载给定请求时抛出无效的证书错误error时，会发出此信号。

可以通过使用WebEngineCertificateError类型的处理方法来处理证书错误。

此信号在QtWebEngine 1.1中引入。

当请求颜色选择对话框时，会发出此信号。

可以使用ColorDialogRequest类型的方法处理request。

此信号在QtWebEngine 1.4中引入。

在请求上下文菜单时，会发出此信号。

可以使用ContextMenuRequest类型的属性处理request。

此信号在QtWebEngine 1.4中引入。

当由securityOrigin标识的网站请求使用由feature标识的资源或设备时，会发出此信号。

此信号在QtWebEngine 1.1中引入。

另请参阅：grantFeaturePermission()。

当请求文件选择对话框时，会发出此信号。

可以使用FileDialogRequest类型的方法处理request。

此信号在QtWebEngine 1.4中引入。

在完成页面中的字符串搜索时，会发出此信号。result是字符串搜索的结果。

此信号在QtWebEngine 1.10中引入。

另请参阅：findText()和FindTextResult。

当网页通过JavaScript API请求全屏模式时，会发出此信号。

此信号在QtWebEngine 1.1中引入。

另请参阅：isFullScreen。

当文档需要改变页面位置和尺寸以便用frameGeometry时，会发出此信号。这可能通过JavaScript来实现。

虽然frameGeometry包含，但geometry不包含边框边界的尺寸。

onGeometryChangeRequested: {
    window.x = geometry.x
    window.y = geometry.y
    window.width = geometry.width
    window.height = geometry.height
}

此信号自QtWebEngine 1.7开始引入。

当JavaScript程序尝试将message打印到网络浏览器的控制台时，会发出此信号。

例如，在评估错误的情况下，源URL可以在sourceID中提供，以及lineNumber。

level表示触发消息的事件的严重性，即它是由错误触发的还是由较轻的事件触发的。

如果没有指定处理程序，视图将记录消息到js 日志分类。

另请参阅控制台日志记录。

当请求JavaScript对话框时，会发出此信号。

可以使用JavaScriptDialogRequest类型的各种方法来处理request。

此信号在QtWebEngine 1.4中引入。

在鼠标驱动的界面中，当鼠标指针穿过一个链接（对应于mouseover DOM事件）时，会发出此信号。该事件也可能在触摸界面上对于未通过preventDefault()取消的mouseover事件发生。hoveredUrl提供了链接的位置。

当开始、结束或失败页面加载时，会发出此信号。

使用onLoadingChanged处理信号时，在loadingInfo指定的WebEngineLoadingInfo上可以找到各种只读参数。

另请参阅loading，LoadStatus和ErrorDomain。

在发出导航请求request时，会发出此信号。

当向独立网络引擎视图加载页面请求发出信号时，将发出此信号。这可能是由于当前页面通过JavaScript调用 window.open 明确请求，也可能是由于用户在按住Shift、Ctrl或内置组合键的同时点击链接，导致页面在新窗口中打开。

通过在目标视图上调用 acceptAsNewWindow() 来处理此信号。如果未处理此信号，则请求将失败。

示例实现

QtObject {
    id: windowParent
    // Create the initial browsing windows and open the startup page.
    Component.onCompleted: {
        var firstWindow = windowComponent.createObject(windowParent);
        firstWindow.webView.loadHtml('<input type="button" value="Click!" onclick="window.open(&quot;http://qt.io&quot;)">');
    }

    property Component windowComponent: Window {
        // Destroy on close to release the Window's QML resources.
        // Because it was created with a parent, it won't be garbage-collected.
        onClosing: destroy()
        visible: true

        property WebEngineView webView: webView_
        WebEngineView {
            id: webView_
            anchors.fill: parent

            // Handle the signal. Dynamically create the window and
            // use its WebEngineView as the destination of our request.
            onNewWindowRequested: function(request) {
                var newWindow = windowComponent.createObject(windowParent);
                newWindow.webView.acceptAsNewWindow(request);
            }
        }
    }
}

此信号是在QtWebEngine 2.0中引入的。

另请参阅 WebEngineNewWindowRequest 和 WebEngine Quick Nano Browser。

将网页打印到PDF文件后，将发出此信号。filePath 将包含请求创建文件的路径，而 success 如果文件成功创建则将是 true，否则将是 false。

此信号是在QtWebEngine 1.5中引入的。

另请参阅 printToPdf。

当调用JavaScript window.print() 方法或用户按下PDF查看器插件中的打印按钮时，将发出此信号。通常，信号处理程序只需简单地调用 printToPdf()。

此信号是在QtWebEngine 1.8中引入的。

另请参阅 printToPdf。

当页面可听状态（由 recentlyAudible 指定）由于音频播放或停止而更改时，将发出此信号。

如果网页包含两个依次启动的视频，此信号仅在第一个视频生成声音时发出一次。两个视频都停止后，在最后生成声音时发出信号。这意味着在网页中无论音频流有多少，此信号都会在产生任何类型的声音时以及当完全无声时发出。

也可能会有虚假信号发射的情况。例如，当停止声音时，此信号首先以值为 true 发出，然后以值为 false 发出。此外，当音频开始播放时，此信号会以值为 true 两度发出。

此信号在QtWebEngine 1.3中引入。

另请参阅 recentlyAudible。

当网页通过发出 registerProtocolHandler 请求来尝试注册自定义协议时，将发出此信号。

此信号自QtWebEngine 1.7开始引入。

另请参阅RegisterProtocolHandlerRequest。

如果没有可用的渲染进程，则返回 0。当页面的底层渲染进程的 pid（进程ID）发生变化时，发出此信号。

此信号从 QtWebEngine 1.11 以来投入使用。

另请参阅renderProcessPid。

当渲染进程以非零退出状态终止时，发出此信号。terminationStatus 是进程的终止状态，exitCode 是进程终止的状态代码。

此信号在QtWebEngine 1.2中引入。

另请参阅RenderProcessTerminationStatus。

当请求 SSL 客户端证书的网站，并在系统客户端证书存储中找到一个或多个证书时，发出此信号。

处理此信号是异步的，加载将等待直到选择证书，或者 clientCertificateSelection 的最后一个副本被销毁。

如果没有处理此信号，clientCertificateSelection 将自动销毁，并继续加载而无需客户端证书。

此信号从 QtWebEngine 1.9 以来投入使用。

另请参阅WebEngineClientCertificateSelection。

当网页发送 request 以在指定位置显示工具提示时，发出此信号。

此信号在QtWebEngine 1.10中引入。

另请参阅TooltipRequest。

当在指定位置请求触摸选择菜单时，发出此信号。

可以使用 TouchSelectionMenuRequest 类的方法来处理 request。

此信号从 QtWebEngine 6.3 以来投入使用。

另请参阅TouchSelectionMenuRequest。

当由于音频播放或停止，导致页面的可听状态（由 wasRecentlyAudible 指定）发生变化时，发出此信号。

此信号在QtWebEngine 1.3中引入。

当WebAuth认证器在认证过程中需要用户交互时，会发出此信号。这些请求通过向用户显示对话框来处理。

request 包含完成WebAuth UX请求所需的信息和API。

此信号在QtWebEngine 6.7中引入。

另请参阅：QWebEngineWebAuthUxRequest

当页面请求关闭Web浏览器窗口时，会发出此信号，例如通过JavaScript window.close() 调用。

此信号在QtWebEngine 1.2中引入。

通过在此视图中打开 request 来处理 newWindowRequested 信号。

此方法在QtWebEngine 2.0中引入。

另请参阅：newWindowRequested

为指定的 WebAction action 返回一个 WebEngineAction。 WebEngineView 也会负责实现该操作，因此当触发相应的操作时，将在视图中执行。

var copyAction = webEngineView.action(WebEngineView.Copy);

另请参阅：WebEngineAction

在页面中查找指定的字符串，subString。当字符串搜索完成时，发出 findTextFinished() 信号。

要清除搜索高亮，只需传递一个空字符串。

此方法在QtWebEngine 1.1中引入。

另请参阅：findTextFinished

使用给定的 options 在页面中查找指定的字符串，subString。当字符串搜索完成时，发出 findTextFinished() 信号。

要清除搜索高亮，只需传递一个空字符串。

findText("Qt", WebEngineView.FindBackward | WebEngineView.FindCaseSensitively);

此方法在QtWebEngine 1.1中引入。

另请参阅：findTextFinished

使用给定的 options 在页面中查找指定的字符串，subString。当字符串搜索完成时，发出 findTextFinished() 信号。

要清除搜索高亮，只需传递一个空字符串。

resultCallback 必须接受一个整数参数。它将用找到的subString出现的次数来调用。

findText("Qt", WebEngineView.FindCaseSensitively, function(matchCount) {
    if (matchCount > 0)
        console.log("'Qt' tokens found:", matchCount);
});

此方法在QtWebEngine 1.1中引入。

另请参阅：findTextFinished

立即将 isFullScreen 属性设置为 false。它可以用来通知浏览器引擎当窗口系统强制应用程序退出全屏模式。

ApplicationWindow {
    onVisibilityChanged: {
        if (webEngineView.isFullScreen && visibility != Window.FullScreen)
            webEngineView.fullScreenCancelled()
    }

    WebEngineView {
        id: webEngineView
        // ...
    }
}

此方法在QtWebEngine 1.1中引入。

另请参阅：isFullScreen 和 fullScreenRequested

在浏览器会话历史记录中尽可能后退。此功能等同于window.history.back() DOM 方法。

另请参阅canGoBack。

如果 offset 为正，则在当前会话历史记录中向前进指定的偏移页面。如果偏移为负，则后退。如果偏移无效，页面不会更改。

此方法在QtWebEngine 1.1中引入。

另请参阅goBack() 和 goForward。

在可能的情况下，在浏览器会话历史记录中前进。此功能等同于window.history.forward() DOM 方法。

根据 granted 设置或清除权限，以允许由 securityOrigin 标识的网站使用 feature。

此方法在QtWebEngine 1.1中引入。

另请参阅featurePermissionRequested。

将指定的 html 作为网页的内容加载。

此方法提供了对 url 属性的更低级别替代，该属性通过 URL 引用HTML页面。

baseUrl 是可选的，用于解决文档中的相对URL，例如引用的图像或样式表。例如，如果 html 从 http://www.example.com/documents/overview.html 获取，它是基础URL，那么使用相对URL引用的图像，diagram.png，应位于 http://www.example.com/documents/diagram.png。

另请参阅url。

将 WebEngineView 的当前内容打印到PDF文档并存储在 filePath 下。文档的大小将根据 pageSizeId 的值确定，其方向将通过 orientation 确定。

此方法向打印网页到PDF发出异步请求并立即返回。要了解请求的结果，请连接到信号 pdfPrintingFinished。

如果省略 pageSizeId，它默认为 A4。如果省略 orientation，它默认为 Portrait。

此方法在 QtWebEngine 1.3 中引入。

另请参阅pdfPrintingFinished。

将WebEngineView的当前内容打印成PDF文档，并以字节数组的形式返回。文档的大小将由pageSizeId的值决定，其方向将使用orientation确定。

必须使用一个字符串参数的resultCallback。如果打印成功，该字符串将包含文档数据；否则为空字符串。

如果省略 pageSizeId，它默认为 A4。如果省略 orientation，它默认为 Portrait。

此方法在 QtWebEngine 1.3 中引入。

重新加载当前页面。此函数等同于DOM方法window.location.reload()。

另请参阅reloadAndBypassCache。

忽略任何缓存内容，重新加载当前页面。

此方法在QtWebEngine 1.1中引入。

另请参阅reload。

将当前拼写错误的单词替换为replacement。

此方法在 QtWebEngine 1.3 中引入。

在网页的内容中执行指定的script。

callback参数是可选的。如果提供了回调函数，则在脚本执行完毕后会调用它。

runJavaScript("document.title", function(result) { console.log(result); });

JavaScript只能以纯数据作为结果值返回。支持的数据类型包括所有JSON数据类型以及，例如，Date和ArrayBuffer。不支持的数据类型包括，例如，Function和Promise。

脚本将在与加载站点的其他脚本相同的world中运行。

有关注入脚本的更多信息，请参阅脚本注入。有关注入脚本的另一种方法，请参阅WebEngineView::userScripts。

将当前网页保存到磁盘。

网页以指定format保存到filePath。

这是以下操作的快捷方式

• 触发保存网页动作。
• 接受下一个下载项，并设置指定的文件路径和保存格式。

此函数对网页发出异步下载请求并立即返回。

此方法是在QtWebEngine 6.6中引入的。

另请参阅QWebEngineDownloadRequest::SavePageFormat。

如果arg为true，则将活动焦点设置为点击的Web引擎视图。通过将其设置为false，可以使用Web引擎视图创建一个不应获得焦点的UI元素。这在有混合UI的情况下可能很有用。

此方法是在QtWebEngine 1.2中引入的。

另请参阅 activeFocusOnPress、activeFocusOnPressChanged 和 WebEngineSettings::focusOnNavigationEnabled。

停止加载当前页面。

触发网络动作 action。

此方法是在QtWebEngine 1.2中引入的。

另请参阅 WebAction。