QgsPluginLayerRegistry Class Reference

a registry of plugin layers types More...

#include <qgspluginlayerregistry.h>

Collaboration diagram for QgsPluginLayerRegistry:

Public Member Functions
	~QgsPluginLayerRegistry ()
QStringList	pluginLayerTypes ()
	list all known layer types More...
bool	addPluginLayerType (QgsPluginLayerType *pluginLayerType)
	add plugin layer type (take ownership) and return true on success More...
bool	removePluginLayerType (QString typeName)
	remove plugin layer type and return true on success More...
QgsPluginLayerType *	pluginLayerType (QString typeName)
	return plugin layer type metadata or NULL if doesn't exist More...
QgsPluginLayer *	createLayer (QString typeName)
	return new layer if corresponding plugin has been found, else return NULL More...

Static Public Member Functions
static QgsPluginLayerRegistry *	instance ()
	means of accessing canonical single instance More...

Private Types
typedef QMap< QString, QgsPluginLayerType * >	PluginLayerTypes

Private Member Functions
	QgsPluginLayerRegistry ()
	private since instance() creates it More...

Private Attributes
PluginLayerTypes	mPluginLayerTypes

Static Private Attributes
static QgsPluginLayerRegistry *	_instance = NULL
	pointer to canonical Singleton object More...

Detailed Description

a registry of plugin layers types

Note

added in v1.5

Definition at line 58 of file qgspluginlayerregistry.h.

Member Typedef Documentation

typedef QMap<QString, QgsPluginLayerType*> QgsPluginLayerRegistry::PluginLayerTypes

private

Definition at line 85 of file qgspluginlayerregistry.h.

Constructor & Destructor Documentation

QgsPluginLayerRegistry::~QgsPluginLayerRegistry

(

)

Definition at line 67 of file qgspluginlayerregistry.cpp.

References mPluginLayerTypes, QgsDebugMsg, and removePluginLayerType().

QgsPluginLayerRegistry::QgsPluginLayerRegistry ( )

private

private since instance() creates it

Definition at line 63 of file qgspluginlayerregistry.cpp.

Referenced by instance().

Member Function Documentation

bool QgsPluginLayerRegistry::addPluginLayerType

(

QgsPluginLayerType *

pluginLayerType

)

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

Definition at line 82 of file qgspluginlayerregistry.cpp.

References mPluginLayerTypes, and QgsPluginLayerType::name().

QgsPluginLayer * QgsPluginLayerRegistry::createLayer

(

QString

typeName

)

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

Definition at line 124 of file qgspluginlayerregistry.cpp.

References QgsPluginLayerType::createLayer(), pluginLayerType(), and QgsDebugMsg.

Referenced by QgsProject::addLayer(), and QgsMapLayer::fromLayerDefinition().

QgsPluginLayerRegistry * QgsPluginLayerRegistry::instance ( )

static

means of accessing canonical single instance

Definition at line 53 of file qgspluginlayerregistry.cpp.

References _instance, and QgsPluginLayerRegistry().

Referenced by QgsProject::addLayer(), and QgsMapLayer::fromLayerDefinition().

QgsPluginLayerType * QgsPluginLayerRegistry::pluginLayerType

(

QString

typeName

)

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

Definition at line 118 of file qgspluginlayerregistry.cpp.

References mPluginLayerTypes.

Referenced by createLayer().

QStringList QgsPluginLayerRegistry::pluginLayerTypes

(

)

list all known layer types

Note

added in v2.1

Definition at line 77 of file qgspluginlayerregistry.cpp.

References mPluginLayerTypes.

bool QgsPluginLayerRegistry::removePluginLayerType

(

QString

typeName

)

remove plugin layer type and return true on success

Definition at line 94 of file qgspluginlayerregistry.cpp.

References QgsMapLayer::id(), QgsMapLayerRegistry::instance(), QgsMapLayerRegistry::mapLayers(), mPluginLayerTypes, QgsMapLayer::PluginLayer, QgsPluginLayer::pluginLayerType(), QgsMapLayerRegistry::removeMapLayers(), and QgsMapLayer::type().

Referenced by ~QgsPluginLayerRegistry().

Member Data Documentation

QgsPluginLayerRegistry * QgsPluginLayerRegistry::_instance = NULL

staticprivate

pointer to canonical Singleton object

Static calls to enforce singleton behaviour.

Definition at line 91 of file qgspluginlayerregistry.h.

Referenced by instance().

PluginLayerTypes QgsPluginLayerRegistry::mPluginLayerTypes

private

Definition at line 93 of file qgspluginlayerregistry.h.

Referenced by addPluginLayerType(), pluginLayerType(), pluginLayerTypes(), removePluginLayerType(), and ~QgsPluginLayerRegistry().

---

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

• /tmp/buildd/qgis-2.4.0/src/core/qgspluginlayerregistry.h
• /tmp/buildd/qgis-2.4.0/src/core/qgspluginlayerregistry.cpp