Class: QgsLocatorModelBridge

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

Bases: PyQt5.QtCore.QObject

Constructor of QgsLocatorModelBridge

The QgsLocatorModelBridge class provides the core functionality to be used in a locator widget.

New in version 3.6: Methods

childEvent
connectNotify
customEvent
disconnectNotify
hasQueueRequested Returns true if some text to be search is pending in the queue
invalidateResults This will invalidate current search results
isRunning Returns true if the a search is currently running
isSignalConnected
locator Returns the locator
performSearch Perform a search
proxyModel Returns the proxy model
receivers
sender
senderSignalIndex
timerEvent
triggerResult Triggers the result at given index and with optional actionId if an additional action was triggered
updateCanvasCrs Update the canvas CRS used to create search context
updateCanvasExtent Update the canvas extent used to create search context

Signals

isRunningChanged Emitted when the running status changes [signal]
resultAdded Emitted when a result is added [signal]
resultsCleared Emitted when the results are cleared [signal]

Attributes

childEvent()
connectNotify()
customEvent()
disconnectNotify()
hasQueueRequested(self) → bool

Returns true if some text to be search is pending in the queue

invalidateResults(self)

This will invalidate current search results

isRunning(self) → bool

Returns true if the a search is currently running

isRunningChanged

Emitted when the running status changes [signal]

isSignalConnected()
locator(self) → QgsLocator

Returns the locator

performSearch(self, text: str)

Perform a search

proxyModel(self) → QgsLocatorProxyModel

Returns the proxy model

receivers()
resultAdded

Emitted when a result is added [signal]

resultsCleared

Emitted when the results are cleared [signal]

sender()
senderSignalIndex()
timerEvent()
triggerResult(self, index: QModelIndex, actionId: int = -1)

Triggers the result at given index and with optional actionId if an additional action was triggered

updateCanvasCrs(self, crs: QgsCoordinateReferenceSystem)

Update the canvas CRS used to create search context

updateCanvasExtent(self, extent: QgsRectangle)

Update the canvas extent used to create search context