QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Member Functions | Protected Attributes | List of all members
QgsPluginLayerType Class Reference

Class for creating plugin specific layers. More...

#include <qgspluginlayerregistry.h>

Public Member Functions

 QgsPluginLayerType (const QString &name)
 
virtual ~QgsPluginLayerType ()=default
 
virtual QgsPluginLayercreateLayer ()
 Returns new layer of this type. Return nullptr on error. More...
 
virtual QgsPluginLayercreateLayer (const QString &uri)
 Returns new layer of this type, using layer URI (specific to this plugin layer type). More...
 
QString name () const
 
virtual bool showLayerProperties (QgsPluginLayer *layer)
 Show plugin layer properties dialog. Return false if the dialog cannot be shown. More...
 

Protected Attributes

QString mName
 

Detailed Description

Class for creating plugin specific layers.

Definition at line 34 of file qgspluginlayerregistry.h.

Constructor & Destructor Documentation

◆ QgsPluginLayerType()

QgsPluginLayerType::QgsPluginLayerType ( const QString &  name)

Definition at line 24 of file qgspluginlayerregistry.cpp.

◆ ~QgsPluginLayerType()

virtual QgsPluginLayerType::~QgsPluginLayerType ( )
virtualdefault

Member Function Documentation

◆ createLayer() [1/2]

QgsPluginLayer * QgsPluginLayerType::createLayer ( )
virtual

Returns new layer of this type. Return nullptr on error.

Definition at line 34 of file qgspluginlayerregistry.cpp.

◆ createLayer() [2/2]

QgsPluginLayer * QgsPluginLayerType::createLayer ( const QString &  uri)
virtual

Returns new layer of this type, using layer URI (specific to this plugin layer type).

Return nullptr on error.

Definition at line 39 of file qgspluginlayerregistry.cpp.

◆ name()

QString QgsPluginLayerType::name ( ) const

Definition at line 29 of file qgspluginlayerregistry.cpp.

◆ showLayerProperties()

bool QgsPluginLayerType::showLayerProperties ( QgsPluginLayer layer)
virtual

Show plugin layer properties dialog. Return false if the dialog cannot be shown.

Definition at line 45 of file qgspluginlayerregistry.cpp.

Member Data Documentation

◆ mName

QString QgsPluginLayerType::mName
protected

Definition at line 55 of file qgspluginlayerregistry.h.


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