Class: QgsEffectStackPropertiesWidget¶

class qgis.gui.QgsEffectStackPropertiesWidget¶

Bases: QgsPanelWidget

A widget for modifying the properties of a QgsEffectStack, including adding and reordering effects within the stack.

See also

QgsEffectStackCompactWidget

Added in version 2.9.

QgsEffectStackPropertiesWidget(stack: Optional[QgsEffectStack], parent: Optional[QWidget] = None) QgsEffectStackPropertiesWidget constructor

Parameters:

stack – QgsEffectStack to modify in the widget

parent –

parent widget

Methods

`actionEvent`
`addEffect`	Adds a new effect to the stack.
`changeEffect`	Updates the effect stack when the currently selected effect changes properties.
`changeEvent`
`childEvent`
`closeEvent`
`connectNotify`
`contextMenuEvent`
`create`
`customEvent`
`destroy`
`disconnectNotify`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`dropEvent`
`effectChanged`	Updates the widget when the selected effect changes type.
`enterEvent`
`event`
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPreviousChild`
`hideEvent`
`initPainter`
`inputMethodEvent`
`isSignalConnected`
`keyPressEvent`	Overridden key press event to handle the esc event on the widget.
`keyReleaseEvent`
`leaveEvent`
`loadStack`	Refreshes the widget to reflect the current state of the stack.
`metric`
`mouseDoubleClickEvent`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`moveEffectByOffset`	Moves the currently selected effect within the stack by a specified offset
`moveEffectDown`	Moves the currently selected effect down in the stack.
`moveEffectUp`	Moves the currently selected effect up in the stack.
`moveEvent`
`nativeEvent`
`paintEvent`
`receivers`
`removeEffect`	Removes the currently selected effect from the stack.
`resizeEvent`
`sender`
`senderSignalIndex`
`setPreviewPicture`	Sets the picture to use for effect previews for the dialog
`setWidget`	Sets the effect properties widget
`sharedPainter`
`showEvent`
`stack`	Returns effect stack attached to the widget
`tabletEvent`
`timerEvent`
`updateMicroFocus`
`updatePreview`	Updates the effect preview icon.
`updateUi`	Enables or disables widgets depending on the selected effect within the stack.
`wheelEvent`

actionEvent(self, a0: QActionEvent | None)¶

addEffect(self)¶: Adds a new effect to the stack.

changeEffect(self, newEffect: QgsPaintEffect | None)¶

Updates the effect stack when the currently selected effect changes properties.

Parameters:: newEffect (Optional[QgsPaintEffect]) – new effect to replace existing effect at selected position within the stack.

changeEvent(self, a0: QEvent | None)¶

childEvent(self, a0: QChildEvent | None)¶

closeEvent(self, a0: QCloseEvent | None)¶

connectNotify(self, signal: QMetaMethod)¶

contextMenuEvent(self, a0: QContextMenuEvent | None)¶

create(self, window: PyQt5.sip.voidptr = None, initializeWindow: bool = True, destroyOldWindow: bool = True)¶

customEvent(self, a0: QEvent | None)¶

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

disconnectNotify(self, signal: QMetaMethod)¶

dragEnterEvent(self, a0: QDragEnterEvent | None)¶

dragLeaveEvent(self, a0: QDragLeaveEvent | None)¶

dragMoveEvent(self, a0: QDragMoveEvent | None)¶

dropEvent(self, a0: QDropEvent | None)¶

effectChanged(self)¶: Updates the widget when the selected effect changes type.

enterEvent(self, a0: QEvent | None)¶

event(self, a0: QEvent | None) → bool¶

focusInEvent(self, a0: QFocusEvent | None)¶

focusNextChild(self) → bool¶

focusNextPrevChild(self, next: bool) → bool¶

focusOutEvent(self, a0: QFocusEvent | None)¶

focusPreviousChild(self) → bool¶

hideEvent(self, a0: QHideEvent | None)¶

initPainter(self, painter: QPainter | None)¶

inputMethodEvent(self, a0: QInputMethodEvent | None)¶

isSignalConnected(self, signal: QMetaMethod) → bool¶

keyPressEvent(self, event: QKeyEvent | None)¶

Overridden key press event to handle the esc event on the widget.

Parameters:: event – The key event

keyReleaseEvent(self, a0: QKeyEvent | None)¶

leaveEvent(self, a0: QEvent | None)¶

loadStack(self)¶

Refreshes the widget to reflect the current state of the stack.

loadStack(self, stack: Optional[QgsEffectStack]) Refreshes the widget to reflect the current state of a specified stack.

Parameters:: stack – QgsEffectStack for widget

metric(self, a0: QPaintDevice.PaintDeviceMetric) → int¶

mouseDoubleClickEvent(self, a0: QMouseEvent | None)¶

mouseMoveEvent(self, a0: QMouseEvent | None)¶

mousePressEvent(self, a0: QMouseEvent | None)¶

mouseReleaseEvent(self, a0: QMouseEvent | None)¶

moveEffectByOffset(self, offset: int)¶

Moves the currently selected effect within the stack by a specified offset

Parameters:: offset (int)

moveEffectDown(self)¶: Moves the currently selected effect down in the stack.

moveEffectUp(self)¶: Moves the currently selected effect up in the stack.

moveEvent(self, a0: QMoveEvent | None)¶

nativeEvent(self, eventType: QByteArray | bytes | bytearray, message: PyQt5.sip.voidptr | None)¶

paintEvent(self, a0: QPaintEvent | None)¶

receivers(self, signal: PYQT_SIGNAL) → int¶

removeEffect(self)¶: Removes the currently selected effect from the stack.

resizeEvent(self, a0: QResizeEvent | None)¶

sender(self) → QObject | None¶

senderSignalIndex(self) → int¶

setPreviewPicture(self, picture: QPicture)¶

Sets the picture to use for effect previews for the dialog

Parameters:: picture (QPicture) – preview picture

setWidget(self, widget: QWidget | None)¶

Sets the effect properties widget

Parameters:: widget (Optional[QWidget])

sharedPainter(self) → QPainter | None¶

showEvent(self, a0: QShowEvent | None)¶

stack(self) → QgsEffectStack | None¶

Returns effect stack attached to the widget

Return type:: Optional[QgsEffectStack]
Returns:: QgsEffectStack modified by the widget

tabletEvent(self, a0: QTabletEvent | None)¶

timerEvent(self, a0: QTimerEvent | None)¶

updateMicroFocus(self)¶

updatePreview(self)¶: Updates the effect preview icon.

updateUi(self)¶: Enables or disables widgets depending on the selected effect within the stack.

wheelEvent(self, a0: QWheelEvent | None)¶