QGIS API Documentation  2.9.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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
QgsPluginLayercreateLayer (QString typeName, const QString &uri=QString())
 return new layer if corresponding plugin has been found, else return NULL.
QgsPluginLayerTypepluginLayerType (QString typeName)
 return plugin layer type metadata or NULL if doesn't exist
QStringList pluginLayerTypes ()
 list all known layer types
bool removePluginLayerType (QString typeName)
 remove plugin layer type and return true on success

Static Public Member Functions

static QgsPluginLayerRegistryinstance ()
 means of accessing canonical single instance

Detailed Description

a registry of plugin layers types

Definition at line 59 of file qgspluginlayerregistry.h.

Constructor & Destructor Documentation

QgsPluginLayerRegistry::~QgsPluginLayerRegistry ( )

Definition at line 73 of file qgspluginlayerregistry.cpp.

Member Function Documentation

bool QgsPluginLayerRegistry::addPluginLayerType ( QgsPluginLayerType pluginLayerType)

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

Definition at line 88 of file qgspluginlayerregistry.cpp.

QgsPluginLayer * QgsPluginLayerRegistry::createLayer ( 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 130 of file qgspluginlayerregistry.cpp.

QgsPluginLayerRegistry * QgsPluginLayerRegistry::instance ( )
static

means of accessing canonical single instance

Definition at line 59 of file qgspluginlayerregistry.cpp.

QgsPluginLayerType * QgsPluginLayerRegistry::pluginLayerType ( QString  typeName)

return plugin layer type metadata or NULL if doesn't exist

Definition at line 124 of file qgspluginlayerregistry.cpp.

QStringList QgsPluginLayerRegistry::pluginLayerTypes ( )

list all known layer types

Note
added in v2.1

Definition at line 83 of file qgspluginlayerregistry.cpp.

bool QgsPluginLayerRegistry::removePluginLayerType ( QString  typeName)

remove plugin layer type and return true on success

Definition at line 100 of file qgspluginlayerregistry.cpp.


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