A registry of plugin layers types. More...

#include <qgspluginlayerregistry.h>

Public Member Functions
	QgsPluginLayerRegistry ()=default
	Constructor for QgsPluginLayerRegistry. More...

	QgsPluginLayerRegistry (const QgsPluginLayerRegistry &rh)=delete
	QgsPluginLayerRegistry cannot be copied. More...

	~QgsPluginLayerRegistry ()

bool	addPluginLayerType (QgsPluginLayerType *pluginLayerType)
	Add plugin layer type (take ownership) and return `true` on success. More...

QgsPluginLayer *	createLayer (const QString &typeName, const QString &uri=QString())
	Returns new layer if corresponding plugin has been found else returns `nullptr`. More...

QgsPluginLayerRegistry &	operator= (const QgsPluginLayerRegistry &rh)=delete
	QgsPluginLayerRegistry cannot be copied. More...

QgsPluginLayerType *	pluginLayerType (const QString &typeName)
	Returns plugin layer type metadata or `nullptr` if doesn't exist. More...

QStringList	pluginLayerTypes ()
	List all known layer types. More...

bool	removePluginLayerType (const QString &typeName)
	Remove plugin layer type and return `true` on success. More...

Detailed Description

A registry of plugin layers types.

QgsPluginLayerRegistry is not usually directly created, but rather accessed through QgsApplication::pluginLayerRegistry().

Definition at line 68 of file qgspluginlayerregistry.h.

Constructor & Destructor Documentation

◆ QgsPluginLayerRegistry() [1/2]

QgsPluginLayerRegistry::QgsPluginLayerRegistry ( )

default

Constructor for QgsPluginLayerRegistry.

◆ ~QgsPluginLayerRegistry()

QgsPluginLayerRegistry::~QgsPluginLayerRegistry ( )

Definition at line 55 of file qgspluginlayerregistry.cpp.

◆ QgsPluginLayerRegistry() [2/2]

QgsPluginLayerRegistry::QgsPluginLayerRegistry ( const QgsPluginLayerRegistry & rh )

delete

QgsPluginLayerRegistry cannot be copied.

Member Function Documentation

◆ addPluginLayerType()

bool QgsPluginLayerRegistry::addPluginLayerType ( QgsPluginLayerType * pluginLayerType )

Add plugin layer type (take ownership) and return true on success.

Definition at line 73 of file qgspluginlayerregistry.cpp.

◆ createLayer()

QgsPluginLayer * QgsPluginLayerRegistry::createLayer	(	const QString &	typeName,
		const QString &	uri = `QString()`
	)

Returns new layer if corresponding plugin has been found else returns nullptr.

Note: parameter uri has been added in QGIS 2.10

Definition at line 117 of file qgspluginlayerregistry.cpp.

◆ operator=()

QgsPluginLayerRegistry & QgsPluginLayerRegistry::operator= ( const QgsPluginLayerRegistry & rh )

delete

QgsPluginLayerRegistry cannot be copied.

◆ pluginLayerType()

QgsPluginLayerType * QgsPluginLayerRegistry::pluginLayerType ( const QString & typeName )

Returns plugin layer type metadata or nullptr if doesn't exist.

Definition at line 111 of file qgspluginlayerregistry.cpp.

◆ pluginLayerTypes()

QStringList QgsPluginLayerRegistry::pluginLayerTypes ( )

List all known layer types.

Definition at line 68 of file qgspluginlayerregistry.cpp.

◆ removePluginLayerType()

bool QgsPluginLayerRegistry::removePluginLayerType ( const QString & typeName )

Remove plugin layer type and return true on success.

Definition at line 86 of file qgspluginlayerregistry.cpp.

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

/build/qgis-3.28.0+99sid/src/core/qgspluginlayerregistry.h
/build/qgis-3.28.0+99sid/src/core/qgspluginlayerregistry.cpp

Public Member Functions