A registry of known symbol converters. More...

#include <qgssymbolconverterregistry.h>

Inheritance diagram for QgsSymbolConverterRegistry:

Public Member Functions
	QgsSymbolConverterRegistry (QObject *parent=nullptr)
	Creates a new empty symbol converter registry.
	~QgsSymbolConverterRegistry () override
bool	addConverter (QgsAbstractSymbolConverter *converter)
	Adds a converter to the registry.
QgsAbstractSymbolConverter *	converter (const QString &name) const
	Returns the converter with matching name, or `nullptr` if no matching converter is registered.
QStringList	converterNames () const
	Returns a list of the registered converter names (IDs).
void	populate ()
	Adds the default symbol converters to the registry.
bool	removeConverter (const QString &name)
	Removes the converter with matching name.

Detailed Description

A registry of known symbol converters.

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

Since: QGIS 4.2

Definition at line 41 of file qgssymbolconverterregistry.h.

Constructor & Destructor Documentation

◆ QgsSymbolConverterRegistry()

QgsSymbolConverterRegistry::QgsSymbolConverterRegistry ( QObject * parent = nullptr )

Creates a new empty symbol converter registry.

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

Definition at line 29 of file qgssymbolconverterregistry.cpp.

◆ ~QgsSymbolConverterRegistry()

QgsSymbolConverterRegistry::~QgsSymbolConverterRegistry ( )

override

Definition at line 33 of file qgssymbolconverterregistry.cpp.

Member Function Documentation

◆ addConverter()

bool QgsSymbolConverterRegistry::addConverter ( QgsAbstractSymbolConverter * converter )

Adds a converter to the registry.

Ownership of the converter is transferred to the registry.

Returns: true if the converter was successfully added.

Definition at line 47 of file qgssymbolconverterregistry.cpp.

◆ converter()

QgsAbstractSymbolConverter * QgsSymbolConverterRegistry::converter ( const QString & name ) const

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

Definition at line 59 of file qgssymbolconverterregistry.cpp.

◆ converterNames()

QStringList QgsSymbolConverterRegistry::converterNames ( ) const

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

Definition at line 73 of file qgssymbolconverterregistry.cpp.

◆ populate()

void QgsSymbolConverterRegistry::populate ( )

Adds the default symbol converters to the registry.

Note: Not available through Python bindings.

Definition at line 38 of file qgssymbolconverterregistry.cpp.

◆ removeConverter()

bool QgsSymbolConverterRegistry::removeConverter ( const QString & name )

Removes the converter with matching name.

The converter will be deleted.

Returns: true if the converter was successfully removed.

Definition at line 64 of file qgssymbolconverterregistry.cpp.

The documentation for this class was generated from the following files:

/build/qgis-4.1.0+git20260419+3b8ef1f72a3+99sid/src/core/symbology/converters/qgssymbolconverterregistry.h
/build/qgis-4.1.0+git20260419+3b8ef1f72a3+99sid/src/core/symbology/converters/qgssymbolconverterregistry.cpp

Public Member Functions