WebEngineView QML Type

Describes various high-level error types:

Describes the platform feature access categories that the user may be asked to grant or deny access to:

See also featurePermissionRequested() and grantFeaturePermission().

Describes the options available to the findText() function. The options can be OR-ed together from the following list:

See also findText().

Indicates the severity of a JavaScript console message:

This enum describes the lifecycle state of the page:

This property was introduced in QtWebEngine 1.10.

See also lifecycleState, Page Lifecycle API, and WebEngine Lifecycle Example.

Reflects a page's load status:

Describes the orientation of a PDF document that gets created from the WebEngineView's contents. The enumeration values are mapped from and must match QPageLayout::Orientation.

This property was introduced in QtWebEngine 1.3.

See also WebEngineView::printToPdf().

This enum type lists the available page sizes as defined in the Postscript PPD standard.

The enumeration values are mapped from and must match QPageSize::PageSizeId. They are also duplicated in QPagedPaintDevice and QPrinter.

The defined sizes are:

This property was introduced in QtWebEngine 1.3.

See also WebEngineView::printToPdf().

Describes the status with which the render process terminated:

This property was introduced in QtWebEngine 1.2.

Describes the types of action that can be performed on a web page:

This property was introduced in QtWebEngine 1.2.

Specifies whether the view should gain active focus when pressed. The default value is true.

This property was introduced in QtWebEngine 1.2.

The state of whether the current page audio is muted.

This property was introduced in QtWebEngine 1.3.

See also recentlyAudible.

Changes the color of the WebEngineView's background, behind the document's body. Can be set to "transparent" or to a translucent color to see through the document or to match the web content in a hybrid app to prevent the white flashes that may appear during loading.

The default value is white.

This property was introduced in QtWebEngine 1.2.

Returns true if there are prior session history entries, false otherwise.

Returns true if there are subsequent session history entries, false otherwise.

Size of the page contents.

This property was introduced in QtWebEngine 1.3.

The id of the developer tools host associated with this page.

If remote debugging is enabled (see Qt WebEngine Developer Tools), the id can be used to build the URL to connect to the developer tool websocket: ws://localhost:<debugggin-port>/devtools/page/<id>). The websocket can be used to to interact with the page using the DevTools Protocol.

This property was introduced in QtWebEngine 6.6.

The view currently hosting the developer tools for this view. Setting it to a new view will navigate that view to an internal URL with the developer tools, and bind it to this view.

This property was introduced in QtWebEngine 1.7.

See also inspectedView.

The navigation history of the current view.

This property was introduced in QtWebEngine 1.1.

See also WebEngineHistory.

An internal URL for accessing the currently displayed web site icon, also known as favicon or shortcut icon. This read-only URL corresponds to the image used within a mobile browser application to represent a bookmarked page on the device's home screen.

The following snippet uses the icon property to build an Image component:

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

Specifying the Image::sourceSize property informs the Qt WebEngine's favicon provider about the requested size and resizes the icon to it. If Image::sourceSize property is not specified, the provider provides the icon with the largest available resolution.

The view this view is currently inspecting, if any. Setting it will navigate to an internal URL with the developer tools of the view set.

It is recommended to unset this property when developer tools are not visible; otherwise some debug information may appear in the inspected WebEngineView.

This property was introduced in QtWebEngine 1.7.

See also devToolsView.

Returns true if the web view is in fullscreen mode, false otherwise.

This property was introduced in QtWebEngine 1.1.

See also fullScreenRequested() and fullScreenCancelled().

The current lifecycle state of the page.

The following restrictions are enforced by the setter:

• A visible page must remain in the Active state.
• If the page is being inspected by a devToolsView then both pages must remain in the Active states.
• A page in the Discarded state can only transition to the Active state. This will cause a reload of the page.

These are the only hard limits on the lifecycle state, but see also recommendedState for the recommended soft limits.

This property was introduced in QtWebEngine 1.10.

See also recommendedState, Page Lifecycle API, and WebEngine Lifecycle Example.

The amount of data from the page that has been loaded, expressed as an integer percentage in the range from 0 to 100.

Returns true if the HTML page is currently loading, false otherwise.

The current profile used for the view.

This property was introduced in QtWebEngine 1.1.

See also WebEngineProfile.

Returns the current page's audible state (audio was recently played, or not).

This property was introduced in QtWebEngine 1.3.

See also audioMuted and recentlyAudibleChanged.

The recommended limit for the lifecycle state of the page.

Setting the lifecycle state to a lower resource usage state than the recommended state may cause side-effects such as stopping background audio playback or loss of HTML form input. Setting the lifecycle state to a higher resource state is however completely safe.

This property was introduced in QtWebEngine 1.10.

See also lifecycleState, Page Lifecycle API, and WebEngine Lifecycle Example.

Returns the process ID (PID) of the render process assigned to the current page's main frame.

If no render process is available yet, 0 is returned.

This property was introduced in QtWebEngine 1.11.

See also renderProcessPidChanged.

Scroll position of the page contents.

This property was introduced in QtWebEngine 1.3.

Settings used by this view.

This property was introduced in QtWebEngine 1.1.

See also WebEngineSettings.

The title of the currently displayed HTML page. This is a read-only value that reflects the contents of the <title> tag.

The touchHandleDelegate provides a template defining visual touch handles instantiated by the view whenever touch selection handling is required.

The handle's position, opacity, and visibility are updated automatically. The delegate should be a QML Item or any QML type which inherits it.

The following code uses a custom touch handle delegate:

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

The touch handles can be also switched dynamically:

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

This property was introduced in QtWebEngine 6.4.

The location of the currently displayed HTML page. This writable property offers the main interface to load a page into a web view. It functions the same as the window.location DOM property.

See also loadHtml().

The user scripts' collection associated with the view.

This property was introduced in QtWebEngine 1.1.

See also WebEngineScriptCollection.

The web channel instance used by this view. This channel is automatically using the internal QtWebEngine transport mechanism over Chromium IPC, and exposed in the javascript context of the page it is rendering as qt.webChannelTransport. This transport object is used when instantiating the JavaScript counterpart of QWebChannel using the Qt WebChannel JavaScript API.

This property was introduced in QtWebEngine 1.1.

JavaScript world that the web channel instance used by this view is installed in. The world must be a number between 0 and 256.

This property was introduced in QtWebEngine 1.3.

Zoom factor for the view. Valid values are within the range from 0.25 to 5.0. The default factor is 1.0.

This property was introduced in QtWebEngine 1.1.

This signal is emitted when the value of activeFocusOnPress changes. It specifies whether the view should gain active focus when pressed.

This signal was introduced in QtWebEngine 1.2.

See also activeFocusOnPress and setActiveFocusOnPress().

This signal is emitted when the value of muted changes. The value is specified using the audioMuted property.

This signal was introduced in QtWebEngine 1.3.

See also audioMuted and recentlyAudibleChanged.

This signal is emitted when an authentication dialog is requested.

The request can be handled by using the methods of the AuthenticationDialogRequest type.

This signal was introduced in QtWebEngine 1.4.

This signal is emitted when the web engine view background color changes.

This signal was introduced in QtWebEngine 1.2.

This signal is emitted when an invalid certificate error, error, is raised while loading a given request.

The certificate error can be handled by using the methods of the WebEngineCertificateError type.

This signal was introduced in QtWebEngine 1.1.

This signal is emitted when a color picker dialog is requested.

The request can be handled by using the methods of the ColorDialogRequest type.

This signal was introduced in QtWebEngine 1.4.

This signal is emitted when a context menu is requested.

The request can be handled by using the properties of the ContextMenuRequest type.

This signal was introduced in QtWebEngine 1.4.

This signal is emitted when the web site identified by securityOrigin requests to make use of the resource or device identified by feature.

This signal was introduced in QtWebEngine 1.1.

See also grantFeaturePermission().

This signal is emitted when a file picker dialog is requested.

The request can be handled by using the methods of the FileDialogRequest type.

This signal was introduced in QtWebEngine 1.4.

This signal is emitted when a string search on a page is completed. result is the result of the string search.

This signal was introduced in QtWebEngine 1.10.

See also findText() and FindTextResult.

This signal is emitted when the web page issues the request for fullscreen mode through the JavaScript API.

This signal was introduced in QtWebEngine 1.1.

See also isFullScreen.

This signal is emitted whenever the document wants to change the position and size of the page to frameGeometry. This can happen for example through JavaScript.

While frameGeometry includes, geometry excludes the size of frame margins.

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

This signal was introduced in QtWebEngine 1.7.

This signal is emitted when a JavaScript program tries to print a message to the web browser's console.

For example, in case of evaluation errors the source URL may be provided in sourceID as well as the lineNumber.

level indicates the severity of the event that triggered the message, that is, whether it was triggered by an error or a less severe event.

If no handler is specified, the view will log the messages into a js logging category.

See also Console Logging.

This signal is emitted when a JavaScript dialog is requested.

The request can be handled by using the methods of the JavaScriptDialogRequest type.

This signal was introduced in QtWebEngine 1.4.

Within a mouse-driven interface, this signal is emitted when a mouse pointer passes over a link, corresponding to the mouseover DOM event. This event may also occur in touch interfaces for mouseover events that are not cancelled with preventDefault(). hoveredUrl provides the link's location.

This signal is emitted when a page load begins, ends, or fails.

When handling the signal with onLoadingChanged, various read-only parameters are available on the WebEngineLoadingInfo specified by loadingInfo.

See also loading, LoadStatus, and ErrorDomain.

This signal is emitted when the navigation request request is issued.

This signal is emitted when request is issued to load a page in a separate web engine view. This can either be because the current page requested it explicitly through a JavaScript call to window.open, or because the user clicked on a link while holding Shift, Ctrl, or a built-in combination that triggers the page to open in a new window.

The signal is handled by calling acceptAsNewWindow() on the destination view. If this signal is not handled, the requested load will fail.

An example implementation:

 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);
             }
         }
     }
 }

This signal was introduced in QtWebEngine 2.0.

See also WebEngineNewWindowRequest and WebEngine Quick Nano Browser.

This signal is emitted when printing the web page into a PDF file has finished. filePath will contain the path the file was requested to be created at, and success will be true if the file was successfully created and false otherwise.

This signal was introduced in QtWebEngine 1.5.

See also printToPdf().

This signal is emitted when the JavaScript window.print() method is called or the user pressed the print button of PDF viewer plugin. Typically, the signal handler can simply call printToPdf().

This signal was introduced in QtWebEngine 1.8.

See also printToPdf.

This signal is emitted when the page's audible state, specified by recentlyAudible, is changed, due to audio being played or stopped.

If a web page contains two videos that are started in sequence, this signal gets emitted only once, for the first video to generate sound. After both videos are stopped, the signal is emitted upon the last sound generated. This means that the signal is emitted both when any kind of sound is generated and when everything is completely silent within a web page, regardless of the number of audio streams.

Spurious signal emissions might also happen. For example, when sound is stopped, this signal gets emitted first with a value of true, and then with a value of false. Further, when audio starts playing, the signal is emitted twice with a value of true.

This signal was introduced in QtWebEngine 1.3.

See also recentlyAudible.

This signal is emitted when the web page tries to register a custom protocol by issuing a registerProtocolHandler request.

This signal was introduced in QtWebEngine 1.7.

See also RegisterProtocolHandlerRequest.

If no render process is available yet, 0 is returned. This signal is emitted when pid (process ID) of the page's underlying render process changed.

This signal was introduced in QtWebEngine 1.11.

See also renderProcessPid.

This signal is emitted when the render process is terminated with a non-zero exit status. terminationStatus is the termination status of the process and exitCode is the status code with which the process terminated.

This signal was introduced in QtWebEngine 1.2.

See also RenderProcessTerminationStatus.

This signal is emitted when a web site requests an SSL client certificate, and one or more were found in the system's client certificate store.

Handling the signal is asynchronous, and loading will be waiting until a certificate is selected, or the last copy of clientCertificateSelection is destroyed.

If the signal is not handled, clientCertificateSelection is automatically destroyed, and loading will continue without a client certificate.

This signal was introduced in QtWebEngine 1.9.

See also WebEngineClientCertificateSelection.

This signal is emitted when the web page sends a request to show a tooltip at a specified position.

This signal was introduced in QtWebEngine 1.10.

See also TooltipRequest.

This signal is emitted when a touch selection menu is requested at a specified position.

The request can be handled by using the methods of the TouchSelectionMenuRequest type.

This signal was introduced in QtWebEngine 6.3.

See also TouchSelectionMenuRequest.

This signal is emitted when the page's audible state, specified by wasRecentlyAudible, is changed, due to audio being played or stopped.

This signal was introduced in QtWebEngine 1.3.

This signal is emitted when a WebAuth authenticator requires user interaction during the authentication process. These requests are handled by displaying a dialog to the user.

The request contains the information and API required to complete the WebAuth UX request.

This signal was introduced in QtWebEngine 6.7.

See also QWebEngineWebAuthUxRequest.

This signal is emitted whenever the page requests the web browser window to be closed, for example through the JavaScript window.close() call.

This signal was introduced in QtWebEngine 1.2.

Handle the newWindowRequested signal by opening the request in this view.

This method was introduced in QtWebEngine 2.0.

See also newWindowRequested.

Returns a WebEngineAction for the specified WebAction action. WebEngineView also takes care of implementing the action, so that upon triggering the corresponding action is performed on the view.

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

See also WebEngineAction.

Finds the specified string, subString, in the page. The findTextFinished() signal is emitted when a string search is completed.

To clear the search highlight, just pass an empty string.

This method was introduced in QtWebEngine 1.1.

See also findTextFinished().

Finds the specified string, subString, in the page, using the given options. The findTextFinished() signal is emitted when a string search is completed.

To clear the search highlight, just pass an empty string.

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

This method was introduced in QtWebEngine 1.1.

See also findTextFinished().

Finds the specified string, subString, in the page, using the given options. The findTextFinished() signal is emitted when a string search is completed.

To clear the search highlight, just pass an empty string.

The resultCallback must take an integer parameter. It will be called with the number of found occurrences of the subString.

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

This method was introduced in QtWebEngine 1.1.

See also findTextFinished().

Immediately sets isFullScreen property to false. It can be used to notify the browser engine when the windowing system forces the application to leave fullscreen mode.

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

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

This method was introduced in QtWebEngine 1.1.

See also isFullScreen and fullScreenRequested().

Go backward within the browser's session history, if possible. This function is equivalent to the window.history.back() DOM method.

See also canGoBack.

If offset is positive, goes forward the specified number of offset pages in the current session history. If offset is negative, it goes back. If the offset is invalid, the page is not changed.

This method was introduced in QtWebEngine 1.1.

See also goBack() and goForward().

Go forward within the browser's session history, if possible. This function is equivalent to the window.history.forward() DOM method.

Sets or unsets the permission, depending on granted, for the web site identified by securityOrigin to use feature.

This method was introduced in QtWebEngine 1.1.

See also featurePermissionRequested().

Loads the specified html as the content of the web view.

This method offers a lower-level alternative to the url property, which references HTML pages via URL.

baseUrl is optional and used to resolve relative URLs in the document, such as referenced images or stylesheets. For example, if html is retrieved from http://www.example.com/documents/overview.html, which is the base URL, then an image referenced with the relative URL, diagram.png, should be at http://www.example.com/documents/diagram.png.

See also url.

Prints the WebEngineView's current content to a PDF document and stores it under filePath. The document's size will be determined by the value of pageSizeId and its orientation will be determined using orientation.

This method issues an asynchronous request for printing the web page into a PDF and returns immediately. To be informed about the result of the request, connect to the signal pdfPrintingFinished().

If you leave out pageSizeId, it defaults to A4. If you leave out orientation, it defaults to Portrait.

This method was introduced in QtWebEngine 1.3.

See also pdfPrintingFinished().

Prints the WebEngineView's current content to a PDF document and returns it in a byte array. The document's size will be determined by the value of pageSizeId and its orientation will be determined using orientation.

The resultCallback must take a string parameter. This string will contain the document's data upon successful printing and an empty string otherwise.

If you leave out pageSizeId, it defaults to A4. If you leave out orientation, it defaults to Portrait.

This method was introduced in QtWebEngine 1.3.

Reloads the current page. This function is equivalent to the window.location.reload() DOM method.

See also reloadAndBypassCache().

Reloads the current page, ignoring any cached content.

This method was introduced in QtWebEngine 1.1.

See also reload().

Replace the current misspelled word with replacement.

This method was introduced in QtWebEngine 1.3.

Runs the specified script in the content of the web view.

The callback parameter is optional. If a callback function is provided, it will be invoked after the script finishes running.

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

Only plain data can be returned from JavaScript as the result value. Supported data types include all of the JSON data types as well as, for example, Date and ArrayBuffer. Unsupported data types include, for example, Function and Promise.

The script will run in the same world as other scripts that are part of the loaded site.

For more information about injecting scripts, see Script Injection. For an alternative way to inject scripts, see WebEngineView::userScripts.

Save the current web page to disk.

The web page is saved to filePath in the specified format.

This is a shortcut for the following actions:

• Trigger the Save web action.
• Accept the next download item and set the specified file path and save format.

This function issues an asynchronous download request for the web page and returns immediately.

This method was introduced in QtWebEngine 6.6.

See also QWebEngineDownloadRequest::SavePageFormat.

Sets active focus to a clicked web engine view if arg is true. By setting it to false, a web engine view can be used to create a UI element that should not get focus. This can be useful in a hybrid UI.

This method was introduced in QtWebEngine 1.2.

See also activeFocusOnPress, activeFocusOnPressChanged, and WebEngineSettings::focusOnNavigationEnabled.

Stops loading the current page.

Triggers the web action action.

This method was introduced in QtWebEngine 1.2.

See also WebAction.