Class: QgsGeocoderLocatorFilter¶
- class qgis.gui.QgsGeocoderLocatorFilter¶
Bases:
QgsAbstractGeocoderLocatorFilter
An adapter class which implements a locator filter populated from a
QgsGeocoderInterface
.This class implements the required logic to bridge a class which implements the
QgsGeocoderInterface
interface to aQgsLocatorFilter
. It allows easy creation of a locator filter from a geocoder.New in version 3.18.
QgsGeocoderLocatorFilter(name: str, displayName: str, prefix: str, geocoder:
QgsGeocoderInterface
, canvas:QgsMapCanvas
, boundingBox:QgsRectangle
= QgsRectangle()) Constructor for QgsGeocoderLocatorFilter.The
name
argument specifies a unique name for the filter. This should be an untranslated string identifying the filter.The
displayName
argument must specify a translated, user-friendly name for the filter.The
prefix
argument specifies the prefix character(s) for this filter. Prefixing a search with these characters will restrict the locator search to only include results from this filter. Theprefix
must consist of at least three characters.The
geocoder
must specify an instance of a class which implements theQgsGeocoderInterface
interface. Ownership ofgeocoder
is not transferred, and the caller must ensure thatgeocoder
exists for the lifetime of this filter.The
boundingBox
argument specifies the geographic bounding box, in WGS84, covered by the filter.Methods
- rtype:
QgsLocatorFilter
- childEvent(self, QChildEvent)¶
- clone(self) QgsLocatorFilter ¶
- Return type:
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- isSignalConnected(self, QMetaMethod) bool ¶
- receivers(self, PYQT_SIGNAL) int ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- timerEvent(self, QTimerEvent)¶