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>

11 files changed, 58 insertions, 47 deletions

diff --git a/src/core/web_contents_adapter.cpp b/src/core/web_contents_adapter.cpp
index 71d2172fe..7ac3ad72b 100644
--- a/src/core/web_contents_adapter.cpp
+++ b/src/core/web_contents_adapter.cpp
@@ -847,7 +847,7 @@ void WebContentsAdapter::setAudioMuted(bool muted)
     d->webContents->SetAudioMuted(muted);
 }
 
-bool WebContentsAdapter::wasRecentlyAudible()
+bool WebContentsAdapter::recentlyAudible()
 {
     Q_D(WebContentsAdapter);
     return d->webContents->WasRecentlyAudible();
diff --git a/src/core/web_contents_adapter.h b/src/core/web_contents_adapter.h
index 600e759e2..454215359 100644
--- a/src/core/web_contents_adapter.h
+++ b/src/core/web_contents_adapter.h
@@ -124,7 +124,7 @@ public:
     void download(const QUrl &url, const QString &suggestedFileName);
     bool isAudioMuted() const;
     void setAudioMuted(bool mute);
-    bool wasRecentlyAudible();
+    bool recentlyAudible();
 
     // Must match blink::WebMediaPlayerAction::Type.
     enum MediaPlayerAction {
diff --git a/src/core/web_contents_adapter_client.h b/src/core/web_contents_adapter_client.h
index 559898411..93ba2fe3e 100644
--- a/src/core/web_contents_adapter_client.h
+++ b/src/core/web_contents_adapter_client.h
@@ -212,7 +212,7 @@ public:
     virtual void loadProgressChanged(int progress) = 0;
     virtual void didUpdateTargetURL(const QUrl&) = 0;
     virtual void selectionChanged() = 0;
-    virtual void wasRecentlyAudibleChanged(bool wasRecentlyAudible) = 0;
+    virtual void recentlyAudibleChanged(bool recentlyAudible) = 0;
     virtual QRectF viewportRect() const = 0;
     virtual qreal dpiScale() const = 0;
     virtual QColor backgroundColor() const = 0;
diff --git a/src/core/web_contents_delegate_qt.cpp b/src/core/web_contents_delegate_qt.cpp
index 51b9d5bd0..e7d94d338 100644
--- a/src/core/web_contents_delegate_qt.cpp
+++ b/src/core/web_contents_delegate_qt.cpp
@@ -131,7 +131,7 @@ void WebContentsDelegateQt::NavigationStateChanged(content::WebContents* source,
     // Make sure to only emit the signal when loading isn't in progress, because it causes multiple
     // false signals to be emitted.
     if ((changed_flags & content::INVALIDATE_TYPE_TAB) && !(changed_flags & content::INVALIDATE_TYPE_LOAD)) {
-        m_viewClient->wasRecentlyAudibleChanged(source->WasRecentlyAudible());
+        m_viewClient->recentlyAudibleChanged(source->WasRecentlyAudible());
     }
 }
 
diff --git a/src/webengine/api/qquickwebengineview.cpp b/src/webengine/api/qquickwebengineview.cpp
index 6d1060661..23cd25366 100644
--- a/src/webengine/api/qquickwebengineview.cpp
+++ b/src/webengine/api/qquickwebengineview.cpp
@@ -420,10 +420,10 @@ void QQuickWebEngineViewPrivate::didUpdateTargetURL(const QUrl &hoveredUrl)
     Q_EMIT q->linkHovered(hoveredUrl);
 }
 
-void QQuickWebEngineViewPrivate::wasRecentlyAudibleChanged(bool wasRecentlyAudible)
+void QQuickWebEngineViewPrivate::recentlyAudibleChanged(bool recentlyAudible)
 {
     Q_Q(QQuickWebEngineView);
-    Q_EMIT q->wasRecentlyAudibleChanged(wasRecentlyAudible);
+    Q_EMIT q->recentlyAudibleChanged(recentlyAudible);
 }
 
 QRectF QQuickWebEngineViewPrivate::viewportRect() const
@@ -1187,10 +1187,10 @@ void QQuickWebEngineView::setAudioMuted(bool muted) {
     }
 }
 
-bool QQuickWebEngineView::wasRecentlyAudible()
+bool QQuickWebEngineView::recentlyAudible() const
 {
-    Q_D(QQuickWebEngineView);
-    return d->adapter->wasRecentlyAudible();
+    const Q_D(QQuickWebEngineView);
+    return d->adapter->recentlyAudible();
 }
 
 void QQuickWebEngineView::printToPdf(const QString& filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation)
diff --git a/src/webengine/api/qquickwebengineview_p.h b/src/webengine/api/qquickwebengineview_p.h
index 390b46429..595da26cd 100644
--- a/src/webengine/api/qquickwebengineview_p.h
+++ b/src/webengine/api/qquickwebengineview_p.h
@@ -113,7 +113,8 @@ class Q_WEBENGINE_PRIVATE_EXPORT QQuickWebEngineView : public QQuickItem {
     Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor NOTIFY backgroundColorChanged REVISION 2)
     Q_PROPERTY(QSizeF contentsSize READ contentsSize NOTIFY contentsSizeChanged FINAL REVISION 3)
     Q_PROPERTY(QPointF scrollPosition READ scrollPosition NOTIFY scrollPositionChanged FINAL REVISION 3)
-    Q_PROPERTY(bool audioMuted READ isAudioMuted WRITE setAudioMuted NOTIFY audioMutedChanged REVISION 3)
+    Q_PROPERTY(bool audioMuted READ isAudioMuted WRITE setAudioMuted NOTIFY audioMutedChanged FINAL REVISION 3)
+    Q_PROPERTY(bool recentlyAudible READ recentlyAudible NOTIFY recentlyAudibleChanged FINAL REVISION 3)
     Q_PROPERTY(uint webChannelWorld READ webChannelWorld WRITE setWebChannelWorld NOTIFY webChannelWorldChanged REVISION 3)
 
 #ifdef ENABLE_QML_TESTSUPPORT_API
@@ -447,6 +448,10 @@ public:
     uint webChannelWorld() const;
     void setWebChannelWorld(uint);
 
+    bool isAudioMuted() const;
+    void setAudioMuted(bool muted);
+    bool recentlyAudible() const;
+
 #ifdef ENABLE_QML_TESTSUPPORT_API
     QQuickWebEngineTestSupport *testSupport() const;
     void setTestSupport(QQuickWebEngineTestSupport *testSupport);
@@ -469,9 +474,6 @@ public Q_SLOTS:
     Q_REVISION(1) void grantFeaturePermission(const QUrl &securityOrigin, Feature, bool granted);
     Q_REVISION(2) void setActiveFocusOnPress(bool arg);
     Q_REVISION(2) void triggerWebAction(WebAction action);
-    Q_REVISION(3) bool isAudioMuted() const;
-    Q_REVISION(3) void setAudioMuted(bool muted);
-    Q_REVISION(3) bool wasRecentlyAudible();
     Q_REVISION(3) void printToPdf(const QString &filePath, PrintedPageSizeId pageSizeId = PrintedPageSizeId::A4, PrintedPageOrientation orientation = PrintedPageOrientation::Portrait);
     Q_REVISION(3) void printToPdf(PrintedPageSizeId pageSizeId = PrintedPageSizeId::A4, PrintedPageOrientation orientation = PrintedPageOrientation::Portrait, const QJSValue &callback = QJSValue());
 
@@ -502,7 +504,7 @@ Q_SIGNALS:
     Q_REVISION(3) void contentsSizeChanged(const QSizeF& size);
     Q_REVISION(3) void scrollPositionChanged(const QPointF& position);
     Q_REVISION(3) void audioMutedChanged(bool muted);
-    Q_REVISION(3) void wasRecentlyAudibleChanged(bool wasRecentlyAudible);
+    Q_REVISION(3) void recentlyAudibleChanged(bool recentlyAudible);
     Q_REVISION(3) void webChannelWorldChanged(uint);
 
 protected:
diff --git a/src/webengine/api/qquickwebengineview_p_p.h b/src/webengine/api/qquickwebengineview_p_p.h
index 05c2228c4..d3d6603f5 100644
--- a/src/webengine/api/qquickwebengineview_p_p.h
+++ b/src/webengine/api/qquickwebengineview_p_p.h
@@ -135,7 +135,7 @@ public:
     virtual void loadProgressChanged(int progress) Q_DECL_OVERRIDE;
     virtual void didUpdateTargetURL(const QUrl&) Q_DECL_OVERRIDE;
     virtual void selectionChanged() Q_DECL_OVERRIDE { }
-    virtual void wasRecentlyAudibleChanged(bool wasRecentlyAudible) Q_DECL_OVERRIDE;
+    virtual void recentlyAudibleChanged(bool recentlyAudible) Q_DECL_OVERRIDE;
     virtual QRectF viewportRect() const Q_DECL_OVERRIDE;
     virtual qreal dpiScale() const Q_DECL_OVERRIDE;
     virtual QColor backgroundColor() const Q_DECL_OVERRIDE;
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.
-*/
diff --git a/src/webenginewidgets/api/qwebenginepage.cpp b/src/webenginewidgets/api/qwebenginepage.cpp
index 341c4724d..0a27a3938 100644
--- a/src/webenginewidgets/api/qwebenginepage.cpp
+++ b/src/webenginewidgets/api/qwebenginepage.cpp
@@ -172,10 +172,10 @@ void QWebEnginePagePrivate::selectionChanged()
     Q_EMIT q->selectionChanged();
 }
 
-void QWebEnginePagePrivate::wasRecentlyAudibleChanged(bool wasRecentlyAudible)
+void QWebEnginePagePrivate::recentlyAudibleChanged(bool recentlyAudible)
 {
     Q_Q(QWebEnginePage);
-    Q_EMIT q->wasRecentlyAudibleChanged(wasRecentlyAudible);
+    Q_EMIT q->recentlyAudibleChanged(recentlyAudible);
 }
 
 QRectF QWebEnginePagePrivate::viewportRect() const
@@ -566,14 +566,14 @@ QWebEnginePage::QWebEnginePage(QObject* parent)
 */
 
 /*!
-    \fn void QWebEnginePage::wasRecentlyAudibleChanged(bool wasRecentlyAudible);
+    \fn void QWebEnginePage::recentlyAudibleChanged(bool recentlyAudible);
     \since 5.7
 
-    This signal is emitted when the page's audible state, \a wasRecentlyAudible, changes, because
+    This signal is emitted when the page's audible state, \a recentlyAudible, 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
+    Also, if the audio is paused, this signal is emitted with an approximate \b{two-second
     delay}, from the moment the audio is paused.
 */
 
@@ -721,6 +721,7 @@ void QWebEnginePage::setBackgroundColor(const QColor &color)
     \since 5.7
 
     The default value is \c false.
+    \sa recentlyAudible
 */
 bool QWebEnginePage::isAudioMuted() const {
     const Q_D(QWebEnginePage);
@@ -736,17 +737,20 @@ void QWebEnginePage::setAudioMuted(bool muted) {
     }
 }
 
+
 /*!
+    \property QWebEnginePage::recentlyAudible
+    \brief the current page's \e {audible state}, that is, whether audio was recently played
+    or not.
     \since 5.7
-    \sa wasRecentlyAudibleChanged()
 
-    Returns the current page's \e {audible state}, that is, whether audio was recently played
-    or not.
+    The default value is \c false.
+    \sa audioMuted
 */
-bool QWebEnginePage::wasRecentlyAudible()
+bool QWebEnginePage::recentlyAudible() const
 {
-    Q_D(QWebEnginePage);
-    return d->adapter->wasRecentlyAudible();
+    const Q_D(QWebEnginePage);
+    return d->adapter->recentlyAudible();
 }
 
 void QWebEnginePage::setView(QWidget *view)
diff --git a/src/webenginewidgets/api/qwebenginepage.h b/src/webenginewidgets/api/qwebenginepage.h
index 0faa385da..bc6d101a1 100644
--- a/src/webenginewidgets/api/qwebenginepage.h
+++ b/src/webenginewidgets/api/qwebenginepage.h
@@ -79,6 +79,7 @@ class QWEBENGINEWIDGETS_EXPORT QWebEnginePage : public QObject {
     Q_PROPERTY(QSizeF contentsSize READ contentsSize NOTIFY contentsSizeChanged)
     Q_PROPERTY(QPointF scrollPosition READ scrollPosition NOTIFY scrollPositionChanged)
     Q_PROPERTY(bool audioMuted READ isAudioMuted WRITE setAudioMuted NOTIFY audioMutedChanged)
+    Q_PROPERTY(bool recentlyAudible READ recentlyAudible NOTIFY recentlyAudibleChanged)
 
 public:
     enum WebAction {
@@ -269,7 +270,7 @@ public:
 
     bool isAudioMuted() const;
     void setAudioMuted(bool muted);
-    bool wasRecentlyAudible();
+    bool recentlyAudible() const;
 
     void printToPdf(const QString &filePath, const QPageLayout &layout);
 #ifdef Q_QDOC
@@ -308,7 +309,7 @@ Q_SIGNALS:
     void scrollPositionChanged(const QPointF &position);
     void contentsSizeChanged(const QSizeF &size);
     void audioMutedChanged(bool muted);
-    void wasRecentlyAudibleChanged(bool wasRecentlyAudible);
+    void recentlyAudibleChanged(bool recentlyAudible);
 
 protected:
     virtual QWebEnginePage *createWindow(WebWindowType type);
diff --git a/src/webenginewidgets/api/qwebenginepage_p.h b/src/webenginewidgets/api/qwebenginepage_p.h
index de7d35354..58515bfbe 100644
--- a/src/webenginewidgets/api/qwebenginepage_p.h
+++ b/src/webenginewidgets/api/qwebenginepage_p.h
@@ -88,7 +88,7 @@ public:
     virtual void loadProgressChanged(int progress) Q_DECL_OVERRIDE;
     virtual void didUpdateTargetURL(const QUrl&) Q_DECL_OVERRIDE;
     virtual void selectionChanged() Q_DECL_OVERRIDE;
-    virtual void wasRecentlyAudibleChanged(bool wasRecentlyAudible) Q_DECL_OVERRIDE;
+    virtual void recentlyAudibleChanged(bool recentlyAudible) Q_DECL_OVERRIDE;
     virtual QRectF viewportRect() const Q_DECL_OVERRIDE;
     virtual qreal dpiScale() const Q_DECL_OVERRIDE;
     virtual QColor backgroundColor() const Q_DECL_OVERRIDE;