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:

Reflects a page's load status:

Describes how to open a new view:

See also WebEngineNewViewRequest.destination.

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 QML 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 QML property was introduced in QtWebEngine 1.3.

See also WebEngineView::printToPdf().

Describes the status with which the render process terminated:

This QML property was introduced in QtWebEngine 1.2.

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

This QML property was introduced in QtWebEngine 1.2.

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

This QML property was introduced in QtWebEngine 1.2.

The state of whether the current page audio is muted.

This QML 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 QML 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 QML property was introduced in QtWebEngine 1.3.

An internal URL for accessing the currently displayed web site icon, also known as favicon or shortcut icon. The icon is already downloaded and stored by the Qt WebEngine's favicon manager. 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 sourceSize property of the Image element informs the Qt WebEngine's favicon provider about the requested size. The favicon provider tries to find the best fit among the web page candidate icons. If sourceSize property is not specified, the provider provides the icon with the largest resolution.

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

This QML property was introduced in QtWebEngine 1.1.

See also fullScreenRequested() and fullScreenCancelled().

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 navigation history of the current view.

This QML property was introduced in QtWebEngine 1.1.

See also WebEngineHistory.

The current profile used for the view.

This QML property was introduced in QtWebEngine 1.1.

See also WebEngineProfile.

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

This QML property was introduced in QtWebEngine 1.3.

See also audioMuted and recentlyAudibleChanged.

Scroll position of the page contents.

This QML property was introduced in QtWebEngine 1.3.

Settings used by this view.

This QML 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 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().

List of script objects attached to the view.

This QML property was introduced in QtWebEngine 1.1.

See also WebEngineScript.

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.

Note: The view does not take ownership for an assigned webChannel object.

This QML property was introduced in QtWebEngine 1.1.

JavaScript world that the web channel instance used by this view is installed in.

This QML 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 QML property was introduced in QtWebEngine 1.1.

This signal is emitted when the ability of the web engine view to get focus when clicked changes.

This QML signal was introduced in QtWebEngine 1.2.

See also setActiveFocusOnPress().

This signal is emitted when the page's audio is (un)muted using audioMuted property.

Note: Not to be confused with a specific HTML5 audio / video element being muted.

This QML signal was introduced in QtWebEngine 1.3.

See also audioMuted and recentlyAudibleChanged.

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

This QML signal was introduced in QtWebEngine 1.2.

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

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

This QML signal was introduced in QtWebEngine 1.1.

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

This QML signal was introduced in QtWebEngine 1.1.

See also grantFeaturePermission().

This signal is emitted when the web page requests fullscreen mode through the JavaScript API.

This QML signal was introduced in QtWebEngine 1.1.

See also isFullScreen.

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.

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 loadRequest:

See also loading, LoadStatus, and ErrorDomain.

This signal is emitted when a page load is requested to happen 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.

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.
              onNewViewRequested: {
                  var newWindow = windowComponent.createObject(windowParent)
                  request.openIn(newWindow.webView)
              }
          }
      }
  }

This QML signal was introduced in QtWebEngine 1.1.

See also NewViewDestination and WebEngine Quick Nano Browser.

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

Note: The signal is also emitted when the audioMuted property changes. Also if the audio is paused, this signal is emitted with an approximate two-second delay, from the moment the audio is paused.

This signal is also emitted for Flash plugin audio.

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 QML signal was introduced in QtWebEngine 1.3.

See also recentlyAudible.

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 QML signal was introduced in QtWebEngine 1.2.

See also RenderProcessTerminationStatus.

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

Note: The signal is also emitted when calling the setAudioMuted method. Also if the audio is paused, this signal is emitted with an approximate 2 second delay, from the moment the audio is paused.

This QML signal was introduced in QtWebEngine 1.3.

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

This QML signal was introduced in QtWebEngine 1.2.

Finds the specified string, subString, in the page, using the given options.

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

The resultCallback must take a boolean parameter. It will be called with a value of true if the subString was found; otherwise the callback value will be false.

  findText("Qt", WebEngineView.FindCaseSensitively, function(success) {
      if (success)
          console.log("Qt was found!");
  });

This QML method was introduced in QtWebEngine 1.1.

Finds the specified string, subString, in the page, using the given options.

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

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

This QML method was introduced in QtWebEngine 1.1.

Finds the specified string, subString, in the page.

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

This QML method was introduced in QtWebEngine 1.1.

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 QML 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 QML 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 QML 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.

External objects, such as stylesheets or images referenced in the HTML document, should be located relative to baseUrl. 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 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.

This QML method was introduced in QtWebEngine 1.3.

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 QML 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 QML method was introduced in QtWebEngine 1.1.

See also reload().

Replace the current misspelled word with replacement.

This QML method was introduced in QtWebEngine 1.3.

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

In case a callback function is provided, it will be invoked after the script finishes running.

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

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

Warning: Do not execute lengthy routines in the callback function, because it might block the rendering of the web content.

See WebEngineView::userScripts for an alternative API to inject scripts.

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 QML method was introduced in QtWebEngine 1.2.

See also activeFocusOnPressChanged().

Stops loading the current page.

Triggers the web action action.

This QML method was introduced in QtWebEngine 1.2.

See also WebAction.