From 507f46dbd702250cf2b6195ceb733c8f1e4d6bbc Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 21 Dec 2016 17:20:33 +0100 Subject: Doc: Describe missing WebEngineFullScreenRequest property and method The origin property and reject() method were not documented. Remove \since commands, because all the properties and methods were added when the type was added. Change-Id: Ic63e20fca6469b06b65af78963a968df7a236e0d Reviewed-by: Kai Koehne --- src/webengine/doc/src/webengineview.qdoc | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) (limited to 'src/webengine/doc/src') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 418da9f9d..a076b6d8c 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -1020,9 +1020,14 @@ \sa WebEngineView::fullScreenRequested() */ +/*! + \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 +1037,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. @@ -1055,6 +1059,11 @@ \sa toggleOn */ +/*! + \qmlmethod void WebEngineFullScreenRequest::reject() + Rejects a fullscreen request. +*/ + /*! \qmlproperty bool WebEngineView::audioMuted \brief The state of whether the current page audio is muted. -- cgit v1.2.3 From 5c3d41ab2cf02d3ea463ee8e2b07fc54b34d83ca Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 19 Dec 2016 11:56:42 +0100 Subject: Doc: Describe the WebEngineView.LoadStoppedStatus enum value Task-number: QTBUG-57636 Change-Id: I71aabeb670385037d938ecf130320e2aa8828331 Reviewed-by: Kai Koehne --- src/webengine/doc/src/webengineview.qdoc | 3 +++ 1 file changed, 3 insertions(+) (limited to 'src/webengine/doc/src') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index a076b6d8c..36e558c83 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -681,6 +681,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 -- cgit v1.2.3 From 4c95ac27ce18181de428fb97c421a582808d9089 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Wed, 21 Dec 2016 14:08:13 +0100 Subject: Doc: Remove return value from qmlsignal Change-Id: Id354b217a1e584c1f1766953cdfc5fc56435daa8 Reviewed-by: Leena Miettinen --- src/webengine/doc/src/webengineview.qdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/webengine/doc/src') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 36e558c83..518099c3b 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -1147,7 +1147,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 -- cgit v1.2.3 From 4bcf51ba125a8c74a71a949fbfce2e106646c0fc Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 21 Dec 2016 15:04:40 +0100 Subject: Doc: WebEngineView::runJavaScript() callback parameter is optional This is currently implied, but not stated. Use the \a command for the callback parameter. Change-Id: I4d593f19362e04f54ae555c75897c50d03c643f7 Reviewed-by: Kai Koehne --- src/webengine/doc/src/webengineview.qdoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'src/webengine/doc/src') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 518099c3b..52ca84c6b 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); }); -- cgit v1.2.3 From be24f42336537e891df2b59e2e64713571a0792a Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 21 Dec 2016 14:07:13 +0100 Subject: Doc: Describe default values for WebEngineView::printToPdf() MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The doc does not mention that two out of three parameters have default values and can be left out. Also fix the method signature to use QML conventions. Change-Id: I4c88653ce1fc5890aadce74be878098d16ae274c Reviewed-by: Michael Brüning --- src/webengine/doc/src/webengineview.qdoc | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'src/webengine/doc/src') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 52ca84c6b..2e5bde409 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -1121,11 +1121,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. */ /*! @@ -1137,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. */ /*! -- cgit v1.2.3 From 7a438e191bcc196025a43e21e2cb7bd23c00247a Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 21 Dec 2016 14:02:16 +0100 Subject: Doc: Describe the WebEngineView::navigationRequested() signal Change-Id: I78fc7ecd3e453da16e1e2c493ac4b697e4ab5bcc Reviewed-by: Kai Koehne --- src/webengine/doc/src/webengineview.qdoc | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'src/webengine/doc/src') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 2e5bde409..41b080f57 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -1247,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. +*/ -- cgit v1.2.3 From ebf7fb31be10485b614cc655b595395300d4519e Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 21 Dec 2016 12:55:23 +0100 Subject: Doc: Fix QML type name in QML signal signature Change-Id: I1cfa958c02d40f6ac1ec4d3922457d841abc5ea3 Reviewed-by: Kai Koehne --- src/webengine/doc/src/webengineview.qdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/webengine/doc/src') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 41b080f57..6e403929d 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -576,7 +576,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 -- cgit v1.2.3 From 4723e88f6ec4aeadb35d65cfebbbb471ad8eb784 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 19 Dec 2016 17:28:57 +0100 Subject: Doc: Describe WebEngineLoadRequest::errorDomain MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Remove the WebEngineLoadRequest property doc from WebEngineView::loadingChanged() method docs and add the type name to create an automatic link to the type docs. Fix a typo in the copied ErrorDomain docs. Change-Id: I9798e066d599c75a062bb7f596e4465f32d613b4 Reviewed-by: Michael Brüning --- src/webengine/doc/src/webengineview.qdoc | 26 +++----------------------- 1 file changed, 3 insertions(+), 23 deletions(-) (limited to 'src/webengine/doc/src') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 6e403929d..364fa6c8a 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -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 */ @@ -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 -- cgit v1.2.3