Back to Doc.qt.io
Contact Us Blog Download Qt

WebView QML Type

A component for displaying web content. More...

Import Statement: import QtWebView

Properties

Signals

Methods

Detailed Description

WebView is a component for displaying web content which is implemented using native APIs on the platforms where this is available, thus it does not necessarily require including a full web browser stack as part of the application.

To make the Qt WebView module function correctly across all platforms, it is necessary to call QtWebView::initialize() right after creating the QGuiApplication instance.

Note: Due to platform limitations overlapping the WebView and other QML components is not supported.

Property Documentation

[read-only] canGoBack : bool

Holds true if it's currently possible to navigate back in the web history.


[read-only] canGoForward : bool

Holds true if it's currently possible to navigate forward in the web history.


[since QtWebView 1.14] httpUserAgent : url

The user agent in use.

Note: on WinRT, this property affects all WebViews of the application.

This property was introduced in QtWebView 1.14.


[read-only] loadProgress : int

The current load progress of the web content, represented as an integer between 0 and 100.


[read-only] loading : bool

Holds true if the WebView is currently in the process of loading new content, false otherwise.

See also loadingChanged().


[read-only, since QtWebView 6.5] settings : WebViewSettings

Settings object for the WebView.

This property was introduced in QtWebView 6.5.

See also WebViewSettings.


[read-only] title : string

The title of the currently loaded web page.


url : url

The URL of currently loaded web page. Changing this will trigger loading new content.

The URL is used as-is. URLs that originate from user input should be parsed with QUrl::fromUserInput().

Note: The WebView does not support loading content through the Qt Resource system.


Signal Documentation

cookieAdded(string domain, string name)

This signal is emitted when a cookie is added.

The parameters provide information about the domain and the name of the added cookie.

Note: When Qt WebEngine module is used as backend, cookieAdded signal will be emitted for any cookie added to the underlying QWebEngineCookieStore, including those added by websites. In other cases cookieAdded signal is only emitted for cookies explicitly added with setCookie().

Note: The corresponding handler is onCookieAdded.


cookieRemoved(string domain, string name)

This signal is emitted when a cookie is deleted.

The parameters provide information about the domain and the name of the deleted cookie.

Note: The corresponding handler is onCookieRemoved.


loadingChanged(WebViewLoadRequest loadRequest)

This signal is emitted when the state of loading the web content changes. By handling this signal it's possible, for example, to react to page load errors.

The loadRequest parameter holds the url and status of the request, as well as an errorString containing an error message for a failed request.

Note: The corresponding handler is onLoadingChanged.

See also WebViewLoadRequest.


Method Documentation

[since QtWebView 6.3] void deleteAllCookies()

Deletes all the cookies.

This method was introduced in QtWebView 6.3.


[since QtWebView 6.3] void deleteCookie(string domain, string name)

Deletes a cookie with the specified domain and name.

The cookieRemoved signal will be emitted when the cookie is deleted.

This method was introduced in QtWebView 6.3.


void goBack()

Navigates back in the web history.


void goForward()

Navigates forward in the web history.


void loadHtml(string html, url baseUrl)

Loads the specified html content to 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.

Note: The WebView does not support loading content through the Qt Resource system.

See also url.


void reload()

Reloads the current url.


void runJavaScript(string script, variant callback)

Runs the specified JavaScript. In case a callback function is provided, it will be invoked after the script finished running.

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

[since QtWebView 6.3] void setCookie(string domain, string name, string value)

Adds a cookie with the specified domain, name and value.

The cookieAdded signal will be emitted when the cookie is added.

This method was introduced in QtWebView 6.3.


void stop()

Stops loading the current url.


© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.