summaryrefslogtreecommitdiffstats
path: root/src/webenginewidgets/doc/src
diff options
context:
space:
mode:
authorPierre Rossi <pierre.rossi@digia.com>2014-09-17 14:52:03 +0200
committerPierre Rossi <pierre.rossi@gmail.com>2014-09-18 15:13:48 +0200
commit77ea8b243c7c7706ff22d277c24fbaf3580dee75 (patch)
tree061fd1e151656c9629440451ee1ca1d3027e73ab /src/webenginewidgets/doc/src
parent3188a0d9976a02f76c0a8d6d91e77bb1d2e131c8 (diff)
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>
Diffstat (limited to 'src/webenginewidgets/doc/src')
-rw-r--r--src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc27
-rw-r--r--src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc14
2 files changed, 34 insertions, 7 deletions
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()
*/