Class: QgsProcessingAlgorithmConfigurationWidget¶
-
class
qgis.gui.
QgsProcessingAlgorithmConfigurationWidget
(parent: QWidget = None)¶ Bases:
PyQt5.QtWidgets.QWidget
,QgsExpressionContextGenerator
Creates a new QgsProcessingAlgorithmConfigurationWidget
A configuration widget for processing algorithms allows providing additional configuration options directly on algorithm level, in addition to parameters.
New in version 3.2.
- Parameters
parent –
-
actionEvent
(self, QActionEvent)¶
-
algorithm
(self) → QgsProcessingAlgorithm¶ Returns the algorithm instance associated with this widget.
See also
New in version 3.6.
- Return type
-
changeEvent
(self, QEvent)¶
-
childEvent
(self, QChildEvent)¶
-
closeEvent
(self, QCloseEvent)¶
-
configuration
(self) → Dict[str, Any]¶ Read the current configuration from this widget.
- Return type
Dict[str, Any]
-
connectNotify
(self, QMetaMethod)¶
-
contextMenuEvent
(self, QContextMenuEvent)¶
-
create
(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
-
createExpressionContext
(self) → QgsExpressionContext¶ - Return type
-
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)¶
-
inputMethodEvent
(self, QInputMethodEvent)¶
-
isSignalConnected
(self, QMetaMethod) → bool¶
-
keyPressEvent
(self, QKeyEvent)¶
-
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], sip.voidptr) → Tuple[bool, int]¶
-
paintEvent
(self, QPaintEvent)¶
-
receivers
(self, PYQT_SIGNAL) → int¶
-
registerProcessingContextGenerator
(self, generator: QgsProcessingContextGenerator)¶ Registers a Processing context
generator
class that will be used to retrieve a Processing context for the widget when required.New in version 3.6.
- Parameters
generator (QgsProcessingContextGenerator) –
-
resizeEvent
(self, QResizeEvent)¶
-
sender
(self) → QObject¶
-
senderSignalIndex
(self) → int¶
-
setAlgorithm
(self, algorithm: QgsProcessingAlgorithm)¶ Sets the algorithm instance associated with the widget.
See also
New in version 3.6.
- Parameters
algorithm (QgsProcessingAlgorithm) –
-
setConfiguration
(self, configuration: Dict[str, Any])¶ Set the configuration which this widget should represent.
- Parameters
configuration (Dict[str) –
-
setWidgetContext
(self, context: QgsProcessingParameterWidgetContext)¶ Sets the
context
in which the Processing algorithm widget is shown, e.g., the parent model algorithm, a linked map canvas, and other relevant information which allows the widget to fine-tune its behavior.Subclasses should take care to call the base class method when reimplementing this method.
See also
New in version 3.6.
- Parameters
context (QgsProcessingParameterWidgetContext) –
-
showEvent
(self, QShowEvent)¶
-
tabletEvent
(self, QTabletEvent)¶
-
timerEvent
(self, QTimerEvent)¶
-
updateMicroFocus
(self)¶
-
wheelEvent
(self, QWheelEvent)¶
-
widgetContext
(self) → QgsProcessingParameterWidgetContext¶ Returns the context in which the Processing algorithm widget is shown, e.g., the parent model algorithm, a linked map canvas, and other relevant information which allows the widget to fine-tune its behavior.
See also
New in version 3.6.
- Return type