Class: QgsProcessingAbstractParameterDefinitionWidget¶
- class qgis.gui.QgsProcessingAbstractParameterDefinitionWidget¶
Bases:
PyQt5.QtWidgets.QWidget
,QgsExpressionContextGenerator
Abstract base class for widgets which allow users to specify the properties of a Processing parameter.
New in version 3.10.
QgsProcessingAbstractParameterDefinitionWidget(context:
QgsProcessingContext
, widgetContext:QgsProcessingParameterWidgetContext
, definition:QgsProcessingParameterDefinition
= None, algorithm:QgsProcessingAlgorithm
= None, parent: QWidget = None) Creates a newQgsProcessingAbstractParameterDefinitionWidget
, with the specifiedparent
widget.The
context
argument must specify a Processing context, which will be used by the widget to evaluate existingdefinition
properties such as default values. Similarly, thewidgetContext
argument specifies the wider GUI context in which the widget will be used.The optional
definition
argument may be used to provide a parameter definition to use to initially populate the widget’s state.Additionally, the optional
algorithm
parameter may be used to specify the algorithm or model associated with the parameter.Methods
- rtype
QgsExpressionContext
Returns a new instance of a parameter definition, using the current settings defined in the dialog.
Registers a Processing context
generator
class that will be used to retrieve a Processing context for the widget when required.Sets the
context
in which the Processing definition 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.Returns the context in which the Processing definition 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.
- actionEvent(self, QActionEvent)¶
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- createExpressionContext(self) QgsExpressionContext ¶
- Return type
- createParameter(self, name: str, description: str, flags: Union[QgsProcessingParameterDefinition.Flags, QgsProcessingParameterDefinition.Flag]) QgsProcessingParameterDefinition ¶
Returns a new instance of a parameter definition, using the current settings defined in the dialog.
Common properties for parameters, including the
name
,description
, and parameterflags
are passed to the method. Subclass implementations must use these properties when crafting a parameter definition which also respects the additional properties specific to the parameter type handled by the widget subclass.- Parameters
name (str) –
description (str) –
flags (Union[QgsProcessingParameterDefinition.Flags) –
- 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.18.
- Parameters
generator (QgsProcessingContextGenerator) –
- resizeEvent(self, QResizeEvent)¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setWidgetContext(self, context: QgsProcessingParameterWidgetContext)¶
Sets the
context
in which the Processing definition 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.18.
- 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 definition 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.18.
- Return type