Add basic drag and drop support in the model designer

python/PyQt6/core/auto_additions/qgsprocessingutils.py

@@ -65,6 +65,7 @@
     QgsProcessingUtils.tempFolder = staticmethod(QgsProcessingUtils.tempFolder)
     QgsProcessingUtils.generateTempFilename = staticmethod(QgsProcessingUtils.generateTempFilename)
     QgsProcessingUtils.formatHelpMapAsHtml = staticmethod(QgsProcessingUtils.formatHelpMapAsHtml)
+    QgsProcessingUtils.outputDefinitionIndex = staticmethod(QgsProcessingUtils.outputDefinitionIndex)
     QgsProcessingUtils.convertToCompatibleFormat = staticmethod(QgsProcessingUtils.convertToCompatibleFormat)
     QgsProcessingUtils.convertToCompatibleFormatAndLayerName = staticmethod(QgsProcessingUtils.convertToCompatibleFormatAndLayerName)
     QgsProcessingUtils.combineFields = staticmethod(QgsProcessingUtils.combineFields)

python/PyQt6/core/auto_generated/processing/qgsprocessingutils.sip.in

@@ -435,6 +435,12 @@ but not changing the ``basename``.
 %Docstring
 Returns a HTML formatted version of the help text encoded in a variant ``map`` for
 a specified ``algorithm``.
+%End
+
+    static int outputDefinitionIndex( const QgsProcessingAlgorithm *algorithm, const QString &name ) /HoldGIL/;
+%Docstring
+Returns the index of the output matching ``name`` for a specified ``algorithm``.
+Matching is done in a case-insensitive manner.
 %End
 
     static QString convertToCompatibleFormat( const QgsVectorLayer *layer,

python/PyQt6/gui/auto_additions/qgsmodelarrowitem.py

@@ -1,6 +1,7 @@
 # The following has been generated automatically from src/gui/processing/models/qgsmodelarrowitem.h
 QgsModelArrowItem.Circle = QgsModelArrowItem.Marker.Circle
 QgsModelArrowItem.ArrowHead = QgsModelArrowItem.Marker.ArrowHead
+QgsModelArrowItem.NoMarker = QgsModelArrowItem.Marker.NoMarker
 try:
     QgsModelArrowItem.__group__ = ['processing', 'models']
 except (NameError, AttributeError):

python/PyQt6/gui/auto_additions/qgsmodelgraphicitem.py

@@ -10,3 +10,7 @@
     QgsModelDesignerFoldButtonGraphicItem.__group__ = ['processing', 'models']
 except (NameError, AttributeError):
     pass
+try:
+    QgsModelDesignerSocketGraphicItem.__group__ = ['processing', 'models']
+except (NameError, AttributeError):
+    pass

python/PyQt6/gui/auto_additions/qgsmodelgraphicsview.py

@@ -5,8 +5,8 @@
 QgsModelGraphicsView.PasteModeCenter = QgsModelGraphicsView.PasteMode.PasteModeCenter
 QgsModelGraphicsView.PasteModeInPlace = QgsModelGraphicsView.PasteMode.PasteModeInPlace
 try:
-    QgsModelGraphicsView.__attribute_docs__ = {'algorithmDropped': 'Emitted when an algorithm is dropped onto the view.\n', 'inputDropped': 'Emitted when an input parameter is dropped onto the view.\n', 'itemFocused': 'Emitted when an ``item`` is "focused" in the view, i.e. it becomes the active\nitem and should have its properties displayed in any designer windows.\n', 'willBeDeleted': 'Emitted in the destructor when the view is about to be deleted,\nbut is still in a perfectly valid state.\n', 'macroCommandStarted': 'Emitted when a macro command containing a group of interactions is started in the view.\n', 'macroCommandEnded': 'Emitted when a macro command containing a group of interactions in the view has ended.\n', 'beginCommand': 'Emitted when an undo command is started in the view.\n', 'endCommand': 'Emitted when an undo command in the view has ended.\n', 'deleteSelectedItems': 'Emitted when the selected items should be deleted;\n'}
-    QgsModelGraphicsView.__signal_arguments__ = {'algorithmDropped': ['algorithmId: str', 'pos: QPointF'], 'inputDropped': ['inputId: str', 'pos: QPointF'], 'itemFocused': ['item: QgsModelComponentGraphicItem'], 'macroCommandStarted': ['text: str'], 'beginCommand': ['text: str']}
+    QgsModelGraphicsView.__attribute_docs__ = {'algorithmDropped': 'Emitted when an algorithm is dropped onto the view.\n', 'inputDropped': 'Emitted when an input parameter is dropped onto the view.\n', 'itemFocused': 'Emitted when an ``item`` is "focused" in the view, i.e. it becomes the active\nitem and should have its properties displayed in any designer windows.\n', 'willBeDeleted': 'Emitted in the destructor when the view is about to be deleted,\nbut is still in a perfectly valid state.\n', 'macroCommandStarted': 'Emitted when a macro command containing a group of interactions is started in the view.\n', 'macroCommandEnded': 'Emitted when a macro command containing a group of interactions in the view has ended.\n', 'commandBegun': 'Emitted when an undo command is started in the view.\n', 'commandEnded': 'Emitted when an undo command in the view has ended.\n', 'deleteSelectedItems': 'Emitted when the selected items should be deleted;\n'}
+    QgsModelGraphicsView.__signal_arguments__ = {'algorithmDropped': ['algorithmId: str', 'pos: QPointF'], 'inputDropped': ['inputId: str', 'pos: QPointF'], 'itemFocused': ['item: QgsModelComponentGraphicItem'], 'macroCommandStarted': ['text: str'], 'commandBegun': ['text: str']}
     QgsModelGraphicsView.__group__ = ['processing', 'models']
 except (NameError, AttributeError):
     pass

python/PyQt6/gui/auto_generated/processing/models/qgsmodelarrowitem.sip.in

@@ -31,6 +31,7 @@ A link arrow item for use in the model designer.
     {
       Circle,
       ArrowHead,
+      NoMarker
     };
 
     QgsModelArrowItem( QgsModelComponentGraphicItem *startItem, Qt::Edge startEdge, int startIndex, bool startIsOutgoing, Marker startMarker, QgsModelComponentGraphicItem *endItem, Qt::Edge endEdge, int endIndex, bool endIsIncoming, Marker endMarker );

python/PyQt6/gui/auto_generated/processing/models/qgsmodelcomponentgraphicitem.sip.in

@@ -69,6 +69,7 @@ Returns the model component associated with this item.
 Returns the model associated with this item.
 %End
 
+
     QgsModelGraphicsView *view();
 %Docstring
 Returns the associated view.
@@ -183,6 +184,14 @@ Returns the best link point to use for a link originating at a specified ``other
          - edge: item edge for calculated best link point
 %End
 
+    QgsModelDesignerSocketGraphicItem *outSocketAt( int index ) const;
+%Docstring
+Returns the output socket graphics items at the specified ``index``.
+
+May return ``None`` if no corresponding output socket exists.
+%End
+
+
     virtual void editComment();
 %Docstring
 Called when the comment attached to the item should be edited.
@@ -345,6 +354,11 @@ Ownership of ``parameter`` is transferred to the item.
 
     virtual QPicture iconPicture() const;
 
+
+    virtual int linkPointCount( Qt::Edge edge ) const;
+
+    virtual QString linkPointText( Qt::Edge edge, int index ) const;
+
     virtual void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size );
 
 

python/PyQt6/gui/auto_generated/processing/models/qgsmodelgraphicitem.sip.in

@@ -47,6 +47,11 @@ for the button. The button will be rendered at the specified ``position`` and ``
 
 
 
+    QPointF getPosition();
+%Docstring
+Returns the button's position.
+%End
+
     void setPosition( const QPointF &position );
 %Docstring
 Sets the button's ``position``.
@@ -114,6 +119,65 @@ If ``folded`` is ``True``, the button represents the collapsed state for the ite
 };
 
 
+class QgsModelDesignerSocketGraphicItem : QgsModelDesignerFlatButtonGraphicItem
+{
+%Docstring(signature="appended")
+A socket allowing linking component together
+
+.. warning::
+
+   Not stable API
+
+.. versionadded:: 3.42
+%End
+
+%TypeHeaderCode
+#include "qgsmodelgraphicitem.h"
+%End
+  public:
+    QgsModelDesignerSocketGraphicItem( QgsModelComponentGraphicItem *parent /TransferThis/, QgsProcessingModelComponent *component, int index, const QPointF &position, Qt::Edge edge, const QSizeF &size = QSizeF( 11, 11 ) );
+%Docstring
+Constructor for QgsModelDesignerSocketGraphicItem, with the specified ``parent`` item.
+
+The ``index`` argument specifies whether the input or output index of this socket inside the component
+And the ``edge`` argument specifies if it's an input socket( Qt.Edge.TopEdge ) or output ( Qt.Edge.BottomEdge )
+
+The sockets will be rendered at the specified ``position``
+%End
+
+    virtual void paint( QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0 );
+
+    int index() const;
+%Docstring
+Returns the index of this socket in either QgsModelDesignerSocketGraphicItem.mInSockets 
+or QgsModelDesignerSocketGraphicItem.mOutSockets array
+%End
+    Qt::Edge edge() const;
+%Docstring
+Returns on which edge this socket is:
+* Qt.Edge.TopEdge for input socket
+* Qt.Edge.BottomEdge for output socket
+%End
+    bool isInput() const;
+%Docstring
+Returns whether the socket is an input socket or not
+
+Convenient function around mEdge member
+%End
+    QgsProcessingModelComponent *component();
+%Docstring
+Return the component associated to the socket */
+%End
+    QgsModelComponentGraphicItem *componentItem();
+%Docstring
+Return the parent GraphicItem (:py:class:`QgsModelComponentGraphicItem`) associated to the socket */
+%End
+  signals:
+
+
+};
+
+
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *

python/PyQt6/gui/auto_generated/processing/models/qgsmodelgraphicsscene.sip.in

@@ -103,6 +103,16 @@ Returns the topmost component item at a specified ``position``.
     QgsModelComponentGraphicItem *groupBoxItem( const QString &uuid );
 %Docstring
 Returns the graphic item corresponding to the specified group box ``uuid``.
+%End
+
+    QgsModelChildAlgorithmGraphicItem *childAlgorithmItem( const QString &childId );
+%Docstring
+Returns the graphic item corresponding to the specified  specified child algorithm
+%End
+
+    QgsModelComponentGraphicItem *parameterItem( const QString &name );
+%Docstring
+Returns the :py:class:`QgsModelComponentGraphicItem` corresponding to the specified child algorithm
 %End
 
     void selectAll();

python/PyQt6/gui/auto_generated/processing/models/qgsmodelgraphicsview.sip.in

@@ -79,6 +79,16 @@ Starts a macro command, containing a group of interactions in the view.
 Ends a macro command, containing a group of interactions in the view.
 %End
 
+    void beginCommand( const QString &text );
+%Docstring
+Starts a single undo command
+%End
+
+    void endCommand();
+%Docstring
+Ends a single undo command 
+%End
+
 
     enum ClipboardOperation /BaseType=IntEnum/
     {
@@ -162,12 +172,12 @@ Emitted when a macro command containing a group of interactions is started in th
 Emitted when a macro command containing a group of interactions in the view has ended.
 %End
 
-    void beginCommand( const QString &text );
+    void commandBegun( const QString &text );
 %Docstring
 Emitted when an undo command is started in the view.
 %End
 
-    void endCommand();
+    void commandEnded();
 %Docstring
 Emitted when an undo command in the view has ended.
 %End

python/PyQt6/gui/auto_generated/processing/qgsprocessingmodelerparameterwidget.sip.in

@@ -81,6 +81,17 @@ The ``compatibleDataTypes`` list corresponds to the compatible data types
 from :py:class:`QgsProcessing`.SourceType.
 %End
 
+    QList<QgsProcessingModelChildParameterSource> availableSourcesForChild();
+%Docstring
+HACK : Ugly workaround to expose the compatible sources for a parameter definition ( :py:class:`QgsProcessingParameterDefinition`)
+Idealy we should no rely on any UI-related function to get this
+
+see also :py:class:`QgsProcessingModelAlgorithm`.availableSourcesForChild
+
+The available sources are created on widget creation in :py:func:`populateSources`
+%End
+
+
     void setExpressionHelpText( const QString &text );
 %Docstring
 Set the expected expression format ``text``, which is shown in the expression builder dialog for the widget

python/core/auto_additions/qgsprocessingutils.py

@@ -65,6 +65,7 @@
     QgsProcessingUtils.tempFolder = staticmethod(QgsProcessingUtils.tempFolder)
     QgsProcessingUtils.generateTempFilename = staticmethod(QgsProcessingUtils.generateTempFilename)
     QgsProcessingUtils.formatHelpMapAsHtml = staticmethod(QgsProcessingUtils.formatHelpMapAsHtml)
+    QgsProcessingUtils.outputDefinitionIndex = staticmethod(QgsProcessingUtils.outputDefinitionIndex)
     QgsProcessingUtils.convertToCompatibleFormat = staticmethod(QgsProcessingUtils.convertToCompatibleFormat)
     QgsProcessingUtils.convertToCompatibleFormatAndLayerName = staticmethod(QgsProcessingUtils.convertToCompatibleFormatAndLayerName)
     QgsProcessingUtils.combineFields = staticmethod(QgsProcessingUtils.combineFields)

python/core/auto_generated/processing/qgsprocessingutils.sip.in

@@ -435,6 +435,12 @@ but not changing the ``basename``.
 %Docstring
 Returns a HTML formatted version of the help text encoded in a variant ``map`` for
 a specified ``algorithm``.
+%End
+
+    static int outputDefinitionIndex( const QgsProcessingAlgorithm *algorithm, const QString &name ) /HoldGIL/;
+%Docstring
+Returns the index of the output matching ``name`` for a specified ``algorithm``.
+Matching is done in a case-insensitive manner.
 %End
 
     static QString convertToCompatibleFormat( const QgsVectorLayer *layer,

python/gui/auto_additions/qgsmodelgraphicitem.py

@@ -10,3 +10,7 @@
     QgsModelDesignerFoldButtonGraphicItem.__group__ = ['processing', 'models']
 except (NameError, AttributeError):
     pass
+try:
+    QgsModelDesignerSocketGraphicItem.__group__ = ['processing', 'models']
+except (NameError, AttributeError):
+    pass

python/gui/auto_additions/qgsmodelgraphicsview.py

@@ -1,7 +1,7 @@
 # The following has been generated automatically from src/gui/processing/models/qgsmodelgraphicsview.h
 try:
-    QgsModelGraphicsView.__attribute_docs__ = {'algorithmDropped': 'Emitted when an algorithm is dropped onto the view.\n', 'inputDropped': 'Emitted when an input parameter is dropped onto the view.\n', 'itemFocused': 'Emitted when an ``item`` is "focused" in the view, i.e. it becomes the active\nitem and should have its properties displayed in any designer windows.\n', 'willBeDeleted': 'Emitted in the destructor when the view is about to be deleted,\nbut is still in a perfectly valid state.\n', 'macroCommandStarted': 'Emitted when a macro command containing a group of interactions is started in the view.\n', 'macroCommandEnded': 'Emitted when a macro command containing a group of interactions in the view has ended.\n', 'beginCommand': 'Emitted when an undo command is started in the view.\n', 'endCommand': 'Emitted when an undo command in the view has ended.\n', 'deleteSelectedItems': 'Emitted when the selected items should be deleted;\n'}
-    QgsModelGraphicsView.__signal_arguments__ = {'algorithmDropped': ['algorithmId: str', 'pos: QPointF'], 'inputDropped': ['inputId: str', 'pos: QPointF'], 'itemFocused': ['item: QgsModelComponentGraphicItem'], 'macroCommandStarted': ['text: str'], 'beginCommand': ['text: str']}
+    QgsModelGraphicsView.__attribute_docs__ = {'algorithmDropped': 'Emitted when an algorithm is dropped onto the view.\n', 'inputDropped': 'Emitted when an input parameter is dropped onto the view.\n', 'itemFocused': 'Emitted when an ``item`` is "focused" in the view, i.e. it becomes the active\nitem and should have its properties displayed in any designer windows.\n', 'willBeDeleted': 'Emitted in the destructor when the view is about to be deleted,\nbut is still in a perfectly valid state.\n', 'macroCommandStarted': 'Emitted when a macro command containing a group of interactions is started in the view.\n', 'macroCommandEnded': 'Emitted when a macro command containing a group of interactions in the view has ended.\n', 'commandBegun': 'Emitted when an undo command is started in the view.\n', 'commandEnded': 'Emitted when an undo command in the view has ended.\n', 'deleteSelectedItems': 'Emitted when the selected items should be deleted;\n'}
+    QgsModelGraphicsView.__signal_arguments__ = {'algorithmDropped': ['algorithmId: str', 'pos: QPointF'], 'inputDropped': ['inputId: str', 'pos: QPointF'], 'itemFocused': ['item: QgsModelComponentGraphicItem'], 'macroCommandStarted': ['text: str'], 'commandBegun': ['text: str']}
     QgsModelGraphicsView.__group__ = ['processing', 'models']
 except (NameError, AttributeError):
     pass

python/gui/auto_generated/processing/models/qgsmodelarrowitem.sip.in

@@ -31,6 +31,7 @@ A link arrow item for use in the model designer.
     {
       Circle,
       ArrowHead,
+      NoMarker
     };
 
     QgsModelArrowItem( QgsModelComponentGraphicItem *startItem, Qt::Edge startEdge, int startIndex, bool startIsOutgoing, Marker startMarker, QgsModelComponentGraphicItem *endItem, Qt::Edge endEdge, int endIndex, bool endIsIncoming, Marker endMarker );

python/gui/auto_generated/processing/models/qgsmodelcomponentgraphicitem.sip.in

@@ -69,6 +69,7 @@ Returns the model component associated with this item.
 Returns the model associated with this item.
 %End
 
+
     QgsModelGraphicsView *view();
 %Docstring
 Returns the associated view.
@@ -183,6 +184,14 @@ Returns the best link point to use for a link originating at a specified ``other
          - edge: item edge for calculated best link point
 %End
 
+    QgsModelDesignerSocketGraphicItem *outSocketAt( int index ) const;
+%Docstring
+Returns the output socket graphics items at the specified ``index``.
+
+May return ``None`` if no corresponding output socket exists.
+%End
+
+
     virtual void editComment();
 %Docstring
 Called when the comment attached to the item should be edited.
@@ -345,6 +354,11 @@ Ownership of ``parameter`` is transferred to the item.
 
     virtual QPicture iconPicture() const;
 
+
+    virtual int linkPointCount( Qt::Edge edge ) const;
+
+    virtual QString linkPointText( Qt::Edge edge, int index ) const;
+
     virtual void updateStoredComponentPosition( const QPointF &pos, const QSizeF &size );
 
 

python/gui/auto_generated/processing/models/qgsmodelgraphicitem.sip.in

@@ -47,6 +47,11 @@ for the button. The button will be rendered at the specified ``position`` and ``
 
 
 
+    QPointF getPosition();
+%Docstring
+Returns the button's position.
+%End
+
     void setPosition( const QPointF &position );
 %Docstring
 Sets the button's ``position``.
@@ -114,6 +119,65 @@ If ``folded`` is ``True``, the button represents the collapsed state for the ite
 };
 
 
+class QgsModelDesignerSocketGraphicItem : QgsModelDesignerFlatButtonGraphicItem
+{
+%Docstring(signature="appended")
+A socket allowing linking component together
+
+.. warning::
+
+   Not stable API
+
+.. versionadded:: 3.42
+%End
+
+%TypeHeaderCode
+#include "qgsmodelgraphicitem.h"
+%End
+  public:
+    QgsModelDesignerSocketGraphicItem( QgsModelComponentGraphicItem *parent /TransferThis/, QgsProcessingModelComponent *component, int index, const QPointF &position, Qt::Edge edge, const QSizeF &size = QSizeF( 11, 11 ) );
+%Docstring
+Constructor for QgsModelDesignerSocketGraphicItem, with the specified ``parent`` item.
+
+The ``index`` argument specifies whether the input or output index of this socket inside the component
+And the ``edge`` argument specifies if it's an input socket( Qt.Edge.TopEdge ) or output ( Qt.Edge.BottomEdge )
+
+The sockets will be rendered at the specified ``position``
+%End
+
+    virtual void paint( QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0 );
+
+    int index() const;
+%Docstring
+Returns the index of this socket in either QgsModelDesignerSocketGraphicItem.mInSockets 
+or QgsModelDesignerSocketGraphicItem.mOutSockets array
+%End
+    Qt::Edge edge() const;
+%Docstring
+Returns on which edge this socket is:
+* Qt.Edge.TopEdge for input socket
+* Qt.Edge.BottomEdge for output socket
+%End
+    bool isInput() const;
+%Docstring
+Returns whether the socket is an input socket or not
+
+Convenient function around mEdge member
+%End
+    QgsProcessingModelComponent *component();
+%Docstring
+Return the component associated to the socket */
+%End
+    QgsModelComponentGraphicItem *componentItem();
+%Docstring
+Return the parent GraphicItem (:py:class:`QgsModelComponentGraphicItem`) associated to the socket */
+%End
+  signals:
+
+
+};
+
+
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *