Class: QgsAdvancedDigitizingToolAbstractMetadata

Stores metadata about one advanced digitizing tool class.

Added in version 3.40.

Methods

createTool

Returns new tool of this type.

icon

Returns the tool's icon

name

Returns the tool's unique name

visibleName

Returns the tool's translatable user-friendly name

class qgis.gui.QgsAdvancedDigitizingToolAbstractMetadata[source]

Bases: object

__init__(name: str | None, visibleName: str | None, icon: QIcon = QIcon())

Constructor for QgsAdvancedDigitizingToolAbstractMetadata with the specified tool name.

visibleName should be set to a translated, user visible name identifying the corresponding annotation item.

An optional icon can be set, which will be used by the advanced digitizing dock widget.

Parameters:
  • name (Optional[str])

  • visibleName (Optional[str])

  • icon (QIcon = QIcon())

__init__(a0: QgsAdvancedDigitizingToolAbstractMetadata)
Parameters:

a0 (QgsAdvancedDigitizingToolAbstractMetadata)

createTool(self, canvas: QgsMapCanvas | None, cadDockWidget: QgsAdvancedDigitizingDockWidget | None) QgsAdvancedDigitizingTool | None[source]

Returns new tool of this type. Return None on error

Parameters:
Return type:

Optional[QgsAdvancedDigitizingTool]

icon(self) QIcon[source]

Returns the tool’s icon

Return type:

QIcon

name(self) str[source]

Returns the tool’s unique name

Return type:

str

visibleName(self) str[source]

Returns the tool’s translatable user-friendly name

Return type:

str