QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
QgsPluginLayerRegistry Class Reference

A registry of plugin layers types. More...

#include <qgspluginlayerregistry.h>

Public Member Functions

 QgsPluginLayerRegistry ()=default
 QgsPluginLayerRegistry (const QgsPluginLayerRegistry &rh)=delete
 ~QgsPluginLayerRegistry ()
bool addPluginLayerType (QgsPluginLayerType *pluginLayerType)
 Add plugin layer type (take ownership) and return true on success.
QgsPluginLayercreateLayer (const QString &typeName, const QString &uri=QString())
 Returns new layer if corresponding plugin has been found else returns nullptr.
QgsPluginLayerRegistryoperator= (const QgsPluginLayerRegistry &rh)=delete
QgsPluginLayerTypepluginLayerType (const QString &typeName)
 Returns plugin layer type metadata or nullptr if doesn't exist.
QStringList pluginLayerTypes ()
 List all known layer types.
bool removePluginLayerType (const QString &typeName)
 Remove plugin layer type and return true on success.

Detailed Description

A registry of plugin layers types.

QgsPluginLayerRegistry is not usually directly created, but rather accessed through QgsApplication::pluginLayerRegistry().

Definition at line 67 of file qgspluginlayerregistry.h.

Constructor & Destructor Documentation

◆ QgsPluginLayerRegistry() [1/2]

QgsPluginLayerRegistry::QgsPluginLayerRegistry ( )
default

◆ ~QgsPluginLayerRegistry()

QgsPluginLayerRegistry::~QgsPluginLayerRegistry ( )

Definition at line 56 of file qgspluginlayerregistry.cpp.

◆ QgsPluginLayerRegistry() [2/2]

QgsPluginLayerRegistry::QgsPluginLayerRegistry ( const QgsPluginLayerRegistry & rh)
delete

Member Function Documentation

◆ addPluginLayerType()

bool QgsPluginLayerRegistry::addPluginLayerType ( QgsPluginLayerType * pluginLayerType)

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

Definition at line 74 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 nullptr.

Note
parameter uri has been added in QGIS 2.10

Definition at line 118 of file qgspluginlayerregistry.cpp.

◆ operator=()

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

◆ pluginLayerType()

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

Returns plugin layer type metadata or nullptr if doesn't exist.

Definition at line 112 of file qgspluginlayerregistry.cpp.

◆ pluginLayerTypes()

QStringList QgsPluginLayerRegistry::pluginLayerTypes ( )

List all known layer types.

Definition at line 69 of file qgspluginlayerregistry.cpp.

◆ removePluginLayerType()

bool QgsPluginLayerRegistry::removePluginLayerType ( const QString & typeName)

Remove plugin layer type and return true on success.

Definition at line 87 of file qgspluginlayerregistry.cpp.


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