diff options
author | Allan Sandfeld Jensen <allan.jensen@qt.io> | 2017-01-16 12:26:49 +0100 |
---|---|---|
committer | Allan Sandfeld Jensen <allan.jensen@qt.io> | 2017-01-16 12:27:24 +0100 |
commit | 7a85314056409b79c0db44f9bb7a2258a6ed557f (patch) | |
tree | 53a2c734a3bdaaf3b4f303c10f09624661f6dd78 /src/webengine/doc | |
parent | ceff67e0bab4d34c5b791d1f1b1d43c7a4e44d84 (diff) | |
parent | d740d6a7dbfec387752c7bc8a8b06db0e757c9dc (diff) |
Merge remote-tracking branch 'origin/5.8.0' into 5.8
Change-Id: I6b16bee2d0034865270fb26a5ad93da05b9129fa
Diffstat (limited to 'src/webengine/doc')
-rw-r--r-- | src/webengine/doc/src/webengineview.qdoc | 62 |
1 files changed, 32 insertions, 30 deletions
diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 418da9f9d..364fa6c8a 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 @@ -1109,11 +1101,14 @@ */ /*! - \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 under \a filePath. The document's size will be determined by the value of \a pageSizeId and its orientation will be determined using \a orientation. + + If you leave out \a pageSizeID, it defaults to \c A4. If you leave out + \a orientation, it defaults to \c Portrait. */ /*! @@ -1125,6 +1120,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. */ /*! @@ -1135,7 +1133,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 @@ -1229,3 +1227,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. +*/ |