QWebEngineView Class

     QWebEngineView view;
     view.load(QUrl("https://qt-project.org/"));
     view.resize(1024, 750);
     view.show();

Member Function Documentation

[explicit] QWebEngineView::QWebEngineView(QWidget *parent = nullptr)

Constructs an empty web view with the parent parent.

See also load().

[explicit, since 6.4] QWebEngineView::QWebEngineView(QWebEngineProfile *profile, QWidget *parent = nullptr)

Constructs an empty web view using profile with the parent parent.

This function was introduced in Qt 6.4.

See also load().

[explicit, since 6.4] QWebEngineView::QWebEngineView(QWebEnginePage *page, QWidget *parent = nullptr)

Constructs a web view containing page with the parent parent.

This function was introduced in Qt 6.4.

See also load() and setPage().

[virtual noexcept] QWebEngineView::~QWebEngineView()

Destroys the web view.

[slot] void 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() and pageAction().

[override virtual protected] void QWebEngineView::closeEvent(QCloseEvent *event)

Reimplements: QWidget::closeEvent(QCloseEvent *event).

[override virtual protected] void QWebEngineView::contextMenuEvent(QContextMenuEvent *event)

Reimplements: QWidget::contextMenuEvent(QContextMenuEvent *event).

QMenu *QWebEngineView::createStandardContextMenu()

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

[virtual protected] QWebEngineView *QWebEngineView::createWindow(QWebEnginePage::WebWindowType type)

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.

See also QWebEnginePage::createWindow().

[override virtual protected] void QWebEngineView::dragEnterEvent(QDragEnterEvent *e)

Reimplements: QWidget::dragEnterEvent(QDragEnterEvent *event).

[override virtual protected] void QWebEngineView::dragLeaveEvent(QDragLeaveEvent *e)

Reimplements: QWidget::dragLeaveEvent(QDragLeaveEvent *event).

[override virtual protected] void QWebEngineView::dragMoveEvent(QDragMoveEvent *e)

Reimplements: QWidget::dragMoveEvent(QDragMoveEvent *event).

[override virtual protected] void QWebEngineView::dropEvent(QDropEvent *e)

Reimplements: QWidget::dropEvent(QDropEvent *event).

[override virtual protected] bool QWebEngineView::event(QEvent *ev)

Reimplements: QWidget::event(QEvent *event).

void QWebEngineView::findText(const QString &subString, QWebEnginePage::FindFlags options = {}, const std::function<void (const QWebEngineFindTextResult &)> &resultCallback = std::function<void(const QWebEngineFindTextResult &)>())

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

To clear the selection, just pass an empty string.

The resultCallback must take a QWebEngineFindTextResult parameter.

See also selectedText() and selectionChanged().

[static, since 6.2] QWebEngineView *QWebEngineView::forPage(const QWebEnginePage *page)

Returns the view if any, associated with the page.

This function was introduced in Qt 6.2.

See also page() and setPage().

[slot] void 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() and pageAction().

[override virtual protected] void QWebEngineView::hideEvent(QHideEvent *event)

Reimplements: QWidget::hideEvent(QHideEvent *event).

QWebEngineHistory *QWebEngineView::history() const

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

It is equivalent to:

     view->page()->history();

[signal] void QWebEngineView::iconChanged(const QIcon &icon)

This signal is emitted when the icon ("favicon") associated with the view is changed. The new icon is specified by icon.

See also icon(), iconUrl(), and iconUrlChanged().

[signal] void QWebEngineView::iconUrlChanged(const QUrl &url)

This signal is emitted when the URL of the icon ("favicon") associated with the view is changed. The new URL is specified by url.

See also iconUrl(), icon(), and iconChanged().

[since 6.2] QWebEngineContextMenuRequest *QWebEngineView::lastContextMenuRequest() const

Returns additional data about the current context menu. It is only guaranteed to be valid during the call to the contextMenuEvent().

This function was introduced in Qt 6.2.

See also createStandardContextMenu().

void QWebEngineView::load(const QUrl &url)

Loads the specified url and displays it.

See also load(), setUrl(), url(), urlChanged(), and QUrl::fromUserInput().

void QWebEngineView::load(const QWebEngineHttpRequest &request)

Issues the specified request and loads the response.

See also load(), setUrl(), url(), urlChanged(), and QUrl::fromUserInput().

[signal] void QWebEngineView::loadFinished(bool ok)

This signal is emitted when a load of the page has finished. ok will indicate whether the load was successful or an error occurred.

See also loadStarted().

[signal] void QWebEngineView::loadProgress(int progress)

This signal is emitted every time an element in the web view completes loading, such as an embedded image or a script. Therefore, it tracks the collective progress of loading the web view.

The current value is provided by progress and scales from 0 to 100, which is the default range of QProgressBar.

See also loadStarted() and loadFinished().

[signal] void QWebEngineView::loadStarted()

This signal is emitted when a new load of the page is started.

See also loadProgress() and loadFinished().

QWebEnginePage *QWebEngineView::page() const

Returns a pointer to the underlying web page.

See also setPage().

QAction *QWebEngineView::pageAction(QWebEnginePage::WebAction action) const

Returns a pointer to a QAction that encapsulates the specified web action action. This function will also set a default styled icon to the QAction if it lacks one.

[signal, since 6.2] void QWebEngineView::pdfPrintingFinished(const QString &filePath, bool success)

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, and success will be true if the file was successfully created and false otherwise.

This function was introduced in Qt 6.2.

See also printToPdf().

[since 6.2] void QWebEngineView::print(QPrinter *printer)

Renders the current content of the page into a temporary PDF document, then prints it using printer.

The settings for creating and printing the PDF document will be retrieved from the printer object.

When finished the signal printFinished() is emitted with the true for success or false for failure.

It is the users responsibility to ensure the printer remains valid until printFinished() has been emitted.

This function was introduced in Qt 6.2.

[signal, since 6.2] void QWebEngineView::printFinished(bool success)

This signal is emitted when printing requested with print() has finished. The parameter success is true for success or false for failure.

This function was introduced in Qt 6.2.

See also print().

[signal, since 6.2] void QWebEngineView::printRequested()

This signal is emitted when the JavaScript window.print() method is called or the user pressed the print button of PDF viewer plugin. Typically, the signal handler can simply call print().

This function was introduced in Qt 6.2.

See also print().

[since 6.2] void QWebEngineView::printToPdf(const QString &filePath, const QPageLayout &layout = QPageLayout(QPageSize(QPageSize::A4), QPageLayout::Portrait, QMarginsF()), const QPageRanges &ranges = {})

Renders the current content of the page into a PDF document and saves it in the location specified in filePath. The page size and orientation of the produced PDF document are taken from the values specified in layout, while the range of pages printed is taken from ranges with the default being printing all pages.

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 signal pdfPrintingFinished().

If a file already exists at the provided file path, it will be overwritten.

This function was introduced in Qt 6.2.

See also pdfPrintingFinished().

[since 6.2] void QWebEngineView::printToPdf(const std::function<void (const QByteArray &)> &resultCallback, const QPageLayout &layout = QPageLayout(QPageSize(QPageSize::A4), QPageLayout::Portrait, QMarginsF()), const QPageRanges &ranges = {})

Renders the current content of the page into a PDF document and returns a byte array containing the PDF data as parameter to resultCallback. The page size and orientation of the produced PDF document are taken from the values specified in layout, while the range of pages printed is taken from ranges with the default being printing all pages.

The resultCallback must take a const reference to a QByteArray as parameter. If printing was successful, this byte array will contain the PDF data, otherwise, the byte array will be empty.

This function was introduced in Qt 6.2.

[slot] void QWebEngineView::reload()

Reloads the current document.

See also stop(), pageAction(), and loadStarted().

[signal] void QWebEngineView::renderProcessTerminated(QWebEnginePage::RenderProcessTerminationStatus terminationStatus, int exitCode)

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.

[signal] void QWebEngineView::selectionChanged()

This signal is emitted whenever the selection changes.

See also selectedText().

void QWebEngineView::setContent(const QByteArray &data, const QString &mimeType = QString(), const QUrl &baseUrl = QUrl())

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 with relative URLs to be loaded, baseUrl cannot be empty.

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

See also load(), setHtml(), and QWebEnginePage::toHtml().

void QWebEngineView::setHtml(const QString &html, const QUrl &baseUrl = QUrl())

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

baseUrl is optional and used to resolve relative URLs in the document, such as referenced images or stylesheets. 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).

See also load(), setContent(), QWebEnginePage::toHtml(), and QWebEnginePage::setContent().

void QWebEngineView::setPage(QWebEnginePage *page)

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

QWebEngineSettings *QWebEngineView::settings() const

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

It is equivalent to:

     view->page()->settings();

[override virtual protected] void QWebEngineView::showEvent(QShowEvent *event)

Reimplements: QWidget::showEvent(QShowEvent *event).

[override virtual] QSize QWebEngineView::sizeHint() const

Reimplements an access function for property: QWidget::sizeHint.

[slot] void QWebEngineView::stop()

Convenience slot that stops loading the document.

It is equivalent to:

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

See also reload(), pageAction(), and loadFinished().

[signal] void QWebEngineView::titleChanged(const QString &title)

This signal is emitted whenever the title of the view changes.

See also title().

void QWebEngineView::triggerPageAction(QWebEnginePage::WebAction action, bool checked = false)

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

[signal] void QWebEngineView::urlChanged(const QUrl &url)

This signal is emitted when the url of the view changes.

See also url() and load().