Class: QgsModelDesignerDialog

Model designer dialog base class.

Warning

Not stable API

Added in version 3.14.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: addAlgorithm(), addInput(), createExecutionDialog(), exportAsScriptAlgorithm(), repaintModel(), saveModel()

Class Hierarchy

Base classes

QMainWindow
QWidget
QObject
QPaintDevice

Enums

SaveAction

Save action.

Abstract Methods

addAlgorithm
addInput
createExecutionDialog
exportAsScriptAlgorithm
repaintModel
saveModel

Methods

actionOpen
actionRun
actionSaveInProject
activate	Raise, unminimize and activate this window.
beginUndoCommand	Starts an undo command.
checkForUnsavedChanges	Checks if there are unsaved changes in the model, and if so, prompts the user to save them.
endUndoCommand	Ends the current undo command.
loadModel	Loads a model into the designer from the specified file path.
messageBar
model	Returns the model shown in the dialog.
setDirty
setLastRunResult	Sets the result of the last run of the model through the designer window.
setModel	Sets the model shown in the dialog.
setModelName	Sets the model name.
setModelScene	Sets the related scene.
toolbar
validateSave	Checks if the model can current be saved, and returns True if it can.
view

class qgis.gui.QgsModelDesignerDialog

Bases: QMainWindow

class SaveAction(*values)

Bases: IntEnum

Save action.

Added in version 3.24.

• SaveAsFile: Save model as a file

• SaveInProject: Save model into project

SaveAsFile = 0

SaveInProject = 1

actionOpen(self) → QAction | None

Return type:

Optional[QAction]

actionRun(self) → QAction | None

Return type:

Optional[QAction]

actionSaveInProject(self) → QAction | None

Return type:

Optional[QAction]

activate(self)

Raise, unminimize and activate this window.

Added in version 3.24.

abstract addAlgorithm(self, algorithmId: str | None, pos: QPointF | QPoint)

Parameters:

• algorithmId (Optional[str])

• pos (Union[QPointF, QPoint])

abstract addInput(self, inputId: str | None, pos: QPointF | QPoint)

Parameters:

• inputId (Optional[str])

• pos (Union[QPointF, QPoint])

beginUndoCommand(self, text: str | None, id: int = 0)

Starts an undo command. This should be called before any changes are made to the model.

Parameters:

• text (Optional[str])

• id (int = 0)

checkForUnsavedChanges(self) → bool

Checks if there are unsaved changes in the model, and if so, prompts the user to save them.

Returns False if the cancel option was selected

Return type:

bool

abstract createExecutionDialog(self) → QgsProcessingAlgorithmDialogBase | None

Return type:

Optional[QgsProcessingAlgorithmDialogBase]

endUndoCommand(self)

Ends the current undo command. This should be called after changes are made to the model.

abstract exportAsScriptAlgorithm(self)

loadModel(self, path: str | None)

Loads a model into the designer from the specified file path.

Parameters:

path (Optional[str])

messageBar(self) → QgsMessageBar | None

Return type:

Optional[QgsMessageBar]

model(self) → QgsProcessingModelAlgorithm | None

Returns the model shown in the dialog.

Return type:

Optional[QgsProcessingModelAlgorithm]

abstract repaintModel(self, showControls: bool = True)

Parameters:

showControls (bool = True)

abstract saveModel(self, saveAs: bool = False) → bool

Parameters:

saveAs (bool = False)

Return type:

bool

setDirty(self, dirty: bool)

Parameters:

dirty (bool)

setLastRunResult(self, result: QgsProcessingModelResult)

Sets the result of the last run of the model through the designer window.

Parameters:

result (QgsProcessingModelResult)

setModel(self, model: QgsProcessingModelAlgorithm | None)

Sets the model shown in the dialog.

Ownership of model is transferred to the dialog.

Parameters:

model (Optional[QgsProcessingModelAlgorithm])

setModelName(self, name: str | None)

Sets the model name.

Updates both the name text edit and the model name itself.

Added in version 3.24.

Parameters:

name (Optional[str])

setModelScene(self, scene: QgsModelGraphicsScene | None)

Sets the related scene.

Parameters:

scene (Optional[QgsModelGraphicsScene])

toolbar(self) → QToolBar | None

Return type:

Optional[QToolBar]

validateSave(self, action: QgsModelDesignerDialog.SaveAction) → bool

Checks if the model can current be saved, and returns True if it can.

Parameters:

action (QgsModelDesignerDialog.SaveAction)

Return type:

bool

view(self) → QGraphicsView | None

Return type:

Optional[QGraphicsView]