QWebEngineView¶

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

Synopsis¶

Functions¶

def createStandardContextMenu ()
def findText (arg__1, arg__2, arg__3)
def findText (subString[, options={}])
def hasSelection ()
def history ()
def icon ()
def iconUrl ()
def lastContextMenuRequest ()
def load (request)
def load (url)
def page ()
def pageAction (action)
def print (printer)
def printToPdf (filePath[, layout=QPageLayout(QPageSize(QPageSize.A4), QPageLayout.Portrait, QMarginsF())[, ranges={}]])
def selectedText ()
def setContent (data[, mimeType=””[, baseUrl=QUrl()]])
def setHtml (html[, baseUrl=QUrl()])
def setPage (page)
def setUrl (url)
def setZoomFactor (factor)
def settings ()
def title ()
def triggerPageAction (action[, checked=false])
def url ()
def zoomFactor ()

Virtual functions¶

def createWindow (type)

Slots¶

def back ()
def forward ()
def reload ()
def stop ()

Signals¶

def iconChanged (arg__1)
def iconUrlChanged (arg__1)
def loadFinished (arg__1)
def loadProgress (progress)
def loadStarted ()
def pdfPrintingFinished (filePath, success)
def printFinished (success)
def printRequested ()
def renderProcessTerminated (terminationStatus, exitCode)
def selectionChanged ()
def titleChanged (title)
def urlChanged (arg__1)

Static functions¶

def forPage (page)

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:

view = 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 PySide6.QtWebEngineWidgets.QWebEngineView([parent=None])¶

Parameters: parent – PySide6.QtWidgets.QWidget

Constructs an empty web view with the parent parent.

See also

load()

PySide6.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)
See also

forward() pageAction()

PySide6.QtWebEngineWidgets.QWebEngineView.createStandardContextMenu()¶

Return type: PySide6.QtWidgets.QMenu

Creates a standard context menu and returns a pointer to it.

PySide6.QtWebEngineWidgets.QWebEngineView.createWindow(type)¶

Parameters: type – WebWindowType
Return type: PySide6.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.

Table of Contents

Previous topic

Next topic