QGIS API Documentation  2.17.0-Master (0497e4a)
Public Member Functions | Static Public Member Functions | List of all members
QgsPluginLayerRegistry Class Reference

a registry of plugin layers types More...

#include <qgspluginlayerregistry.h>

Public Member Functions

 ~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...
 
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...
 

Static Public Member Functions

static QgsPluginLayerRegistryinstance ()
 Means of accessing canonical single instance. More...
 

Detailed Description

a registry of plugin layers types

Definition at line 59 of file qgspluginlayerregistry.h.

Constructor & Destructor Documentation

§ ~QgsPluginLayerRegistry()

QgsPluginLayerRegistry::~QgsPluginLayerRegistry ( )

Definition at line 73 of file qgspluginlayerregistry.cpp.

Member Function Documentation

§ addPluginLayerType()

bool QgsPluginLayerRegistry::addPluginLayerType ( QgsPluginLayerType pluginLayerType)

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

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

§ instance()

QgsPluginLayerRegistry * QgsPluginLayerRegistry::instance ( )
static

Means of accessing canonical single instance.

Definition at line 59 of file qgspluginlayerregistry.cpp.

§ pluginLayerType()

QgsPluginLayerType * QgsPluginLayerRegistry::pluginLayerType ( const QString typeName)

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

Definition at line 128 of file qgspluginlayerregistry.cpp.

§ pluginLayerTypes()

QStringList QgsPluginLayerRegistry::pluginLayerTypes ( )

List all known layer types.

Note
added in v2.1

Definition at line 86 of file qgspluginlayerregistry.cpp.

§ removePluginLayerType()

bool QgsPluginLayerRegistry::removePluginLayerType ( const QString typeName)

Remove plugin layer type and return true on success.

Definition at line 104 of file qgspluginlayerregistry.cpp.


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