Subgroup: Processing
Class: QgsProcessingAlgorithmDialogBase¶
-
class
qgis.gui.
QgsProcessingAlgorithmDialogBase
(parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = 0)¶ Bases:
PyQt5.QtWidgets.QDialog
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: Methods
accept
actionEvent
algorithm
Returns the algorithm running in the dialog. buttonBox
Returns the dialog’s button box. cancelButton
Returns the dialog’s cancel button. changeEvent
childEvent
clearLog
Clears the current log contents. clearProgress
Clears any current progress from the dialog. closeEvent
connectNotify
contextMenuEvent
copyLogToClipboard
Copies the current log contents to the clipboard. create
createFeedback
Creates a new processing feedback object, automatically connected to the appropriate slots in this dialog. createProgressDialog
Creates a modal progress dialog showing progress and log messages from this dialog. customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
enterEvent
event
eventFilter
finished
Called when the algorithm has finished executing. focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
formatStringForLog
Formats an input string
for display in the log tab.getParameterValues
Returns the parameter values for the algorithm to run in the dialog. hideEvent
hideShortHelp
Hides the short help panel. initPainter
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
mainWidget
Returns the main widget for the dialog, usually a panel for configuring algorithm parameters. messageBar
Returns the dialog’s message bar. metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
paintEvent
pushCommandInfo
Pushes command info to the dialog’s log. pushConsoleInfo
Pushes a console info string to the dialog’s log. pushDebugInfo
Pushes a debug info string to the dialog’s log. pushInfo
Pushes an information string to the dialog’s log. receivers
reportError
Reports an error
string to the dialog’s log.resetGui
Resets the dialog’s gui, ready for another algorithm execution. resizeEvent
results
Returns the results returned by the algorithm executed. runButton
Returns the dialog’s run button. saveLog
Opens a dialog allowing users to save the current log contents. saveLogToFile
Saves the log contents to a text file (specified by the file path
), in the givenformat
.sender
senderSignalIndex
setAlgorithm
Sets the algorithm
to run in the dialog.setCurrentTask
Sets the current task
running in the dialog.setExecuted
Sets whether the algorithm was executed through the dialog. setInfo
Displays an info message
in the dialog’s log.setMainWidget
Sets the main widget
for the dialog, usually a panel for configuring algorithm parameters.setPercentage
Sets the percentage progress for the dialog, between 0 and 100. setProgressText
Sets a progress text message. setResults
Sets the algorithm results. sharedPainter
showEvent
showLog
Switches the dialog to the log page. tabWidget
Returns the dialog’s tab widget. tabletEvent
timerEvent
updateMicroFocus
wasExecuted
Returns true if an algorithm was executed in the dialog. wheelEvent
Signals
Attributes
FormatHtml
FormatPlainText
-
FormatHtml
= 1¶
-
FormatPlainText
= 0¶
-
class
LogFormat
¶ Bases:
int
-
accept
(self)¶
-
actionEvent
()¶
-
algorithm
(self) → QgsProcessingAlgorithm¶ Returns the algorithm running in the dialog.
See also
Returns the dialog’s button box.
-
cancelButton
(self) → QPushButton¶ Returns the dialog’s cancel button.
-
changeEvent
()¶
-
childEvent
()¶
-
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)¶
-
connectNotify
()¶
-
contextMenuEvent
()¶
-
copyLogToClipboard
(self)¶ Copies the current log contents to the clipboard.
New in version 3.2.
-
create
()¶
-
createFeedback
(self) → QgsProcessingFeedback¶ Creates a new processing feedback object, automatically connected to the appropriate slots in this dialog.
-
createProgressDialog
(self) → QDialog¶ Creates a modal progress dialog showing progress and log messages from this dialog.
-
customEvent
()¶
-
destroy
()¶
-
disconnectNotify
()¶
-
dragEnterEvent
()¶
-
dragLeaveEvent
()¶
-
dragMoveEvent
()¶
-
dropEvent
()¶
-
enterEvent
()¶
-
event
()¶
-
eventFilter
()¶
-
finished
(self, successful: bool, result: Dict[str, Any], context: QgsProcessingContext, feedback: QgsProcessingFeedback)¶ Called when the algorithm has finished executing.
-
focusInEvent
()¶
-
focusNextChild
()¶
-
focusNextPrevChild
()¶
-
focusOutEvent
()¶
-
focusPreviousChild
()¶
-
formatStringForLog
(string: str) → str¶ Formats an input
string
for display in the log tab.New in version 3.0.1.
-
getParameterValues
(self) → Dict[str, Any]¶ Returns the parameter values for the algorithm to run in the dialog.
-
hideEvent
()¶
-
hideShortHelp
(self)¶ Hides the short help panel.
-
initPainter
()¶
-
inputMethodEvent
()¶
-
isSignalConnected
()¶
-
keyPressEvent
()¶
-
keyReleaseEvent
()¶
-
leaveEvent
()¶
-
mainWidget
(self) → QWidget¶ Returns the main widget for the dialog, usually a panel for configuring algorithm parameters.
See also
-
messageBar
(self) → QgsMessageBar¶ Returns the dialog’s message bar.
-
metric
()¶
-
mouseDoubleClickEvent
()¶
-
mouseMoveEvent
()¶
-
mousePressEvent
()¶
-
mouseReleaseEvent
()¶
-
moveEvent
()¶
-
nativeEvent
()¶
-
paintEvent
()¶
-
pushCommandInfo
(self, info: str)¶ Pushes command info to the dialog’s log.
-
pushConsoleInfo
(self, info: str)¶ Pushes a console info string to the dialog’s log.
-
pushDebugInfo
(self, message: str)¶ Pushes a debug info string to the dialog’s log.
-
pushInfo
(self, info: str)¶ Pushes an information string to the dialog’s log.
-
receivers
()¶
-
reportError
(self, error: str, fatalError: bool)¶ Reports an
error
string to the dialog’s log.If
fatalError
is true, the error prevented the algorithm from executing.
-
resetGui
(self)¶ Resets the dialog’s gui, ready for another algorithm execution.
-
resizeEvent
()¶
-
results
(self) → Dict[str, Any]¶ Returns the results returned by the algorithm executed.
See also
See also
-
runButton
(self) → QPushButton¶ Returns the dialog’s run button.
-
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.
-
sender
()¶
-
senderSignalIndex
()¶
-
setAlgorithm
(self, algorithm: QgsProcessingAlgorithm)¶ Sets the
algorithm
to run in the dialog.See also
-
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.
-
setExecuted
(self, executed: bool)¶ Sets whether the algorithm was executed through the dialog.
See also
See also
-
setInfo
(self, message: str, isError: bool = False, escapeHtml: bool = True)¶ Displays an info
message
in the dialog’s log.
-
setMainWidget
(self, widget: QWidget)¶ Sets the main
widget
for the dialog, usually a panel for configuring algorithm parameters.See also
-
setPercentage
(self, percent: float)¶ Sets the percentage progress for the dialog, between 0 and 100.
-
setProgressText
(self, text: str)¶ Sets a progress text message.
-
setResults
(self, results: Dict[str, Any])¶ Sets the algorithm results.
See also
See also
-
showEvent
()¶
-
showLog
(self)¶ Switches the dialog to the log page.
-
tabWidget
(self) → QTabWidget¶ Returns the dialog’s tab widget.
-
tabletEvent
()¶
-
timerEvent
()¶
-
updateMicroFocus
()¶
-
wasExecuted
(self) → bool¶ Returns true if an algorithm was executed in the dialog.
See also
See also
-
wheelEvent
()¶
-