Merge pull request #50381 from nirvn/sort_sort_sort

New layer tree insertion methods (on top of tree, optimal) and sorting of drag and dropped layers
qgis · Oct 26, 2022 · 087e55d · 087e55d
2 parents 5700f9e + 09d4b0a
commit 087e55d
Show file tree

Hide file tree

Showing 18 changed files with 700 additions and 293 deletions.
diff --git a/python/core/auto_additions/qgis.py b/python/core/auto_additions/qgis.py
@@ -2057,3 +2057,10 @@
 Qgis.ScriptLanguage.__doc__ = 'Scripting languages.\n\n.. versionadded:: 3.30\n\n' + '* ``Css``: ' + Qgis.ScriptLanguage.Css.__doc__ + '\n' + '* ``QgisExpression``: ' + Qgis.ScriptLanguage.QgisExpression.__doc__ + '\n' + '* ``Html``: ' + Qgis.ScriptLanguage.Html.__doc__ + '\n' + '* ``JavaScript``: ' + Qgis.ScriptLanguage.JavaScript.__doc__ + '\n' + '* ``Json``: ' + Qgis.ScriptLanguage.Json.__doc__ + '\n' + '* ``Python``: ' + Qgis.ScriptLanguage.Python.__doc__ + '\n' + '* ``R``: ' + Qgis.ScriptLanguage.R.__doc__ + '\n' + '* ``Sql``: ' + Qgis.ScriptLanguage.Sql.__doc__ + '\n' + '* ``Unknown``: ' + Qgis.ScriptLanguage.Unknown.__doc__
 # --
 Qgis.ScriptLanguage.baseClass = Qgis
+# monkey patching scoped based enum
+Qgis.LayerTreeInsertionMethod.AboveInsertionPoint.__doc__ = "Layers are added in the tree above the insertion point"
+Qgis.LayerTreeInsertionMethod.TopOfTree.__doc__ = "Layers are added at the top of the layer tree"
+Qgis.LayerTreeInsertionMethod.OptimalInInsertionGroup.__doc__ = "Layers are added at optimal locations across the insertion point's group"
+Qgis.LayerTreeInsertionMethod.__doc__ = 'Layer tree insertion methods\n\n.. versionadded:: 3.30\n\n' + '* ``AboveInsertionPoint``: ' + Qgis.LayerTreeInsertionMethod.AboveInsertionPoint.__doc__ + '\n' + '* ``TopOfTree``: ' + Qgis.LayerTreeInsertionMethod.TopOfTree.__doc__ + '\n' + '* ``OptimalInInsertionGroup``: ' + Qgis.LayerTreeInsertionMethod.OptimalInInsertionGroup.__doc__
+# --
+Qgis.LayerTreeInsertionMethod.baseClass = Qgis
diff --git a/python/core/auto_generated/layertree/qgslayertreeregistrybridge.sip.in b/python/core/auto_generated/layertree/qgslayertreeregistrybridge.sip.in
@@ -67,6 +67,20 @@ Set where the new layers should be inserted - can be used to follow current sele
 By default it is root group with zero index.
 
 .. versionadded:: 3.10
+%End
+
+    void setLayerInsertionMethod( Qgis::LayerTreeInsertionMethod method );
+%Docstring
+Sets the insertion ``method`` used to add layers to the tree
+
+.. versionadded:: 3.30
+%End
+
+    Qgis::LayerTreeInsertionMethod layerInsertionMethod() const;
+%Docstring
+Returns the insertion method used to add layers to the tree
+
+.. versionadded:: 3.30
 %End
 
   signals:

diff --git a/python/core/auto_generated/layertree/qgslayertreeutils.sip.in b/python/core/auto_generated/layertree/qgslayertreeutils.sip.in
@@ -141,6 +141,25 @@ or the group itself if it doesn't hold the property
 :param property: the property
 
 .. versionadded:: 3.8
+%End
+
+    static QgsLayerTreeLayer *insertLayerAtOptimalPlacement( QgsLayerTreeGroup *group, QgsMapLayer *layer );
+%Docstring
+Inserts a ``layer`` within a given ``group`` at an optimal index position by insuring a given layer
+type will always sit on top of or below other types. From top to bottom, the stacking logic is
+as follow:
+
+- vector points
+- vector lines
+- vector polygons
+- point clouds
+- meshes
+- rasters
+- base maps
+
+A base map is defined as a non-gdal provider raster layer (e.g. XYZ raster layer, vector tile layer, etc.)
+
+.. versionadded:: 3.28
 %End
 };
 

diff --git a/python/core/auto_generated/qgis.sip.in b/python/core/auto_generated/qgis.sip.in
@@ -1340,6 +1340,13 @@ The development version
       Unknown,
     };
 
+    enum class LayerTreeInsertionMethod
+    {
+      AboveInsertionPoint,
+      TopOfTree,
+      OptimalInInsertionGroup,
+    };
+
     static const double DEFAULT_SEARCH_RADIUS_MM;
 
     static const float DEFAULT_MAPTOPIXEL_THRESHOLD;

diff --git a/python/gui/auto_generated/layertree/qgslayertreeview.sip.in b/python/gui/auto_generated/layertree/qgslayertreeview.sip.in
@@ -297,6 +297,7 @@ Returns width of contextual menu mark, at right of layer node items.
 
 
 
+
   public slots:
     void refreshLayerSymbology( const QString &layerId );
 %Docstring
@@ -351,6 +352,11 @@ Returns the show private layers status
     void currentLayerChanged( QgsMapLayer *layer );
 %Docstring
 Emitted when a current layer is changed
+%End
+
+    void datasetsDropped( QDropEvent *event );
+%Docstring
+Emitted when datasets are dropped onto the layer tree view
 %End
 
   protected:
@@ -366,6 +372,10 @@ Emitted when a current layer is changed
     virtual void keyPressEvent( QKeyEvent *event );
 
 
+    virtual void dragEnterEvent( QDragEnterEvent *event );
+
+    virtual void dragMoveEvent( QDragMoveEvent *event );
+
     virtual void dropEvent( QDropEvent *event );