From 2a9bf8ac5d33927d6bdd2ea7c42c2521ae672255 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Mon, 27 Jun 2016 12:33:04 +0200 Subject: Doc: Specify types of qmlsignal arguments Change-Id: I8694de2fa43eb7d343e8abcb617939dafab59ebc Reviewed-by: Joerg Bornemann --- src/webengine/doc/src/webengineview.qdoc | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) (limited to 'src/webengine/doc/src/webengineview.qdoc') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 2aeb88b26..bdee3da8e 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -474,7 +474,7 @@ */ /*! - \qmlsignal WebEngineView::loadingChanged(loadRequest) + \qmlsignal WebEngineView::loadingChanged(WebEngineLoadRequest loadRequest) This signal is emitted when a page load begins, ends, or fails. The corresponding handler is \c onLoadingChanged. @@ -507,7 +507,7 @@ */ /*! - \qmlsignal WebEngineView::certificateError(error) + \qmlsignal WebEngineView::certificateError(WebEngineCertificateError error) \since QtWebEngine 1.1 This signal is emitted when an invalid certificate error is raised while loading a given request. @@ -516,12 +516,10 @@ type. The corresponding handler is \c onCertificateError. - - \sa WebEngineCertificateError */ /*! - \qmlsignal WebEngineView::linkHovered(hoveredUrl) + \qmlsignal WebEngineView::linkHovered(url hoveredUrl) Within a mouse-driven interface, this signal is emitted when a mouse pointer passes over a link, corresponding to the \c{mouseover} DOM @@ -533,7 +531,7 @@ */ /*! - \qmlsignal WebEngineView::javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, message, lineNumber, sourceID) + \qmlsignal WebEngineView::javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, string message, int lineNumber, string sourceID) This signal is emitted when a JavaScript program tries to print a \a message to the web browser's console. For example, in case of evaluation errors the source URL may be provided in \a sourceID as well @@ -549,7 +547,7 @@ */ /*! - \qmlsignal WebEngineView::newViewRequested(request) + \qmlsignal WebEngineView::newViewRequested(WebEngineViewRequest request) \since QtWebEngine 1.1 This signal is emitted when a page load is requested to happen in a separate @@ -566,7 +564,7 @@ The corresponding handler is \c onNewViewRequested. - \sa WebEngineNewViewRequest, NewViewDestination, {WebEngine Quick Nano Browser} + \sa NewViewDestination, {WebEngine Quick Nano Browser} */ /*! @@ -578,11 +576,11 @@ The corresponding handler is \c onFullScreenRequested. - \sa WebEngineFullScreenRequest, isFullScreen + \sa isFullScreen */ /*! - \qmlsignal WebEngineView::activeFocusOnPressChanged(bool) + \qmlsignal WebEngineView::activeFocusOnPressChanged(bool activeFocusOnPress) \since QtWebEngine 1.2 This signal is emitted when the ability of the web engine view to get focus when clicked -- cgit v1.2.3 From 04c1f1a0039c7e90f31f5a8245b1d78ceff3a687 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Mon, 27 Jun 2016 12:34:41 +0200 Subject: Doc: Do not explicitly mention names of signal handlers MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit You can also connect arbitrary methods using the Connections type, or the connect() method. Anyhow, this is standard QML behavior, so no need to mention it in every signal. Change-Id: I419c74eee7ce190c44336d9f25c1a3aa30f36ab4 Reviewed-by: Michal Klocek Reviewed-by: Topi Reiniö --- src/webengine/doc/src/webengineview.qdoc | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) (limited to 'src/webengine/doc/src/webengineview.qdoc') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index bdee3da8e..5359c0349 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -477,7 +477,6 @@ \qmlsignal WebEngineView::loadingChanged(WebEngineLoadRequest loadRequest) This signal is emitted when a page load begins, ends, or fails. - The corresponding handler is \c onLoadingChanged. When handling the signal with \c onLoadingChanged, various read-only parameters are available on the \a loadRequest: @@ -514,8 +513,6 @@ The certificate error can be handled by using the methods of the WebEngineCertificateError type. - - The corresponding handler is \c onCertificateError. */ /*! @@ -526,8 +523,6 @@ event. This event may also occur in touch interfaces for \c{mouseover} events that are not cancelled with \c{preventDefault()}. \a{hoveredUrl} provides the link's location. - - The corresponding handler is \c onLinkHovered. */ /*! @@ -540,8 +535,8 @@ \a 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. - The corresponding handler is \c onJavaScriptConsoleMessage. If no handler is specified, - the view will log the messages into a \c js \l{QLoggingCategory}{logging category}. + If no handler is specified, the view will log the messages into a \c js + \l{QLoggingCategory}{logging category}. \sa{Console Logging} */ @@ -562,8 +557,6 @@ \snippet snippets/qtwebengine_webengineview_newviewrequested.qml 0 - The corresponding handler is \c onNewViewRequested. - \sa NewViewDestination, {WebEngine Quick Nano Browser} */ @@ -574,8 +567,6 @@ This signal is emitted when the web page requests fullscreen mode through the JavaScript API. - The corresponding handler is \c onFullScreenRequested. - \sa isFullScreen */ @@ -614,8 +605,6 @@ This signal is emitted whenever the page requests the web browser window to be closed, for example through the JavaScript \c{window.close()} call. - - The corresponding handler is \c onWindowCloseRequested. */ /*! -- cgit v1.2.3 From 5cb2aa149bbbdbaf45c1085b0736bb4501896827 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Fri, 22 Jul 2016 15:18:20 +0200 Subject: Doc: Link to QWebEngineProfile::downloadRequested from WebAction MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task-number: QTBUG-54644 Change-Id: Ief2e92e6baf3057cb4c1835557c51c4728c34ec0 Reviewed-by: Michael Brüning --- src/webengine/doc/src/webengineview.qdoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'src/webengine/doc/src/webengineview.qdoc') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 5359c0349..c84a4d64f 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -756,7 +756,9 @@ \value ToggleMediaMute Mute or unmute the hovered audio or video element. (Added in Qt 5.6) \value DownloadLinkToDisk - Download the current link to the disk. (Added in Qt 5.6) + Download the current link to the disk. To implement download + actions, connect to the QWebEngineProfile::downloadRequested signal. + (Added in Qt 5.6) \value DownloadImageToDisk Download the highlighted image to the disk. (Added in Qt 5.6) \value DownloadMediaToDisk -- cgit v1.2.3