QGIS API Documentation  2.99.0-Master (90ae728)
Public Member Functions | List of all members
QgsPluginLayerRegistry Class Reference

A registry of plugin layers types. More...

#include <qgspluginlayerregistry.h>

Public Member Functions

 QgsPluginLayerRegistry ()
 
 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...
 
QgsPluginLayercreateLayer (const QString &typeName, const QString &uri=QString())
 Return new layer if corresponding plugin has been found, else return NULL. More...
 
QgsPluginLayerRegistryoperator= (const QgsPluginLayerRegistry &rh)=delete
 QgsPluginLayerRegistry cannot be copied. More...
 
QgsPluginLayerTypepluginLayerType (const QString &typeName)
 Return 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 64 of file qgspluginlayerregistry.h.

Constructor & Destructor Documentation

◆ QgsPluginLayerRegistry() [1/2]

QgsPluginLayerRegistry::QgsPluginLayerRegistry ( )

Definition at line 55 of file qgspluginlayerregistry.cpp.

◆ ~QgsPluginLayerRegistry()

QgsPluginLayerRegistry::~QgsPluginLayerRegistry ( )

Definition at line 59 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 77 of file qgspluginlayerregistry.cpp.

◆ createLayer()

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

Return new layer if corresponding plugin has been found, else return NULL.

Note
optional param uri added in 2.10

Definition at line 120 of file qgspluginlayerregistry.cpp.

◆ operator=()

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

QgsPluginLayerRegistry cannot be copied.

◆ pluginLayerType()

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

Return plugin layer type metadata or NULL if doesn't exist.

Definition at line 114 of file qgspluginlayerregistry.cpp.

◆ pluginLayerTypes()

QStringList QgsPluginLayerRegistry::pluginLayerTypes ( )

List all known layer types.

Note
added in v2.1

Definition at line 72 of file qgspluginlayerregistry.cpp.

◆ removePluginLayerType()

bool QgsPluginLayerRegistry::removePluginLayerType ( const QString &  typeName)

Remove plugin layer type and return true on success.

Definition at line 90 of file qgspluginlayerregistry.cpp.


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