Add mechanism to show warning messages in modeler designer

qgis · Apr 14, 2020 · 0558d64 · 0558d64
1 parent 0f66c3e
commit 0558d64
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 0 deletions.
diff --git a/python/gui/auto_generated/processing/models/qgsmodelgraphicsscene.sip.in b/python/gui/auto_generated/processing/models/qgsmodelgraphicsscene.sip.in
@@ -132,6 +132,25 @@ Sets the results for child algorithms for the last model execution.
     void setChildAlgorithmInputs( const QVariantMap &inputs );
 %Docstring
 Sets the inputs for child algorithms for the last model execution.
+%End
+
+    QgsMessageBar *messageBar() const;
+%Docstring
+Returns the message bar associated with the scene.
+
+.. seealso:: :py:func:`setMessageBar`
+%End
+
+    void setMessageBar( QgsMessageBar *bar );
+%Docstring
+Sets the message ``bar`` associated with the scene.
+
+.. seealso:: :py:func:`messageBar`
+%End
+
+    void showWarning( const QString &shortMessage, const QString &title, const QString &longMessage, Qgis::MessageLevel level = Qgis::Warning );
+%Docstring
+Shows a warning message, allowing users to click a button to see the full details (``longMessage``).
 %End
 
   signals:

diff --git a/src/gui/processing/models/qgsmodelgraphicsscene.cpp b/src/gui/processing/models/qgsmodelgraphicsscene.cpp
@@ -19,7 +19,11 @@
 #include "qgsmodelcomponentgraphicitem.h"
 #include "qgsmodelarrowitem.h"
 #include "qgsprocessingmodelgroupbox.h"
+#include "qgsmessagebar.h"
+#include "qgsmessagebaritem.h"
+#include "qgsmessageviewer.h"
 #include <QGraphicsSceneMouseEvent>
+#include <QPushButton>
 
 ///@cond NOT_STABLE
 
@@ -431,5 +435,30 @@ void QgsModelGraphicsScene::addCommentItemForComponent( QgsProcessingModelAlgori
   addItem( arrow.release() );
 }
 
+QgsMessageBar *QgsModelGraphicsScene::messageBar() const
+{
+  return mMessageBar;
+}
+
+void QgsModelGraphicsScene::setMessageBar( QgsMessageBar *messageBar )
+{
+  mMessageBar = messageBar;
+}
+
+void QgsModelGraphicsScene::showWarning( const QString &shortMessage, const QString &title, const QString &longMessage, Qgis::MessageLevel level )
+{
+  QgsMessageBarItem *messageWidget = mMessageBar->createMessage( QString(), shortMessage );
+  QPushButton *detailsButton = new QPushButton( tr( "Details" ) );
+  connect( detailsButton, &QPushButton::clicked, detailsButton, [ = ]
+  {
+    QgsMessageViewer dialog( mMessageBar, QgsGuiUtils::ModalDialogFlags, false );
+    dialog.setTitle( title );
+    dialog.setMessage( longMessage, QgsMessageOutput::MessageHtml );
+    dialog.showMessage();
+  } );
+  messageWidget->layout()->addWidget( detailsButton );
+  mMessageBar->pushWidget( messageWidget, level, 0 );
+}
+
 ///@endcond
 
diff --git a/src/gui/processing/models/qgsmodelgraphicsscene.h b/src/gui/processing/models/qgsmodelgraphicsscene.h
@@ -30,6 +30,7 @@ class QgsProcessingModelComponent;
 class QgsProcessingModelComment;
 class QgsModelChildAlgorithmGraphicItem;
 class QgsProcessingModelGroupBox;
+class QgsMessageBar;
 
 ///@cond NOT_STABLE
 
@@ -146,6 +147,25 @@ class GUI_EXPORT QgsModelGraphicsScene : public QGraphicsScene
      */
     void setChildAlgorithmInputs( const QVariantMap &inputs );
 
+    /**
+     * Returns the message bar associated with the scene.
+     *
+     * \see setMessageBar()
+     */
+    QgsMessageBar *messageBar() const;
+
+    /**
+     * Sets the message \a bar associated with the scene.
+     *
+     * \see messageBar()
+     */
+    void setMessageBar( QgsMessageBar *bar );
+
+    /**
+     * Shows a warning message, allowing users to click a button to see the full details (\a longMessage).
+     */
+    void showWarning( const QString &shortMessage, const QString &title, const QString &longMessage, Qgis::MessageLevel level = Qgis::Warning );
+
   signals:
 
     /**
@@ -223,6 +243,8 @@ class GUI_EXPORT QgsModelGraphicsScene : public QGraphicsScene
     QVariantMap mChildResults;
     QVariantMap mChildInputs;
 
+    QgsMessageBar *mMessageBar = nullptr;
+
 };
 
 Q_DECLARE_METATYPE( QgsModelGraphicsScene::Flags )