add note on how to invalidate results

This commit is contained in:
Denis Rouzaud 2018-05-31 16:38:40 -04:00
parent a15d8903ed
commit dc9fb90b01
2 changed files with 8 additions and 0 deletions

View File

@ -54,6 +54,11 @@ class QgsLocatorFilter : QObject
%Docstring
Abstract base class for filters which collect locator results.
.. note::
If the configuration of the filter is changed outside of the main application settings,
one needs to invalidate current results of the locator widget: see QgisInterface.invalidateLocatorResults
.. versionadded:: 3.0
%End

View File

@ -97,6 +97,9 @@ class CORE_EXPORT QgsLocatorResult
* \class QgsLocatorFilter
* \ingroup core
* Abstract base class for filters which collect locator results.
*
* \note If the configuration of the filter is changed outside of the main application settings,
* one needs to invalidate current results of the locator widget: \see QgisInterface::invalidateLocatorResults
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLocatorFilter : public QObject