Class: QgsEffectStackCompactWidget

A small widget consisting of a checkbox for enabling/disabling an effect stack and a button for opening an effect stack customization dialog.

See also

QgsEffectStack

QgsEffectStackCompactWidget

QgsEffectStackCompactWidget

Class Hierarchy

Inheritance diagram of qgis.gui.QgsEffectStackCompactWidget

Base classes

QgsPanelWidget

Base class for any widget that can be shown as an inline panel.

QWidget

QObject

QPaintDevice

Methods

paintEffect

Returns paint effect attached to the widget

setPaintEffect

Sets paint effect attached to the widget,

setPreviewPicture

Sets the picture to use for effect previews for the dialog

Signals

changed

Emitted when the paint effect properties change

class qgis.gui.QgsEffectStackCompactWidget[source]

Bases: QgsPanelWidget

__init__(parent: QWidget | None = None, effect: QgsPaintEffect | None = None)

QgsEffectStackCompactWidget constructor

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

  • effect (Optional[QgsPaintEffect] = None) – QgsPaintEffect for modification by the widget. If the effect is not a QgsEffectStack, it will be automatically converted to an effect stack consisting of the original effect

signal changed[source]

Emitted when the paint effect properties change

paintEffect(self) QgsPaintEffect | None[source]

Returns paint effect attached to the widget

Return type:

Optional[QgsPaintEffect]

Returns:

QgsPaintEffect modified by the widget

See also

setPaintEffect()

setPaintEffect(self, effect: QgsPaintEffect | None)[source]

Sets paint effect attached to the widget,

Parameters:

effect (Optional[QgsPaintEffect]) – QgsPaintEffect for modification by the widget. If the effect is not a QgsEffectStack, it will be automatically converted to an effect stack consisting of the original effect

See also

paintEffect()

setPreviewPicture(self, picture: QPicture)[source]

Sets the picture to use for effect previews for the dialog

Parameters:

picture (QPicture) – preview picture