summaryrefslogtreecommitdiffstats
path: root/src/webengine/doc
diff options
context:
space:
mode:
authorAllan Sandfeld Jensen <allan.jensen@qt.io>2017-01-18 12:59:54 +0100
committerAllan Sandfeld Jensen <allan.jensen@qt.io>2017-01-18 13:02:22 +0100
commitc2447a308882ba3691d66b2c28df197f571518c7 (patch)
treec6535d8e038a517f06ddbef9fee649412555b8ae /src/webengine/doc
parentb63a932bbe1eb2bdf2584e44378ac3fab243320c (diff)
parent42c6033724e2b5a54702d626c57806e53f163c62 (diff)
Merge remote-tracking branch 'origin/5.8' into dev
Diffstat (limited to 'src/webengine/doc')
-rw-r--r--src/webengine/doc/src/qtwebengine-deploying.qdoc2
-rw-r--r--src/webengine/doc/src/webengineview.qdoc62
2 files changed, 33 insertions, 31 deletions
diff --git a/src/webengine/doc/src/qtwebengine-deploying.qdoc b/src/webengine/doc/src/qtwebengine-deploying.qdoc
index 25b6d218c..351ef49de 100644
--- a/src/webengine/doc/src/qtwebengine-deploying.qdoc
+++ b/src/webengine/doc/src/qtwebengine-deploying.qdoc
@@ -31,7 +31,7 @@
The way to package and deploy applications varies between operating systems.
For Windows and \macos, \l{The Windows Deployment Tool}{windeployqt} and
- \l{Deploying Applications on OS X}{macdeployqt} automate the steps to
+ \l{Deploying Applications on macOS}{macdeployqt} automate the steps to
generate a stand-alone application package.
When manually deploying applications that depend on Qt WebEngine, all the
diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc
index 8135cad53..160cb4415 100644
--- a/src/webengine/doc/src/webengineview.qdoc
+++ b/src/webengine/doc/src/webengineview.qdoc
@@ -387,8 +387,8 @@
\qmlmethod void WebEngineView::runJavaScript(string script, variant callback)
Runs the specified \a script in the content of the web view.
- In case a callback function is provided, it will be invoked after the script
- finishes running.
+ The \a callback parameter is optional. If a callback function is provided,
+ it will be invoked after the script finishes running.
\code
runJavaScript("document.title", function(result) { console.log(result); });
@@ -513,28 +513,8 @@
This signal is emitted when a page load begins, ends, or fails.
When handling the signal with \c onLoadingChanged, various read-only
- parameters are available on the \a loadRequest:
-
- \table
- \header
- \li Property
- \li Description
- \row
- \li url
- \li The location of the resource that is loading.
- \row
- \li status
- \li The \l{LoadStatus}{load status} of the page.
- \row
- \li errorString
- \li The description of load error.
- \row
- \li errorCode
- \li The HTTP error code.
- \row
- \li errorDomain
- \li The high-level \l{ErrorDomain}{error type}.
- \endtable
+ parameters are available on the WebEngineLoadRequest specified by
+ \a loadRequest.
\sa loading, LoadStatus, ErrorDomain
*/
@@ -576,7 +556,7 @@
*/
/*!
- \qmlsignal WebEngineView::newViewRequested(WebEngineViewRequest request)
+ \qmlsignal WebEngineView::newViewRequested(WebEngineNewViewRequest request)
\since QtWebEngine 1.1
This signal is emitted when a page load is requested to happen in a separate
@@ -652,7 +632,7 @@
\value WebEngineView.ConnectionErrorDomain
Error results from faulty network connection.
\value WebEngineView.CertificateErrorDomain
- Error related to the SSL/TLS certficate.
+ Error related to the SSL/TLS certificate.
\value WebEngineView.HttpErrorDomain
Error related to the HTTP connection.
\value WebEngineView.FtpErrorDomain
@@ -681,6 +661,9 @@
\value WebEngineView.LoadStartedStatus
Page is currently loading.
+ \value WebEngineView.LoadStoppedStatus
+ Loading the page was stopped by the stop() method or by the loader
+ code or network stack in Chromium.
\value WebEngineView.LoadSucceededStatus
Page has successfully loaded, and is not currently loading.
\value WebEngineView.LoadFailedStatus
@@ -1021,8 +1004,13 @@
*/
/*!
+ \qmlproperty url WebEngineFullScreenRequest::origin
+ \readonly
+ The URL of the web page that issued the fullscreen request.
+*/
+
+/*!
\qmlproperty bool WebEngineFullScreenRequest::toggleOn
- \since QtWebEngine 1.1
\readonly
Returns \c{true} if the application should toggle fullscreen mode on, \c{false} otherwise.
@@ -1032,7 +1020,6 @@
/*!
\qmlmethod void WebEngineFullScreenRequest::accept()
- \since QtWebEngine 1.1
Call this method to accept the fullscreen request. It sets the WebEngineView::isFullScreen
property to be equal to toggleOn.
@@ -1056,6 +1043,11 @@
*/
/*!
+ \qmlmethod void WebEngineFullScreenRequest::reject()
+ Rejects a fullscreen request.
+*/
+
+/*!
\qmlproperty bool WebEngineView::audioMuted
\brief The state of whether the current page audio is muted.
\since QtWebEngine 1.3
@@ -1122,7 +1114,7 @@
*/
/*!
- \qmlmethod void WebEngineView::printToPdf(const QString &filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation)
+ \qmlmethod void WebEngineView::printToPdf(const string filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation)
\since QtWebEngine 1.3
Prints the WebEngineView's current content to a PDF document and stores it
@@ -1133,6 +1125,9 @@
PDF and returns immediately. To be informed about the result of the
request, connect to the signal pdfPrintingFinished().
+ If you leave out \a pageSizeID, it defaults to \c A4. If you leave out
+ \a orientation, it defaults to \c Portrait.
+
\sa pdfPrintingFinished()
*/
@@ -1145,6 +1140,9 @@
The \a resultCallback must take a string parameter. This string will contain the document's data upon successful printing and an empty
string otherwise.
+
+ If you leave out \a pageSizeID, it defaults to \c A4. If you leave out
+ \a orientation, it defaults to \c Portrait.
*/
/*!
@@ -1155,7 +1153,7 @@
*/
/*!
- \qmlsignal void WebEngineView::wasRecentlyAudibleChanged(bool wasRecentlyAudible)
+ \qmlsignal WebEngineView::wasRecentlyAudibleChanged(bool wasRecentlyAudible)
\since QtWebEngine 1.3
This signal is emitted when the page's audible state is changed, due to audio
@@ -1249,3 +1247,7 @@
\note Signal handlers need to call \c{request.accepted = true} to prevent a
default context menu from showing up.
*/
+
+/*! \qmlsignal WebEngineView::navigationRequested(WebEngineNavigationRequest request)
+ This signal is emitted when the navigation request \a request is issued.
+*/