Don't mark project dirty when legend nodes are expanded/collapsed

nyalldawson · nyalldawson · commit 40ceb7bdcefb · 2018-03-13T10:10:23.000+11:00
diff --git a/python/gui/layertree/qgslayertreeview.sip.in b/python/gui/layertree/qgslayertreeview.sip.in
@@ -148,6 +148,8 @@ Returns list of indicators associated with a particular layer tree node.
 .. versionadded:: 3.2
 %End
 
+
+
   public slots:
     void refreshLayerSymbology( const QString &layerId );
 %Docstring
diff --git a/src/app/qgisapp.cpp b/src/app/qgisapp.cpp
@@ -3238,7 +3238,12 @@ void QgisApp::setupConnections()
   connect( mLayerTreeView->layerTreeModel()->rootGroup(), &QgsLayerTreeNode::visibilityChanged,
            this, &QgisApp::markDirty );
   connect( mLayerTreeView->layerTreeModel()->rootGroup(), &QgsLayerTreeNode::customPropertyChanged,
-           this, &QgisApp::markDirty );
+           this, [ = ]( QgsLayerTreeNode *, const QString & key )
+  {
+    // only mark dirty for non-view only changes
+    if ( !QgsLayerTreeView::viewOnlyCustomProperties().contains( key ) )
+      QgisApp::markDirty();
+  } );
 
   // connect map layer registry
   connect( QgsProject::instance(), &QgsProject::layersAdded,
diff --git a/src/gui/layertree/qgslayertreeview.cpp b/src/gui/layertree/qgslayertreeview.cpp
@@ -355,6 +355,12 @@ QList<QgsLayerTreeViewIndicator *> QgsLayerTreeView::indicators( QgsLayerTreeNod
   return mIndicators.value( node );
 }
 
+///@cond PRIVATE
+QStringList QgsLayerTreeView::viewOnlyCustomProperties()
+{
+  return QStringList() << QStringLiteral( "expandedLegendNodes" );
+}
+///@endcond
 
 void QgsLayerTreeView::refreshLayerSymbology( const QString &layerId )
 {
diff --git a/src/gui/layertree/qgslayertreeview.h b/src/gui/layertree/qgslayertreeview.h
@@ -135,6 +135,20 @@ class GUI_EXPORT QgsLayerTreeView : public QTreeView
      */
     QList<QgsLayerTreeViewIndicator *> indicators( QgsLayerTreeNode *node ) const;
 
+///@cond PRIVATE
+
+    /**
+     * Returns a list of custom property keys which are considered as related to view operations
+     * only. E.g. node expanded state.
+     *
+     * Changes to these keys will not mark a project as "dirty" and trigger unsaved changes
+     * warnings.
+     *
+     * \since QGIS 3.2
+     */
+    static QStringList viewOnlyCustomProperties() SIP_SKIP;
+///@endcond
+
   public slots:
     //! Force refresh of layer symbology. Normally not needed as the changes of layer's renderer are monitored by the model
     void refreshLayerSymbology( const QString &layerId );

Original file line number	Diff line number	Diff line change
`@@ -355,6 +355,12 @@ QList<QgsLayerTreeViewIndicator *> QgsLayerTreeView::indicators( QgsLayerTreeNod`
`355`	`355`	`return mIndicators.value( node );`
`356`	`356`	`}`
`357`	`357`
	`358`	`+///@cond PRIVATE`
	`359`	`+QStringList QgsLayerTreeView::viewOnlyCustomProperties()`
	`360`	`+{`
	`361`	`+ return QStringList() << QStringLiteral( "expandedLegendNodes" );`
	`362`	`+}`
	`363`	`+///@endcond`
`358`	`364`
`359`	`365`	`void QgsLayerTreeView::refreshLayerSymbology( const QString &layerId )`
`360`	`366`	`{`