diff options
| author | Samuel Gaist <samuel.gaist@idiap.ch> | 2020-06-08 07:47:57 +0200 |
|---|---|---|
| committer | Samuel Gaist <samuel.gaist@idiap.ch> | 2020-06-08 09:39:02 +0200 |
| commit | 131d08f789237cd59d108e8ca882a797089764f9 (patch) | |
| tree | 6f64b743acbc3ecf93f33c31735348352c31ff52 /src/assistant/help/qhelpenginecore.cpp | |
| parent | 5c0c5b54b9c3c8743f694614ce4729baa0399e3e (diff) | |
Doc: make it clearer that setUsesFilterEngine is required for filtering
The new API to use is an "opt in" with regard to the deprecated API so
make it more prominent in the documentation as it is easily missed.
Pick-to: 5.15
Change-Id: Ifacac03f0e05cea141c6c4a7d88eaac609e7b712
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/assistant/help/qhelpenginecore.cpp')
| -rw-r--r-- | src/assistant/help/qhelpenginecore.cpp | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/src/assistant/help/qhelpenginecore.cpp b/src/assistant/help/qhelpenginecore.cpp index 6f1a7a840..2e640da7e 100644 --- a/src/assistant/help/qhelpenginecore.cpp +++ b/src/assistant/help/qhelpenginecore.cpp @@ -119,13 +119,14 @@ void QHelpEngineCorePrivate::errorReceived(const QString &msg) The management of the filters, including adding new filters, changing filter definitions, or removing existing filters, is done through the QHelpFilterEngine class, which can be accessed - by the filterEngine() method. This replaces older filter API that is - deprecated since Qt 5.13. Please call setUsesFilterEngine() with - \c true to enable the new functionality. + by the filterEngine() method. + \note QHelpFilterEngine replaces the older filter API that is + deprecated since Qt 5.13. Call setUsesFilterEngine() with \c true to + enable the new functionality. The help engine also offers the possibility to set and read values - in a persistant way comparable to ini files or Windows registry + in a persistent way comparable to ini files or Windows registry entries. For more information see setValue() or value(). This class does not offer any GUI components or functionality for |