QgsMapSettings and QgsComposerMap store layers for rendering as weak …

…pointers ... instead of using layer IDs which need to be resolved using QgsProject
qgis · Dec 10, 2016 · c143be7 · c143be7
1 parent 64f1356
commit c143be7
Show file tree

Hide file tree

Showing 61 changed files with 340 additions and 281 deletions.
diff --git a/doc/api_break.dox b/doc/api_break.dox
@@ -527,6 +527,7 @@ QgsComposerLegendItem        {#qgis_api_break_3_0_QgsComposerLegendItem}
 QgsComposerMap        {#qgis_api_break_3_0_QgsComposerMap}
 --------------
 
+- layerSet() and setLayerSet() have been replaced by layers() and setLayers() which work with list of layers instead of layer IDs
 - containsWMSLayer() has been renamed to containsWmsLayer()
 - mapRenderer() has been removed. Use mapSettings() instead.
 - All grid style and format enums were moved to QgsComposerMapGrid.
@@ -1121,6 +1122,7 @@ QgsMapLayerRegistry        {#qgis_api_break_3_0_QgsMapLayerRegistry}
 QgsMapOverviewCanvas        {#qgis_api_break_3_0_QgsMapOverviewCanvas}
 --------------------
 
+- layerSet() and setLayerSet() have been replaced by layers() and setLayers() which work with list of layers instead of layer IDs
 - destinationSrsChanged() was renamed to destinationCrsChanged()
 
 
@@ -1174,6 +1176,7 @@ The whole class has been refactored to stop using WKB and to use QgsAbstractGeom
 QgsMapSettings        {#qgis_api_break_3_0_QgsMapSettings}
 --------------
 
+- layers() and setLayers() now work with list of layers instead of layer IDs
 - layerTransform() now returns a QgsCoordinateTransform object, not a pointer. An invalid QgsCoordinateTransform will
 be returned instead of a null pointer if no transformation is required.
 - destinationCrs() now returns a copy instead of a reference to the CRS. This has no effect on PyQGIS code, but c++

diff --git a/python/core/composer/qgscomposermap.sip b/python/core/composer/qgscomposermap.sip
@@ -136,9 +136,9 @@ class QgsComposerMap : QgsComposerItem
     void setKeepLayerSet( bool enabled );
 
     /** Getter for stored layer set that is used if mKeepLayerSet is true */
-    QStringList layerSet() const;
+    QList<QgsMapLayer*> layers() const;
     /** Setter for stored layer set that is used if mKeepLayerSet is true */
-    void setLayerSet( const QStringList& layerSet );
+    void setLayers( const QList<QgsMapLayer*> layers );
     /** Stores the current layer set of the qgis mapcanvas in mLayerSet*/
     void storeCurrentLayerSet();
 

diff --git a/python/core/qgsmapsettings.sip b/python/core/qgsmapsettings.sip
@@ -54,10 +54,13 @@ class QgsMapSettings
 
     //! Get list of layer IDs for map rendering
     //! The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top)
-    QStringList layers() const;
-    //! Set list of layer IDs for map rendering. The layers must be registered in QgsProject.
+    QStringList layerIds() const;
+    //! Get list of layers for map rendering
     //! The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top)
-    void setLayers( const QStringList& layers );
+    QList<QgsMapLayer*> layers();
+    //! Set list of layers for map rendering. The layers must be registered in QgsProject.
+    //! The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top)
+    void setLayers( const QList<QgsMapLayer*>& layers );
 
     //! Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one
     //! @note added in 2.8

diff --git a/python/gui/qgsmapoverviewcanvas.sip b/python/gui/qgsmapoverviewcanvas.sip
@@ -17,9 +17,10 @@ class QgsMapOverviewCanvas : QWidget
     void setBackgroundColor( const QColor& color );
 
     //! updates layer set for overview
-    void setLayerSet( const QStringList& layerSet );
+    void setLayers( const QList<QgsMapLayer*>& layers );
 
-    QStringList layerSet() const;
+    //! Returns list of layers visible in the overview
+    QList<QgsMapLayer*> layers() const;
 
     void enableAntiAliasing( bool flag );
 

diff --git a/src/app/composer/qgscomposermapwidget.cpp b/src/app/composer/qgscomposermapwidget.cpp
@@ -197,11 +197,11 @@ void QgsComposerMapWidget::keepLayersVisibilityPresetSelected()
     return;
 
   QString presetName = action->text();
-  QStringList lst = QgsMapThemes::instance()->orderedPresetVisibleLayers( presetName );
+  QList<QgsMapLayer*> lst = QgsMapThemes::instance()->orderedPresetVisibleLayers2( presetName );
   if ( mComposerMap )
   {
     mKeepLayerListCheckBox->setChecked( true );
-    mComposerMap->setLayerSet( lst );
+    mComposerMap->setLayers( lst );
 
     mKeepLayerStylesCheckBox->setChecked( true );
 
@@ -836,8 +836,7 @@ void QgsComposerMapWidget::on_mKeepLayerListCheckBox_stateChanged( int state )
   }
   else
   {
-    QStringList emptyLayerSet;
-    mComposerMap->setLayerSet( emptyLayerSet );
+    mComposerMap->setLayers( QList<QgsMapLayer*>() );
     mComposerMap->setKeepLayerSet( false );
 
     mKeepLayerStylesCheckBox->setChecked( Qt::Unchecked );

diff --git a/src/app/qgsmapthemes.cpp b/src/app/qgsmapthemes.cpp
@@ -151,6 +151,17 @@ QStringList QgsMapThemes::orderedPresetVisibleLayers( const QString& name ) cons
   return order2;
 }
 
+QList<QgsMapLayer*> QgsMapThemes::orderedPresetVisibleLayers2( const QString& name ) const
+{
+  QList<QgsMapLayer*> lst;
+  Q_FOREACH ( const QString& layerId, orderedPresetVisibleLayers( name ) )
+  {
+    if ( QgsMapLayer* layer = QgsProject::instance()->mapLayer( layerId ) )
+      lst << layer;
+  }
+  return lst;
+}
+
 QMenu* QgsMapThemes::menu()
 {
   return mMenu;

diff --git a/src/app/qgsmapthemes.h b/src/app/qgsmapthemes.h
@@ -50,6 +50,10 @@ class APP_EXPORT QgsMapThemes : public QObject
     //! The order will match the layer order from the map canvas
     QStringList orderedPresetVisibleLayers( const QString& name ) const;
 
+    //! Return list of layer IDs that should be visible for particular preset.
+    //! The order will match the layer order from the map canvas
+    QList<QgsMapLayer*> orderedPresetVisibleLayers2( const QString& name ) const;
+
     //! Convenience menu that lists available presets and actions for management
     QMenu* menu();