add note on how to invalidate results

qgis · Jun 1, 2018 · dc9fb90b01751412d5eb180021fab87754e73884 · dc9fb90
1 parent a15d890
commit dc9fb90b01751412d5eb180021fab87754e73884
Unified Split

Showing with 8 additions and 0 deletions.

+5 −0 python/core/auto_generated/locator/qgslocatorfilter.sip.in

+3 −0 src/core/locator/qgslocatorfilter.h
diff --git a/python/core/auto_generated/locator/qgslocatorfilter.sip.in b/python/core/auto_generated/locator/qgslocatorfilter.sip.in
@@ -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
 

diff --git a/src/core/locator/qgslocatorfilter.h b/src/core/locator/qgslocatorfilter.h
@@ -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