QWebEngineView Class

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

Member Function Documentation

QWebEngineView::QWebEngineView(QWidget *parent = Q_NULLPTR)

Constructs an empty web view with the parent parent.

See also load().

[virtual] 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().

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

Reimplemented from QWidget::contextMenuEvent().

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

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 QWebEnginePage::createWindow().

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

Reimplemented from QWidget::dragEnterEvent().

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

Reimplemented from QWidget::dragLeaveEvent().

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

Reimplemented from QWidget::dragMoveEvent().

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

Reimplemented from QWidget::dropEvent().

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

void QWebEngineView::findText(const QString &subString, QWebEnginePage::FindFlags options = QWebEnginePage::FindFlags())

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

To clear the selection, just pass an empty string.

See also selectedText() and selectionChanged().

void QWebEngineView::findText(const QString &subString, QWebEnginePage::FindFlags options, FunctorOrLambda resultCallback)

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

To clear the selection, just pass an empty string.

resultCallback must take a boolean parameter. It will be called with a value of true if subString was found; otherwise the callback value will be false.

See also selectedText() and selectionChanged().

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

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

Reimplemented from QWidget::hideEvent().

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.

This function was introduced in Qt 5.7.

Note: Notifier signal for property 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.

Note: Notifier signal for property iconUrl.

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

void QWebEngineView::load(const QUrl &url)

Loads the specified url and displays it.

Note: The view remains the same until enough data has arrived to display the new URL.

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

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

This function was introduced in Qt 5.6.

[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 the specified content data. If the mimeType argument is empty, it is currently assumed that the content is HTML but in future versions we may introduce auto-detection.

External objects referenced in the content are located relative to baseUrl.

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.

External objects, such as stylesheets or images referenced in the HTML document, are located relative to baseUrl.

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.

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

See also QWebEngineSettings::globalSettings().

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

Reimplemented from QWidget::showEvent().

[virtual] QSize QWebEngineView::sizeHint() const

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