Class: QgsProcessingAlgorithmDialogBase¶
-
class
qgis.gui.
QgsProcessingAlgorithmDialogBase
(parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags())¶ Bases:
PyQt5.QtWidgets.QDialog
,QgsProcessingParametersGenerator
Constructor for QgsProcessingAlgorithmDialogBase.
Base class for processing algorithm dialogs.
Note
This is not considered stable API and may change in future QGIS versions.
New in version 3.0.
- Parameters
parent (QWidget = None) –
flags –
-
FormatHtml
= 1¶
-
FormatPlainText
= 0¶
-
class
LogFormat
¶ Bases:
int
-
actionEvent
(self, QActionEvent)¶
-
algorithm
(self) → QgsProcessingAlgorithm¶ Returns the algorithm running in the dialog.
See also
- Return type
-
algorithmFinished
¶ Emitted whenever an algorithm has finished executing in the dialog.
New in version 3.14: [signal]
- Parameters
successful (bool) –
result (Dict[str) –
-
blockAdditionalControlsWhileRunning
(self)¶ For subclasses to register their own GUI controls to be blocked while the algorithm is running.
-
blockControlsWhileRunning
(self)¶ Blocks run and changeParameters buttons and parameters tab while the algorithm is running.
Returns the dialog’s button box.
- Return type
QDialogButtonBox
-
cancelButton
(self) → QPushButton¶ Returns the dialog’s cancel button.
- Return type
QPushButton
-
changeEvent
(self, QEvent)¶
-
changeParametersButton
(self) → QPushButton¶ Returns the dialog’s change parameters button.
- Return type
QPushButton
-
childEvent
(self, QChildEvent)¶
-
clearLog
(self)¶ Clears the current log contents.
New in version 3.2.
-
clearProgress
(self)¶ Clears any current progress from the dialog.
-
closeEvent
(self, e: QCloseEvent)¶ - Parameters
e (QCloseEvent) –
-
connectNotify
(self, QMetaMethod)¶
-
contextMenuEvent
(self, QContextMenuEvent)¶
-
copyLogToClipboard
(self)¶ Copies the current log contents to the clipboard.
New in version 3.2.
-
create
(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
-
createFeedback
(self) → QgsProcessingFeedback¶ Creates a new processing feedback object, automatically connected to the appropriate slots in this dialog.
- Return type
-
createProgressDialog
(self) → QDialog¶ Creates a modal progress dialog showing progress and log messages from this dialog.
- Return type
QDialog
-
customEvent
(self, QEvent)¶
-
destroy
(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
-
disconnectNotify
(self, QMetaMethod)¶
-
dragEnterEvent
(self, QDragEnterEvent)¶
-
dragLeaveEvent
(self, QDragLeaveEvent)¶
-
dragMoveEvent
(self, QDragMoveEvent)¶
-
dropEvent
(self, QDropEvent)¶
-
enterEvent
(self, QEvent)¶
-
event
(self, QEvent) → bool¶
-
eventFilter
(self, QObject, QEvent) → bool¶
-
finished
(self, successful: bool, result: Dict[str, Any], context: QgsProcessingContext, feedback: QgsProcessingFeedback)¶ Called when the algorithm has finished executing.
- Parameters
successful (bool) –
result (Dict[str) –
context (QgsProcessingContext) –
feedback (QgsProcessingFeedback) –
-
focusInEvent
(self, QFocusEvent)¶
-
focusNextChild
(self) → bool¶
-
focusNextPrevChild
(self, bool) → bool¶
-
focusOutEvent
(self, QFocusEvent)¶
-
focusPreviousChild
(self) → bool¶
-
formatStringForLog
(string: str) → str¶ Formats an input
string
for display in the log tab.New in version 3.0.1.
- Parameters
string (str) –
- Return type
str
-
hideEvent
(self, QHideEvent)¶
-
hideShortHelp
(self)¶ Hides the short help panel.
-
initPainter
(self, QPainter)¶
-
inputMethodEvent
(self, QInputMethodEvent)¶
-
isSignalConnected
(self, QMetaMethod) → bool¶
-
keyPressEvent
(self, QKeyEvent)¶
-
keyReleaseEvent
(self, QKeyEvent)¶
-
leaveEvent
(self, QEvent)¶
-
mainWidget
(self) → QgsPanelWidget¶ Returns the main widget for the dialog, usually a panel for configuring algorithm parameters.
See also
- Return type
-
messageBar
(self) → QgsMessageBar¶ Returns the dialog’s message bar.
- Return type
-
metric
(self, QPaintDevice.PaintDeviceMetric) → int¶
-
mouseDoubleClickEvent
(self, QMouseEvent)¶
-
mouseMoveEvent
(self, QMouseEvent)¶
-
mousePressEvent
(self, QMouseEvent)¶
-
mouseReleaseEvent
(self, QMouseEvent)¶
-
moveEvent
(self, QMoveEvent)¶
-
nativeEvent
(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]¶
-
paintEvent
(self, QPaintEvent)¶
-
pushCommandInfo
(self, info: str)¶ Pushes command info to the dialog’s log.
- Parameters
info (str) –
-
pushConsoleInfo
(self, info: str)¶ Pushes a console info string to the dialog’s log.
- Parameters
info (str) –
-
pushDebugInfo
(self, message: str)¶ Pushes a debug info string to the dialog’s log.
- Parameters
message (str) –
-
pushInfo
(self, info: str)¶ Pushes an information string to the dialog’s log.
- Parameters
info (str) –
-
receivers
(self, PYQT_SIGNAL) → int¶
-
reject
(self)¶
-
reportError
(self, error: str, fatalError: bool)¶ Reports an
error
string to the dialog’s log.If
fatalError
isTrue
, the error prevented the algorithm from executing.- Parameters
error (str) –
fatalError (bool) –
-
resetAdditionalGui
(self)¶ For subclasses to register their own GUI controls to be reset, ready for another algorithm execution.
-
resetGui
(self)¶ Resets the dialog’s gui, ready for another algorithm execution.
-
resizeEvent
(self, QResizeEvent)¶
-
results
(self) → Dict[str, Any]¶ Returns the results returned by the algorithm executed.
See also
See also
- Return type
Dict[str, Any]
-
runAlgorithm
(self)¶ Called when the dialog’s algorithm should be run. Must be overridden by subclasses.
-
runButton
(self) → QPushButton¶ Returns the dialog’s run button.
- Return type
QPushButton
-
saveLog
(self)¶ Opens a dialog allowing users to save the current log contents.
See also
New in version 3.2.
-
saveLogToFile
(self, path: str, format: QgsProcessingAlgorithmDialogBase.LogFormat = QgsProcessingAlgorithmDialogBase.FormatPlainText)¶ Saves the log contents to a text file (specified by the file
path
), in the givenformat
.See also
New in version 3.2.
- Parameters
path (str) –
format (QgsProcessingAlgorithmDialogBase.LogFormat = QgsProcessingAlgorithmDialogBase.FormatPlainText) –
-
sender
(self) → QObject¶
-
senderSignalIndex
(self) → int¶
-
setAlgorithm
(self, algorithm: QgsProcessingAlgorithm)¶ Sets the
algorithm
to run in the dialog.Ownership of the algorithm instance is transferred to the dialog.
See also
- Parameters
algorithm (QgsProcessingAlgorithm) –
-
setCurrentTask
(self, task: QgsProcessingAlgRunnerTask)¶ Sets the current
task
running in the dialog. The task will automatically be started by the dialog. Ownership oftask
is transferred to the dialog.- Parameters
task (QgsProcessingAlgRunnerTask) –
-
setExecuted
(self, executed: bool)¶ Sets whether the algorithm was executed through the dialog.
See also
See also
- Parameters
executed (bool) –
-
setExecutedAnyResult
(self, executedAnyResult: bool)¶ Sets whether the algorithm was executed through the dialog (no matter the result).
- Parameters
executedAnyResult (bool) –
-
setInfo
(self, message: str, isError: bool = False, escapeHtml: bool = True)¶ Displays an info
message
in the dialog’s log.- Parameters
message (str) –
isError (bool = False) –
escapeHtml (bool = True) –
-
setMainWidget
(self, widget: QgsPanelWidget)¶ Sets the main
widget
for the dialog, usually a panel for configuring algorithm parameters.See also
- Parameters
widget (QgsPanelWidget) –
-
setPercentage
(self, percent: float)¶ Sets the percentage progress for the dialog, between 0 and 100.
- Parameters
percent (float) –
-
setProgressText
(self, text: str)¶ Sets a progress text message.
- Parameters
text (str) –
-
setResults
(self, results: Dict[str, Any])¶ Sets the algorithm results.
See also
See also
- Parameters
results (Dict[str) –
-
showEvent
(self, QShowEvent)¶
-
showLog
(self)¶ Switches the dialog to the log page.
-
showParameters
(self)¶ Switches the dialog to the parameters page.
-
tabWidget
(self) → QTabWidget¶ Returns the dialog’s tab widget.
- Return type
QTabWidget
-
tabletEvent
(self, QTabletEvent)¶
-
timerEvent
(self, QTimerEvent)¶
-
updateMicroFocus
(self)¶
-
updateRunButtonVisibility
(self)¶ Sets visibility for mutually exclusive buttons Run and Change Parameters.
-
wasExecuted
(self) → bool¶ Returns
True
if an algorithm was executed in the dialog.See also
See also
- Return type
bool
-
wheelEvent
(self, QWheelEvent)¶