Class: QgsProcessingParametersWidget

class qgis.gui.QgsProcessingParametersWidget

Bases: QgsPanelWidget, QgsProcessingParametersGenerator

A widget which allows users to select the value for the parameters for an algorithm.

Note

Not stable API

New in version 3.14.

QgsProcessingParametersWidget(algorithm: QgsProcessingAlgorithm, parent: QWidget = None) Constructor for QgsProcessingParametersWidget, for the specified algorithm.

Methods

actionEvent

addExtraWidget

param widget:

addOutputLabel

param label:

addOutputWidget

param widget:

addParameterLabel

param parameter:

addParameterWidget

param parameter:

algorithm

rtype:

QgsProcessingAlgorithm

changeEvent

childEvent

closeEvent

connectNotify

contextMenuEvent

create

customEvent

destroy

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

enterEvent

event

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

initPainter

initWidgets

inputMethodEvent

isSignalConnected

keyPressEvent

Overridden key press event to handle the esc event on the widget.

keyReleaseEvent

leaveEvent

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

paintEvent

receivers

resizeEvent

sender

senderSignalIndex

sharedPainter

showEvent

tabletEvent

timerEvent

updateMicroFocus

wheelEvent

actionEvent(self, QActionEvent)
addExtraWidget(self, widget: QWidget)
Parameters:

widget (QWidget) –

addOutputLabel(self, label: QWidget)
Parameters:

label (QWidget) –

addOutputWidget(self, widget: QWidget, stretch: int = 0)
Parameters:
  • widget (QWidget) –

  • stretch (int = 0) –

addParameterLabel(self, parameter: QgsProcessingParameterDefinition, label: QWidget)
Parameters:
addParameterWidget(self, parameter: QgsProcessingParameterDefinition, widget: QWidget, stretch: int = 0)
Parameters:
algorithm(self) QgsProcessingAlgorithm
Return type:

QgsProcessingAlgorithm

changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
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
focusInEvent(self, QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, bool) bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self) bool
hideEvent(self, QHideEvent)
initPainter(self, QPainter)
initWidgets(self)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod) bool
keyPressEvent(self, event: QKeyEvent)

Overridden key press event to handle the esc event on the widget.

Parameters:

event – The key event

keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
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], PyQt5.sip.voidptr) Tuple[bool, int]
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL) int
resizeEvent(self, QResizeEvent)
sender(self) QObject
senderSignalIndex(self) int
sharedPainter(self) QPainter
showEvent(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateMicroFocus(self)
wheelEvent(self, QWheelEvent)