Subgroup: Locator
Class: QgsLocatorAutomaticModel¶
-
class
qgis.core.
QgsLocatorAutomaticModel
(locator: QgsLocator)¶ Bases:
qgis._core.QgsLocatorModel
Constructor for QgsLocatorAutomaticModel, linked with the specified
locator
.The
locator
is used as the model’s parent.A QgsLocatorModel which has is associated directly with a
QgsLocator
, and is automatically populated with results from locator searches.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.New in version 3.0: Methods
beginInsertColumns
beginInsertRows
beginMoveColumns
beginMoveRows
beginRemoveColumns
beginRemoveRows
beginResetModel
changePersistentIndex
changePersistentIndexList
childEvent
connectNotify
createContext
Returns a new locator context for searches. createIndex
customEvent
decodeData
disconnectNotify
encodeData
endInsertColumns
endInsertRows
endMoveColumns
endMoveRows
endRemoveColumns
endRemoveRows
endResetModel
isSignalConnected
locator
Returns a pointer to the locator utilized by this model. persistentIndexList
receivers
resetInternalData
search
Enqueues a search for a specified string
within the model.sender
senderSignalIndex
timerEvent
Signals
Attributes
-
beginInsertColumns
()¶
-
beginInsertRows
()¶
-
beginMoveColumns
()¶
-
beginMoveRows
()¶
-
beginRemoveColumns
()¶
-
beginRemoveRows
()¶
-
beginResetModel
()¶
-
changePersistentIndex
()¶
-
changePersistentIndexList
()¶
-
childEvent
()¶
-
connectNotify
()¶
-
createContext
(self) → QgsLocatorContext¶ 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.
-
createIndex
()¶
-
customEvent
()¶
-
decodeData
()¶
-
disconnectNotify
()¶
-
encodeData
()¶
-
endInsertColumns
()¶
-
endInsertRows
()¶
-
endMoveColumns
()¶
-
endMoveRows
()¶
-
endRemoveColumns
()¶
-
endRemoveRows
()¶
-
endResetModel
()¶
-
isSignalConnected
()¶
-
locator
(self) → QgsLocator¶ Returns a pointer to the locator utilized by this model.
-
persistentIndexList
()¶
-
receivers
()¶
-
resetInternalData
()¶
-
search
(self, string: str)¶ 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.
-
sender
()¶
-
senderSignalIndex
()¶
-
timerEvent
()¶
-