QgsAbstractGeocoderLocatorFilter Class Reference

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

#include <qgsabstractgeocoderlocatorfilter.h>

Inheritance diagram for QgsAbstractGeocoderLocatorFilter:

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

Detailed Description

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.

Since

QGIS 3.18

Definition at line 39 of file qgsabstractgeocoderlocatorfilter.h.

Constructor & Destructor Documentation

QgsAbstractGeocoderLocatorFilter()

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 21 of file qgsabstractgeocoderlocatorfilter.cpp.

Member Function Documentation

boundingBox()

const QgsRectangle QgsAbstractGeocoderLocatorFilter::boundingBox ( )

inline

Returns the WGS84 bounding box attached to the filter.

Definition at line 83 of file qgsabstractgeocoderlocatorfilter.h.

displayName()

QString QgsAbstractGeocoderLocatorFilter::displayName ( ) const

override

Definition at line 36 of file qgsabstractgeocoderlocatorfilter.cpp.

fetchResults()

void QgsAbstractGeocoderLocatorFilter::fetchResults ( const QString &  string, const QgsLocatorContext &  context, QgsFeedback *  feedback  )

override

Definition at line 46 of file qgsabstractgeocoderlocatorfilter.cpp.

geocoder()

QgsGeocoderInterface * QgsAbstractGeocoderLocatorFilter::geocoder

(

)

const

Returns the geocoder attached to the filter.

Definition at line 69 of file qgsabstractgeocoderlocatorfilter.cpp.

geocoderResultToLocatorResult()

QgsLocatorResult QgsAbstractGeocoderLocatorFilter::geocoderResultToLocatorResult

(

const QgsGeocoderResult &

result

)

Converts a geocoder result to a locator result.

See also

locatorResultToGeocoderResult()

Definition at line 87 of file qgsabstractgeocoderlocatorfilter.cpp.

locatorResultToGeocoderResult()

QgsGeocoderResult QgsAbstractGeocoderLocatorFilter::locatorResultToGeocoderResult

(

const QgsLocatorResult &

result

)

const

Converts a locator result to a geocoder result.

See also

geocoderResultToLocatorResult()

Definition at line 74 of file qgsabstractgeocoderlocatorfilter.cpp.

name()

QString QgsAbstractGeocoderLocatorFilter::name ( ) const

override

Definition at line 31 of file qgsabstractgeocoderlocatorfilter.cpp.

prefix()

QString QgsAbstractGeocoderLocatorFilter::prefix ( ) const

override

Definition at line 41 of file qgsabstractgeocoderlocatorfilter.cpp.

triggerResult()

void QgsAbstractGeocoderLocatorFilter::triggerResult ( const QgsLocatorResult &  result )

override

Definition at line 63 of file qgsabstractgeocoderlocatorfilter.cpp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/geocoding/qgsabstractgeocoderlocatorfilter.h
• /build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/geocoding/qgsabstractgeocoderlocatorfilter.cpp