diff options
| author | Alexandru Croitor <alexandru.croitor@theqtcompany.com> | 2016-04-05 15:33:38 +0200 |
|---|---|---|
| committer | Alexandru Croitor <alexandru.croitor@theqtcompany.com> | 2016-04-08 09:05:54 +0000 |
| commit | 8b587a85efaf73082dd6522f757ea7c6d1b33aae (patch) | |
| tree | ea62451e081e863c6be8216ffe4bb23fe06fc8a1 /src/webengine/doc/src/webengineview.qdoc | |
| parent | d1d83b229b1a015d40fec943e7b9018053b0d59d (diff) | |
Fix recentlyAudible Widgets and Quick API.
Rename all uses of wasRecentlyAudible to recentlyAudible.
Add missing recentlyAudible properties.
Change QtQuick slots to simple functions.
Change affected demobrowser example.
Adjust documentation for the API.
Change-Id: I5a6f7b8384c0b7e34afaa5c412a5543c210d3ef9
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Reviewed-by: Michal Klocek <michal.klocek@theqtcompany.com>
Diffstat (limited to 'src/webengine/doc/src/webengineview.qdoc')
| -rw-r--r-- | src/webengine/doc/src/webengineview.qdoc | 40 |
1 files changed, 22 insertions, 18 deletions
diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index bcabe2152..a52c6c248 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -1033,22 +1033,39 @@ \qmlproperty bool WebEngineView::audioMuted \brief The state of whether the current page audio is muted. \since QtWebEngine 1.3 + \sa recentlyAudible */ /*! - \qmlsignal void WebEngineView::audioMutedChanged(bool muted) + \qmlsignal WebEngineView::audioMutedChanged(bool muted) \since QtWebEngine 1.3 - This signal is emitted when the page's audio is (un)muted using setAudioMuted method. + This signal is emitted when the page's audio is (un)muted using audioMuted property. \note Not to be confused with a specific HTML5 audio / video element being muted. + + \sa audioMuted +*/ + +/*! + \qmlproperty bool WebEngineView::recentlyAudible + \brief Returns the current page's audible state (audio was recently played, or not). + \since QtWebEngine 1.3 + \readonly + \sa audioMuted */ /*! - \qmlmethod bool WebEngineView::wasRecentlyAudible() + \qmlsignal WebEngineView::recentlyAudibleChanged(bool recentlyAudible) \since QtWebEngine 1.3 - \sa wasRecentlyAudibleChanged() - Returns the current page's audible state (audio was recently played, or not). + This signal is emitted when the page's audible state is changed, due to audio + being played or stopped. + + \note The signal is also emitted when the audioMuted property changes. + Also if the audio is paused, this signal is emitted with an approximate \b{two-second + delay}, from the moment the audio is paused. + + \sa recentlyAudible */ /*! @@ -1069,16 +1086,3 @@ The \a resultCallback must take a string parameter. This string will contain the document's data upon successful printing and an empty string otherwise. */ - - -/*! - \qmlsignal void WebEngineView::wasRecentlyAudibleChanged(bool wasRecentlyAudible) - \since QtWebEngine 1.3 - - This signal is emitted when the page's audible state is changed, due to audio - being 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 \b{2 second - delay}, from the moment the audio is paused. -*/ |