do not insert layers in embedded groups (#10004)

3nids · web-flow · commit d7fa0286c401 · 2019-05-26T23:25:15.000-05:00
fixes #29678
diff --git a/python/core/auto_generated/layertree/qgslayertreeutils.sip.in b/python/core/auto_generated/layertree/qgslayertreeutils.sip.in
@@ -126,6 +126,17 @@ of a map layer within a layer tree and only connecting/disconnecting when
 there is only one occurrence of that layer.
 
 .. versionadded:: 3.4
+%End
+
+    static QgsLayerTreeGroup *firstGroupWithoutCustomProperty( QgsLayerTreeGroup *group, const QString &property );
+%Docstring
+Returns the first parent which doesn't have the given custom property
+or the group itself if it doesn't hold the property
+
+:param group: the layer tree group
+:param property: the property
+
+.. versionadded:: 3.8
 %End
 };
 
diff --git a/src/app/qgisapp.cpp b/src/app/qgisapp.cpp
@@ -4066,31 +4066,39 @@ void QgisApp::setupLayerTreeViewFromSettings()
 void QgisApp::updateNewLayerInsertionPoint()
 {
   // defaults
-  QgsLayerTreeGroup *parentGroup = mLayerTreeView->layerTreeModel()->rootGroup();
-  int index = 0;
+  QgsLayerTreeGroup *insertGroup = mLayerTreeView->layerTreeModel()->rootGroup();
   QModelIndex current = mLayerTreeView->currentIndex();
+  int index = 0;
 
   if ( current.isValid() )
   {
+    index = current.row();
+
     if ( QgsLayerTreeNode *currentNode = mLayerTreeView->currentNode() )
     {
       // if the insertion point is actually a group, insert new layers into the group
       if ( QgsLayerTree::isGroup( currentNode ) )
       {
-        QgsProject::instance()->layerTreeRegistryBridge()->setLayerInsertionPoint( QgsLayerTree::toGroup( currentNode ), 0 );
+        // if the group is embedded go to the first non-embedded group, at worst the top level item
+        QgsLayerTreeGroup *insertGroup = QgsLayerTreeUtils::firstGroupWithoutCustomProperty( QgsLayerTree::toGroup( currentNode ), QStringLiteral( "embedded" ) );
+        QgsProject::instance()->layerTreeRegistryBridge()->setLayerInsertionPoint( insertGroup, 0 );
         return;
       }
 
       // otherwise just set the insertion point in front of the current node
       QgsLayerTreeNode *parentNode = currentNode->parent();
       if ( QgsLayerTree::isGroup( parentNode ) )
-        parentGroup = QgsLayerTree::toGroup( parentNode );
+      {
+        // if the group is embedded go to the first non-embedded group, at worst the top level item
+        QgsLayerTreeGroup *parentGroup = QgsLayerTree::toGroup( parentNode );
+        insertGroup = QgsLayerTreeUtils::firstGroupWithoutCustomProperty( parentGroup, QStringLiteral( "embedded" ) );
+        if ( parentGroup != insertGroup )
+          index = 0;
+      }
     }
-
-    index = current.row();
   }
 
-  QgsProject::instance()->layerTreeRegistryBridge()->setLayerInsertionPoint( parentGroup, index );
+  QgsProject::instance()->layerTreeRegistryBridge()->setLayerInsertionPoint( insertGroup, index );
 }
 
 void QgisApp::autoSelectAddedLayer( QList<QgsMapLayer *> layers )
diff --git a/src/core/layertree/qgslayertreeutils.cpp b/src/core/layertree/qgslayertreeutils.cpp
@@ -512,3 +512,19 @@ int QgsLayerTreeUtils::countMapLayerInTree( QgsLayerTreeNode *tree, QgsMapLayer
     cnt += countMapLayerInTree( child, layer );
   return cnt;
 }
+
+QgsLayerTreeGroup *QgsLayerTreeUtils::firstGroupWithoutCustomProperty( QgsLayerTreeGroup *group, const QString &property )
+{
+  // if the group is embedded go to the first non-embedded group, at worst the top level item
+  while ( group->customProperty( property ).toInt() )
+  {
+    if ( !group->parent() )
+      break;
+
+    if ( QgsLayerTree::isGroup( group->parent() ) )
+      group = QgsLayerTree::toGroup( group->parent() );
+    else
+      Q_ASSERT( false );
+  }
+  return group;
+}
diff --git a/src/core/layertree/qgslayertreeutils.h b/src/core/layertree/qgslayertreeutils.h
@@ -115,6 +115,15 @@ class CORE_EXPORT QgsLayerTreeUtils
      * \since QGIS 3.4
      */
     static int countMapLayerInTree( QgsLayerTreeNode *tree, QgsMapLayer *layer );
+
+    /**
+     * Returns the first parent which doesn't have the given custom property
+     * or the group itself if it doesn't hold the property
+     * \param group the layer tree group
+     * \param property the property
+     * \since QGIS 3.8
+     */
+    static QgsLayerTreeGroup *firstGroupWithoutCustomProperty( QgsLayerTreeGroup *group, const QString &property );
 };
 
 #endif // QGSLAYERTREEUTILS_H

Original file line number	Diff line number	Diff line change
`@@ -4066,31 +4066,39 @@ void QgisApp::setupLayerTreeViewFromSettings()`
`4066`	`4066`	`void QgisApp::updateNewLayerInsertionPoint()`
`4067`	`4067`	`{`
`4068`	`4068`	`// defaults`
`4069`		`- QgsLayerTreeGroup *parentGroup = mLayerTreeView->layerTreeModel()->rootGroup();`
`4070`		`- int index = 0;`
	`4069`	`+ QgsLayerTreeGroup *insertGroup = mLayerTreeView->layerTreeModel()->rootGroup();`
`4071`	`4070`	`QModelIndex current = mLayerTreeView->currentIndex();`
	`4071`	`+ int index = 0;`
`4072`	`4072`
`4073`	`4073`	`if ( current.isValid() )`
`4074`	`4074`	`{`
	`4075`	`+ index = current.row();`
	`4076`	`+`
`4075`	`4077`	`if ( QgsLayerTreeNode *currentNode = mLayerTreeView->currentNode() )`
`4076`	`4078`	`{`
`4077`	`4079`	`// if the insertion point is actually a group, insert new layers into the group`
`4078`	`4080`	`if ( QgsLayerTree::isGroup( currentNode ) )`
`4079`	`4081`	`{`
`4080`		`- QgsProject::instance()->layerTreeRegistryBridge()->setLayerInsertionPoint( QgsLayerTree::toGroup( currentNode ), 0 );`
	`4082`	`+ // if the group is embedded go to the first non-embedded group, at worst the top level item`
	`4083`	`+ QgsLayerTreeGroup *insertGroup = QgsLayerTreeUtils::firstGroupWithoutCustomProperty( QgsLayerTree::toGroup( currentNode ), QStringLiteral( "embedded" ) );`
	`4084`	`+ QgsProject::instance()->layerTreeRegistryBridge()->setLayerInsertionPoint( insertGroup, 0 );`
`4081`	`4085`	`return;`
`4082`	`4086`	`}`
`4083`	`4087`
`4084`	`4088`	`// otherwise just set the insertion point in front of the current node`
`4085`	`4089`	`QgsLayerTreeNode *parentNode = currentNode->parent();`
`4086`	`4090`	`if ( QgsLayerTree::isGroup( parentNode ) )`
`4087`		`- parentGroup = QgsLayerTree::toGroup( parentNode );`
	`4091`	`+ {`
	`4092`	`+ // if the group is embedded go to the first non-embedded group, at worst the top level item`
	`4093`	`+ QgsLayerTreeGroup *parentGroup = QgsLayerTree::toGroup( parentNode );`
	`4094`	`+ insertGroup = QgsLayerTreeUtils::firstGroupWithoutCustomProperty( parentGroup, QStringLiteral( "embedded" ) );`
	`4095`	`+ if ( parentGroup != insertGroup )`
	`4096`	`+ index = 0;`
	`4097`	`+ }`
`4088`	`4098`	`}`
`4089`		`-`
`4090`		`- index = current.row();`
`4091`	`4099`	`}`
`4092`	`4100`
`4093`		`- QgsProject::instance()->layerTreeRegistryBridge()->setLayerInsertionPoint( parentGroup, index );`
	`4101`	`+ QgsProject::instance()->layerTreeRegistryBridge()->setLayerInsertionPoint( insertGroup, index );`
`4094`	`4102`	`}`
`4095`	`4103`
`4096`	`4104`	`void QgisApp::autoSelectAddedLayer( QList<QgsMapLayer *> layers )`