customPropertyChanged signal in map layers to handle things like e.g.…

… the offline layer indicator in the legend tree accordingly
qgis · Oct 21, 2020 · 8a33a14 · 8a33a14
1 parent cdff8ba
commit 8a33a14
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 4 deletions.
diff --git a/python/core/auto_generated/qgsmaplayer.sip.in b/python/core/auto_generated/qgsmaplayer.sip.in
@@ -1593,6 +1593,12 @@ Emitted when the validity of this layer changed.
 .. versionadded:: 3.16
 %End
 
+    void customPropertyChanged( QgsMapLayer *layer, const QString &key );
+%Docstring
+Emitted when a custom property of a node within the tree has been changed or removed
+
+.. versionadded:: 3.16
+%End
 
   protected:
 

diff --git a/src/app/qgslayertreeviewofflineindicator.cpp b/src/app/qgslayertreeviewofflineindicator.cpp
@@ -30,8 +30,7 @@ void QgsLayerTreeViewOfflineIndicatorProvider::connectSignals( QgsMapLayer *laye
   if ( !layer )
     return;
 
-  //this has to be solved different
-  connect( mLayerTreeView->layerTreeModel()->rootGroup(), &QgsLayerTreeNode::customPropertyChanged, this, [ this, layer ]( ) { this->onLayerChanged( layer ); } );
+  connect( layer, &QgsMapLayer::customPropertyChanged, this, [ this, layer ]( ) { this->onLayerChanged( layer ); } );
 }
 
 bool QgsLayerTreeViewOfflineIndicatorProvider::acceptLayer( QgsMapLayer *layer )

diff --git a/src/core/qgsmaplayer.cpp b/src/core/qgsmaplayer.cpp
@@ -1707,7 +1707,11 @@ QStringList QgsMapLayer::customPropertyKeys() const
 
 void QgsMapLayer::setCustomProperty( const QString &key, const QVariant &value )
 {
-  mCustomProperties.setValue( key, value );
+  if ( !mCustomProperties.contains( key ) || mCustomProperties.value( key ) != value )
+  {
+    mCustomProperties.setValue( key, value );
+    emit customPropertyChanged( this, key );
+  }
 }
 
 void QgsMapLayer::setCustomProperties( const QgsObjectCustomProperties &properties )
@@ -1727,7 +1731,12 @@ QVariant QgsMapLayer::customProperty( const QString &value, const QVariant &defa
 
 void QgsMapLayer::removeCustomProperty( const QString &key )
 {
-  mCustomProperties.remove( key );
+
+  if ( mCustomProperties.contains( key ) )
+  {
+    mCustomProperties.remove( key );
+    emit customPropertyChanged( this, key );
+  }
 }
 
 QgsError QgsMapLayer::error() const

diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h
@@ -1424,6 +1424,12 @@ class CORE_EXPORT QgsMapLayer : public QObject
      */
     void isValidChanged();
 
+    /**
+     * Emitted when a custom property of a node within the tree has been changed or removed
+     *
+     * \since QGIS 3.16
+     */
+    void customPropertyChanged( QgsMapLayer *layer, const QString &key );
 
   private slots: