QgsLocatorAutomaticModel class

A QgsLocatorModel which has is associated directly with a QgsLocator, and is automatically populated with results from locator searches.

Reference

Use this QgsLocatorModel subclass when you want the connections between a QgsLocator and the model to be automatically created for you. If more flexibility in model behavior is required, use the base QgsLocatorModel class instead and setup the connections manually.

Note that this class should generally be used with a QgsLocatorProxyModel in order to ensure correct sorting of results by priority and match level.

Base classes

class QgsLocatorModel: An abstract list model for displaying the results of locator searches.

Constructors, destructors, conversion operators

QgsLocatorAutomaticModel(QgsLocator* locator) explicit: Constructor for QgsLocatorAutomaticModel, linked with the specified locator.

Public functions

auto createContext() -> QgsLocatorContext virtual: Returns a new locator context for searches.
auto locator() -> QgsLocator*: Returns a pointer to the locator utilized by this model.
void search(const QString& string): Enqueues a search for a specified string within the model.

Function documentation

QgsLocatorAutomaticModel::QgsLocatorAutomaticModel(QgsLocator* locator) explicit

Constructor for QgsLocatorAutomaticModel, linked with the specified locator.

The locator is used as the model's parent.

QgsLocatorContext QgsLocatorAutomaticModel::createContext() virtual

Returns a new locator context for searches.

The default implementation returns a default constructed QgsLocatorContext. Subclasses can override this method to implement custom context creation logic.

void QgsLocatorAutomaticModel::search(const QString& string)

Enqueues a search for a specified string within the model.

Note that the search may not begin immediately if an existing search request is still running. In this case the existing search must be completely terminated before the new search can begin. The model handles this situation automatically, and will trigger a search for the new search string as soon as possible.