diff --git a/python/core/auto_generated/locator/qgslocatorfilter.sip.in b/python/core/auto_generated/locator/qgslocatorfilter.sip.in index 103db5191cb..53022832b04 100644 --- a/python/core/auto_generated/locator/qgslocatorfilter.sip.in +++ b/python/core/auto_generated/locator/qgslocatorfilter.sip.in @@ -138,6 +138,13 @@ Returns the unique name for the filter. This should be an untranslated string id Returns a translated, user-friendly name for the filter. .. seealso:: :py:func:`name` +%End + + virtual QString description() const; +%Docstring +Returns a translated, description for the filter. + +.. versionadded:: 3.20 %End virtual QgsLocatorFilter::Flags flags() const; diff --git a/src/core/locator/qgslocatorfilter.h b/src/core/locator/qgslocatorfilter.h index f2fa6da2733..dfa03e425b6 100644 --- a/src/core/locator/qgslocatorfilter.h +++ b/src/core/locator/qgslocatorfilter.h @@ -198,6 +198,12 @@ class CORE_EXPORT QgsLocatorFilter : public QObject */ virtual QString displayName() const = 0; + /** + * Returns a translated, description for the filter. + * \since QGIS 3.20 + */ + virtual QString description() const { return QString(); } + /** * Returns flags which specify the filter's behavior. */ diff --git a/tests/src/python/test_qgslocator.py b/tests/src/python/test_qgslocator.py index bfd6ef996c2..e0c1fc8e65a 100644 --- a/tests/src/python/test_qgslocator.py +++ b/tests/src/python/test_qgslocator.py @@ -47,6 +47,9 @@ class test_filter(QgsLocatorFilter): def displayName(self): return 'test_' + self.identifier + def description(self): + return 'test_description' + def prefix(self): return self._prefix