Class: QgsProcessingLayerOutputDestinationWidget

A widget which allows users to select the destination path for an output style Processing parameter.

Note

Not stable API

Added in version 3.14.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsProcessingLayerOutputDestinationWidget

Base classes

QWidget

QObject

QPaintDevice
class qgis.gui.QgsProcessingLayerOutputDestinationWidget[source]

Bases: QWidget

__init__(parameter: QgsProcessingDestinationParameter | None, defaultSelection: bool, parent: QWidget | None = None)

Constructor for QgsProcessingLayerOutputDestinationWidget, associated with the specified parameter.

Parameters:
addOpenAfterRunningOption(self)[source]

Adds the “Open output file after running” option to the widget.

signal destinationChanged[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

openAfterRunning(self) → bool[source]

Returns True if the widget has the “Open output file after running” option checked.

Return type:

bool

outputIsSkipped(self) → bool[source]

Returns True if the output is set to be skipped.

Return type:

bool

registerProcessingParametersGenerator(self, generator: QgsProcessingParametersGenerator | None)[source]

Registers a Processing parameters generator class that will be used to retrieve algorithm parameters for the widget when required.

Added in version 3.14.

Parameters:

generator (Optional[QgsProcessingParametersGenerator])

setContext(self, context: QgsProcessingContext | None)[source]

Sets the processing context in which this widget is being shown.

Parameters:

context (Optional[QgsProcessingContext])

setValue(self, value: Any)[source]

Sets the value to show in the widget.

Parameters:

value (Any)

setWidgetContext(self, context: QgsProcessingParameterWidgetContext)[source]

Sets the context in which the 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.

Parameters:

context (QgsProcessingParameterWidgetContext)

signal skipOutputChanged[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

value(self) → Any[source]

Returns the widgets current value.

Return type:

Any