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
See also
See also
New in version 2.9.
QgsEffectStackPropertiesWidget(stack:
QgsEffectStack
, parent: QWidget = None)QgsEffectStackPropertiesWidget
constructor- Parameters
stack –
QgsEffectStack
to modify in the widgetparent –
parent widget
Methods
Adds a new effect to the stack.
Updates the effect stack when the currently selected effect changes properties.
Updates the widget when the selected effect changes type.
Overridden key press event to handle the esc event on the widget.
Refreshes the widget to reflect the current state of the stack.
Moves the currently selected effect within the stack by a specified offset
Moves the currently selected effect down in the stack.
Moves the currently selected effect up in the stack.
Removes the currently selected effect from the stack.
Sets the picture to use for effect previews for the dialog
Sets the effect properties widget
Returns effect stack attached to the widget
Updates the effect preview icon.
Enables or disables widgets depending on the selected effect within the stack.
- actionEvent(self, QActionEvent)¶
- addEffect(self)¶
Adds a new effect to the stack.
- changeEffect(self, newEffect: QgsPaintEffect)¶
Updates the effect stack when the currently selected effect changes properties.
- Parameters
newEffect (QgsPaintEffect) – new effect to replace existing effect at selected position within the stack.
- 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)¶
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- disconnectNotify(self, QMetaMethod)¶
- dragEnterEvent(self, QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- dropEvent(self, QDropEvent)¶
- effectChanged(self)¶
Updates the widget when the selected effect changes type.
- 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, event: QKeyEvent)¶
Overridden key press event to handle the esc event on the widget.
- Parameters
event – The key event
- keyReleaseEvent(self, QKeyEvent)¶
- leaveEvent(self, QEvent)¶
- loadStack(self)¶
Refreshes the widget to reflect the current state of the stack.
loadStack(self, stack:
QgsEffectStack
) Refreshes the widget to reflect the current state of a specified stack.- Parameters
stack –
QgsEffectStack
for widget
- metric(self, QPaintDevice.PaintDeviceMetric) int ¶
- mouseDoubleClickEvent(self, QMouseEvent)¶
- mouseMoveEvent(self, QMouseEvent)¶
- mousePressEvent(self, QMouseEvent)¶
- mouseReleaseEvent(self, QMouseEvent)¶
- 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, QMoveEvent)¶
- nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) Tuple[bool, int] ¶
- paintEvent(self, QPaintEvent)¶
- receivers(self, PYQT_SIGNAL) int ¶
- removeEffect(self)¶
Removes the currently selected effect from the stack.
- resizeEvent(self, QResizeEvent)¶
- sender(self) QObject ¶
- 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)¶
Sets the effect properties widget
- Parameters
widget (QWidget) –
- showEvent(self, QShowEvent)¶
- stack(self) QgsEffectStack ¶
Returns effect stack attached to the widget
- Return type
- Returns
QgsEffectStack
modified by the widget
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- 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, QWheelEvent)¶