QWebEnginePage Class

Member Function Documentation

Runs the JavaScript code contained in scriptSource without checking whether the DOM of the page has been constructed. If you need more control over how the script is run, consider using scripts() instead.

To avoid conflicts with other scripts executed on the page, the world in which the script is run is specified by worldId. The world ID values are the same as provided by QWebEngineScript::ScriptWorldId, and between 0 and 256. If you leave out the world ID, the script is run in the MainWorld.

When the script has been executed, resultCallback is called with the result of the last executed statement. resultCallback can be any of a function pointer, a functor or a lambda, and it is expected to take a QVariant parameter. For example:

 page.runJavaScript("document.title", [](const QVariant &v) { qDebug() << v.toString(); });

Only plain data can be returned from JavaScript as the result value. Supported data types include all of the JSON data types as well as, for example, Date and ArrayBuffer. Unsupported data types include, for example, Function and Promise.

This function was introduced in Qt 5.7.

See also scripts(), QWebEngineScript::ScriptWorldId, and Script Injection.

[since 5.5] QWebEnginePage::QWebEnginePage(QWebEngineProfile *profile, QObject *parent = nullptr)

Constructs an empty web engine page in the web engine profile profile with the parent parent.

If the profile is not the default profile, the caller must ensure that the profile stays alive for as long as the page does.

This function was introduced in Qt 5.5.

QWebEnginePage::QWebEnginePage(QObject *parent = nullptr)

Constructs an empty QWebEnginePage with the parent parent.

[signal, since 5.7] void QWebEnginePage::audioMutedChanged(bool muted)

This signal is emitted when the page's muted state changes.

Note: Notifier signal for property audioMuted.

This function was introduced in Qt 5.7.

[signal] void QWebEnginePage::authenticationRequired(const QUrl &requestUrl, QAuthenticator *authenticator)

This signal is emitted when access to requestUrl requires authentication. authenticator should be used to pass the user name and password for the connection.

[signal] void QWebEnginePage::certificateError(const QWebEngineCertificateError &certificateError)

This signal is emitted when an invalid certificate error is raised while loading a given request.

The certificateError parameter contains information about the certificate and details of the error, it also provides the way to ignore the error and complete the request or stop loading the request.

See also QWebEngineCertificateError.

[signal] void QWebEnginePage::featurePermissionRequestCanceled(const QUrl &securityOrigin, QWebEnginePage::Feature feature)

This signal is emitted when the web site identified by securityOrigin cancels a previously issued request to make use of feature.

See also featurePermissionRequested() and setFeaturePermission().

[signal] void QWebEnginePage::featurePermissionRequested(const QUrl &securityOrigin, QWebEnginePage::Feature feature)

This signal is emitted when the web site identified by securityOrigin requests to make use of the resource or device identified by feature.

See also featurePermissionRequestCanceled() and setFeaturePermission().

[signal, since 5.14] void QWebEnginePage::findTextFinished(const QWebEngineFindTextResult &result)

This signal is emitted when a search string search on a page is completed. result is the result of the string search.

This function was introduced in Qt 5.14.

See also findText().

[signal] void QWebEnginePage::fullScreenRequested(QWebEngineFullScreenRequest fullScreenRequest)

This signal is emitted when the web page issues the request to enter fullscreen mode for a web-element, usually a video element.

The request object fullScreenRequest can be used to accept or reject the request.

If the request is accepted the element requesting fullscreen will fill the viewport, but it is up to the application to make the view fullscreen or move the page to a view that is fullscreen.

See also QWebEngineSettings::FullScreenSupportEnabled.

[signal] void QWebEnginePage::geometryChangeRequested(const QRect &geom)

This signal is emitted whenever the document wants to change the position and size of the page to geom. This can happen for example through JavaScript.

 window->setGeometry(geom.marginsRemoved(window->frameMargins()));

[signal, since 5.7] void QWebEnginePage::iconChanged(const QIcon &icon)

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

Note: Notifier signal for property icon.

This function was introduced in Qt 5.7.

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

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

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

Note: Notifier signal for property iconUrl.

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

[signal] void QWebEnginePage::linkHovered(const QString &url)

This signal is emitted when the mouse hovers over a link. url contains the target URL of the link.

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

This signal is emitted when the page finishes loading content. This signal is independent of script execution or page rendering. ok will indicate whether the load was successful or any error occurred.

See also loadStarted() and acceptNavigationRequest().

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

This signal is emitted when the global progress status changes. The current value is provided by progress and scales from 0 to 100, which is the default range of QProgressBar. It accumulates changes from all the child frames.

[signal] void QWebEnginePage::loadStarted()

This signal is emitted when a page starts loading content.

See also loadFinished() and acceptNavigationRequest().

[signal, since 6.2] void QWebEnginePage::loadingChanged(const QWebEngineLoadingInfo &loadingInfo)

This signal is emitted when loading the page specified by loadingInfo begins, ends, or fails.

Note: Notifier signal for property loading.

This function was introduced in Qt 6.2.

[signal, since 6.2] void QWebEnginePage::navigationRequested(QWebEngineNavigationRequest &request)

This signal is emitted on navigation together with the call the acceptNavigationRequest(). It can be used to accept or ignore the request. The default is to accept.

This function was introduced in Qt 6.2.

See also acceptNavigationRequest().

[signal, since 6.2] void QWebEnginePage::newWindowRequested(QWebEngineNewWindowRequest &request)

This signal is emitted when request is issued to load a page in a separate web engine window. This can either be because the current page requested it explicitly through a JavaScript call to window.open, or because the user clicked on a link while holding Shift, Ctrl, or a built-in combination that triggers the page to open in a new window.

The signal is handled by calling openIn() with the new page on the request. If this signal is not handled, the requested load will fail.

This function was introduced in Qt 6.2.

See also createWindow() and QWebEngineNewWindowRequest::openIn().

[signal] void QWebEnginePage::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.

See also printToPdf().

[signal] void QWebEnginePage::proxyAuthenticationRequired(const QUrl &requestUrl, QAuthenticator *authenticator, const QString &proxyHost)

This signal is emitted when access to requestUrl via proxyHost requires authentication for the proxy. authenticator should be used to pass the user name and password for the connection.

[signal, since 5.11] void QWebEnginePage::quotaRequested(QWebEngineQuotaRequest quotaRequest)

This signal is emitted when the web page requests larger persistent storage than the application's current allocation in File System API. The default quota is 0 bytes.

The request object quotaRequest can be used to accept or reject the request.

This function was introduced in Qt 5.11.

[signal, since 5.7] void QWebEnginePage::recentlyAudibleChanged(bool recentlyAudible)

This signal is emitted when the page's audible state, recentlyAudible, changes, because the audio is played or stopped.

Note: Notifier signal for property recentlyAudible.

This function was introduced in Qt 5.7.

[signal, since 5.11] void QWebEnginePage::registerProtocolHandlerRequested(QWebEngineRegisterProtocolHandlerRequest request)

This signal is emitted when the web page tries to register a custom protocol using the registerProtocolHandler API.

The request object request can be used to accept or reject the request:

 void WebView::handleRegisterProtocolHandlerRequested(
         QWebEngineRegisterProtocolHandlerRequest request)
 {
     auto answer = QMessageBox::question(window(), tr("Permission Request"),
                                         tr("Allow %1 to open all %2 links?")
                                                 .arg(request.origin().host())
                                                 .arg(request.scheme()));
     if (answer == QMessageBox::Yes)
         request.accept();
     else
         request.reject();
 }

This function was introduced in Qt 5.11.

[signal, since 5.15] void QWebEnginePage::renderProcessPidChanged(qint64 pid)

This signal is emitted when the underlying render process PID, pid, changes.

Note: Notifier signal for property renderProcessPid.

This function was introduced in Qt 5.15.

[signal, since 5.6] void QWebEnginePage::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, since 5.12] void QWebEnginePage::selectClientCertificate(QWebEngineClientCertificateSelection clientCertificateSelection)

This signal is emitted when a web site requests an SSL client certificate, and one or more were found in system's client certificate store.

Handling the signal is asynchronous, and loading will be waiting until a certificate is selected, or the last copy of clientCertificateSelection is destroyed.

If the signal is not handled, clientCertificateSelection is automatically destroyed, and loading will continue without a client certificate.

This function was introduced in Qt 5.12.

See also QWebEngineClientCertificateSelection.

[signal] void QWebEnginePage::selectionChanged()

This signal is emitted whenever the selection changes, either interactively or programmatically. For example, by calling triggerAction() with a selection action.

See also selectedText().

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

This signal is emitted whenever the title of the page changes. The title string specifies the new title.

See also title().

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

This signal is emitted with the URL of the page when the page title is received. The new URL is specified by url.

See also url().

[signal] void QWebEnginePage::windowCloseRequested()

This signal is emitted whenever the page requests the web browser window to be closed, for example through the JavaScript window.close() call.

See also RequestClose.

[virtual] QWebEnginePage::~QWebEnginePage()

Destroys the web page.

[virtual protected, since 5.5] bool QWebEnginePage::acceptNavigationRequest(const QUrl &url, QWebEnginePage::NavigationType type, bool isMainFrame)

This function is called upon receiving a request to navigate to the specified url by means of the specified navigation type type. isMainFrame indicates whether the request corresponds to the main frame or a child frame. If the function returns true, the navigation request is accepted and url is loaded. The default implementation accepts all navigation requests.

Navigation requests can be delegated to the Qt application instead of having the HTML handler engine process them by overloading this function. This is necessary when an HTML document is used as part of the user interface, and not to display external data, for example, when displaying a list of results.

The QWebEngineUrlRequestInterceptor class offers further options for intercepting and manipulating requests.

This function was introduced in Qt 5.5.

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

Returns a QAction for the specified WebAction action.

The action is owned by the QWebEnginePage but you can customize the look by changing its properties.

QWebEnginePage also takes care of implementing the action, so that upon triggering the corresponding action is performed on the page.

See also triggerAction().

[virtual protected] QStringList QWebEnginePage::chooseFiles(QWebEnginePage::FileSelectionMode mode, const QStringList &oldFiles, const QStringList &acceptedMimeTypes)

This function is called when the web content requests a file name, for example as a result of the user clicking on a file upload button in an HTML form.

mode indicates whether only one file or multiple files are expected to be returned.

A suggested filename may be provided as the first entry of oldFiles. acceptedMimeTypes is ignored by the default implementation, but might be used by overrides.

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

This function is called to create a new window of the specified type. For example, when a JavaScript program requests to open a document in a new window.

If the new window can be created, the new window's QWebEnginePage is returned; otherwise a null pointer is returned.

If the view associated with the web page is a QWebEngineView object, then the default implementation forwards the request to QWebEngineView::createWindow(); otherwise it returns a null pointer.

If this call is not implemented or does not return a new page, newWindowRequested() is emitted to handle the request.

See also QWebEngineView::createWindow() and newWindowRequested().

[since 5.11] QWebEnginePage *QWebEnginePage::devToolsPage() const

Returns the page that is hosting the developer tools of this page, if any.

Returns nullptr if no developer tools page is set.

This function was introduced in Qt 5.11.

See also setDevToolsPage() and inspectedPage().

[since 5.10] void QWebEnginePage::download(const QUrl &url, const QString &filename = QString())

Downloads the resource from the location given by url to a local file.

If filename is given, it is used as the suggested file name. If it is relative, the file is saved in the standard download location with the given name. If it is a null or empty QString, the default file name is used.

This will emit QWebEngineProfile::downloadRequested() after the download has started.

This function was introduced in Qt 5.10.

[override virtual] bool QWebEnginePage::event(QEvent *e)

Reimplements: QObject::event(QEvent *e).

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

Finds the specified string, subString, in the page, using the given options. The findTextFinished() signal is emitted when a string search is completed.

To clear the search highlight, just pass an empty string.

The resultCallback must take a QWebEngineFindTextResult parameter.

For example:

     m_view->page()->findText(QStringLiteral("Qt"), QWebEnginePage::FindFlags(), [this](bool found) {
         if (!found) QMessageBox::information(m_view, QString(), QStringLiteral("No occurrences found"));
     });

See also findTextFinished().

QWebEngineHistory *QWebEnginePage::history() const

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

[since 5.11] QWebEnginePage *QWebEnginePage::inspectedPage() const

Returns the page this page is inspecting, if any.

Returns nullptr if this page is not a developer tools page.

This function was introduced in Qt 5.11.

See also setInspectedPage() and devToolsPage().

[virtual protected] void QWebEnginePage::javaScriptAlert(const QUrl &securityOrigin, const QString &msg)

This function is called whenever a JavaScript program running in a frame affiliated with securityOrigin calls the alert() function with the message msg.

The default implementation shows the message, msg, with QMessageBox::information.

[virtual protected] bool QWebEnginePage::javaScriptConfirm(const QUrl &securityOrigin, const QString &msg)

This function is called whenever a JavaScript program running in a frame affiliated with securityOrigin calls the confirm() function with the message msg. Returns true if the user confirms the message; otherwise returns false.

It is also called when the onbeforeunload handler is requesting a confirmation before leaving a page.

The default implementation executes the query using QMessageBox::information with QMessageBox::Ok and QMessageBox::Cancel buttons.

[virtual protected] void QWebEnginePage::javaScriptConsoleMessage(QWebEnginePage::JavaScriptConsoleMessageLevel level, const QString &message, int lineNumber, const QString &sourceID)

This function is called when a JavaScript program tries to print the message to the web browser's console.

For example, in case of evaluation errors the source URL may be provided in sourceID as well as the lineNumber.

level indicates the severity of the event that triggered the message. That is, whether it was triggered by an error or a less severe event.

Since Qt 5.6, the default implementation logs the messages in a js logging category.

See also Console Logging.

[virtual protected] bool QWebEnginePage::javaScriptPrompt(const QUrl &securityOrigin, const QString &msg, const QString &defaultValue, QString *result)

This function is called whenever a JavaScript program running in a frame affiliated with securityOrigin tries to prompt the user for input. The program may provide an optional message, msg, as well as a default value for the input in defaultValue.

If the prompt was cancelled by the user, the implementation should return false; otherwise the result should be written to result and true should be returned. If the prompt was not cancelled by the user, the implementation should return true and the result string must not be null.

The default implementation uses QInputDialog::getText().

void QWebEnginePage::load(const QUrl &url)

Loads url into this page.

See also setUrl(), setHtml(), and setContent().

[since 5.9] void QWebEnginePage::load(const QWebEngineHttpRequest &request)

Issues the specified request and loads the response.

This function was introduced in Qt 5.9.

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

void QWebEnginePage::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.

See also pdfPrintingFinished().

void QWebEnginePage::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.

[since 5.5] QWebEngineProfile *QWebEnginePage::profile() const

Returns the web engine profile the page belongs to.

This function was introduced in Qt 5.5.

[since 5.8] void QWebEnginePage::replaceMisspelledWord(const QString &replacement)

Replace the current misspelled word with replacement.

The current misspelled word can be found in QWebEngineContextMenuRequest::misspelledWord(), and suggested replacements in QWebEngineContextMenuRequest::spellCheckerSuggestions().

This function was introduced in Qt 5.8.

[since 5.8] void QWebEnginePage::save(const QString &filePath, QWebEngineDownloadRequest::SavePageFormat format = QWebEngineDownloadRequest::MimeHtmlSaveFormat) const

Save the currently loaded web page to disk.

The web page is saved to filePath in the specified format.

This is a short cut for the following actions:

• Trigger the Save web action.
• Accept the next download item and set the specified file path and save format.

This function issues an asynchronous download request for the web page and returns immediately.

This function was introduced in Qt 5.8.

See also QWebEngineDownloadRequest::SavePageFormat.

QWebEngineScriptCollection &QWebEnginePage::scripts()

Returns the collection of scripts that are injected into the page.

In addition, a page might also execute scripts added through QWebEngineProfile::scripts().

See also QWebEngineScriptCollection, QWebEngineScript, and Script Injection.

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

Sets the content of the web page 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.

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

See also toHtml() and setHtml().

[since 5.11] void QWebEnginePage::setDevToolsPage(QWebEnginePage *devToolsPage)

Binds devToolsPage to be the developer tools of this page. Triggers devToolsPage to navigate to an internal URL with the developer tools.

This is the same as calling setInspectedPage() on devToolsPage with this as argument.

This function was introduced in Qt 5.11.

See also devToolsPage() and setInspectedPage().

void QWebEnginePage::setFeaturePermission(const QUrl &securityOrigin, QWebEnginePage::Feature feature, QWebEnginePage::PermissionPolicy policy)

Sets the permission for the web site identified by securityOrigin to use feature to policy.

See also featurePermissionRequested() and featurePermissionRequestCanceled().

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

Sets the content of this page to html. baseUrl is optional and used to resolve relative URLs in the document, such as referenced images or stylesheets.

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

If a script in the html runs longer than the default script timeout (currently 10 seconds), for example due to being blocked by a modal JavaScript alert dialog, this method will return as soon as possible after the timeout and any subsequent html will be loaded asynchronously.

When using this method, the web engine 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. It is also possible for the encoding to be specified by the web server.

This is a convenience function equivalent to setContent(html, "text/html", baseUrl).

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

[since 5.11] void QWebEnginePage::setInspectedPage(QWebEnginePage *page)

Navigates this page to an internal URL that is the developer tools of page.

This is the same as calling setDevToolsPage() on page with this as argument.

This function was introduced in Qt 5.11.

See also inspectedPage() and setDevToolsPage().

[since 5.13] void QWebEnginePage::setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)

Registers the request interceptor interceptor to intercept URL requests.

The page does not take ownership of the pointer. This interceptor is called after any interceptors on the profile, and unlike profile interceptors, only URL requests from this page are intercepted.

To unset the request interceptor, set a nullptr.

This function was introduced in Qt 5.13.

See also QWebEngineUrlRequestInfo and QWebEngineProfile::setUrlRequestInterceptor().

[since 5.7] void QWebEnginePage::setWebChannel(QWebChannel *channel, quint32 worldId = 0)

Sets the web channel instance to be used by this page to channel and connects it to web engine's transport using Chromium IPC messages. The transport is exposed in the JavaScript world worldId as qt.webChannelTransport, which should be used when using the Qt WebChannel JavaScript API.

This function was introduced in Qt 5.7.

See also webChannel() and QWebEngineScript::ScriptWorldId.

QWebEngineSettings *QWebEnginePage::settings() const

Returns a pointer to the page's settings object.

void QWebEnginePage::toHtml(const std::function<void (const QString &)> &resultCallback) const

Asynchronous method to retrieve the page's content as HTML, enclosed in HTML and BODY tags. Upon successful completion, resultCallback is called with the page's content.

See also setHtml() and toPlainText().

void QWebEnginePage::toPlainText(const std::function<void (const QString &)> &resultCallback) const

Asynchronous method to retrieve the page's content converted to plain text, completely stripped of all HTML formatting. Upon successful completion, resultCallback is called with the page's content.

See also toHtml().

[virtual] void QWebEnginePage::triggerAction(QWebEnginePage::WebAction action, bool checked = false)

This function can be called to trigger the specified action. It is also called by Qt WebEngine if the user triggers the action, for example through a context menu item.

If action is a checkable action, then checked specifies whether the action is toggled or not.

See also action().

[since 5.5] QWebChannel *QWebEnginePage::webChannel() const

Returns a pointer to the web channel instance used by this page or a null pointer if none was set. This channel automatically uses the internal web engine transport mechanism over Chromium IPC that is exposed in the JavaScript context of this page as qt.webChannelTransport.

This function was introduced in Qt 5.5.

See also setWebChannel().