Add API to QgsMapLayerRegistry to rely less on ids

Author: m-kuhn

python/core/qgsmaplayerregistry.sip

@@ -95,6 +95,21 @@ class QgsMapLayerRegistry : QObject
      */
     void removeMapLayers( const QStringList& theLayerIds );
 
+    /**
+     * @brief
+     * Remove a set of layers from the registry
+     *
+     * Any canvases using the affected layers will need to remove them
+     *
+     * The layers being removed are deleted as well as the registry
+     * table entries.
+     *
+     * @param layers  The layers to remove
+     *
+     * @note As a side-effect QgsProject is made dirty.
+     */
+    void removeMapLayers( const QList<QgsMapLayer*>& theLayerIds );
+
     /**
      * @brief
      * Remove a layer from qgis
@@ -110,6 +125,21 @@ class QgsMapLayerRegistry : QObject
      */
     void removeMapLayer( const QString& theLayerId );
 
+    /**
+     * @brief
+     * Remove a layer from qgis
+     *
+     * Any canvases using the affected layers will need to remove them
+     *
+     * The layer being removed is deleted as well as the registry
+     * table entry.
+     *
+     * @param layer   The layer to remove
+     *
+     * @note As a side-effect QgsProject is made dirty.
+     */
+    void removeMapLayer( QgsMapLayer* layer );
+
     /**
      * Remove all registered layers
      *
@@ -141,14 +171,30 @@ class QgsMapLayerRegistry : QObject
     void layersWillBeRemoved( const QStringList& theLayerIds );
 
     /**
-     * Emitted when a layer is removed from the registry
+     * Emitted when one or more layers are removed from the registry
+     *
+     * @param theLayerIds  A list layers which are removed.
+     */
+    void layersWillBeRemoved( const QList<QgsMapLayer*>& layer );
+
+    /**
+     * Emitted when an owned layer is removed from the registry
      *
      * @param theLayerId  The id of the layer being removed
      *
      * @note Consider using {@link layersWillBeRemoved()} instead
      */
     void layerWillBeRemoved( const QString& theLayerId );
 
+    /**
+     * Emitted when an owned layer is removed from the registry
+     *
+     * @param layer  The layer being removed
+     *
+     * @note Consider using {@link layersWillBeRemoved()} instead
+     */
+    void layerWillBeRemoved( QgsMapLayer* layer );
+
     /**
      * Emitted after one or more layers were removed from the registry
      *

src/core/qgsmaplayerregistry.cpp

@@ -116,26 +116,52 @@ QgsMapLayerRegistry::addMapLayer( QgsMapLayer* theMapLayer,
 //introduced in 1.8
 void QgsMapLayerRegistry::removeMapLayers( const QStringList& theLayerIds )
 {
-  emit layersWillBeRemoved( theLayerIds );
-
+  QList<QgsMapLayer*> layers;
   Q_FOREACH ( const QString &myId, theLayerIds )
   {
-    QgsMapLayer* lyr = mMapLayers[myId];
+    layers << mMapLayers[myId];
+  }
+
+  removeMapLayers( layers );
+}
+
+void QgsMapLayerRegistry::removeMapLayers( const QList<QgsMapLayer*>& layers )
+{
+  QStringList layerIds;
+
+  Q_FOREACH ( QgsMapLayer* layer, layers )
+  {
+    layerIds << layer->id();
+  }
+
+  emit layersWillBeRemoved( layerIds );
+  emit layersWillBeRemoved( layers );
+
+  Q_FOREACH ( QgsMapLayer* lyr, layers )
+  {
+    QString myId( lyr->id() );
     if ( mOwnedLayers.contains( lyr ) )
     {
       emit layerWillBeRemoved( myId );
+      emit layerWillBeRemoved( lyr );
       delete lyr;
       mOwnedLayers.remove( lyr );
     }
     mMapLayers.remove( myId );
     emit layerRemoved( myId );
   }
-  emit layersRemoved( theLayerIds );
+
+  emit layersRemoved( layerIds );
 }
 
 void QgsMapLayerRegistry::removeMapLayer( const QString& theLayerId )
 {
-  removeMapLayers( QStringList( theLayerId ) );
+  removeMapLayers( QList<QgsMapLayer*>() << mMapLayers[theLayerId] );
+}
+
+void QgsMapLayerRegistry::removeMapLayer( QgsMapLayer* layer )
+{
+  removeMapLayers( QList<QgsMapLayer*>() << layer );
 }
 
 void QgsMapLayerRegistry::removeAllMapLayers()
@@ -147,10 +173,6 @@ void QgsMapLayerRegistry::removeAllMapLayers()
   mMapLayers.clear();
 } // QgsMapLayerRegistry::removeAllMapLayers()
 
-void QgsMapLayerRegistry::clearAllLayerCaches()
-{
-}
-
 void QgsMapLayerRegistry::reloadAllLayers()
 {
   QMap<QString, QgsMapLayer *>::iterator it;

src/core/qgsmaplayerregistry.h

@@ -120,6 +120,21 @@ class CORE_EXPORT QgsMapLayerRegistry : public QObject
      */
     void removeMapLayers( const QStringList& theLayerIds );
 
+    /**
+     * @brief
+     * Remove a set of layers from the registry
+     *
+     * Any canvases using the affected layers will need to remove them
+     *
+     * The layers being removed are deleted as well as the registry
+     * table entries.
+     *
+     * @param layers  The layers to remove
+     *
+     * @note As a side-effect QgsProject is made dirty.
+     */
+    void removeMapLayers( const QList<QgsMapLayer*>& theLayerIds );
+
     /**
      * @brief
      * Remove a layer from qgis
@@ -135,6 +150,21 @@ class CORE_EXPORT QgsMapLayerRegistry : public QObject
      */
     void removeMapLayer( const QString& theLayerId );
 
+    /**
+     * @brief
+     * Remove a layer from qgis
+     *
+     * Any canvases using the affected layers will need to remove them
+     *
+     * The layer being removed is deleted as well as the registry
+     * table entry.
+     *
+     * @param layer   The layer to remove
+     *
+     * @note As a side-effect QgsProject is made dirty.
+     */
+    void removeMapLayer( QgsMapLayer* layer );
+
     /**
      * Remove all registered layers
      *
@@ -150,7 +180,7 @@ class CORE_EXPORT QgsMapLayerRegistry : public QObject
      * see ticket #1974 for more details.
      */
     //! @deprecated since 2.4 - does nothing
-    Q_DECL_DEPRECATED void clearAllLayerCaches();
+    Q_DECL_DEPRECATED void clearAllLayerCaches() {}
 
     /**
      * Reload all provider data caches (currently used for WFS and WMS providers)
@@ -166,14 +196,30 @@ class CORE_EXPORT QgsMapLayerRegistry : public QObject
     void layersWillBeRemoved( const QStringList& theLayerIds );
 
     /**
-     * Emitted when a layer is removed from the registry
+     * Emitted when one or more layers are removed from the registry
+     *
+     * @param theLayerIds  A list layers which are removed.
+     */
+    void layersWillBeRemoved( const QList<QgsMapLayer*>& layer );
+
+    /**
+     * Emitted when an owned layer is removed from the registry
      *
      * @param theLayerId  The id of the layer being removed
      *
      * @note Consider using {@link layersWillBeRemoved()} instead
      */
     void layerWillBeRemoved( const QString& theLayerId );
 
+    /**
+     * Emitted when an owned layer is removed from the registry
+     *
+     * @param layer  The layer being removed
+     *
+     * @note Consider using {@link layersWillBeRemoved()} instead
+     */
+    void layerWillBeRemoved( QgsMapLayer* layer );
+
     /**
      * Emitted after one or more layers were removed from the registry
      *