Class: QgsAbstractGeocoderLocatorFilter¶

An abstract base class which implements a locator filter populated from a QgsGeocoderInterface.

This base class implements the required logic to bridge a class which implements the QgsGeocoderInterface interface to a QgsLocatorFilter. It allows easy creation of a locator filter from a geocoder.

Note

This is a low-level API, designed for use by client applications which do not utilize the QGIS gui library. Usually the concrete class QgsGeocoderLocatorFilter from the gui library should be used instead.

Added in version 3.18.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: QgsLocatorFilter.clone()

Class Hierarchy¶

Base classes¶

`QgsLocatorFilter`	Abstract base class for filters which collect locator results.
QObject

Subclasses¶

QgsGeocoderLocatorFilter

An adapter class which implements a locator filter populated from a QgsGeocoderInterface.

Methods

`boundingBox`	Returns the WGS84 bounding box attached to the filter.
`geocoder`	Returns the geocoder attached to the filter.
`geocoderResultToLocatorResult`	Converts a geocoder result to a locator result.
`locatorResultToGeocoderResult`	Converts a locator result to a geocoder result.

class qgis.core.QgsAbstractGeocoderLocatorFilter[source]¶

Bases: QgsLocatorFilter

__init__(name: str | None, displayName: str | None, prefix: str | None, geocoder: QgsGeocoderInterface | None, boundingBox: QgsRectangle = QgsRectangle())

Constructor for QgsAbstractGeocoderLocatorFilter.

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. The prefix must consist of at least three characters.

The geocoder must specify an instance of a class which implements the QgsGeocoderInterface interface. Ownership of geocoder is not transferred, and the caller must ensure that geocoder exists for the lifetime of this filter.

The boundingBox argument specifies the geographic bounding box, in WGS84, covered by the filter.

Parameters:

name (Optional[str])
displayName (Optional[str])
prefix (Optional[str])
geocoder (Optional[QgsGeocoderInterface])
boundingBox (QgsRectangle = QgsRectangle())

boundingBox(self) → QgsRectangle[source]¶

Returns the WGS84 bounding box attached to the filter.

Return type:: QgsRectangle

geocoder(self) → QgsGeocoderInterface | None[source]¶

Returns the geocoder attached to the filter.

Return type:: Optional[QgsGeocoderInterface]

geocoderResultToLocatorResult(self, result: QgsGeocoderResult) → QgsLocatorResult[source]¶

Converts a geocoder result to a locator result.