Class: QgsEffectStackPropertiesWidget

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

See also

QgsEffectStack

See also

QgsEffectStackPropertiesDialog

See also

QgsEffectStackCompactWidget

QgsEffectStackPropertiesWidget

Class Hierarchy

Base classes

QgsPanelWidget	Base class for any widget that can be shown as a inline panel
QWidget
QObject
QPaintDevice

Methods

addEffect	Adds a new effect to the stack.
changeEffect	Updates the effect stack when the currently selected effect changes properties.
effectChanged	Updates the widget when the selected effect changes type.
loadStack	Refreshes the widget to reflect the current state of the stack.
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.
removeEffect	Removes the currently selected effect from the stack.
setPreviewPicture	Sets the picture to use for effect previews for the dialog
setWidget	Sets the effect properties widget
stack	Returns effect stack attached to the widget
updatePreview	Updates the effect preview icon.
updateUi	Enables or disables widgets depending on the selected effect within the stack.

class qgis.gui.QgsEffectStackPropertiesWidget

Bases: QgsPanelWidget

__init__(stack: QgsEffectStack | None, parent: QWidget | None = None)

QgsEffectStackPropertiesWidget constructor

Parameters:

• stack (Optional[QgsEffectStack]) – QgsEffectStack to modify in the widget

• parent (Optional[QWidget] = None) – parent widget

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.

effectChanged(self)

Updates the widget when the selected effect changes type.

loadStack(self)

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

loadStack(self, stack: QgsEffectStack | None)

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

Parameters:

stack (Optional[QgsEffectStack]) – QgsEffectStack for widget

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.

removeEffect(self)

Removes the currently selected effect from the stack.

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

stack(self) → QgsEffectStack | None

Returns effect stack attached to the widget

Return type:

Optional[QgsEffectStack]

Returns:

QgsEffectStack modified by the widget

updatePreview(self)

Updates the effect preview icon.

updateUi(self)

Enables or disables widgets depending on the selected effect within the stack.