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

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]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

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