QWebEngineView

The QWebEngineView class provides a widget that is used to view and edit web documents. More

Inheritance diagram of PySide2.QtWebEngineWidgets.QWebEngineView

Synopsis

Functions

Virtual functions

Slots

Signals

Detailed Description

A web view is the main widget component of the Qt WebEngine web browsing module. It can be used in various applications to display web content live from the Internet.

A web site can be loaded to a web view with the load() function. The GET method is always used to load URLs.

Like all Qt widgets, the show() function must be invoked in order to display the web view. The snippet below illustrates this:

QWebEngineView *view = new QWebEngineView(parent);
view->load(QUrl("http://qt-project.org/"));
view->show();

Alternatively, setUrl() can be used to load a web site. If you have the HTML content readily available, you can use setHtml() instead.

The loadStarted() signal is emitted when the view begins loading and the loadProgress() signal is emitted whenever an element of the web view completes loading, such as an embedded image or a script. The loadFinished() signal is emitted when the view has been loaded completely. Its argument, either true or false , indicates whether loading was successful or failed.

The page() function returns a pointer to a web page object. A QWebEngineView contains a QWebEnginePage , which in turn allows access to the QWebEngineHistory in the page’s context.

The title of an HTML document can be accessed with the title() property. Additionally, a web site may specify an icon, which can be accessed using the icon() or its URL using the iconUrl() property. If the title or the icon changes, the corresponding titleChanged() , iconChanged() and iconUrlChanged() signals will be emitted. The zoomFactor() property enables zooming the contents of the web page by a scale factor.

The widget features a context menu that is tailored to the element at hand, and includes actions useful in a browser. For a custom context menu, or for embedding actions in a menu or toolbar, the individual actions are available via pageAction() . The web view maintains the state of the returned actions, but allows modification of action properties such as text or icon . The action semantics can also be triggered directly through triggerPageAction() .

If you want to provide support for web sites that allow the user to open new windows, such as pop-up windows, you can subclass QWebEngineView and reimplement the createWindow() function.

See also

WebEngine Widgets Simple Browser Example WebEngine Content Manipulation Example WebEngine Markdown Editor Example

class PySide2.QtWebEngineWidgets.QWebEngineView([parent=Q_NULLPTR])

Constructs an empty web view with the parent parent .

See also

load()

PySide2.QtWebEngineWidgets.QWebEngineView.back()

Convenience slot that loads the previous document in the list of documents built by navigating links. Does nothing if there is no previous document.

It is equivalent to:

view->page()->triggerAction(QWebEnginePage::Back);
PySide2.QtWebEngineWidgets.QWebEngineView.createWindow(type)
Parameters

typeWebWindowType

Return type

PySide2.QtWebEngineWidgets.QWebEngineView

This function is called from the createWindow() method of the associated QWebEnginePage each time the page wants to create a new window of the given type . For example, when a JavaScript request to open a document in a new window is issued.

Note

If the createWindow() method of the associated page is reimplemented, this method is not called, unless explicitly done so in the reimplementation.

See also

createWindow()

PySide2.QtWebEngineWidgets.QWebEngineView.findText(arg__1, arg__2, arg__3)
Parameters
  • arg__1 – str

  • arg__2FindFlags

  • arg__3 – object

PySide2.QtWebEngineWidgets.QWebEngineView.findText(subString[, options=QWebEnginePage.FindFlags()])
Parameters
  • subString – str

  • optionsFindFlags

PySide2.QtWebEngineWidgets.QWebEngineView.forward()

Convenience slot that loads the next document in the list of documents built by navigating links. Does nothing if there is no next document.

It is equivalent to:

view->page()->triggerAction(QWebEnginePage::Forward);

See also

back() pageAction()

PySide2.QtWebEngineWidgets.QWebEngineView.hasSelection()
Return type

bool

This property holds Whether this page contains selected content or not..

By default, this property is false .

PySide2.QtWebEngineWidgets.QWebEngineView.history()
Return type

PySide2.QtWebEngineWidgets.QWebEngineHistory

Returns a pointer to the view’s history of navigated web pages.

It is equivalent to:

view->page()->history();
PySide2.QtWebEngineWidgets.QWebEngineView.icon()
Return type

PySide2.QtGui.QIcon

This property holds The icon associated with the page currently viewed..

By default, this property contains a null icon.

PySide2.QtWebEngineWidgets.QWebEngineView.iconChanged(arg__1)
Parameters

arg__1PySide2.QtGui.QIcon

PySide2.QtWebEngineWidgets.QWebEngineView.iconUrl()
Return type

PySide2.QtCore.QUrl

This property holds The URL of the icon associated with the page currently viewed..

By default, this property contains an empty URL.

PySide2.QtWebEngineWidgets.QWebEngineView.iconUrlChanged(arg__1)
Parameters

arg__1PySide2.QtCore.QUrl

PySide2.QtWebEngineWidgets.QWebEngineView.load(url)
Parameters

urlPySide2.QtCore.QUrl

PySide2.QtWebEngineWidgets.QWebEngineView.load(request)
Parameters

requestPySide2.QtWebEngineCore.QWebEngineHttpRequest

PySide2.QtWebEngineWidgets.QWebEngineView.loadFinished(arg__1)
Parameters

arg__1 – bool

PySide2.QtWebEngineWidgets.QWebEngineView.loadProgress(progress)
Parameters

progress – int

PySide2.QtWebEngineWidgets.QWebEngineView.loadStarted()
PySide2.QtWebEngineWidgets.QWebEngineView.page()
Return type

PySide2.QtWebEngineWidgets.QWebEnginePage

Returns a pointer to the underlying web page.

See also

setPage()

PySide2.QtWebEngineWidgets.QWebEngineView.pageAction(action)
Parameters

actionWebAction

Return type

PySide2.QtWidgets.QAction

Returns a pointer to a QAction that encapsulates the specified web action action .

PySide2.QtWebEngineWidgets.QWebEngineView.reload()

Reloads the current document.

PySide2.QtWebEngineWidgets.QWebEngineView.renderProcessTerminated(terminationStatus, exitCode)
Parameters
PySide2.QtWebEngineWidgets.QWebEngineView.selectedText()
Return type

str

This property holds The text currently selected..

By default, this property contains an empty string.

PySide2.QtWebEngineWidgets.QWebEngineView.selectionChanged()
PySide2.QtWebEngineWidgets.QWebEngineView.setContent(data[, mimeType=""[, baseUrl=QUrl()]])
Parameters

Sets the content of the web view to data . If the mimeType argument is empty, it is assumed that the content is text/plain,charset=US-ASCII .

External objects referenced in the content are located relative to baseUrl . For external objects to be loaded, baseUrl cannot be empty.

The data is loaded immediately; external objects are loaded asynchronously.

PySide2.QtWebEngineWidgets.QWebEngineView.setHtml(html[, baseUrl=QUrl()])
Parameters

Sets the content of the web view to the specified html content.

External objects, such as stylesheets or images referenced in the HTML document, are located relative to baseUrl . For external objects to be loaded, baseUrl cannot be empty. 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 .

The HTML document is loaded immediately, whereas external objects are loaded asynchronously.

When using this method, Qt WebEngine assumes that external resources, such as JavaScript programs or style sheets, are encoded in UTF-8 unless otherwise specified. For example, the encoding of an external script can be specified through the charset attribute of the HTML script tag. Alternatively, the encoding can be specified by the web server.

This is a convenience function equivalent to setContent(html, "text/html;charset=UTF-8", baseUrl) .

Warning

This function works only for HTML. For other MIME types (such as XHTML or SVG), setContent() should be used instead.

Note

Content larger than 2 MB cannot be displayed, because converts the provided HTML to percent-encoding and places data : in front of it to create the URL that it navigates to. Thereby, the provided code becomes a URL that exceeds the 2 MB limit set by Chromium. If the content is too large, the loadFinished() signal is triggered with success=false .

PySide2.QtWebEngineWidgets.QWebEngineView.setPage(page)
Parameters

pagePySide2.QtWebEngineWidgets.QWebEnginePage

Makes page the new web page of the web view.

The parent QObject of the provided page remains the owner of the object. If the current page is a child of the web view, it will be deleted.

See also

page()

PySide2.QtWebEngineWidgets.QWebEngineView.setUrl(url)
Parameters

urlPySide2.QtCore.QUrl

This property holds The URL of the web page currently viewed..

Setting this property clears the view and loads the URL.

By default, this property contains an empty, invalid URL.

See also

load() urlChanged()

PySide2.QtWebEngineWidgets.QWebEngineView.setZoomFactor(factor)
Parameters

factor – float

This property holds The zoom factor for the view..

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

PySide2.QtWebEngineWidgets.QWebEngineView.settings()
Return type

PySide2.QtWebEngineWidgets.QWebEngineSettings

Returns a pointer to the view or page specific settings object.

It is equivalent to:

view->page()->settings();
PySide2.QtWebEngineWidgets.QWebEngineView.stop()

Convenience slot that stops loading the document.

It is equivalent to:

view->page()->triggerAction(QWebEnginePage::Stop);
PySide2.QtWebEngineWidgets.QWebEngineView.title()
Return type

str

This property holds The title of the page as defined by the HTML <title> element..

Equivalent to title() .

See also

titleChanged()

PySide2.QtWebEngineWidgets.QWebEngineView.titleChanged(title)
Parameters

title – str

PySide2.QtWebEngineWidgets.QWebEngineView.triggerPageAction(action[, checked=false])
Parameters

Triggers the specified action . If it is a checkable action, the specified checked state is assumed.

The following example triggers the copy action and therefore copies any selected text to the clipboard.

view->triggerPageAction(QWebEnginePage::Copy);

See also

pageAction()

PySide2.QtWebEngineWidgets.QWebEngineView.url()
Return type

PySide2.QtCore.QUrl

This property holds The URL of the web page currently viewed..

Setting this property clears the view and loads the URL.

By default, this property contains an empty, invalid URL.

See also

load() urlChanged()

PySide2.QtWebEngineWidgets.QWebEngineView.urlChanged(arg__1)
Parameters

arg__1PySide2.QtCore.QUrl

PySide2.QtWebEngineWidgets.QWebEngineView.zoomFactor()
Return type

float

This property holds The zoom factor for the view..

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