Class: QgsProcessingLayerOutputDestinationWidget

class qgis.gui.QgsProcessingLayerOutputDestinationWidget

Bases: PyQt5.QtWidgets.QWidget

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

Note

Not stable API

New in version 3.14.

QgsProcessingLayerOutputDestinationWidget(parameter: QgsProcessingDestinationParameter, defaultSelection: bool, parent: QWidget = None) Constructor for QgsProcessingLayerOutputDestinationWidget, associated with the specified parameter.

Methods

actionEvent
addOpenAfterRunningOption	Adds the “Open output file after running” option to the widget.
changeEvent
childEvent
closeEvent
connectNotify
contextMenuEvent
create
customEvent
destroy
disconnectNotify
dragEnterEvent	param event
dragLeaveEvent	param event
dragMoveEvent
dropEvent	param event
enterEvent
event
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideEvent
initPainter
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
openAfterRunning	Returns True if the widget has the “Open output file after running” option checked.
outputIsSkipped	Returns True if the output is set to be skipped.
paintEvent
receivers
registerProcessingParametersGenerator	Registers a Processing parameters generator class that will be used to retrieve algorithm parameters for the widget when required.
resizeEvent
sender
senderSignalIndex
setContext	Sets the processing context in which this widget is being shown.
setValue	Sets the value to show in the widget.
setWidgetContext	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.
sharedPainter
showEvent
tabletEvent
timerEvent
updateMicroFocus
value	Returns the widgets current value.
wheelEvent

Signals

destinationChanged	Emitted whenever the destination value is changed in the widget.
skipOutputChanged	Emitted whenever the “skip output” option is toggled in the widget.

actionEvent(self, QActionEvent)

addOpenAfterRunningOption(self)

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

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)

customEvent(self, QEvent)

destinationChanged

Emitted whenever the destination value is changed in the widget. [signal]

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)

disconnectNotify(self, QMetaMethod)

dragEnterEvent(self, event: QDragEnterEvent)

Parameters

event (QDragEnterEvent) –

dragLeaveEvent(self, event: QDragLeaveEvent)

Parameters

event (QDragLeaveEvent) –

dragMoveEvent(self, QDragMoveEvent)

dropEvent(self, event: QDropEvent)

Parameters

event (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]

openAfterRunning(self) → bool

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

Return type

bool

outputIsSkipped(self) → bool

Returns True if the output is set to be skipped.

Return type

bool

paintEvent(self, QPaintEvent)

receivers(self, PYQT_SIGNAL) → int

registerProcessingParametersGenerator(self, generator: QgsProcessingParametersGenerator)

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

New in version 3.14.

Parameters

generator (QgsProcessingParametersGenerator) –

resizeEvent(self, QResizeEvent)

sender(self) → QObject

senderSignalIndex(self) → int

setContext(self, context: QgsProcessingContext)

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

Parameters

context (QgsProcessingContext) –

setValue(self, value: Any)

Sets the value to show in the widget.

Parameters

value (Any) –

setWidgetContext(self, context: QgsProcessingParameterWidgetContext)

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) –

sharedPainter(self) → QPainter

showEvent(self, QShowEvent)

skipOutputChanged

Emitted whenever the “skip output” option is toggled in the widget. [signal]

Parameters

skipped (bool) –

tabletEvent(self, QTabletEvent)

timerEvent(self, QTimerEvent)

updateMicroFocus(self)

value(self) → Any

Returns the widgets current value.

Return type

Any

wheelEvent(self, QWheelEvent)