QWebEnginePage Class

The QWebEnginePage class provides an object to view and edit web documents. More...

Header:	#include <QWebEnginePage>
qmake:	QT += webenginewidgets
Since:	Qt 5.4
Inherits:	QObject

• List of all members, including inherited members
• Obsolete members

Public Types

enum	Feature { Geolocation, MediaAudioCapture, MediaVideoCapture, MediaAudioVideoCapture, ..., DesktopAudioVideoCapture }
enum	FileSelectionMode { FileSelectOpen, FileSelectOpenMultiple }
enum	FindFlag { FindBackward, FindCaseSensitively }
flags	FindFlags
enum	JavaScriptConsoleMessageLevel { InfoMessageLevel, WarningMessageLevel, ErrorMessageLevel }
enum	NavigationType { NavigationTypeLinkClicked, NavigationTypeTyped, NavigationTypeFormSubmitted, NavigationTypeBackForward, NavigationTypeReload, NavigationTypeOther }
enum	PermissionPolicy { PermissionUnknown, PermissionGrantedByUser, PermissionDeniedByUser }
enum	RenderProcessTerminationStatus { NormalTerminationStatus, AbnormalTerminationStatus, CrashedTerminationStatus, KilledTerminationStatus }
enum	WebAction { NoWebAction, Back, Forward, Stop, ..., InsertUnorderedList }
enum	WebWindowType { WebBrowserWindow, WebBrowserTab, WebDialog, WebBrowserBackgroundTab }

Properties

audioMuted : bool backgroundColor : QColor contentsSize : const QSizeF hasSelection : const bool icon : const QIcon iconUrl : const QUrl recentlyAudible : const bool

requestedUrl : const QUrl scrollPosition : const QPointF selectedText : const QString title : const QString url : QUrl zoomFactor : qreal

• 1 property inherited from QObject

Public Functions

	QWebEnginePage(QObject *parent = Q_NULLPTR)
	QWebEnginePage(QWebEngineProfile *profile, QObject *parent = Q_NULLPTR)
virtual	~QWebEnginePage()
QAction *	action(QWebEnginePage::WebAction action) const
QColor	backgroundColor() const
QSizeF	contentsSize() const
const QWebEngineContextMenuData &	contextMenuData() const
QMenu *	createStandardContextMenu()
QWebEnginePage *	devToolsPage() const
void	download(const QUrl &url, const QString &filename = QString())
void	findText(const QString &subString, QWebEnginePage::FindFlags options = ..., const QWebEngineCallback<bool> &resultCallback = ...)
bool	hasSelection() const
QWebEngineHistory *	history() const
QIcon	icon() const
QUrl	iconUrl() const
QWebEnginePage *	inspectedPage() const
bool	isAudioMuted() const
void	load(const QUrl &url)
void	load(const QWebEngineHttpRequest &request)
void	print(QPrinter *printer, const QWebEngineCallback<bool> &resultCallback)
void	printToPdf(const QString &filePath, const QPageLayout &pageLayout = QPageLayout(QPageSize(QPageSize::A4), QPageLayout::Portrait, QMarginsF()))
void	printToPdf(const QWebEngineCallback<const QByteArray &> &resultCallback, const QPageLayout &pageLayout = QPageLayout(QPageSize(QPageSize::A4), QPageLayout::Portrait, QMarginsF()))
QWebEngineProfile *	profile() const
bool	recentlyAudible() const
void	replaceMisspelledWord(const QString &replacement)
QUrl	requestedUrl() const
void	runJavaScript(const QString &scriptSource)
void	runJavaScript(const QString &scriptSource, quint32 worldId)
void	runJavaScript(const QString &scriptSource, const QWebEngineCallback<const QVariant &> &resultCallback)
void	runJavaScript(const QString &scriptSource, quint32 worldId, const QWebEngineCallback<const QVariant &> &resultCallback)
void	save(const QString &filePath, QWebEngineDownloadItem::SavePageFormat format = QWebEngineDownloadItem::MimeHtmlSaveFormat) const
QWebEngineScriptCollection &	scripts()
QPointF	scrollPosition() const
QString	selectedText() const
void	setAudioMuted(bool muted)
void	setBackgroundColor(const QColor &color)
void	setContent(const QByteArray &data, const QString &mimeType = QString(), const QUrl &baseUrl = QUrl())
void	setDevToolsPage(QWebEnginePage *devToolsPage)
void	setFeaturePermission(const QUrl &securityOrigin, QWebEnginePage::Feature feature, QWebEnginePage::PermissionPolicy policy)
void	setHtml(const QString &html, const QUrl &baseUrl = QUrl())
void	setInspectedPage(QWebEnginePage *page)
void	setUrl(const QUrl &url)
void	setView(QWidget *view)
void	setWebChannel(QWebChannel *channel, uint worldId)
void	setWebChannel(QWebChannel *channel)
void	setZoomFactor(qreal factor)
QWebEngineSettings *	settings() const
QString	title() const
void	toHtml(const QWebEngineCallback<const QString &> &resultCallback) const
void	toPlainText(const QWebEngineCallback<const QString &> &resultCallback) const
virtual void	triggerAction(QWebEnginePage::WebAction action, bool checked = ...)
QUrl	url() const
QWidget *	view() const
QWebChannel *	webChannel() const
qreal	zoomFactor() const

Reimplemented Public Functions

virtual bool

event(QEvent *e)

• 31 public functions inherited from QObject

Signals

void	audioMutedChanged(bool muted)
void	authenticationRequired(const QUrl &requestUrl, QAuthenticator *authenticator)
void	contentsSizeChanged(const QSizeF &size)
void	featurePermissionRequestCanceled(const QUrl &securityOrigin, QWebEnginePage::Feature feature)
void	featurePermissionRequested(const QUrl &securityOrigin, QWebEnginePage::Feature feature)
void	fullScreenRequested(QWebEngineFullScreenRequest fullScreenRequest)
void	geometryChangeRequested(const QRect &geom)
void	iconChanged(const QIcon &icon)
void	iconUrlChanged(const QUrl &url)
void	linkHovered(const QString &url)
void	loadFinished(bool ok)
void	loadProgress(int progress)
void	loadStarted()
void	pdfPrintingFinished(const QString &filePath, bool success)
void	printRequested()
void	proxyAuthenticationRequired(const QUrl &requestUrl, QAuthenticator *authenticator, const QString &proxyHost)
void	quotaRequested(QWebEngineQuotaRequest quotaRequest)
void	recentlyAudibleChanged(bool recentlyAudible)
void	registerProtocolHandlerRequested(QWebEngineRegisterProtocolHandlerRequest request)
void	renderProcessTerminated(QWebEnginePage::RenderProcessTerminationStatus terminationStatus, int exitCode)
void	scrollPositionChanged(const QPointF &position)
void	selectClientCertificate(QWebEngineClientCertificateSelection clientCertificateSelection)
void	selectionChanged()
void	titleChanged(const QString &title)
void	urlChanged(const QUrl &url)
void	windowCloseRequested()

• 2 signals inherited from QObject

Static Public Members

const QMetaObject

staticMetaObject

• 9 static public members inherited from QObject

Protected Functions

virtual bool	acceptNavigationRequest(const QUrl &url, QWebEnginePage::NavigationType type, bool isMainFrame)
virtual bool	certificateError(const QWebEngineCertificateError &certificateError)
virtual QStringList	chooseFiles(QWebEnginePage::FileSelectionMode mode, const QStringList &oldFiles, const QStringList &acceptedMimeTypes)
virtual QWebEnginePage *	createWindow(QWebEnginePage::WebWindowType type)
virtual void	javaScriptAlert(const QUrl &securityOrigin, const QString &msg)
virtual bool	javaScriptConfirm(const QUrl &securityOrigin, const QString &msg)
virtual void	javaScriptConsoleMessage(QWebEnginePage::JavaScriptConsoleMessageLevel level, const QString &message, int lineNumber, const QString &sourceID)
virtual bool	javaScriptPrompt(const QUrl &securityOrigin, const QString &msg, const QString &defaultValue, QString *result)

• 9 protected functions inherited from QObject

Additional Inherited Members

• 1 public slot inherited from QObject

Detailed Description

The QWebEnginePage class provides an object to view and edit web documents.

A web engine page holds the contents of an HTML document, the history of navigated links, and actions.

QWebEnginePage's API is very similar to QWebEngineView, as you are still provided with common functions like action() (known as pageAction() in QWebEngineView), triggerAction(), and findText().

A page can be loaded using load() or setUrl(). Alternatively, if you have the HTML content readily available, you can use setHtml(). The GET method is always used to load URLs.

The QWebEnginePage class also offers methods to retrieve both the URL currently loaded by the page (see url()) as well as the URL originally requested to be loaded (see requestedUrl()). These methods make possible the retrieval of the URL before and after a DNS resolution or a redirection occurs during the load process. The requestedUrl() also matches to the URL added to the page history (QWebEngineHistory) if load is successful.

The title of an HTML page can be accessed with the title() property. Additionally, a page may also 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 loadStarted() signal is emitted when the page begins to load, whereas the loadProgress() signal is emitted whenever an element of the web page completes loading, such as an embedded image or a script. The loadFinished() signal is emitted when the page contents have been loaded completely, independent of script execution or page rendering. Its argument, either true or false, indicates whether or not the load operation succeeded.

An HTML document is loaded in a main frame within the web page. If it references child frames (as defined by the <frame> or <iframe> elements), they are considered part of the content. Child frames are individually accessible only through JavaScript.

Web sites define security origin for safely accessing each other's resources for client-side scripting or databases. An origin consist of a host name, a scheme, and a port number. For example, the sites http://www.example.com/my/page.html and http://www.example.com/my/overview.html are allowed to share the same database or access each other's documents when used in HTML frame sets and JavaScript. At the same time, http://www.malicious.com/evil.html is prevented from accessing the resources of http://www.example.com/, because they are of a different security origin. By default, local schemes like file:// and qrc:// are considered to be in the same security origin, and can access each other's resources. Local resources are by default restricted from accessing remote content, which means that file:// will not be able to access http://domain.com/foo.html.

Scripts can be executed on the web page by using runJavaScript(), either in the main JavaScript world, along with the rest of the JavaScript coming from the web contents, or in their own isolated world. While the DOM of the page can be accessed from any world, JavaScript variables of a function defined in one world are not accessible from a different one. QWebEngineScript::ScriptWorldId provides some predefined IDs for this purpose. Using the runJavaScript() version without the world ID is the same as running the script in the MainWorld.

The FocusOnNavigationEnabled setting can be used to make the view associated with the page automatically receive focus when a navigation operation occurs (like loading or reloading a page or navigating through history).

Member Type Documentation

enum QWebEnginePage::Feature

This enum describes the platform feature access categories that the user may be asked to grant or deny access to:

Constant	Value	Description
QWebEnginePage::Geolocation	1	Location hardware or service.
QWebEnginePage::MediaAudioCapture	2	Audio capture devices, such as microphones.
QWebEnginePage::MediaVideoCapture	3	Video devices, such as cameras.
QWebEnginePage::MediaAudioVideoCapture	4	Both audio and video capture devices.
QWebEnginePage::MouseLock	5	Mouse locking, which locks the mouse pointer to the web view and is typically used in games.
QWebEnginePage::DesktopVideoCapture	6	Video output capture, that is, the capture of the user's display, for screen sharing purposes for example. (Added in Qt 5.10)
QWebEnginePage::DesktopAudioVideoCapture	7	Both audio and video output capture. (Added in Qt 5.10)

See also featurePermissionRequested(), featurePermissionRequestCanceled(), setFeaturePermission(), and PermissionPolicy.

enum QWebEnginePage::FileSelectionMode

This enum indicates whether the implementation of the chooseFiles() function should return only one file or may return multiple files:

Constant	Value	Description
QWebEnginePage::FileSelectOpen	0	Return only one file name.
QWebEnginePage::FileSelectOpenMultiple	1	Return multiple file names.

See also chooseFiles().

enum QWebEnginePage::FindFlagflags QWebEnginePage::FindFlags

This enum describes the options available to the findText() function. The options can be OR-ed together from the following list:

Constant	Value	Description
QWebEnginePage::FindBackward	1	Searches backwards instead of forwards.
QWebEnginePage::FindCaseSensitively	2	By default findText() works case insensitive. Specifying this option changes the behavior to a case sensitive find operation.

The FindFlags type is a typedef for QFlags<FindFlag>. It stores an OR combination of FindFlag values.

enum QWebEnginePage::JavaScriptConsoleMessageLevel

This enum describes the different severity levels a JavaScript console message can have:

Constant	Value	Description
QWebEnginePage::InfoMessageLevel	0	The message is purely informative and can safely be ignored.
QWebEnginePage::WarningMessageLevel	1	The message informs about unexpected behavior or errors that may need attention.
QWebEnginePage::ErrorMessageLevel	2	The message indicates there has been an error.

enum QWebEnginePage::NavigationType

This enum describes the type of a navigation request:

Constant	Value	Description
QWebEnginePage::NavigationTypeLinkClicked	0	The navigation request resulted from a clicked link.
QWebEnginePage::NavigationTypeTyped	1	The navigation request resulted from an explicitly loaded URL.
QWebEnginePage::NavigationTypeFormSubmitted	2	The navigation request resulted from a form submission.
QWebEnginePage::NavigationTypeBackForward	3	The navigation request resulted from a back or forward action.
QWebEnginePage::NavigationTypeReload	4	The navigation request resulted from a reload action.
QWebEnginePage::NavigationTypeOther	5	The navigation request was triggered by other means not covered by the above.

See also acceptNavigationRequest().

enum QWebEnginePage::PermissionPolicy

This enum describes the permission policies that the user may set for data or device access:

Constant	Value	Description
QWebEnginePage::PermissionUnknown	0	It is unknown whether the user grants or denies permission.
QWebEnginePage::PermissionGrantedByUser	1	The user has granted permission.
QWebEnginePage::PermissionDeniedByUser	2	The user has denied permission.

See also featurePermissionRequested(), featurePermissionRequestCanceled(), setFeaturePermission(), and Feature.

enum QWebEnginePage::RenderProcessTerminationStatus

This enum describes the status with which the render process terminated:

Constant	Value	Description
QWebEnginePage::NormalTerminationStatus	0	The render process terminated normally.
QWebEnginePage::AbnormalTerminationStatus	1	The render process terminated with with a non-zero exit status.
QWebEnginePage::CrashedTerminationStatus	2	The render process crashed, for example because of a segmentation fault.
QWebEnginePage::KilledTerminationStatus	3	The render process was killed, for example by SIGKILL or task manager kill.

This enum was introduced or modified in Qt 5.6.

enum QWebEnginePage::WebAction

This enum describes the types of action which can be performed on the web page.

Actions only have an effect when they are applicable.

The availability of actions can be be determined by checking isEnabled() on the action returned by action(). Context-dependent actions are always enabled.

Constant	Value	Description
QWebEnginePage::NoWebAction	- 1	No action is triggered.
QWebEnginePage::Back	0	Navigate back in the history of navigated links.
QWebEnginePage::Forward	1	Navigate forward in the history of navigated links.
QWebEnginePage::Stop	2	Stop loading the current page.
QWebEnginePage::Reload	3	Reload the current page.
QWebEnginePage::ReloadAndBypassCache	10	Reload the current page, but do not use any local cache.
QWebEnginePage::Cut	4	Cut the content currently selected into the clipboard.
QWebEnginePage::Copy	5	Copy the content currently selected into the clipboard.
QWebEnginePage::Paste	6	Paste content from the clipboard.
QWebEnginePage::Undo	7	Undo the last editing action.
QWebEnginePage::Redo	8	Redo the last editing action.
QWebEnginePage::SelectAll	9	Select all content.
QWebEnginePage::PasteAndMatchStyle	11	Paste content from the clipboard with current style.
QWebEnginePage::OpenLinkInThisWindow	12	Open the current link in the current window. (Added in Qt 5.6)
QWebEnginePage::OpenLinkInNewWindow	13	Open the current link in a new window. Requires implementation of createWindow(). (Added in Qt 5.6)
QWebEnginePage::OpenLinkInNewTab	14	Open the current link in a new tab. Requires implementation of createWindow(). (Added in Qt 5.6)
QWebEnginePage::OpenLinkInNewBackgroundTab	31	Open the current link in a new background tab. Requires implementation of createWindow(). (Added in Qt 5.7)
QWebEnginePage::CopyLinkToClipboard	15	Copy the current link to the clipboard. (Added in Qt 5.6)
QWebEnginePage::CopyImageToClipboard	17	Copy the clicked image to the clipboard. (Added in Qt 5.6)
QWebEnginePage::CopyImageUrlToClipboard	18	Copy the clicked image's URL to the clipboard. (Added in Qt 5.6)
QWebEnginePage::CopyMediaUrlToClipboard	20	Copy the hovered audio or video's URL to the clipboard. (Added in Qt 5.6)
QWebEnginePage::ToggleMediaControls	21	Toggle between showing and hiding the controls for the hovered audio or video element. (Added in Qt 5.6)
QWebEnginePage::ToggleMediaLoop	22	Toggle whether the hovered audio or video should loop on completetion or not. (Added in Qt 5.6)
QWebEnginePage::ToggleMediaPlayPause	23	Toggle the play/pause state of the hovered audio or video element. (Added in Qt 5.6)
QWebEnginePage::ToggleMediaMute	24	Mute or unmute the hovered audio or video element. (Added in Qt 5.6)
QWebEnginePage::DownloadLinkToDisk	16	Download the current link to the disk. Requires a slot for downloadRequested(). (Added in Qt 5.6)
QWebEnginePage::DownloadImageToDisk	19	Download the highlighted image to the disk. Requires a slot for downloadRequested(). (Added in Qt 5.6)
QWebEnginePage::DownloadMediaToDisk	25	Download the hovered audio or video to the disk. Requires a slot for downloadRequested(). (Added in Qt 5.6)
QWebEnginePage::InspectElement	26	Trigger any attached Web Inspector to inspect the highlighed element. (Added in Qt 5.6)
QWebEnginePage::ExitFullScreen	27	Exit the fullscreen mode. (Added in Qt 5.6)
QWebEnginePage::RequestClose	28	Request to close the web page. If defined, the window.onbeforeunload handler is run, and the user can confirm or reject to close the page. If the close request is confirmed, windowCloseRequested is emitted. (Added in Qt 5.6)
QWebEnginePage::Unselect	29	Clear the current selection. (Added in Qt 5.7)
QWebEnginePage::SavePage	30	Save the current page to disk. MHTML is the default format that is used to store the web page on disk. Requires a slot for downloadRequested(). (Added in Qt 5.7)
QWebEnginePage::ViewSource	32	Show the source of the current page in a new tab. Requires implementation of createWindow(). (Added in Qt 5.8)
QWebEnginePage::ToggleBold	33	Toggles boldness for the selection or at the cursor position. Requires contenteditable="true". (Added in Qt 5.10)
QWebEnginePage::ToggleItalic	34	Toggles italics for the selection or at the cursor position. Requires contenteditable="true". (Added in Qt 5.10)
QWebEnginePage::ToggleUnderline	35	Toggles underlining of the selection or at the cursor position. Requires contenteditable="true". (Added in Qt 5.10)
QWebEnginePage::ToggleStrikethrough	36	Toggles striking through the selection or at the cursor position. Requires contenteditable="true". (Added in Qt 5.10)
QWebEnginePage::AlignLeft	37	Aligns the lines containing the selection or the cursor to the left. Requires contenteditable="true". (Added in Qt 5.10)
QWebEnginePage::AlignCenter	38	Aligns the lines containing the selection or the cursor at the center. Requires contenteditable="true". (Added in Qt 5.10)
QWebEnginePage::AlignRight	39	Aligns the lines containing the selection or the cursor to the right. Requires contenteditable="true". (Added in Qt 5.10)
QWebEnginePage::AlignJustified	40	Stretches the lines containing the selection or the cursor so that each line has equal width. Requires contenteditable="true". (Added in Qt 5.10)
QWebEnginePage::Indent	41	Indents the lines containing the selection or the cursor. Requires contenteditable="true". (Added in Qt 5.10)
QWebEnginePage::Outdent	42	Outdents the lines containing the selection or the cursor. Requires contenteditable="true". (Added in Qt 5.10)
QWebEnginePage::InsertOrderedList	43	Inserts an ordered list at the current cursor position, deleting the current selection. Requires contenteditable="true". (Added in Qt 5.10)
QWebEnginePage::InsertUnorderedList	44	Inserts an unordered list at the current cursor position, deleting the current selection. Requires contenteditable="true". (Added in Qt 5.10)

enum QWebEnginePage::WebWindowType

This enum describes the types of window that can be created by the createWindow() function:

Constant	Value	Description
QWebEnginePage::WebBrowserWindow	0	A complete web browser window.
QWebEnginePage::WebBrowserTab	1	A web browser tab.
QWebEnginePage::WebDialog	2	A window without decoration.
QWebEnginePage::WebBrowserBackgroundTab	3	A web browser tab without hiding the current visible WebEngineView. (Added in Qt 5.7)

Member Function Documentation

Runs the JavaScript code contained in scriptSource in the world specified by worldId. The world ID values are the same as provided by QWebEngineScript::ScriptWorldId, and between 0 and 256. Using the runJavaScript() versions without the world ID is the same as running the script 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.

Warning: Do not execute lengthy routines in the callback function, because it might block the rendering of the web engine page.

Warning: We guarantee that the callback (resultCallback) is always called, but it might be done during page destruction. When QWebEnginePage is deleted, the callback is triggered with an invalid value and it is not safe to use the corresponding QWebEnginePage or QWebEngineView instance inside it.

See scripts() for an alternative API to inject scripts.

This documentation was introduced in Qt 5.7.

See also QWebEngineScript::ScriptWorldId.

QWebEnginePage::QWebEnginePage(QObject *parent = Q_NULLPTR)

Constructs an empty QWebEnginePage with the parent parent.

QWebEnginePage::QWebEnginePage(QWebEngineProfile *profile, QObject *parent = Q_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.

[virtual] QWebEnginePage::~QWebEnginePage()

Destroys the web page.

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

This function is called for absolute URLs that are prefixed with http:// or https:// and for unrecognized schemes, such as mailto:, which will be handled by QDesktopServices if accepted. To have this function called also upon receiving navigation requests to local URLs, prefix the URLs with http://.

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.

Note: The loading process is started and the loadStarted() signal is emitted before the request is accepted or rejected. Therefore, a loadFinished() signal that returns false is to be expected even after delegating the request.

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

[signal] void QWebEnginePage::audioMutedChanged(bool muted)

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

Note: Not to be confused with a specific HTML5 audio or video element being muted.

This function was introduced in Qt 5.7.

Note: Notifier signal for property audioMuted.

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

[virtual protected] bool QWebEnginePage::certificateError(const QWebEngineCertificateError &certificateError)

This function is called 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.

Return true to ignore the error and complete the request. Return false to stop loading the request.

See also QWebEngineCertificateError.

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

const QWebEngineContextMenuData &QWebEnginePage::contextMenuData() const

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

This function was introduced in Qt 5.7.

See also createStandardContextMenu().

QMenu *QWebEnginePage::createStandardContextMenu()

Creates the standard context menu which is shown when the user clicks on the web page with the right mouse button. It is called from the default contextMenuEvent() handler. The popup menu's ownership is transferred to the caller.

Returns nullptr if the context menu data is not initialized, for example when it is called when there is actually no context menu requested.

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

Note: In the cases when the window creation is being triggered by JavaScript, apart from reimplementing this method the application must also set QWebEngineSettings::JavascriptCanOpenWindows to true in order for the method to get called.

See also QWebEngineView::createWindow().

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

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.

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

Reimplemented from QObject::event().

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

void QWebEnginePage::findText(const QString &subString, QWebEnginePage::FindFlags options = ..., const QWebEngineCallback<bool> &resultCallback = ...)

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

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

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

Warning: We guarantee that the callback (resultCallback) is always called, but it might be done during page destruction. When QWebEnginePage is deleted, the callback is triggered with an invalid value and it is not safe to use the corresponding QWebEnginePage or QWebEngineView instance inside it.

For example:

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

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

Note: setGeometry() expects a size excluding the window decoration, while geom includes it. You have to remove the size of the frame margins from geom to handle this signal correctly.

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

QWebEngineHistory *QWebEnginePage::history() const

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

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

This function was introduced in Qt 5.7.

Note: Notifier signal for property icon.

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

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

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

void QWebEnginePage::load(const QUrl &url)

Loads url into this page.

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

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

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

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

Note: Navigation requests can be delegated to the Qt application instead of having the HTML handler engine process them by overloading the acceptNavigationRequest() function. Because the loading process is started and the loadStarted() signal is emitted before the request is accepted or rejected, a loadFinished() signal that returns false is to be expected even after delegating the request.

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

This function was introduced in Qt 5.9.

See also printToPdf().

void QWebEnginePage::print(QPrinter *printer, const QWebEngineCallback<bool> &resultCallback)

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. It is the users responsibility to ensure the printer remains valid until resultCallback has been called.

Note: The rendering of the current content into a temporary PDF document is asynchronous and does not block the main thread. However, the subsequent rendering of PDF into printer runs on the main thread and will therefore block the event loop. Moreover, printing runs on the browser process, which is by default not sandboxed.

The resultCallback must take a boolean as parameter. If printing was successful, this boolean will have the value true, otherwise, its value will be false.

Warning: We guarantee that the callback (resultCallback) is always called, but it might be done during page destruction. When QWebEnginePage is deleted, the callback is triggered with an invalid value and it is not safe to use the corresponding QWebEnginePage or QWebEngineView instance inside it.

This function was introduced in Qt 5.8.

[signal] void QWebEnginePage::printRequested()

This signal is emitted when the JavaScript window.print() method is called. Typically, the signal handler can simply call printToPdf().

This function was introduced in Qt 5.12.

See also printToPdf().

void QWebEnginePage::printToPdf(const QString &filePath, const QPageLayout &pageLayout = QPageLayout(QPageSize(QPageSize::A4), QPageLayout::Portrait, QMarginsF()))

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

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

See also pdfPrintingFinished().

void QWebEnginePage::printToPdf(const QWebEngineCallback<const QByteArray &> &resultCallback, const QPageLayout &pageLayout = QPageLayout(QPageSize(QPageSize::A4), QPageLayout::Portrait, QMarginsF()))

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

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.

Warning: We guarantee that the callback (resultCallback) is always called, but it might be done during page destruction. When QWebEnginePage is deleted, the callback is triggered with an invalid value and it is not safe to use the corresponding QWebEnginePage or QWebEngineView instance inside it.

This function was introduced in Qt 5.7.

QWebEngineProfile *QWebEnginePage::profile() const

Returns the web engine profile the page belongs to.

This function was introduced in Qt 5.5.

[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] 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] 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: The signal is also emitted when calling the setAudioMuted() method. Also, if the audio is paused, this signal is emitted with an approximate two-second delay, from the moment the audio is paused.

This function was introduced in Qt 5.7.

Note: Notifier signal for property recentlyAudible.

[signal] 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 WebPage::handleRegisterProtocolHandlerRequested(QWebEngineRegisterProtocolHandlerRequest request)
{
    auto answer = QMessageBox::question(
        view()->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] 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.

void QWebEnginePage::replaceMisspelledWord(const QString &replacement)

Replace the current misspelled word with replacement.

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

This function was introduced in Qt 5.8.

See also contextMenuData().

void QWebEnginePage::save(const QString &filePath, QWebEngineDownloadItem::SavePageFormat format = QWebEngineDownloadItem::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 QWebEngineDownloadItem::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 and QWebEngineScript.

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

Note: When using the mouse to select text by left-clicking and dragging, the signal will be emitted for each new character selected, and not upon releasing the left mouse button.

See also selectedText().

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.

Note: This method will not affect session or global history for the page.

Warning: The content will be percent encoded before being sent to the renderer via IPC. This may increase its size. The maximum size of the percent encoded content is 2 megabytes minus 6 bytes plus the length of the mime type string.

See also toHtml() and setHtml().

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.

Note: Call this method on the featurePermissionRequested() signal, as it is meant to serve pending feature requests only. Setting feature permissions ahead of a request has no effect.

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

Note: This method will not affect session or global history for the page.

Warning: This function works only for HTML, for other mime types (such as XHTML and SVG) setContent() should be used instead.

Warning: The content will be percent encoded before being sent to the renderer via IPC. This may increase its size. The maximum size of the percent encoded content is 2 megabytes minus 30 bytes.

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

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

void QWebEnginePage::setView(QWidget *view)

Sets the view that is associated with the web page.

See also view().

void QWebEnginePage::setWebChannel(QWebChannel *channel, uint worldId)

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.

Note: The page does not take ownership of the channel object.

Note: Only one web channel can be installed per page, setting one even in another JavaScript world uninstalls any already installed web channel.

This function was introduced in Qt 5.7.

See also webChannel() and QWebEngineScript::ScriptWorldId.

void QWebEnginePage::setWebChannel(QWebChannel *channel)

This is an overloaded function.

Sets the web channel instance to be used by this page to channel and installs it in the main JavaScript world.

With this method the web channel can be accessed by web page content. If the content is not under your control and might be hostile, this could be a security issue and you should consider installing it in a private JavaScript world.

This function was introduced in Qt 5.5.

See also QWebEngineScript::MainWorld.

QWebEngineSettings *QWebEnginePage::settings() const

Returns a pointer to the page's settings object.

See also QWebEngineSettings::globalSettings().

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

void QWebEnginePage::toHtml(const QWebEngineCallback<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.

Note: resultCallback can be any of a function pointer, a functor or a lambda, and it is expected to take a QString parameter.

Warning: We guarantee that the callback (resultCallback) is always called, but it might be done during page destruction. When QWebEnginePage is deleted, the callback is triggered with an invalid value and it is not safe to use the corresponding QWebEnginePage or QWebEngineView instance inside it.

See also setHtml() and toPlainText().

void QWebEnginePage::toPlainText(const QWebEngineCallback<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.

Note: resultCallback can be any of a function pointer, a functor or a lambda, and it is expected to take a QString parameter.

Warning: We guarantee that the callback (resultCallback) is always called, but it might be done during page destruction. When QWebEnginePage is deleted, the callback is triggered with an invalid value and it is not safe to use the corresponding QWebEnginePage or QWebEngineView instance inside it.

See also toHtml().

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

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

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

QWidget *QWebEnginePage::view() const

Returns the view widget that is associated with the web page.

See also setView().

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

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