Save and restore expanded state of legend nodes in tree hierarchy

wonder-sk · wonder-sk · commit aacb1bdf3e90 · 2015-01-22T13:42:31.000+07:00
diff --git a/python/core/layertree/qgslayertreenode.sip b/python/core/layertree/qgslayertreenode.sip
@@ -31,6 +31,8 @@
  * - "showFeatureCount" - whether to show feature counts in layer tree (vector only)
  * - "embedded" - whether the node comes from an external project
  * - "embedded_project" - path to the external project (embedded root node only)
+ * - "legend/..." - properties for legend appearance customization
+ * - "expandedLegendNodes" - list of layer's legend nodes' rules in expanded state
  *
  * @see also QgsLayerTree, QgsLayerTreeLayer, QgsLayerTreeGroup
  * @note added in 2.4
diff --git a/src/core/layertree/qgslayertreenode.h b/src/core/layertree/qgslayertreenode.h
@@ -56,6 +56,8 @@ class QDomElement;
  * - "showFeatureCount" - whether to show feature counts in layer tree (vector only)
  * - "embedded" - whether the node comes from an external project
  * - "embedded_project" - path to the external project (embedded root node only)
+ * - "legend/..." - properties for legend appearance customization
+ * - "expandedLegendNodes" - list of layer's legend nodes' rules in expanded state
  *
  * @see also QgsLayerTree, QgsLayerTreeLayer, QgsLayerTreeGroup
  * @note added in 2.4
diff --git a/src/gui/layertree/qgslayertreeview.cpp b/src/gui/layertree/qgslayertreeview.cpp
@@ -129,7 +129,20 @@ void QgsLayerTreeView::modelRowsInserted( QModelIndex index, int start, int end
     return;
 
   if ( QgsLayerTree::isLayer( parentNode ) )
-    return; // layers have only symbology nodes (no expanded/collapsed handling)
+  {
+    // if ShowLegendAsTree flag is enabled in model, we may need to expand some legend nodes
+    QStringList expandedNodeKeys = parentNode->customProperty( "expandedLegendNodes" ).toStringList();
+    if ( expandedNodeKeys.isEmpty() )
+      return;
+
+    foreach ( QgsLayerTreeModelLegendNode* legendNode, layerTreeModel()->layerLegendNodes( QgsLayerTree::toLayer( parentNode ) ) )
+    {
+      QString ruleKey = legendNode->data( QgsLayerTreeModelLegendNode::RuleKeyRole ).toString();
+      if ( expandedNodeKeys.contains( ruleKey ) )
+        setExpanded( layerTreeModel()->legendNode2index( legendNode ), true );
+    }
+    return;
+  }
 
   QList<QgsLayerTreeNode*> children = parentNode->children();
   for ( int i = start; i <= end; ++i )
@@ -149,11 +162,27 @@ void QgsLayerTreeView::modelRowsRemoved()
 
 void QgsLayerTreeView::updateExpandedStateToNode( QModelIndex index )
 {
-  QgsLayerTreeNode* node = layerTreeModel()->index2node( index );
-  if ( !node )
-    return;
-
-  node->setExpanded( isExpanded( index ) );
+  if ( QgsLayerTreeNode* node = layerTreeModel()->index2node( index ) )
+  {
+    node->setExpanded( isExpanded( index ) );
+  }
+  else if ( QgsLayerTreeModelLegendNode* node = layerTreeModel()->index2legendNode( index ) )
+  {
+    QString ruleKey = node->data( QgsLayerTreeModelLegendNode::RuleKeyRole ).toString();
+    QStringList lst = node->layerNode()->customProperty( "expandedLegendNodes" ).toStringList();
+    bool expanded = isExpanded( index );
+    bool isInList = lst.contains( ruleKey );
+    if ( expanded && !isInList )
+    {
+      lst.append( ruleKey );
+      node->layerNode()->setCustomProperty( "expandedLegendNodes", lst );
+    }
+    else if ( !expanded && isInList )
+    {
+      lst.removeAll( ruleKey );
+      node->layerNode()->setCustomProperty( "expandedLegendNodes", lst );
+    }
+  }
 }
 
 void QgsLayerTreeView::onCurrentChanged()

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,8 @@`
`31`	`31`	`* - "showFeatureCount" - whether to show feature counts in layer tree (vector only)`
`32`	`32`	`* - "embedded" - whether the node comes from an external project`
`33`	`33`	`* - "embedded_project" - path to the external project (embedded root node only)`
	`34`	`+ * - "legend/..." - properties for legend appearance customization`
	`35`	`+ * - "expandedLegendNodes" - list of layer's legend nodes' rules in expanded state`
`34`	`36`	`*`
`35`	`37`	`* @see also QgsLayerTree, QgsLayerTreeLayer, QgsLayerTreeGroup`
`36`	`38`	`* @note added in 2.4`
Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,8 @@ class QDomElement;`
`56`	`56`	`* - "showFeatureCount" - whether to show feature counts in layer tree (vector only)`
`57`	`57`	`* - "embedded" - whether the node comes from an external project`
`58`	`58`	`* - "embedded_project" - path to the external project (embedded root node only)`
	`59`	`+ * - "legend/..." - properties for legend appearance customization`
	`60`	`+ * - "expandedLegendNodes" - list of layer's legend nodes' rules in expanded state`
`59`	`61`	`*`
`60`	`62`	`* @see also QgsLayerTree, QgsLayerTreeLayer, QgsLayerTreeGroup`
`61`	`63`	`* @note added in 2.4`