Class: QgsEffectStackPropertiesWidget

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

See also

QgsEffectStack

QgsEffectStackPropertiesWidget

QgsEffectStackPropertiesWidget

Class Hierarchy

Inheritance diagram of qgis.gui.QgsEffectStackPropertiesWidget

Base classes

QgsPanelWidget

Base class for any widget that can be shown as an 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[source]

Bases: QgsPanelWidget

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

QgsEffectStackPropertiesWidget constructor

Parameters:
addEffect(self)[source]

Adds a new effect to the stack.

changeEffect(self, newEffect: QgsPaintEffect | None)[source]

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

Updates the widget when the selected effect changes type.

loadStack(self)[source]

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

loadStack(self, stack: QgsEffectStack | None)[source]

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

Parameters:

stack (Optional[QgsEffectStack]) – QgsEffectStack for widget

moveEffectByOffset(self, offset: int)[source]

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

Parameters:

offset (int)

moveEffectDown(self)[source]

Moves the currently selected effect down in the stack.

moveEffectUp(self)[source]

Moves the currently selected effect up in the stack.

removeEffect(self)[source]

Removes the currently selected effect from the stack.

setPreviewPicture(self, picture: QPicture)[source]

Sets the picture to use for effect previews for the dialog

Parameters:

picture (QPicture) – preview picture

setWidget(self, widget: QWidget | None)[source]

Sets the effect properties widget

Parameters:

widget (Optional[QWidget])

stack(self) QgsEffectStack | None[source]

Returns effect stack attached to the widget

Return type:

Optional[QgsEffectStack]

Returns:

QgsEffectStack modified by the widget

updatePreview(self)[source]

Updates the effect preview icon.

updateUi(self)[source]

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