Class: QgsProcessingModelConfigWidgetFactory

Factory class for creating panel widgets that can be shown in the Processing model designer dialog.

Warning

Not stable API

Added in version 4.0.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: createWidget(), supportsComponent()

List of all members, including inherited members

Class Hierarchy

Base classes

QObject

Abstract Methods

createWidget	Factory function to create the widget on demand as needed by the dock.
supportsComponent	Check if a model component is supported for this widget.

class qgis.gui.QgsProcessingModelConfigWidgetFactory

Bases: QObject

abstract createWidget(self, component: QgsProcessingModelComponent | None, context: QgsProcessingContext, widgetContext: QgsProcessingParameterWidgetContext) → QgsProcessingModelConfigWidget | None

Factory function to create the widget on demand as needed by the dock.

Parameters:

• component (Optional[QgsProcessingModelComponent]) – model component to create widget for

• context (QgsProcessingContext) – processing context

• widgetContext (QgsProcessingParameterWidgetContext) – processing widget context

Return type:

Optional[QgsProcessingModelConfigWidget]

abstract supportsComponent(self, component: QgsProcessingModelComponent | None) → bool

Check if a model component is supported for this widget.

Parameters:

component (Optional[QgsProcessingModelComponent])

Return type:

bool