Class: QgsSymbolConverterRegistry

A registry of known symbol converters.

QgsSymbolConverterRegistry is not usually directly created, but rather accessed through QgsApplication.symbolConverterRegistry().

Added in version 4.2.

List of all members, including inherited members

Class Hierarchy

Inheritance diagram of qgis.core.QgsSymbolConverterRegistry

Base classes

QObject

Methods

addConverter

Adds a converter to the registry.

converter

Returns the converter with matching name, or None if no matching converter is registered.

converterNames

Returns a list of the registered converter names (IDs).

removeConverter

Removes the converter with matching name.

class qgis.core.QgsSymbolConverterRegistry[source]

Bases: QObject

__init__(parent: QObject | None = None)

Creates a new empty symbol converter registry.

QgsSymbolConverterRegistry is not usually directly created, but rather accessed through QgsApplication.symbolConverterRegistry().

Parameters:

parent (Optional[QObject] = None)

addConverter(self, converter: QgsAbstractSymbolConverter | None) bool[source]

Adds a converter to the registry.

Ownership of the converter is transferred to the registry.

Return type:

bool

Returns:

True if the converter was successfully added.

Parameters:

converter (Optional[QgsAbstractSymbolConverter])

converter(self, name: str | None) QgsAbstractSymbolConverter | None[source]

Returns the converter with matching name, or None if no matching converter is registered.

Parameters:

name (Optional[str])

Return type:

Optional[QgsAbstractSymbolConverter]

converterNames(self) list[str][source]

Returns a list of the registered converter names (IDs).

Return type:

list[str]

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

Removes the converter with matching name.

The converter will be deleted.

Return type:

bool

Returns:

True if the converter was successfully removed.

Parameters:

name (Optional[str])