Class: QgsMapToolEdit

class qgis.gui.QgsMapToolEdit

Bases: qgis._gui.QgsMapTool

Base class for map tools that edit vector geometry

Enums

Methods

addTopologicalPoints

Adds a list of vertices to other features to keep topology up to date, e.g.

childEvent

connectNotify

createGeometryRubberBand

createRubberBand

Creates a rubber band with the color/line width from the QGIS settings.

currentVectorLayer

Returns the current vector layer of the map canvas or 0

customEvent

defaultZValue

Returns default Z value Use for set Z coordinate to new vertex for 2.5d geometries

digitizingFillColor

Returns fill color for rubber bands (from global settings)

digitizingStrokeColor

Returns stroke color for rubber bands (from global settings)

digitizingStrokeWidth

Returns stroke width for rubber bands (from global settings)

disconnectNotify

flags

isSignalConnected

notifyNotEditableLayer

Display a timed message bar noting the active vector layer is not editable.

notifyNotVectorLayer

Display a timed message bar noting the active layer is not vector.

receivers

sender

senderSignalIndex

timerEvent

toCanvasCoordinates

toLayerCoordinates

toMapCoordinates

toMapCoordinatesV2

Signals

Attributes

InvalidCanvas

InvalidLayer

Success

InvalidCanvas = 1
InvalidLayer = 2
Success = 0
class TopologicalResult

Bases: int

addTopologicalPoints(self, vertices: Iterable[QgsPointXY]) → QgsMapToolEdit.TopologicalResult

Adds a list of vertices to other features to keep topology up to date, e.g. to neighbouring polygons. The vertices list specifies a set of topological points to add, in the layer’s coordinate reference system.

addTopologicalPoints(self, vertices: Iterable[QgsPoint]) -> QgsMapToolEdit.TopologicalResult Adds a list of vertices to other features to keep topology up to date, e.g. to neighbouring polygons. The vertices list specifies a set of topological points to add, in the layer’s coordinate reference system.

New in version 3.10.

childEvent()
connectNotify()
createGeometryRubberBand(self, geometryType: QgsWkbTypes.GeometryType = QgsWkbTypes.LineGeometry, alternativeBand: bool = False) → QgsGeometryRubberBand
createRubberBand(self, geometryType: QgsWkbTypes.GeometryType = QgsWkbTypes.LineGeometry, alternativeBand: bool = False) → QgsRubberBand

Creates a rubber band with the color/line width from the QGIS settings. The caller takes ownership of the returned object

Parameters
  • geometryType

  • alternativeBand – if True, rubber band will be set with more transparency and a dash pattern. default is False.

currentVectorLayer(self) → QgsVectorLayer

Returns the current vector layer of the map canvas or 0

customEvent()
defaultZValue(self) → float

Returns default Z value Use for set Z coordinate to new vertex for 2.5d geometries

digitizingFillColor() → QColor

Returns fill color for rubber bands (from global settings)

digitizingStrokeColor() → QColor

Returns stroke color for rubber bands (from global settings)

digitizingStrokeWidth() → int

Returns stroke width for rubber bands (from global settings)

disconnectNotify()
flags(self) → QgsMapTool.Flags
isSignalConnected()
notifyNotEditableLayer(self)

Display a timed message bar noting the active vector layer is not editable.

notifyNotVectorLayer(self)

Display a timed message bar noting the active layer is not vector.

receivers()
sender()
senderSignalIndex()
timerEvent()
toCanvasCoordinates()
toLayerCoordinates()
toMapCoordinates()
toMapCoordinatesV2()