Class: QgsAdvancedDigitizingToolsRegistry

Registry of available advanced digitizing tools.

QgsAdvancedDigitizingToolsRegistry is not usually directly created, but rather accessed through QgsGui.advancedDigitizingToolsRegistry().

Added in version 3.40.

Methods

addDefaultTools

Adds the default tools shipped in QGIS

addTool

Adds an advanced digitizing tool (take ownership) and return True on success

removeTool

Removes the advanced digitizing tool matching the provided name and return True on success

toolMetadata

Returns the advanced digitizing tool matching the provided name or None when no match available

toolMetadataNames

Returns the list of registered tool names

class qgis.gui.QgsAdvancedDigitizingToolsRegistry[source]

Bases: object

addDefaultTools(self)[source]

Adds the default tools shipped in QGIS

addTool(self, toolMetaData: QgsAdvancedDigitizingToolAbstractMetadata | None) bool[source]

Adds an advanced digitizing tool (take ownership) and return True on success

Parameters:

toolMetaData (Optional[QgsAdvancedDigitizingToolAbstractMetadata])

Return type:

bool

removeTool(self, name: str | None) bool[source]

Removes the advanced digitizing tool matching the provided name and return True on success

Parameters:

name (Optional[str])

Return type:

bool

toolMetadata(self, name: str | None) QgsAdvancedDigitizingToolAbstractMetadata | None[source]

Returns the advanced digitizing tool matching the provided name or None when no match available

Parameters:

name (Optional[str])

Return type:

Optional[QgsAdvancedDigitizingToolAbstractMetadata]

toolMetadataNames(self) List[str][source]

Returns the list of registered tool names

Return type:

List[str]