QgsRendererRegistry class

Registry of renderers.

QgsRendererRegistry is not usually directly created, but rather accessed through QgsApplication::rendererRegistry().

Constructors, destructors, conversion operators

QgsRendererRegistry(const QgsRendererRegistry& rh) deleted
QgsRendererRegistry cannot be copied.

Public functions

auto addRenderer(QgsRendererAbstractMetadata* metadata) -> bool
Adds a renderer to the registry.
auto operator=(const QgsRendererRegistry& rh) -> QgsRendererRegistry& deleted
QgsRendererRegistry cannot be copied.
auto removeRenderer(const QString& rendererName) -> bool
Removes a renderer from registry.
auto rendererMetadata(const QString& rendererName) -> QgsRendererAbstractMetadata*
Returns the metadata for a specified renderer.
auto renderersList(QgsRendererAbstractMetadata::LayerTypes layerTypes = QgsRendererAbstractMetadata::All) const -> QStringList
Returns a list of available renderers.
auto renderersList(const QgsVectorLayer* layer) const -> QStringList
Returns a list of available renderers which are compatible with a specified layer.

Function documentation

bool QgsRendererRegistry::addRenderer(QgsRendererAbstractMetadata* metadata)

Adds a renderer to the registry.

Parameters
metadata renderer metadata
Returns true if renderer was added successfully, or false if renderer could not be added (e.g., a renderer with a duplicate name already exists)

Takes ownership of the metadata object.

bool QgsRendererRegistry::removeRenderer(const QString& rendererName)

Removes a renderer from registry.

Parameters
rendererName name of renderer to remove from registry
Returns true if renderer was successfully removed, or false if matching renderer could not be found

QgsRendererAbstractMetadata* QgsRendererRegistry::rendererMetadata(const QString& rendererName)

Returns the metadata for a specified renderer.

Returns NULL if a matching renderer was not found in the registry.

QStringList QgsRendererRegistry::renderersList(QgsRendererAbstractMetadata::LayerTypes layerTypes = QgsRendererAbstractMetadata::All) const

Returns a list of available renderers.

Parameters
layerTypes flags to filter the renderers by compatible layer types

QStringList QgsRendererRegistry::renderersList(const QgsVectorLayer* layer) const

Returns a list of available renderers which are compatible with a specified layer.

Parameters
layer vector layer