Class: QgsLocator

class qgis.core.QgsLocator(parent: QObject = None)

Bases: PyQt5.QtCore.QObject

Constructor for QgsLocator.

Handles the management of QgsLocatorFilter objects and async collection of search results from them.

QgsLocator acts as both a registry for QgsLocatorFilter objects and a means of firing up asynchronous queries against these filter objects.

Filters are first registered to the locator by calling registerFilter(). Registering filters transfers their ownership to the locator object. Plugins which register filters to the locator must take care to correctly call deregisterFilter() and deregister their filter upon plugin unload to avoid crashes.

In order to trigger a search across registered filters, the fetchResults() method is called. This triggers threaded calls to QgsLocatorFilter.fetchResults() for all registered filters. As individual filters find matching results, the foundResult() signal will be triggered for each result. Callers should connect this signal to an appropriate slot designed to collect and handle these results. Since foundResult() is triggered whenever a filter encounters an individual result, it will usually be triggered many times for a single call to fetchResults().

New in version 3.0: Methods

cancel Cancels any current running query, and blocks until query is completely canceled by all filters.
cancelWithoutBlocking Triggers cancelation of any current running query without blocking.
childEvent
clearPreviousResults Will call clearPreviousResults on all filters
connectNotify
customEvent
deregisterFilter Deregisters a filter from the locator and deletes it.
disconnectNotify
fetchResults Triggers the background fetching of filter results for a specified search string.
filters Returns the list of filters registered in the locator.
isRunning Returns true if a query is currently being executed by the locator.
isSignalConnected
prefixedFilters Returns a map of prefix to filter, for all registered filters with valid prefixes.
receivers
registerFilter Registers a filter within the locator.
sender
senderSignalIndex
timerEvent

Signals

finished Emitted when locator has finished a query, either as a result of successful completion or early cancelation.
foundResult Emitted whenever a filter encounters a matching result after the fetchResults() method is called.

Attributes

CORE_FILTERS
CORE_FILTERS = ['actions', 'processing_alg', 'layertree', 'layouts', 'features', 'allfeatures', 'calculator', 'bookmarks', 'optionpages', 'edit_features']
cancel(self)

Cancels any current running query, and blocks until query is completely canceled by all filters.

cancelWithoutBlocking(self)

Triggers cancelation of any current running query without blocking. The query may take some time to cancel after calling this.

See also

cancel()

childEvent()
clearPreviousResults(self)

Will call clearPreviousResults on all filters

New in version 3.2.

connectNotify()
customEvent()
deregisterFilter(self, filter: QgsLocatorFilter)

Deregisters a filter from the locator and deletes it. Calling this will block whilst any currently running query is terminated.

Plugins which register filters to the locator must take care to correctly call deregisterFilter() to deregister their filters upon plugin unload to avoid crashes.

See also

registerFilter()

disconnectNotify()
fetchResults(self, string: str, context: QgsLocatorContext, feedback: QgsFeedback = None)

Triggers the background fetching of filter results for a specified search string. The context argument encapsulates the context relating to the search (such as a map extent to prioritize).

If specified, the feedback object must exist for the lifetime of this query.

The foundResult() signal will be emitted for each individual result encountered by the registered filters.

filters(self, prefix: str = '') → object

Returns the list of filters registered in the locator.

Parameters:prefix – If prefix is not empty, the list returned corresponds to the filter with the given active prefix
finished

Emitted when locator has finished a query, either as a result of successful completion or early cancelation. [signal]

foundResult

Emitted whenever a filter encounters a matching result after the fetchResults() method is called. [signal]

isRunning(self) → bool

Returns true if a query is currently being executed by the locator.

isSignalConnected()
prefixedFilters(self) → object

Returns a map of prefix to filter, for all registered filters with valid prefixes.

See also

filters()

Deprecated since version since: QGIS 3.2 use filters() instead

receivers()
registerFilter(self, filter: QgsLocatorFilter)

Registers a filter within the locator. Ownership of the filter is transferred to the locator.

Warning

Plugins which register filters to the locator must take care to correctly call deregisterFilter() and deregister their filters upon plugin unload to avoid crashes.

sender()
senderSignalIndex()
timerEvent()