QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
An abstract base class which implements a locator filter populated from a QgsGeocoderInterface. More...
#include <qgsabstractgeocoderlocatorfilter.h>
Public Member Functions | |
QgsAbstractGeocoderLocatorFilter (const QString &name, const QString &displayName, const QString &prefix, QgsGeocoderInterface *geocoder, const QgsRectangle &boundingBox=QgsRectangle()) | |
Constructor for QgsAbstractGeocoderLocatorFilter. | |
const QgsRectangle | boundingBox () |
Returns the WGS84 bounding box attached to the filter. | |
QString | displayName () const override |
void | fetchResults (const QString &string, const QgsLocatorContext &context, QgsFeedback *feedback) override |
QgsGeocoderInterface * | geocoder () const |
Returns the geocoder attached to the filter. | |
QgsLocatorResult | geocoderResultToLocatorResult (const QgsGeocoderResult &result) |
Converts a geocoder result to a locator result. | |
QgsGeocoderResult | locatorResultToGeocoderResult (const QgsLocatorResult &result) const |
Converts a locator result to a geocoder result. | |
QString | name () const override |
QString | prefix () const override |
void | triggerResult (const QgsLocatorResult &result) override |
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.
Definition at line 39 of file qgsabstractgeocoderlocatorfilter.h.
QgsAbstractGeocoderLocatorFilter::QgsAbstractGeocoderLocatorFilter | ( | const QString & | name, |
const QString & | displayName, | ||
const QString & | prefix, | ||
QgsGeocoderInterface * | geocoder, | ||
const QgsRectangle & | boundingBox = 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.
Definition at line 20 of file qgsabstractgeocoderlocatorfilter.cpp.
|
inline |
Returns the WGS84 bounding box attached to the filter.
Definition at line 83 of file qgsabstractgeocoderlocatorfilter.h.
|
override |
Definition at line 35 of file qgsabstractgeocoderlocatorfilter.cpp.
|
override |
Definition at line 45 of file qgsabstractgeocoderlocatorfilter.cpp.
QgsGeocoderInterface * QgsAbstractGeocoderLocatorFilter::geocoder | ( | ) | const |
Returns the geocoder attached to the filter.
Definition at line 68 of file qgsabstractgeocoderlocatorfilter.cpp.
QgsLocatorResult QgsAbstractGeocoderLocatorFilter::geocoderResultToLocatorResult | ( | const QgsGeocoderResult & | result | ) |
Converts a geocoder result to a locator result.
Definition at line 86 of file qgsabstractgeocoderlocatorfilter.cpp.
QgsGeocoderResult QgsAbstractGeocoderLocatorFilter::locatorResultToGeocoderResult | ( | const QgsLocatorResult & | result | ) | const |
Converts a locator result to a geocoder result.
Definition at line 73 of file qgsabstractgeocoderlocatorfilter.cpp.
|
override |
Definition at line 30 of file qgsabstractgeocoderlocatorfilter.cpp.
|
override |
Definition at line 40 of file qgsabstractgeocoderlocatorfilter.cpp.
|
override |
Definition at line 62 of file qgsabstractgeocoderlocatorfilter.cpp.