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 alsofeaturePermissionRequested() andgrantFeaturePermission().

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

See alsofindText().

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 alsolifecycleState,Page Lifecycle API, andWebEngine Lifecycle Example.

Reflects a page's load status:

Describes how to open a new view:

See alsoWebEngineNewViewRequest.destination.

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

This property was introduced in QtWebEngine 1.3.

See alsoWebEngineView::printToPdf().

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

The enumeration values are mapped from and must matchQPageSize::PageSizeId. They are also duplicated inQPagedPaintDevice andQPrinter.

The defined sizes are:

This property was introduced in QtWebEngine 1.3.

See alsoWebEngineView::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 istrue.

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

Changes the color of theWebEngineView'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.

Returnstrue if there are prior session history entries,false otherwise.

Returnstrue if there are subsequent session history entries,false otherwise.

Size of the page contents.

This property was introduced in QtWebEngine 1.3.

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

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 theicon property to build anImage component:

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

Specifying thesourceSize property of theImage 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. IfsourceSize property is not specified, the provider provides the icon with the largest 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 inspectedWebEngineView.

This property was introduced in QtWebEngine 1.7.

See alsodevToolsView.

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

This property was introduced in QtWebEngine 1.1.

See alsofullScreenRequested() andfullScreenCancelled().

The current lifecycle state of the page.

The following restrictions are enforced by the setter:

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

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

This property was introduced in QtWebEngine 1.10.

See alsorecommendedState,Page Lifecycle API, andWebEngine Lifecycle Example.

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

Returnstrue if the HTML page is currently loading,false otherwise.

The navigation history of the current view.

This property was introduced in QtWebEngine 1.1.

See alsoWebEngineHistory.

The current profile used for the view.

This property was introduced in QtWebEngine 1.1.

See alsoWebEngineProfile.

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

This property was introduced in QtWebEngine 1.3.

See alsoaudioMuted andrecentlyAudibleChanged.

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 alsolifecycleState,Page Lifecycle API, andWebEngine 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 alsorenderProcessPidChanged.

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

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 thewindow.location DOM property.

See alsoloadHtml().

List of script objects attached to the view.

This property was introduced in QtWebEngine 1.1.

See alsoWebEngineScript.

The web channel instance used by this view. This channel is automatically using the internalQtWebEngine transport mechanism over Chromium IPC, and exposed in the javascript context of the page it is rendering asqt.webChannelTransport. This transport object is used when instantiating the JavaScript counterpart ofQWebChannel using theQt 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 between0 and256.

This property was introduced in QtWebEngine 1.3.

Zoom factor for the view. Valid values are within the range from0.25 to5.0. The default factor is1.0.

This property was introduced in QtWebEngine 1.1.

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

Note:The corresponding handler isonActiveFocusOnPressChanged.

This signal was introduced in QtWebEngine 1.2.

See alsoactiveFocusOnPress andsetActiveFocusOnPress().

This signal is emitted when the value ofmuted changes. The value is specified using theaudioMuted property.

Note:The corresponding handler isonAudioMutedChanged.

This signal was introduced in QtWebEngine 1.3.

See alsoaudioMuted andrecentlyAudibleChanged.

This signal is emitted when an authentication dialog is requested.

Therequest can be handled by using the methods of theAuthenticationDialogRequest type.

Note:The corresponding handler isonAuthenticationDialogRequested.

This signal was introduced in QtWebEngine 1.4.

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

Note:The corresponding handler isonBackgroundColorChanged.

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 theWebEngineCertificateError type.

Note:The corresponding handler isonCertificateError.

This signal was introduced in QtWebEngine 1.1.

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

Therequest can be handled by using the methods of theColorDialogRequest type.

Note:The corresponding handler isonColorDialogRequested.

This signal was introduced in QtWebEngine 1.4.

This signal is emitted when a context menu is requested.

Therequest can be handled by using the properties of theContextMenuRequest type.

Note:The corresponding handler isonContextMenuRequested.

This signal was introduced in QtWebEngine 1.4.

This signal is emitted when the web site identified bysecurityOrigin requests to make use of the resource or device identified byfeature.

Note:The corresponding handler isonFeaturePermissionRequested.

This signal was introduced in QtWebEngine 1.1.

See alsograntFeaturePermission().

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

Therequest can be handled by using the methods of theFileDialogRequest type.

Note:The corresponding handler isonFileDialogRequested.

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.

Note:The corresponding handler isonFindTextFinished.

This signal was introduced in QtWebEngine 1.10.

See alsofindText() andFindTextResult.

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

Note:The corresponding handler isonFullScreenRequested.

This signal was introduced in QtWebEngine 1.1.

See alsoisFullScreen.

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

WhileframeGeometry 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}

Note:The corresponding handler isonGeometryChangeRequested.

This signal was introduced in QtWebEngine 1.7.

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

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

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 ajslogging category.

Note:The corresponding handler isonJavaScriptConsoleMessage.

See alsoConsole Logging.

This signal is emitted when a JavaScript dialog is requested.

Therequest can be handled by using the methods of theJavaScriptDialogRequest type.

Note:The corresponding handler isonJavaScriptDialogRequested.

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 themouseover DOM event. This event may also occur in touch interfaces formouseover events that are not cancelled withpreventDefault().hoveredUrl provides the link's location.

Note:The corresponding handler isonLinkHovered.

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

When handling the signal withonLoadingChanged, various read-only parameters are available on theWebEngineLoadRequest specified byloadRequest.

Note:The corresponding handler isonLoadingChanged.

See alsoloading,LoadStatus, andErrorDomain.

This signal is emitted when the navigation requestrequest is issued.

Note:The corresponding handler isonNavigationRequested.

This signal is emitted whenrequest 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 towindow.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!">');    }    propertyComponentwindowComponent: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        propertyWebEngineViewwebView: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:function(request) {                var newWindow =windowComponent.createObject(windowParent);request.openIn(newWindow.webView);            }        }    }}

Note:The corresponding handler isonNewViewRequested.

This signal was introduced in QtWebEngine 1.1.

See alsoNewViewDestination andWebEngine 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, andsuccess will betrue if the file was successfully created andfalse otherwise.

Note:The corresponding handler isonPdfPrintingFinished.

This signal was introduced in QtWebEngine 1.5.

See alsoprintToPdf().

This signal is emitted when the JavaScriptwindow.print() method is called. Typically, the signal handler can simply callprintToPdf().

Note:The corresponding handler isonPrintRequest.

This signal was introduced in QtWebEngine 1.8.

See alsoprintToPdf.

This signal is emitted when the web page issues arequest for a larger persistent storage than the application's current allocation in File System API. The default quota is 0 bytes.

Note:The corresponding handler isonQuotaRequested.

This signal was introduced in QtWebEngine 1.7.

See alsoQuotaRequest.

This signal is emitted when the page's audible state, specified byrecentlyAudible, 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 oftrue, and then with a value offalse. Further, when audio starts playing, the signal is emitted twice with a value oftrue.

Note:The corresponding handler isonRecentlyAudibleChanged.

This signal was introduced in QtWebEngine 1.3.

See alsorecentlyAudible.

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

Note:The corresponding handler isonRegisterProtocolHandlerRequested.

This signal was introduced in QtWebEngine 1.7.

See alsoRegisterProtocolHandlerRequest.

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

Note:The corresponding handler isonRenderProcessPidChanged.

This signal was introduced in QtWebEngine 1.11.

See alsorenderProcessPid.

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

Note:The corresponding handler isonRenderProcessTerminated.

This signal was introduced in QtWebEngine 1.2.

See alsoRenderProcessTerminationStatus.

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 ofclientCertificateSelection is destroyed.

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

Note:The corresponding handler isonSelectClientCertificate.

This signal was introduced in QtWebEngine 1.9.

See alsoWebEngineClientCertificateSelection.

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

Note:The corresponding handler isonTooltipRequested.

This signal was introduced in QtWebEngine 1.10.

See alsoTooltipRequest.

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

Note:The corresponding handler isonWasRecentlyAudibleChanged.

This 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 JavaScriptwindow.close() call.

Note:The corresponding handler isonWindowCloseRequested.

This signal was introduced in QtWebEngine 1.2.

Returns aWebEngineAction for the specifiedWebActionaction.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);

This method was introduced in Qt 5.12.

See alsoWebEngineAction.

Finds the specified string,subString, in the page, using the givenoptions. ThefindTextFinished() signal is emitted when a string search is completed.

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

TheresultCallback must take an integer parameter. It will be called with the number of found occurrences of thesubString.

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

This method was introduced in QtWebEngine 1.1.

See alsofindTextFinished().

Finds the specified string,subString, in the page, using the givenoptions. ThefindTextFinished() 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 alsofindTextFinished().

Finds the specified string,subString, in the page. ThefindTextFinished() 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 alsofindTextFinished().

Immediately setsisFullScreen property tofalse. 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 alsoisFullScreen andfullScreenRequested().

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

See alsocanGoBack.

Ifoffset 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 alsogoBack() andgoForward().

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

Sets or unsets the permission, depending ongranted, for the web site identified bysecurityOrigin to usefeature.

This method was introduced in QtWebEngine 1.1.

See alsofeaturePermissionRequested().

Loads the specifiedhtml as the content of the web view.

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

External objects, such as stylesheets or images referenced in the HTML document, should be located relative tobaseUrl. For external objects to be loaded,baseUrl cannot be empty. For example, ifhtml is retrieved fromhttp://www.example.com/documents/overview.html, which is the base URL, then an image referenced with the relative URL,diagram.png, should be athttp://www.example.com/documents/diagram.png.

See alsourl.

Prints theWebEngineView's current content to a PDF document and returns it in a byte array. The document's size will be determined by the value ofpageSizeId and its orientation will be determined usingorientation.

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

If you leave outpageSizeId, it defaults toA4. If you leave outorientation, it defaults toPortrait.

This method was introduced in QtWebEngine 1.3.

Prints theWebEngineView's current content to a PDF document and stores it underfilePath. The document's size will be determined by the value ofpageSizeId and its orientation will be determined usingorientation.

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 signalpdfPrintingFinished().

If you leave outpageSizeId, it defaults toA4. If you leave outorientation, it defaults toPortrait.

This method was introduced in QtWebEngine 1.3.

See alsopdfPrintingFinished().

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

See alsoreloadAndBypassCache().

Reloads the current page, ignoring any cached content.

This method was introduced in QtWebEngine 1.1.

See alsoreload().

Replace the current misspelled word withreplacement.

This method was introduced in QtWebEngine 1.3.

Runs the specifiedscript in the content of the web view.

Thecallback 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 andArrayBuffer. Unsupported data types include, for example,Function andPromise.

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

For more information about injecting scripts, seeScript Injection. For an alternative way to inject scripts, seeWebEngineView::userScripts.

Sets active focus to a clicked web engine view ifarg istrue. By setting it tofalse, 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 alsoactiveFocusOnPress,activeFocusOnPressChanged, andWebEngineSettings::focusOnNavigationEnabled.

Stops loading the current page.

Triggers the web actionaction.

This method was introduced in QtWebEngine 1.2.

See alsoWebAction.