QgsPluginLayerRegistry Class Reference

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 a nullptr. More...
QgsPluginLayerRegistry &	operator= (const QgsPluginLayerRegistry &rh)=delete
	QgsPluginLayerRegistry cannot be copied. More...
QgsPluginLayerType *	pluginLayerType (const QString &typeName)
	Returns plugin layer type metadata or NULL 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 a nullptr.

Note

parameter uri has been added in QGIS 2.10

Definition at line 116 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 NULL if doesn't exist.

Definition at line 110 of file qgspluginlayerregistry.cpp.

pluginLayerTypes()

QStringList QgsPluginLayerRegistry::pluginLayerTypes

(

)

List all known layer types.

Since

QGIS

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:

• /tmp/buildd/qgis-3.2.0+99unstable/src/core/qgspluginlayerregistry.h
• /tmp/buildd/qgis-3.2.0+99unstable/src/core/qgspluginlayerregistry.cpp