43#include <QKeySequence>
46#include <QSvgGenerator>
54#include <QActionGroup>
59QgsModelerToolboxModel::QgsModelerToolboxModel( QObject *parent )
65Qt::ItemFlags QgsModelerToolboxModel::flags(
const QModelIndex &index )
const
67 Qt::ItemFlags f = QgsProcessingToolboxProxyModel::flags( index );
68 const QModelIndex sourceIndex = mapToSource( index );
69 if ( toolboxModel()->isAlgorithm( sourceIndex ) )
71 f = f | Qt::ItemIsDragEnabled;
76Qt::DropActions QgsModelerToolboxModel::supportedDragActions()
const
78 return Qt::CopyAction;
83QgsModelDesignerDialog::QgsModelDesignerDialog( QWidget *parent, Qt::WindowFlags flags )
84 : QMainWindow( parent, flags )
85 , mToolsActionGroup( new QActionGroup( this ) )
91 setAttribute( Qt::WA_DeleteOnClose );
92 setDockOptions( dockOptions() | QMainWindow::GroupedDragging );
93 setWindowFlags( Qt::WindowMinimizeButtonHint |
94 Qt::WindowMaximizeButtonHint |
95 Qt::WindowCloseButtonHint );
99 mModel = std::make_unique< QgsProcessingModelAlgorithm >();
102 mUndoStack =
new QUndoStack(
this );
103 connect( mUndoStack, &QUndoStack::indexChanged,
this, [ = ]
105 if ( mIgnoreUndoStackChanges )
108 mBlockUndoCommands++;
109 updateVariablesGui();
110 mGroupEdit->setText( mModel->group() );
111 mNameEdit->setText( mModel->displayName() );
112 mBlockUndoCommands--;
116 mPropertiesDock->setFeatures( QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetMovable );
117 mInputsDock->setFeatures( QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetMovable );
118 mAlgorithmsDock->setFeatures( QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetMovable );
119 mVariablesDock->setFeatures( QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetMovable | QDockWidget::DockWidgetClosable );
121 mAlgorithmsTree->header()->setVisible(
false );
122 mAlgorithmSearchEdit->setShowSearchIcon(
true );
123 mAlgorithmSearchEdit->setPlaceholderText( tr(
"Search…" ) );
124 connect( mAlgorithmSearchEdit, &QgsFilterLineEdit::textChanged, mAlgorithmsTree, &QgsProcessingToolboxTreeView::setFilterString );
126 mInputsTreeWidget->header()->setVisible(
false );
127 mInputsTreeWidget->setAlternatingRowColors(
true );
128 mInputsTreeWidget->setDragDropMode( QTreeWidget::DragOnly );
129 mInputsTreeWidget->setDropIndicatorShown(
true );
131 mNameEdit->setPlaceholderText( tr(
"Enter model name here" ) );
132 mGroupEdit->setPlaceholderText( tr(
"Enter group name here" ) );
135 mMessageBar->setSizePolicy( QSizePolicy::Minimum, QSizePolicy::Fixed );
136 mainLayout->insertWidget( 0, mMessageBar );
138 mView->setAcceptDrops(
true );
141 connect( mActionClose, &QAction::triggered,
this, &QWidget::close );
142 connect( mActionNew, &QAction::triggered,
this, &QgsModelDesignerDialog::newModel );
143 connect( mActionZoomIn, &QAction::triggered,
this, &QgsModelDesignerDialog::zoomIn );
144 connect( mActionZoomOut, &QAction::triggered,
this, &QgsModelDesignerDialog::zoomOut );
145 connect( mActionZoomActual, &QAction::triggered,
this, &QgsModelDesignerDialog::zoomActual );
146 connect( mActionZoomToItems, &QAction::triggered,
this, &QgsModelDesignerDialog::zoomFull );
147 connect( mActionExportImage, &QAction::triggered,
this, &QgsModelDesignerDialog::exportToImage );
148 connect( mActionExportPdf, &QAction::triggered,
this, &QgsModelDesignerDialog::exportToPdf );
149 connect( mActionExportSvg, &QAction::triggered,
this, &QgsModelDesignerDialog::exportToSvg );
150 connect( mActionExportPython, &QAction::triggered,
this, &QgsModelDesignerDialog::exportAsPython );
151 connect( mActionSave, &QAction::triggered,
this, [ = ] { saveModel(
false ); } );
152 connect( mActionSaveAs, &QAction::triggered,
this, [ = ] { saveModel(
true ); } );
153 connect( mActionDeleteComponents, &QAction::triggered,
this, &QgsModelDesignerDialog::deleteSelected );
154 connect( mActionSnapSelected, &QAction::triggered, mView, &QgsModelGraphicsView::snapSelected );
155 connect( mActionValidate, &QAction::triggered,
this, &QgsModelDesignerDialog::validate );
156 connect( mActionReorderInputs, &QAction::triggered,
this, &QgsModelDesignerDialog::reorderInputs );
157 connect( mActionReorderOutputs, &QAction::triggered,
this, &QgsModelDesignerDialog::reorderOutputs );
158 connect( mActionEditHelp, &QAction::triggered,
this, &QgsModelDesignerDialog::editHelp );
159 connect( mReorderInputsButton, &QPushButton::clicked,
this, &QgsModelDesignerDialog::reorderInputs );
161 mActionSnappingEnabled->setChecked( settings.
value( QStringLiteral(
"/Processing/Modeler/enableSnapToGrid" ),
false ).toBool() );
162 connect( mActionSnappingEnabled, &QAction::toggled,
this, [ = ](
bool enabled )
164 mView->snapper()->setSnapToGrid( enabled );
165 QgsSettings().
setValue( QStringLiteral(
"/Processing/Modeler/enableSnapToGrid" ), enabled );
167 mView->snapper()->setSnapToGrid( mActionSnappingEnabled->isChecked() );
169 connect( mActionSelectAll, &QAction::triggered,
this, [ = ]
174 QStringList docksTitle = settings.
value( QStringLiteral(
"ModelDesigner/hiddenDocksTitle" ), QStringList(),
QgsSettings::App ).toStringList();
175 QStringList docksActive = settings.
value( QStringLiteral(
"ModelDesigner/hiddenDocksActive" ), QStringList(),
QgsSettings::App ).toStringList();
176 if ( !docksTitle.isEmpty() )
178 for (
const auto &title : docksTitle )
180 mPanelStatus.insert( title, PanelStatus(
true, docksActive.contains( title ) ) );
183 mActionHidePanels->setChecked( !docksTitle.isEmpty() );
184 connect( mActionHidePanels, &QAction::toggled,
this, &QgsModelDesignerDialog::setPanelVisibility );
186 mUndoAction = mUndoStack->createUndoAction(
this );
188 mUndoAction->setShortcuts( QKeySequence::Undo );
189 mRedoAction = mUndoStack->createRedoAction(
this );
191 mRedoAction->setShortcuts( QKeySequence::Redo );
193 mMenuEdit->insertAction( mActionDeleteComponents, mRedoAction );
194 mMenuEdit->insertAction( mActionDeleteComponents, mUndoAction );
195 mMenuEdit->insertSeparator( mActionDeleteComponents );
196 mToolbar->insertAction( mActionZoomIn, mUndoAction );
197 mToolbar->insertAction( mActionZoomIn, mRedoAction );
198 mToolbar->insertSeparator( mActionZoomIn );
200 mGroupMenu =
new QMenu( tr(
"Zoom To" ),
this );
201 mMenuView->insertMenu( mActionZoomIn, mGroupMenu );
202 connect( mGroupMenu, &QMenu::aboutToShow,
this, &QgsModelDesignerDialog::populateZoomToMenu );
206 mActionCut =
new QAction( tr(
"Cu&t" ),
this );
207 mActionCut->setShortcuts( QKeySequence::Cut );
208 mActionCut->setStatusTip( tr(
"Cut" ) );
210 connect( mActionCut, &QAction::triggered,
this, [ = ]
212 mView->copySelectedItems( QgsModelGraphicsView::ClipboardCut );
215 mActionCopy =
new QAction( tr(
"&Copy" ),
this );
216 mActionCopy->setShortcuts( QKeySequence::Copy );
217 mActionCopy->setStatusTip( tr(
"Copy" ) );
219 connect( mActionCopy, &QAction::triggered,
this, [ = ]
221 mView->copySelectedItems( QgsModelGraphicsView::ClipboardCopy );
224 mActionPaste =
new QAction( tr(
"&Paste" ),
this );
225 mActionPaste->setShortcuts( QKeySequence::Paste );
226 mActionPaste->setStatusTip( tr(
"Paste" ) );
228 connect( mActionPaste, &QAction::triggered,
this, [ = ]
230 mView->pasteItems( QgsModelGraphicsView::PasteModeCursor );
232 mMenuEdit->insertAction( mActionDeleteComponents, mActionCut );
233 mMenuEdit->insertAction( mActionDeleteComponents, mActionCopy );
234 mMenuEdit->insertAction( mActionDeleteComponents, mActionPaste );
235 mMenuEdit->insertSeparator( mActionDeleteComponents );
237 mAlgorithmsModel =
new QgsModelerToolboxModel(
this );
238 mAlgorithmsTree->setToolboxProxyModel( mAlgorithmsModel );
241 if ( settings.
value( QStringLiteral(
"Processing/Configuration/SHOW_ALGORITHMS_KNOWN_ISSUES" ),
false ).toBool() )
245 mAlgorithmsTree->setFilters( filters );
246 mAlgorithmsTree->setDragDropMode( QTreeWidget::DragOnly );
247 mAlgorithmsTree->setDropIndicatorShown(
true );
249 connect( mView, &QgsModelGraphicsView::algorithmDropped,
this, [ = ](
const QString & algorithmId,
const QPointF & pos )
251 addAlgorithm( algorithmId, pos );
253 connect( mAlgorithmsTree, &QgsProcessingToolboxTreeView::doubleClicked,
this, [ = ]()
255 if ( mAlgorithmsTree->selectedAlgorithm() )
256 addAlgorithm( mAlgorithmsTree->selectedAlgorithm()->id(), QPointF() );
258 connect( mInputsTreeWidget, &QgsModelDesignerInputsTreeWidget::doubleClicked,
this, [ = ](
const QModelIndex & )
260 const QString parameterType = mInputsTreeWidget->currentItem()->data( 0, Qt::UserRole ).toString();
261 addInput( parameterType, QPointF() );
264 connect( mView, &QgsModelGraphicsView::inputDropped,
this, &QgsModelDesignerDialog::addInput );
267 QShortcut *ctrlEquals =
new QShortcut( QKeySequence( QStringLiteral(
"Ctrl+=" ) ),
this );
268 connect( ctrlEquals, &QShortcut::activated,
this, &QgsModelDesignerDialog::zoomIn );
271 mUndoDock->setObjectName( QStringLiteral(
"UndoDock" ) );
272 mUndoView =
new QUndoView( mUndoStack,
this );
273 mUndoDock->setWidget( mUndoView );
274 mUndoDock->setFeatures( QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetMovable | QDockWidget::DockWidgetClosable );
275 addDockWidget( Qt::DockWidgetArea::LeftDockWidgetArea, mUndoDock );
277 tabifyDockWidget( mUndoDock, mPropertiesDock );
278 tabifyDockWidget( mVariablesDock, mPropertiesDock );
279 mPropertiesDock->raise();
280 tabifyDockWidget( mInputsDock, mAlgorithmsDock );
281 mInputsDock->raise();
287 beginUndoCommand( tr(
"Change Model Variables" ) );
288 mModel->setVariables( mVariablesEditor->variablesInActiveScope() );
292 connect( mNameEdit, &QLineEdit::textChanged,
this, [ = ](
const QString & name )
296 beginUndoCommand( tr(
"Change Model Name" ), NameChanged );
297 mModel->setName( name );
302 connect( mGroupEdit, &QLineEdit::textChanged,
this, [ = ](
const QString & group )
306 beginUndoCommand( tr(
"Change Model Group" ), GroupChanged );
307 mModel->setGroup( group );
314 QToolButton *toolbuttonExportToScript =
new QToolButton();
315 toolbuttonExportToScript->setPopupMode( QToolButton::InstantPopup );
316 toolbuttonExportToScript->addAction( mActionExportAsScriptAlgorithm );
317 toolbuttonExportToScript->setDefaultAction( mActionExportAsScriptAlgorithm );
318 mToolbar->insertWidget( mActionExportImage, toolbuttonExportToScript );
319 connect( mActionExportAsScriptAlgorithm, &QAction::triggered,
this, &QgsModelDesignerDialog::exportAsScriptAlgorithm );
321 mActionShowComments->setChecked( settings.
value( QStringLiteral(
"/Processing/Modeler/ShowComments" ),
true ).toBool() );
322 connect( mActionShowComments, &QAction::toggled,
this, &QgsModelDesignerDialog::toggleComments );
325 mPanTool->setAction( mActionPan );
327 mToolsActionGroup->addAction( mActionPan );
328 connect( mActionPan, &QAction::triggered, mPanTool, [ = ] { mView->setTool( mPanTool ); } );
331 mSelectTool->setAction( mActionSelectMoveItem );
333 mToolsActionGroup->addAction( mActionSelectMoveItem );
334 connect( mActionSelectMoveItem, &QAction::triggered, mSelectTool, [ = ] { mView->setTool( mSelectTool ); } );
336 mView->setTool( mSelectTool );
339 connect( mView, &QgsModelGraphicsView::macroCommandStarted,
this, [ = ](
const QString & text )
341 mIgnoreUndoStackChanges++;
342 mUndoStack->beginMacro( text );
343 mIgnoreUndoStackChanges--;
345 connect( mView, &QgsModelGraphicsView::macroCommandEnded,
this, [ = ]
347 mIgnoreUndoStackChanges++;
348 mUndoStack->endMacro();
349 mIgnoreUndoStackChanges--;
351 connect( mView, &QgsModelGraphicsView::beginCommand,
this, [ = ](
const QString & text )
353 beginUndoCommand( text );
355 connect( mView, &QgsModelGraphicsView::endCommand,
this, [ = ]
359 connect( mView, &QgsModelGraphicsView::deleteSelectedItems,
this, [ = ]
364 connect( mActionAddGroupBox, &QAction::triggered,
this, [ = ]
366 const QPointF viewCenter = mView->mapToScene( mView->viewport()->rect().center() );
367 QgsProcessingModelGroupBox group;
368 group.setPosition( viewCenter );
369 group.setDescription( tr(
"New Group" ) );
371 beginUndoCommand( tr(
"Add Group Box" ) );
372 model()->addGroupBox( group );
380 restoreState( settings.
value( QStringLiteral(
"ModelDesigner/state" ), QByteArray(),
QgsSettings::App ).toByteArray() );
383QgsModelDesignerDialog::~QgsModelDesignerDialog()
386 if ( !mPanelStatus.isEmpty() )
388 QStringList docksTitle;
389 QStringList docksActive;
391 for (
const auto &panel : mPanelStatus.toStdMap() )
393 if ( panel.second.isVisible )
394 docksTitle << panel.first;
395 if ( panel.second.isActive )
396 docksActive << panel.first;
410 mIgnoreUndoStackChanges++;
414void QgsModelDesignerDialog::closeEvent( QCloseEvent *event )
416 if ( checkForUnsavedChanges() )
422void QgsModelDesignerDialog::beginUndoCommand(
const QString &text,
int id )
424 if ( mBlockUndoCommands || !mUndoStack )
427 if ( mActiveCommand )
430 mActiveCommand = std::make_unique< QgsModelUndoCommand >( mModel.get(), text,
id );
433void QgsModelDesignerDialog::endUndoCommand()
435 if ( mBlockUndoCommands || !mActiveCommand || !mUndoStack )
438 mActiveCommand->saveAfterState();
439 mIgnoreUndoStackChanges++;
440 mUndoStack->push( mActiveCommand.release() );
441 mIgnoreUndoStackChanges--;
445QgsProcessingModelAlgorithm *QgsModelDesignerDialog::model()
450void QgsModelDesignerDialog::setModel( QgsProcessingModelAlgorithm *model )
452 mModel.reset( model );
454 mGroupEdit->setText( mModel->group() );
455 mNameEdit->setText( mModel->displayName() );
457 updateVariablesGui();
459 mView->centerOn( 0, 0 );
462 mIgnoreUndoStackChanges++;
464 mIgnoreUndoStackChanges--;
469void QgsModelDesignerDialog::loadModel(
const QString &path )
471 std::unique_ptr< QgsProcessingModelAlgorithm > alg = std::make_unique< QgsProcessingModelAlgorithm >();
472 if ( alg->fromFile( path ) )
475 alg->setSourceFilePath( path );
476 setModel( alg.release() );
481 QMessageBox::critical(
this, tr(
"Open Model" ), tr(
"The selected model could not be loaded.\n"
482 "See the log for more information." ) );
486void QgsModelDesignerDialog::setModelScene( QgsModelGraphicsScene *scene )
488 QgsModelGraphicsScene *oldScene = mScene;
491 mScene->setParent(
this );
492 mScene->setChildAlgorithmResults( mChildResults );
493 mScene->setModel( mModel.get() );
494 mScene->setMessageBar( mMessageBar );
496 const QPointF center = mView->mapToScene( mView->viewport()->rect().center() );
497 mView->setModelScene( mScene );
499 mSelectTool->resetCache();
500 mSelectTool->setScene( mScene );
502 connect( mScene, &QgsModelGraphicsScene::rebuildRequired,
this, [ = ]
504 if ( mBlockRepaints )
509 connect( mScene, &QgsModelGraphicsScene::componentAboutToChange,
this, [ = ](
const QString & description,
int id ) { beginUndoCommand( description,
id ); } );
510 connect( mScene, &QgsModelGraphicsScene::componentChanged,
this, [ = ] { endUndoCommand(); } );
512 mView->centerOn( center );
515 oldScene->deleteLater();
518void QgsModelDesignerDialog::activate()
522 setWindowState( windowState() & ~Qt::WindowMinimized );
526void QgsModelDesignerDialog::updateVariablesGui()
528 mBlockUndoCommands++;
530 std::unique_ptr< QgsExpressionContextScope > variablesScope = std::make_unique< QgsExpressionContextScope >( tr(
"Model Variables" ) );
531 const QVariantMap modelVars = mModel->variables();
532 for (
auto it = modelVars.constBegin(); it != modelVars.constEnd(); ++it )
534 variablesScope->setVariable( it.key(), it.value() );
537 variablesContext.
appendScope( variablesScope.release() );
538 mVariablesEditor->setContext( &variablesContext );
539 mVariablesEditor->setEditableScopeIndex( 0 );
541 mBlockUndoCommands--;
544void QgsModelDesignerDialog::setDirty(
bool dirty )
550bool QgsModelDesignerDialog::validateSave( SaveAction action )
554 case QgsModelDesignerDialog::SaveAction::SaveAsFile:
556 case QgsModelDesignerDialog::SaveAction::SaveInProject:
557 if ( mNameEdit->text().trimmed().isEmpty() )
559 mMessageBar->pushWarning( QString(), tr(
"Please enter a model name before saving" ) );
568bool QgsModelDesignerDialog::checkForUnsavedChanges()
572 QMessageBox::StandardButton ret = QMessageBox::question(
this, tr(
"Save Model?" ),
573 tr(
"There are unsaved changes in this model. Do you want to keep those?" ),
574 QMessageBox::Save | QMessageBox::Cancel | QMessageBox::Discard, QMessageBox::Cancel );
577 case QMessageBox::Save:
578 return saveModel(
false );
580 case QMessageBox::Discard:
593void QgsModelDesignerDialog::setLastRunChildAlgorithmResults(
const QVariantMap &results )
595 mChildResults = results;
597 mScene->setChildAlgorithmResults( mChildResults );
600void QgsModelDesignerDialog::setLastRunChildAlgorithmInputs(
const QVariantMap &inputs )
602 mChildInputs = inputs;
604 mScene->setChildAlgorithmInputs( mChildInputs );
607void QgsModelDesignerDialog::setModelName(
const QString &name )
609 mNameEdit->setText( name );
612void QgsModelDesignerDialog::zoomIn()
614 mView->setTransformationAnchor( QGraphicsView::NoAnchor );
615 QPointF point = mView->mapToScene( QPoint( mView->viewport()->width() / 2.0, mView->viewport()->height() / 2 ) );
617 const double factor = settings.
value( QStringLiteral(
"/qgis/zoom_favor" ), 2.0 ).toDouble();
618 mView->scale( factor, factor );
619 mView->centerOn( point );
622void QgsModelDesignerDialog::zoomOut()
624 mView->setTransformationAnchor( QGraphicsView::NoAnchor );
625 QPointF point = mView->mapToScene( QPoint( mView->viewport()->width() / 2.0, mView->viewport()->height() / 2 ) );
627 const double factor = 1.0 / settings.
value( QStringLiteral(
"/qgis/zoom_favor" ), 2.0 ).toDouble();
628 mView->scale( factor, factor );
629 mView->centerOn( point );
632void QgsModelDesignerDialog::zoomActual()
634 QPointF point = mView->mapToScene( QPoint( mView->viewport()->width() / 2.0, mView->viewport()->height() / 2 ) );
635 mView->resetTransform();
636 mView->scale( mScreenHelper->screenDpi() / 96, mScreenHelper->screenDpi() / 96 );
637 mView->centerOn( point );
640void QgsModelDesignerDialog::zoomFull()
642 QRectF totalRect = mView->scene()->itemsBoundingRect();
643 totalRect.adjust( -10, -10, 10, 10 );
644 mView->fitInView( totalRect, Qt::KeepAspectRatio );
647void QgsModelDesignerDialog::newModel()
649 if ( !checkForUnsavedChanges() )
652 std::unique_ptr< QgsProcessingModelAlgorithm > alg = std::make_unique< QgsProcessingModelAlgorithm >();
654 setModel( alg.release() );
657void QgsModelDesignerDialog::exportToImage()
660 QString lastExportDir = settings.
value( QStringLiteral(
"lastModelDesignerExportDir" ), QDir::homePath(),
QgsSettings::App ).toString();
662 QString filename = QFileDialog::getSaveFileName(
this, tr(
"Save Model as Image" ),
664 tr(
"PNG files (*.png *.PNG)" ) );
668 if ( filename.isEmpty() )
673 const QFileInfo saveFileInfo( filename );
676 repaintModel(
false );
678 QRectF totalRect = mView->scene()->itemsBoundingRect();
679 totalRect.adjust( -10, -10, 10, 10 );
680 const QRectF imageRect = QRectF( 0, 0, totalRect.width(), totalRect.height() );
682 QImage img( totalRect.width(), totalRect.height(),
683 QImage::Format_ARGB32_Premultiplied );
684 img.fill( Qt::white );
686 painter.setRenderHint( QPainter::Antialiasing );
687 painter.begin( &img );
688 mView->scene()->render( &painter, imageRect, totalRect );
691 img.save( filename );
693 mMessageBar->pushMessage( QString(), tr(
"Successfully exported model as image to <a href=\"%1\">%2</a>" ).arg( QUrl::fromLocalFile( filename ).toString(), QDir::toNativeSeparators( filename ) ),
Qgis::MessageLevel::Success, 0 );
694 repaintModel(
true );
697void QgsModelDesignerDialog::exportToPdf()
700 QString lastExportDir = settings.
value( QStringLiteral(
"lastModelDesignerExportDir" ), QDir::homePath(),
QgsSettings::App ).toString();
702 QString filename = QFileDialog::getSaveFileName(
this, tr(
"Save Model as PDF" ),
704 tr(
"PDF files (*.pdf *.PDF)" ) );
708 if ( filename.isEmpty() )
713 const QFileInfo saveFileInfo( filename );
716 repaintModel(
false );
718 QRectF totalRect = mView->scene()->itemsBoundingRect();
719 totalRect.adjust( -10, -10, 10, 10 );
720 const QRectF printerRect = QRectF( 0, 0, totalRect.width(), totalRect.height() );
722 QPdfWriter pdfWriter( filename );
724 const double scaleFactor = 96 / 25.4;
726 QPageLayout pageLayout( QPageSize( totalRect.size() / scaleFactor, QPageSize::Millimeter ),
727 QPageLayout::Portrait,
728 QMarginsF( 0, 0, 0, 0 ) );
729 pageLayout.setMode( QPageLayout::FullPageMode );
730 pdfWriter.setPageLayout( pageLayout );
732 QPainter painter( &pdfWriter );
733 mView->scene()->render( &painter, printerRect, totalRect );
736 mMessageBar->pushMessage( QString(), tr(
"Successfully exported model as PDF to <a href=\"%1\">%2</a>" ).arg( QUrl::fromLocalFile( filename ).toString(),
738 repaintModel(
true );
741void QgsModelDesignerDialog::exportToSvg()
744 QString lastExportDir = settings.
value( QStringLiteral(
"lastModelDesignerExportDir" ), QDir::homePath(),
QgsSettings::App ).toString();
746 QString filename = QFileDialog::getSaveFileName(
this, tr(
"Save Model as SVG" ),
748 tr(
"SVG files (*.svg *.SVG)" ) );
752 if ( filename.isEmpty() )
757 const QFileInfo saveFileInfo( filename );
760 repaintModel(
false );
762 QRectF totalRect = mView->scene()->itemsBoundingRect();
763 totalRect.adjust( -10, -10, 10, 10 );
764 const QRectF svgRect = QRectF( 0, 0, totalRect.width(), totalRect.height() );
767 svg.setFileName( filename );
768 svg.setSize( QSize( totalRect.width(), totalRect.height() ) );
769 svg.setViewBox( svgRect );
770 svg.setTitle( mModel->displayName() );
772 QPainter painter( &svg );
773 mView->scene()->render( &painter, svgRect, totalRect );
776 mMessageBar->pushMessage( QString(), tr(
"Successfully exported model as SVG to <a href=\"%1\">%2</a>" ).arg( QUrl::fromLocalFile( filename ).toString(), QDir::toNativeSeparators( filename ) ),
Qgis::MessageLevel::Success, 0 );
777 repaintModel(
true );
780void QgsModelDesignerDialog::exportAsPython()
783 QString lastExportDir = settings.
value( QStringLiteral(
"lastModelDesignerExportDir" ), QDir::homePath(),
QgsSettings::App ).toString();
785 QString filename = QFileDialog::getSaveFileName(
this, tr(
"Save Model as Python Script" ),
787 tr(
"Processing scripts (*.py *.PY)" ) );
791 if ( filename.isEmpty() )
796 const QFileInfo saveFileInfo( filename );
801 QFile outFile( filename );
802 if ( !outFile.open( QIODevice::WriteOnly | QIODevice::Truncate ) )
806 QTextStream fout( &outFile );
810 mMessageBar->pushMessage( QString(), tr(
"Successfully exported model as Python script to <a href=\"%1\">%2</a>" ).arg( QUrl::fromLocalFile( filename ).toString(), QDir::toNativeSeparators( filename ) ),
Qgis::MessageLevel::Success, 0 );
813void QgsModelDesignerDialog::toggleComments(
bool show )
817 repaintModel(
true );
820void QgsModelDesignerDialog::updateWindowTitle()
822 QString title = tr(
"Model Designer" );
823 if ( !mModel->name().isEmpty() )
824 title = QStringLiteral(
"%1 - %2" ).arg( title, mModel->name() );
827 title.prepend(
'*' );
829 setWindowTitle( title );
832void QgsModelDesignerDialog::deleteSelected()
834 QList< QgsModelComponentGraphicItem * > items = mScene->selectedComponentItems();
838 if ( items.size() == 1 )
840 items.at( 0 )->deleteComponent();
844 std::sort( items.begin(), items.end(), []( QgsModelComponentGraphicItem * p1, QgsModelComponentGraphicItem * p2 )
847 if ( dynamic_cast< QgsModelCommentGraphicItem *>( p1 ) )
849 else if ( dynamic_cast< QgsModelCommentGraphicItem *>( p2 ) )
851 else if ( dynamic_cast< QgsModelGroupBoxGraphicItem *>( p1 ) )
853 else if ( dynamic_cast< QgsModelGroupBoxGraphicItem *>( p2 ) )
855 else if ( dynamic_cast< QgsModelOutputGraphicItem *>( p1 ) )
857 else if ( dynamic_cast< QgsModelOutputGraphicItem *>( p2 ) )
859 else if ( dynamic_cast< QgsModelChildAlgorithmGraphicItem *>( p1 ) )
861 else if ( dynamic_cast< QgsModelChildAlgorithmGraphicItem *>( p2 ) )
867 beginUndoCommand( tr(
"Delete Components" ) );
869 QVariant prevState = mModel->toVariant();
870 mBlockUndoCommands++;
871 mBlockRepaints =
true;
873 while ( !items.empty() )
875 QgsModelComponentGraphicItem *toDelete =
nullptr;
876 for ( QgsModelComponentGraphicItem *item : items )
878 if ( item->canDeleteComponent() )
891 toDelete->deleteComponent();
892 items.removeAll( toDelete );
897 mModel->loadVariant( prevState );
898 QMessageBox::warning(
nullptr, QObject::tr(
"Could not remove components" ),
899 QObject::tr(
"Components depend on the selected items.\n"
900 "Try to remove them before trying deleting these components." ) );
901 mBlockUndoCommands--;
902 mActiveCommand.reset();
906 mBlockUndoCommands--;
910 mBlockRepaints =
false;
914void QgsModelDesignerDialog::populateZoomToMenu()
917 for (
const QgsProcessingModelGroupBox &box : model()->groupBoxes() )
919 if ( QgsModelComponentGraphicItem *item = mScene->groupBoxItem( box.uuid() ) )
921 QAction *zoomAction =
new QAction( box.description(), mGroupMenu );
922 connect( zoomAction, &QAction::triggered,
this, [ = ]
924 QRectF groupRect = item->mapToScene( item->boundingRect() ).boundingRect();
925 groupRect.adjust( -10, -10, 10, 10 );
926 mView->fitInView( groupRect, Qt::KeepAspectRatio );
927 mView->centerOn( item );
929 mGroupMenu->addAction( zoomAction );
934void QgsModelDesignerDialog::setPanelVisibility(
bool hidden )
936 const QList<QDockWidget *> docks = findChildren<QDockWidget *>();
937 const QList<QTabBar *> tabBars = findChildren<QTabBar *>();
941 mPanelStatus.clear();
943 for ( QDockWidget *dock : docks )
945 mPanelStatus.insert( dock->windowTitle(), PanelStatus( dock->isVisible(),
false ) );
946 dock->setVisible(
false );
950 for ( QTabBar *tabBar : tabBars )
952 QString currentTabTitle = tabBar->tabText( tabBar->currentIndex() );
953 mPanelStatus[ currentTabTitle ].isActive =
true;
959 for ( QDockWidget *dock : docks )
961 if ( mPanelStatus.contains( dock->windowTitle() ) )
963 dock->setVisible( mPanelStatus.value( dock->windowTitle() ).isVisible );
968 for ( QTabBar *tabBar : tabBars )
971 for (
int i = 0; i < tabBar->count(); ++i )
973 QString tabTitle = tabBar->tabText( i );
974 if ( mPanelStatus.contains( tabTitle ) && mPanelStatus.value( tabTitle ).isActive )
976 tabBar->setCurrentIndex( i );
980 mPanelStatus.clear();
984void QgsModelDesignerDialog::editHelp()
986 QgsProcessingHelpEditorDialog dialog(
this );
987 dialog.setWindowTitle( tr(
"Edit Model Help" ) );
988 dialog.setAlgorithm( mModel.get() );
991 beginUndoCommand( tr(
"Edit Model Help" ) );
992 mModel->setHelpContent( dialog.helpContent() );
997void QgsModelDesignerDialog::validate()
1000 if ( model()->validate( issues ) )
1002 mMessageBar->pushSuccess( QString(), tr(
"Model is valid!" ) );
1007 QPushButton *detailsButton =
new QPushButton( tr(
"Details" ) );
1008 connect( detailsButton, &QPushButton::clicked, detailsButton, [ = ]
1011 dialog->
setTitle( tr(
"Model is Invalid" ) );
1013 QString longMessage = tr(
"<p>This model is not valid:</p>" ) + QStringLiteral(
"<ul>" );
1014 for (
const QString &issue : issues )
1016 longMessage += QStringLiteral(
"<li>%1</li>" ).arg( issue );
1018 longMessage += QLatin1String(
"</ul>" );
1023 messageWidget->layout()->addWidget( detailsButton );
1024 mMessageBar->clearWidgets();
1029void QgsModelDesignerDialog::reorderInputs()
1031 QgsModelInputReorderDialog dlg(
this );
1032 dlg.setModel( mModel.get() );
1035 const QStringList inputOrder = dlg.inputOrder();
1036 beginUndoCommand( tr(
"Reorder Inputs" ) );
1037 mModel->setParameterOrder( inputOrder );
1042void QgsModelDesignerDialog::reorderOutputs()
1044 QgsModelOutputReorderDialog dlg(
this );
1045 dlg.setModel( mModel.get() );
1048 const QStringList outputOrder = dlg.outputOrder();
1049 beginUndoCommand( tr(
"Reorder Outputs" ) );
1050 mModel->setOutputOrder( outputOrder );
1051 mModel->setOutputGroup( dlg.outputGroup() );
1056bool QgsModelDesignerDialog::isDirty()
const
1058 return mHasChanged && mUndoStack->index() != -1;
1061void QgsModelDesignerDialog::fillInputsTree()
1064 std::unique_ptr< QTreeWidgetItem > parametersItem = std::make_unique< QTreeWidgetItem >();
1065 parametersItem->setText( 0, tr(
"Parameters" ) );
1069 return QString::localeAwareCompare( a->name(), b->name() ) < 0;
1076 std::unique_ptr< QTreeWidgetItem > paramItem = std::make_unique< QTreeWidgetItem >();
1077 paramItem->setText( 0, param->name() );
1078 paramItem->setData( 0, Qt::UserRole, param->id() );
1079 paramItem->setIcon( 0, icon );
1080 paramItem->setFlags( Qt::ItemIsEnabled | Qt::ItemIsSelectable | Qt::ItemIsDragEnabled );
1081 paramItem->setToolTip( 0, param->description() );
1082 parametersItem->addChild( paramItem.release() );
1085 mInputsTreeWidget->addTopLevelItem( parametersItem.release() );
1086 mInputsTreeWidget->topLevelItem( 0 )->setExpanded(
true );
1094QgsModelChildDependenciesWidget::QgsModelChildDependenciesWidget( QWidget *parent, QgsProcessingModelAlgorithm *model,
const QString &childId )
1097 , mChildId( childId )
1099 QHBoxLayout *hl =
new QHBoxLayout();
1100 hl->setContentsMargins( 0, 0, 0, 0 );
1102 mLineEdit =
new QLineEdit();
1103 mLineEdit->setEnabled(
false );
1104 hl->addWidget( mLineEdit, 1 );
1106 mToolButton =
new QToolButton();
1107 mToolButton->setText( QString( QChar( 0x2026 ) ) );
1108 hl->addWidget( mToolButton );
1112 mLineEdit->setText( tr(
"%1 dependencies selected" ).arg( 0 ) );
1114 connect( mToolButton, &QToolButton::clicked,
this, &QgsModelChildDependenciesWidget::showDialog );
1117void QgsModelChildDependenciesWidget::setValue(
const QList<QgsProcessingModelChildDependency> &value )
1121 updateSummaryText();
1124void QgsModelChildDependenciesWidget::showDialog()
1126 const QList<QgsProcessingModelChildDependency> available = mModel->availableDependenciesForChildAlgorithm( mChildId );
1128 QVariantList availableOptions;
1129 for (
const QgsProcessingModelChildDependency &dep : available )
1130 availableOptions << QVariant::fromValue( dep );
1131 QVariantList selectedOptions;
1132 for (
const QgsProcessingModelChildDependency &dep : mValue )
1133 selectedOptions << QVariant::fromValue( dep );
1138 QgsProcessingMultipleSelectionPanelWidget *widget =
new QgsProcessingMultipleSelectionPanelWidget( availableOptions, selectedOptions );
1139 widget->setPanelTitle( tr(
"Algorithm Dependencies" ) );
1141 widget->setValueFormatter( [ = ](
const QVariant & v ) -> QString
1143 const QgsProcessingModelChildDependency dep = v.value< QgsProcessingModelChildDependency >();
1145 const QString description = mModel->childAlgorithm( dep.childId ).description();
1146 if ( dep.conditionalBranch.isEmpty() )
1149 return tr(
"Condition “%1” from algorithm “%2”" ).arg( dep.conditionalBranch, description );
1152 connect( widget, &QgsProcessingMultipleSelectionPanelWidget::selectionChanged,
this, [ = ]()
1154 QList< QgsProcessingModelChildDependency > res;
1155 for (
const QVariant &v : widget->selectedOptions() )
1157 res << v.value< QgsProcessingModelChildDependency >();
1166void QgsModelChildDependenciesWidget::updateSummaryText()
1168 mLineEdit->setText( tr(
"%n dependencies selected",
nullptr, mValue.count() ) );
@ ExposeToModeler
Is this parameter available in the modeler. Is set to on by default.
@ Warning
Warning message.
@ Critical
Critical/error message.
@ Success
Used for reporting a successful operation.
static QgsProcessingRegistry * processingRegistry()
Returns the application's processing registry, used for managing processing providers,...
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
static QString ensureFileNameHasExtension(const QString &fileName, const QStringList &extensions)
Ensures that a fileName ends with an extension from the provided list of extensions.
static void enableAutoGeometryRestore(QWidget *widget, const QString &key=QString())
Register the widget to allow its position to be automatically saved and restored when open and closed...
Represents an item shown within a QgsMessageBar widget.
A bar for displaying non-blocking messages to the user.
static QgsMessageBarItem * createMessage(const QString &text, QWidget *parent=nullptr)
Creates message bar item widget containing a message text to be displayed on the bar.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
A generic message view for displaying QGIS messages.
void setTitle(const QString &title) override
Sets title for the messages.
void setMessage(const QString &message, MessageType msgType) override
Sets message, it won't be displayed until.
void showMessage(bool blocking=true) override
display the message to the user and deletes itself
Makes metadata of processing parameters available.
QList< QgsProcessingParameterType * > parameterTypes() const
Returns a list with all known parameter types.
@ PythonQgsProcessingAlgorithmSubclass
Full Python QgsProcessingAlgorithm subclass.
A utility class for dynamic handling of changes to screen properties.
This class is a composition of two QSettings instances:
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
void remove(const QString &key, QgsSettings::Section section=QgsSettings::NoSection)
Removes the setting key and any sub-settings of key in a section.
void setValue(const QString &key, const QVariant &value, QgsSettings::Section section=QgsSettings::NoSection)
Sets the value of setting key to value.