QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
qgspluginlayerregistry.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgspluginlayerregistry.cpp - class for
3  registering plugin layer creators
4  -------------------
5  begin : Mon Nov 30 2009
6  copyright : (C) 2009 by Mathias Walker, Sourcepole
7  email : mwa at sourcepole.ch
8  ***************************************************************************/
9 
10 /***************************************************************************
11  * *
12  * This program is free software; you can redistribute it and/or modify *
13  * it under the terms of the GNU General Public License as published by *
14  * the Free Software Foundation; either version 2 of the License, or *
15  * (at your option) any later version. *
16  * *
17  ***************************************************************************/
18 
19 #include "qgspluginlayerregistry.h"
20 #include "qgslogger.h"
21 #include "qgspluginlayer.h"
22 #include "qgsmaplayerregistry.h"
23 
25  : mName( name )
26 {
27 }
28 
30 {
31 }
32 
34 {
35  return mName;
36 }
37 
39 {
40  return NULL;
41 }
42 
44 {
45  Q_UNUSED( layer );
46  return false;
47 }
48 
49 //=============================================================================
50 
52 QgsPluginLayerRegistry* QgsPluginLayerRegistry::_instance = NULL;
54 {
55  if ( _instance == NULL )
56  {
57  _instance = new QgsPluginLayerRegistry();
58  }
59  return _instance;
60 }
61 
62 
63 QgsPluginLayerRegistry::QgsPluginLayerRegistry()
64 {
65 }
66 
68 {
69  if ( !mPluginLayerTypes.isEmpty() )
70  {
71  QgsDebugMsg( "QgsPluginLayerRegistry::~QgsPluginLayerRegistry(): creator list not empty" );
72  foreach ( QString typeName, mPluginLayerTypes.keys() )
73  removePluginLayerType( typeName );
74  }
75 }
76 
78 {
79  return mPluginLayerTypes.keys();
80 }
81 
83 {
84  if ( type == NULL )
85  return false;
86  if ( mPluginLayerTypes.contains( type->name() ) )
87  return false;
88 
89  mPluginLayerTypes[type->name()] = type;
90  return true;
91 }
92 
93 
95 {
96  if ( !mPluginLayerTypes.contains( typeName ) )
97  return false;
98 
99  // remove all remaining layers of this type - to avoid invalid behaviour
100  QList<QgsMapLayer*> layers = QgsMapLayerRegistry::instance()->mapLayers().values();
101  foreach ( QgsMapLayer* layer, layers )
102  {
103  if ( layer->type() == QgsMapLayer::PluginLayer )
104  {
105  QgsPluginLayer* pl = qobject_cast<QgsPluginLayer*>( layer );
106  if ( pl->pluginLayerType() == typeName )
107  {
109  QStringList() << layer->id() );
110  }
111  }
112  }
113 
114  delete mPluginLayerTypes.take( typeName );
115  return true;
116 }
117 
119 {
120  return mPluginLayerTypes.value( typeName, NULL );
121 }
122 
123 
125 {
126  QgsPluginLayerType* type = pluginLayerType( typeName );
127  if ( !type )
128  {
129  QgsDebugMsg( "Unknown plugin layer type: " + typeName );
130  return NULL;
131  }
132 
133  return type->createLayer();
134 }
QgsPluginLayerType * pluginLayerType(QString typeName)
return plugin layer type metadata or NULL if doesn't exist
Base class for all map layer types.
Definition: qgsmaplayer.h:48
QgsPluginLayer * createLayer(QString typeName)
return new layer if corresponding plugin has been found, else return NULL
QgsMapLayer::LayerType type() const
Get the type of the layer.
Definition: qgsmaplayer.cpp:89
a registry of plugin layers types
#define QgsDebugMsg(str)
Definition: qgslogger.h:33
Base class for plugin layers.
virtual QgsPluginLayer * createLayer()
return new layer of this type.
bool addPluginLayerType(QgsPluginLayerType *pluginLayerType)
add plugin layer type (take ownership) and return true on success
QString id() const
Get this layer's unique ID, this ID is used to access this layer from map layer registry.
Definition: qgsmaplayer.cpp:95
QString pluginLayerType()
return plugin layer type (the same as used in QgsPluginLayerRegistry)
virtual bool showLayerProperties(QgsPluginLayer *layer)
show plugin layer properties dialog.
bool removePluginLayerType(QString typeName)
remove plugin layer type and return true on success
static QgsMapLayerRegistry * instance()
Returns the instance pointer, creating the object on the first call.
QStringList pluginLayerTypes()
list all known layer types
void removeMapLayers(QStringList theLayerIds)
Remove a set of layers from the registry.
const QMap< QString, QgsMapLayer * > & mapLayers()
Retrieve the mapLayers collection (mainly intended for use by projection)
static QgsPluginLayerRegistry * instance()
means of accessing canonical single instance
class for creating plugin specific layers