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
Returns
True
if some text to be search is pending in the queueThis will invalidate current search results
Returns
True
if the a search is currently runningReturns the locator
Perform a search
Returns the proxy model
Triggers the result at given
index
and with optionalactionId
if an additional action was triggeredUpdate the canvas CRS used to create search context
Update the canvas extent used to create search context
Signals
Emitted when the running status changes [signal]
Emitted when a result is added [signal]
Emitted when the results are cleared [signal]
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- hasQueueRequested(self) bool ¶
Returns
True
if some text to be search is pending in the queue- Return type
bool
- invalidateResults(self)¶
This will invalidate current search results
- isRunning(self) bool ¶
Returns
True
if the a search is currently running- Return type
bool
- isRunningChanged¶
Emitted when the running status changes [signal]
- isSignalConnected(self, QMetaMethod) bool ¶
- locator(self) QgsLocator ¶
Returns the locator
- Return type
- performSearch(self, text: str)¶
Perform a search
- Parameters
text (str) –
- proxyModel(self) QgsLocatorProxyModel ¶
Returns the proxy model
- Return type
- receivers(self, PYQT_SIGNAL) int ¶
- resultAdded¶
Emitted when a result is added [signal]
- resultsCleared¶
Emitted when the results are cleared [signal]
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- timerEvent(self, QTimerEvent)¶
- triggerResult(self, index: QModelIndex, actionId: int = - 1)¶
Triggers the result at given
index
and with optionalactionId
if an additional action was triggered- Parameters
index (QModelIndex) –
actionId (int = -1) –
- updateCanvasCrs(self, crs: QgsCoordinateReferenceSystem)¶
Update the canvas CRS used to create search context
- Parameters
crs (QgsCoordinateReferenceSystem) –
- updateCanvasExtent(self, extent: QgsRectangle)¶
Update the canvas extent used to create search context
- Parameters
extent (QgsRectangle) –