Subgroup: other

Class: QgsProcessingAlgorithmDialogBase¶

class qgis.gui.QgsProcessingAlgorithmDialogBase¶

Bases: PyQt5.QtWidgets.QDialog

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`
`acceptDrops`
`accessibleDescription`
`accessibleName`
`actionEvent`
`actions`
`activateWindow`
`addAction`
`addActions`
`adjustSize`
`algorithm`	Returns the algorithm running in the dialog.
`autoFillBackground`
`backgroundRole`
`baseSize`
`blockSignals`
`buttonBox`	Returns the dialog’s button box.
`cancelButton`	Returns the dialog’s cancel button.
`changeEvent`
`childAt`	childAt(self, int, int) -> QWidget
`childEvent`
`children`
`childrenRect`
`childrenRegion`
`clearFocus`
`clearMask`
`clearProgress`	Clears any current progress from the dialog.
`close`
`closeEvent`
`colorCount`
`connectNotify`
`contentsMargins`
`contentsRect`
`contextMenuEvent`
`contextMenuPolicy`
`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.
`createWindowContainer`
`cursor`
`customEvent`
`deleteLater`
`depth`
`destroy`
`devType`
`devicePixelRatio`
`devicePixelRatioF`
`devicePixelRatioFScale`
`disconnect`
`disconnectNotify`
`done`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`dropEvent`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`effectiveWinId`
`ensurePolished`
`enterEvent`
`event`
`eventFilter`
`exec`
`exec_`
`find`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`finished`	Called when the algorithm has finished executing.
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPolicy`
`focusPreviousChild`
`focusProxy`
`focusWidget`
`font`
`fontInfo`
`fontMetrics`
`foregroundRole`
`frameGeometry`
`frameSize`
`geometry`
`getContentsMargins`
`getParameterValues`	Returns the parameter values for the algorithm to run in the dialog.
`grab`
`grabGesture`
`grabKeyboard`
`grabMouse`	grabMouse(self, Union[QCursor, Qt.CursorShape])
`grabShortcut`
`graphicsEffect`
`graphicsProxyWidget`
`hasFocus`
`hasHeightForWidth`
`hasMouseTracking`
`hasTabletTracking`
`height`
`heightForWidth`
`heightMM`
`hide`
`hideEvent`
`hideShortHelp`	Hides the short help panel.
`inherits`
`initPainter`
`inputMethodEvent`
`inputMethodHints`
`inputMethodQuery`
`insertAction`
`insertActions`
`installEventFilter`
`isActiveWindow`
`isAncestorOf`
`isEnabled`
`isEnabledTo`
`isFullScreen`
`isHidden`
`isLeftToRight`
`isMaximized`
`isMinimized`
`isModal`
`isRightToLeft`
`isSignalConnected`
`isSizeGripEnabled`
`isVisible`
`isVisibleTo`
`isWidgetType`
`isWindow`
`isWindowModified`
`isWindowType`
`keyPressEvent`
`keyReleaseEvent`
`keyboardGrabber`
`killTimer`
`layout`
`layoutDirection`
`leaveEvent`
`locale`
`logicalDpiX`
`logicalDpiY`
`lower`
`mainWidget`	Returns the main widget for the dialog, usually a panel for configuring algorithm parameters.
`mapFrom`
`mapFromGlobal`
`mapFromParent`
`mapTo`
`mapToGlobal`
`mapToParent`
`mask`
`maximumHeight`
`maximumSize`
`maximumWidth`
`messageBar`	Returns the dialog’s message bar.
`metaObject`
`metric`
`minimumHeight`
`minimumSize`
`minimumSizeHint`
`minimumWidth`
`mouseDoubleClickEvent`
`mouseGrabber`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`move`	move(self, int, int)
`moveEvent`
`moveToThread`
`nativeEvent`
`nativeParentWidget`
`nextInFocusChain`
`normalGeometry`
`objectName`
`open`
`overrideWindowFlags`
`overrideWindowState`
`paintEngine`
`paintEvent`
`paintingActive`
`palette`
`parent`
`parentWidget`
`physicalDpiX`
`physicalDpiY`
`pos`
`previousInFocusChain`
`property`
`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.
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`raise_`
`receivers`
`rect`
`reject`
`releaseKeyboard`
`releaseMouse`
`releaseShortcut`
`removeAction`
`removeEventFilter`
`render`	render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground\|QWidget.DrawChildren))
`repaint`	repaint(self, int, int, int, int)
`reportError`	Reports an `error` string to the dialog’s log.
`resetGui`	Resets the dialog’s gui, ready for another algorithm execution.
`resize`	resize(self, int, int)
`resizeEvent`
`restoreGeometry`
`result`
`results`	Returns the results returned by the algorithm executed.
`runButton`	Returns the dialog’s run button.
`saveGeometry`
`scroll`	scroll(self, int, int, QRect)
`sender`
`senderSignalIndex`
`setAcceptDrops`
`setAccessibleDescription`
`setAccessibleName`
`setAlgorithm`	Sets the `algorithm` to run in the dialog.
`setAttribute`
`setAutoFillBackground`
`setBackgroundRole`
`setBaseSize`	setBaseSize(self, QSize)
`setContentsMargins`	setContentsMargins(self, QMargins)
`setContextMenuPolicy`
`setCursor`
`setDisabled`
`setEnabled`
`setExecuted`	Sets whether the algorithm was executed through the dialog.
`setFixedHeight`
`setFixedSize`	setFixedSize(self, int, int)
`setFixedWidth`
`setFocus`	setFocus(self, Qt.FocusReason)
`setFocusPolicy`
`setFocusProxy`
`setFont`
`setForegroundRole`
`setGeometry`	setGeometry(self, int, int, int, int)
`setGraphicsEffect`
`setHidden`
`setInfo`	Displays an info `message` in the dialog’s log.
`setInputMethodHints`
`setLayout`
`setLayoutDirection`
`setLocale`
`setMainWidget`	Sets the main `widget` for the dialog, usually a panel for configuring algorithm parameters.
`setMask`	setMask(self, QRegion)
`setMaximumHeight`
`setMaximumSize`	setMaximumSize(self, QSize)
`setMaximumWidth`
`setMinimumHeight`
`setMinimumSize`	setMinimumSize(self, QSize)
`setMinimumWidth`
`setModal`
`setMouseTracking`
`setObjectName`
`setPalette`
`setParent`	setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])
`setPercentage`	Sets the percentage progress for the dialog, between 0 and 100.
`setProgressText`	Sets a progress text message.
`setProperty`
`setResult`
`setResults`	Sets the algorithm results.
`setShortcutAutoRepeat`
`setShortcutEnabled`
`setSizeGripEnabled`
`setSizeIncrement`	setSizeIncrement(self, QSize)
`setSizePolicy`	setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
`setStatusTip`
`setStyle`
`setStyleSheet`
`setTabOrder`
`setTabletTracking`
`setToolTip`
`setToolTipDuration`
`setUpdatesEnabled`
`setVisible`
`setWhatsThis`
`setWindowFilePath`
`setWindowFlag`
`setWindowFlags`
`setWindowIcon`
`setWindowIconText`
`setWindowModality`
`setWindowModified`
`setWindowOpacity`
`setWindowRole`
`setWindowState`
`setWindowTitle`
`sharedPainter`
`show`
`showEvent`
`showFullScreen`
`showLog`	Switches the dialog to the log page.
`showMaximized`
`showMinimized`
`showNormal`
`signalsBlocked`
`size`
`sizeHint`
`sizeIncrement`
`sizePolicy`
`stackUnder`
`startTimer`
`statusTip`
`style`
`styleSheet`
`tabWidget`	Returns the dialog’s tab widget.
`tabletEvent`
`testAttribute`
`thread`
`timerEvent`
`toolTip`
`toolTipDuration`
`tr`
`underMouse`
`ungrabGesture`
`unsetCursor`
`unsetLayoutDirection`
`unsetLocale`
`update`	update(self, QRect)
`updateGeometry`
`updateMicroFocus`
`updatesEnabled`
`visibleRegion`
`wasExecuted`	Returns true if an algorithm was executed in the dialog.
`whatsThis`
`wheelEvent`
`width`
`widthMM`
`winId`
`window`
`windowFilePath`
`windowFlags`
`windowHandle`
`windowIcon`
`windowIconText`
`windowModality`
`windowOpacity`
`windowRole`
`windowState`
`windowTitle`
`windowType`
`x`
`y`

Attributes

`Accepted`
`DrawChildren`
`DrawWindowBackground`
`IgnoreMask`
`PdmDepth`
`PdmDevicePixelRatio`
`PdmDevicePixelRatioScaled`
`PdmDpiX`
`PdmDpiY`
`PdmHeight`
`PdmHeightMM`
`PdmNumColors`
`PdmPhysicalDpiX`
`PdmPhysicalDpiY`
`PdmWidth`
`PdmWidthMM`
`Rejected`
`accepted`	accepted(self) [signal]
`customContextMenuRequested`	customContextMenuRequested(self, QPoint) [signal]
`destroyed`	destroyed(self, QObject = None) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`rejected`	rejected(self) [signal]
`staticMetaObject`
`windowIconChanged`	windowIconChanged(self, QIcon) [signal]
`windowIconTextChanged`	windowIconTextChanged(self, str) [signal]
`windowTitleChanged`	windowTitleChanged(self, str) [signal]

accept(self)¶

actionEvent()¶

algorithm(self) → QgsProcessingAlgorithm¶: Returns the algorithm running in the dialog.

See also

setAlgorithm()

buttonBox(self) → QDialogButtonBox¶: Returns the dialog’s button box.

cancelButton(self) → QPushButton¶: Returns the dialog’s cancel button.

changeEvent()¶

childEvent()¶

clearProgress(self)¶: Clears any current progress from the dialog.

closeEvent()¶

connectNotify()¶

contextMenuEvent()¶

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()¶

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

setMainWidget()

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)¶: Reports an error string to the dialog’s log.

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

wasExecuted()

See also

setResults()

runButton(self) → QPushButton¶: Returns the dialog’s run button.

sender()¶

senderSignalIndex()¶

setAlgorithm(self, algorithm: QgsProcessingAlgorithm)¶: Sets the algorithm to run in the dialog.

See also

algorithm()

setExecuted(self, executed: bool)¶: Sets whether the algorithm was executed through the dialog.

See also

wasExecuted()

See also

setResults()

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

mainWidget()

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

results()

See also

setExecuted()

sharedPainter()¶

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

results()

See also

setExecuted()

wheelEvent()¶