Hide QWebEngineCallback from the docs

In the same fashion as what is done in QObject::connect's
documentation, we can keep it simple here and simply document
what is expected.

Change-Id: I98a09280870cf0aab935fd0cb69401bb98134145
Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>

5 files changed, 91 insertions, 7 deletions

diff --git a/src/webenginewidgets/api/qwebenginepage.h b/src/webenginewidgets/api/qwebenginepage.h
index 667098032..cda6e620f 100644
--- a/src/webenginewidgets/api/qwebenginepage.h
+++ b/src/webenginewidgets/api/qwebenginepage.h
@@ -172,7 +172,12 @@ public:
     virtual void triggerAction(WebAction action, bool checked = false);
 
     virtual bool event(QEvent*);
+#ifdef Q_QDOC
+    void findText(const QString &subString, FindFlags options = 0);
+    void findText(const QString &subString, FindFlags options, FunctorOrLambda resultCallback);
+#else
     void findText(const QString &subString, FindFlags options = 0, const QWebEngineCallback<bool> &resultCallback = QWebEngineCallback<bool>());
+#endif
     QMenu *createStandardContextMenu();
 
     void setFeaturePermission(const QUrl &securityOrigin, Feature feature, PermissionPolicy policy);
@@ -182,8 +187,13 @@ public:
     void setHtml(const QString &html, const QUrl &baseUrl = QUrl());
     void setContent(const QByteArray &data, const QString &mimeType = QString(), const QUrl &baseUrl = QUrl());
 
+#ifdef Q_QDOC
+    void toHtml(FunctorOrLambda resultCallback) const;
+    void toPlainText(FunctorOrLambda resultCallback) const;
+#else
     void toHtml(const QWebEngineCallback<const QString &> &resultCallback) const;
     void toPlainText(const QWebEngineCallback<const QString &> &resultCallback) const;
+#endif
 
     QString title() const;
     void setUrl(const QUrl &url);
@@ -195,7 +205,11 @@ public:
     void setZoomFactor(qreal factor);
 
     void runJavaScript(const QString& scriptSource);
+#ifdef Q_QDOC
+    void runJavaScript(const QString& scriptSource, FunctorOrLambda resultCallback);
+#else
     void runJavaScript(const QString& scriptSource, const QWebEngineCallback<const QVariant &> &resultCallback);
+#endif
 
     QWebEngineSettings *settings() const;
 
diff --git a/src/webenginewidgets/api/qwebengineview.h b/src/webenginewidgets/api/qwebengineview.h
index 3e40ca18f..ce3c5495d 100644
--- a/src/webenginewidgets/api/qwebengineview.h
+++ b/src/webenginewidgets/api/qwebengineview.h
@@ -89,7 +89,12 @@ public:
     qreal zoomFactor() const;
     void setZoomFactor(qreal factor);
 
+#ifdef Q_QDOC
+    void findText(const QString &subString, QWebEnginePage::FindFlags options = 0);
+    void findText(const QString &subString, QWebEnginePage::FindFlags options, FunctorOrLambda resultCallback);
+#else
     void findText(const QString &subString, QWebEnginePage::FindFlags options = 0, const QWebEngineCallback<bool> &resultCallback = QWebEngineCallback<bool>());
+#endif
 
     virtual QSize sizeHint() const Q_DECL_OVERRIDE;
     QWebEngineSettings *settings() const;
diff --git a/src/webenginewidgets/doc/snippets/qtwebengine_qwebenginepage_snippet.cpp b/src/webenginewidgets/doc/snippets/qtwebengine_qwebenginepage_snippet.cpp
new file mode 100644
index 000000000..135c04fac
--- /dev/null
+++ b/src/webenginewidgets/doc/snippets/qtwebengine_qwebenginepage_snippet.cpp
@@ -0,0 +1,38 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+void wrapInFunction()
+{
+
+//! [0]
+    m_view->page()->findText(QStringLiteral("Qt"), QWebEnginePage::FindFlags(), [this](bool found) {
+        if (!found) QMessageBox::information(m_view, QString(), QStringLiteral("No occurrences found"));
+    });
+//! [0]
+
+}
+
diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
index d40c436c4..11281c9ac 100644
--- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
@@ -296,12 +296,23 @@
 */
 
 /*!
-    \fn void QWebEnginePage::findText(const QString &subString, FindFlags options, const QWebEngineCallback<bool> &resultCallback)
+    \fn void QWebEnginePage::findText(const QString &subString, FindFlags options)
     Finds the specified string, \a subString, in the page, using the given \a options.
 
     To clear the selection, just pass an empty string.
+*/
+
+/*!
+    \fn void QWebEnginePage::findText(const QString &subString, FindFlags options, FunctorOrLambda resultCallback)
+    Finds the specified string, \a subString, in the page, using the given \a options.
+
+    To clear the selection, just pass an empty string.
+
+    The \a resultCallback must take a boolean parameter. It will be called with a value of true if the \a subString
+    was found; otherwise the callback value will be false.
 
-    The \a resultCallback will be called with a value of true if the \a subString was found; otherwise the callback value will be false.
+    For example:
+    \snippet snippets/qtwebengine_qwebenginepage_snippet.cpp 0
 */
 
 /*!
@@ -397,19 +408,23 @@
 */
 
 /*!
-    \fn void QWebEnginePage::toHtml(const QWebEngineCallback<const QString &> &resultCallback) const
+    \fn void QWebEnginePage::toHtml(FunctorOrLambda resultCallback) const
     Asynchronous method to retrieve the page's content as HTML, enclosed in HTML and BODY tags.
     Upon successful completion, \a resultCallback is called with the page's content.
 
+    \note \a resultCallback can be any of a function pointer, a functor or a lambda, and it is expected to take a QString parameter.
+
     \sa setHtml(), toPlainText()
 */
 
 /*!
-    \fn void QWebEnginePage::toPlainText(const QWebEngineCallback<const QString &> &resultCallback) const
+    \fn void QWebEnginePage::toPlainText(FunctorOrLambda resultCallback) const
     Asynchronous method to retrieve the page's content converted to plain text, completely stripped of all
     HTML formatting.
     Upon successful completion, \a resultCallback is called with the page's content.
 
+    \note \a resultCallback can be any of a function pointer, a functor or a lambda, and it is expected to take a QString parameter.
+
     \sa toHtml()
 */
 
@@ -508,10 +523,12 @@
 */
 
 /*!
-    \fn void QWebEnginePage::runJavaScript(const QString& scriptSource, const QWebEngineCallback<const QVariant &> &resultCallback)
+    \fn void QWebEnginePage::runJavaScript(const QString& scriptSource, FunctorOrLambda resultCallback)
     Runs the JavaScript code contained in \a scriptSource.
 
     When the script has been executed, \a resultCallback is called with the result of the last executed statement.
+
+    \note \a resultCallback can be any of a function pointer, a functor or a lambda, and it is expected to take a QVariant parameter.
 */
 
 /*!
diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
index 462f76255..2d49158d6 100644
--- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
@@ -241,12 +241,22 @@
 */
 
 /*!
-    \fn void QWebEngineView::findText(const QString &subString, QWebEnginePage::FindFlags options, const QWebEngineCallback<bool> &resultCallback)
+    \fn void QWebEngineView::findText(const QString &subString, QWebEnginePage::FindFlags options)
     Finds the specified string, \a subString, in the page, using the given \a options.
 
     To clear the selection, just pass an empty string.
 
-    The \a resultCallback will be called with a value of true if the \a subString was found; otherwise the callback value will be false.
+    \sa selectedText(), selectionChanged()
+*/
+
+/*!
+    \fn void QWebEngineView::findText(const QString &subString, QWebEnginePage::FindFlags options, FunctorOrLambda resultCallback)
+    Finds the specified string, \a subString, in the page, using the given \a options.
+
+    To clear the selection, just pass an empty string.
+
+    The \a resultCallback must take a boolean parameter. It will be called with a value of true if the \a subString
+    was found; otherwise the callback value will be false.
 
     \sa selectedText(), selectionChanged()
 */