diff options
author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2016-01-27 16:08:34 +0100 |
---|---|---|
committer | Alexandru Croitor <alexandru.croitor@theqtcompany.com> | 2016-02-01 08:42:22 +0000 |
commit | 58ab69474b45deab3f333a00daf18f246f283f20 (patch) | |
tree | 39776c6257bb51d81223b3457d8efc0e16738098 | |
parent | 0ceb6fa0871b97dceeeb99cfcca9559cad02ef07 (diff) |
Doc: move and edit docs related to QWebEnginePage::audioMuted
New docs should be placed in the source files. Edited the docs
to fix grammar issues and QDoc errors.
Change-Id: I9f7b1aadccb8a9eac4f93a63e6ce01da82f71eb2
Reviewed-by: Alexandru Croitor <alexandru.croitor@theqtcompany.com>
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@theqtcompany.com>
-rw-r--r-- | src/webenginewidgets/api/qwebenginepage.cpp | 31 | ||||
-rw-r--r-- | src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc | 34 |
2 files changed, 29 insertions, 36 deletions
diff --git a/src/webenginewidgets/api/qwebenginepage.cpp b/src/webenginewidgets/api/qwebenginepage.cpp index 7d57efebc..d68f364e4 100644 --- a/src/webenginewidgets/api/qwebenginepage.cpp +++ b/src/webenginewidgets/api/qwebenginepage.cpp @@ -527,6 +527,26 @@ QWebEnginePage::QWebEnginePage(QObject* parent) */ /*! + \fn void QWebEnginePage::audioMutedChanged(bool muted) + \since 5.7 + + This signal is emitted when the page's \a muted state changes. + \note Not to be confused with a specific HTML5 audio or video element being muted. +*/ + +/*! + \fn void QWebEnginePage::wasRecentlyAudibleChanged(bool wasRecentlyAudible); + \since 5.7 + + This signal is emitted when the page's audible state, \a wasRecentlyAudible, changes, because + the audio is 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 \e {two-second + delay}, from the moment the audio is paused. +*/ + +/*! Constructs an empty web engine page in the web engine profile \a profile with the parent \a parent. @@ -643,10 +663,10 @@ void QWebEnginePage::setBackgroundColor(const QColor &color) /*! \property QWebEnginePage::audioMuted - \brief the state of whether the current page audio is muted. + \brief whether the current page audio is muted. \since 5.7 - The default value is false. + The default value is \c false. */ bool QWebEnginePage::isAudioMuted() const { const Q_D(QWebEnginePage); @@ -662,6 +682,13 @@ void QWebEnginePage::setAudioMuted(bool muted) { } } +/*! + \since 5.7 + \sa wasRecentlyAudibleChanged() + + Returns the current page's \e {audible state}, that is, whether audio was recently played + or not. +*/ bool QWebEnginePage::wasRecentlyAudible() { Q_D(QWebEnginePage); diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc index e09561bef..d3c540016 100644 --- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc @@ -690,37 +690,3 @@ \sa iconUrl() */ - -/*! - \property QWebEnginePage::audioMuted - \brief the state of whether the current page audio is muted. - \since 5.7 -*/ - -/*! - \fn void QWebEnginePage::audioMutedChanged(bool muted) - \since 5.7 - - This signal is emitted when the page's audio is (un)muted using setAudioMuted method. - \note Not to be confused with a specific HTML5 audio / video element being muted. -*/ - -/*! - \fn bool QWebEnginePage::wasRecentlyAudible() - \since 5.7 - \sa wasRecentlyAudibleChanged() - - Returns the current page's audible state (audio was recently played, or not). -*/ - -/*! - \fn void QWebEnginePage::wasRecentlyAudibleChanged(bool wasRecentlyAudible); - \since 5.7 - - 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. -*/ |