Class: QgsMapCanvasSnappingUtils¶

class qgis.gui.QgsMapCanvasSnappingUtils(canvas: QgsMapCanvas, parent: QObject = None)¶

Bases: QgsSnappingUtils

Construct map canvas snapping utils object

Parameters

canvas (QgsMapCanvas) – map canvas
parent (QObject = None) – parent object if False it will block until indexing is done

Snapping utils instance that is connected to a canvas and updates the configuration (map settings + current layer) whenever that is changed in the canvas.

Methods

`childEvent`
`clearAllLocators`	Deletes all existing locators (e.g.
`connectNotify`
`customEvent`
`disconnectNotify`
`isSignalConnected`
`prepareIndexProgress`	param index
`prepareIndexStarting`	param count
`receivers`
`sender`
`senderSignalIndex`
`timerEvent`

childEvent(self, QChildEvent)¶

clearAllLocators(self)¶: Deletes all existing locators (e.g. when destination CRS has changed and we need to reindex)

connectNotify(self, QMetaMethod)¶

customEvent(self, QEvent)¶

disconnectNotify(self, QMetaMethod)¶

isSignalConnected(self, QMetaMethod) → bool¶

prepareIndexProgress(self, index: int)¶

Parameters: index (int) –

prepareIndexStarting(self, count: int)¶

Parameters: count (int) –

receivers(self, PYQT_SIGNAL) → int¶

sender(self) → QObject¶

senderSignalIndex(self) → int¶

timerEvent(self, QTimerEvent)¶