Class: QgsLayoutEffect

class qgis.core.QgsLayoutEffect

Bases: PyQt5.QtWidgets.QGraphicsEffect

A QGraphicsEffect subclass used for rendering layout items onto a scene with custom composition modes.

Deprecated since version QGIS: 3.34 – this class should not be used, it is non-stable and results in crashes. See https://bugreports.qt.io/browse/QTBUG-58501.

QgsLayoutEffect() Constructor for QgsLayoutEffect.

Deprecated since version QGIS: 3.34 – this class should not be used, it is non-stable and results in crashes. See https://bugreports.qt.io/browse/QTBUG-58501.

Methods

childEvent
compositionMode	Returns the composition (blending) mode used for rendering the item.
connectNotify
customEvent
disconnectNotify
draw	param painter:
drawSource
isSignalConnected
receivers
sender
senderSignalIndex
setCompositionMode	Sets the composition (blending) mode used for rendering the item.
sourceBoundingRect
sourceChanged
sourceIsPixmap
sourcePixmap
timerEvent
updateBoundingRect

childEvent(self, a0: QChildEvent | None)

compositionMode(self) → QPainter.CompositionMode

Returns the composition (blending) mode used for rendering the item.

See also

setCompositionMode()

Deprecated since version QGIS: 3.34 – this class should not be used, it is non-stable and results in crashes. See https://bugreports.qt.io/browse/QTBUG-58501.

Return type:

QPainter.CompositionMode

connectNotify(self, signal: QMetaMethod)

customEvent(self, a0: QEvent | None)

disconnectNotify(self, signal: QMetaMethod)

draw(self, painter: QPainter | None)

Parameters:

painter (Optional[QPainter])

drawSource(self, painter: QPainter | None)

isSignalConnected(self, signal: QMetaMethod) → bool

receivers(self, signal: PYQT_SIGNAL) → int

sender(self) → QObject | None

senderSignalIndex(self) → int

setCompositionMode(self, mode: QPainter.CompositionMode)

Sets the composition (blending) mode used for rendering the item.

See also

compositionMode()

Deprecated since version QGIS: 3.34 – this class should not be used, it is non-stable and results in crashes. See https://bugreports.qt.io/browse/QTBUG-58501.

Parameters:

mode (QPainter.CompositionMode)

sourceBoundingRect(self, system: Qt.CoordinateSystem = Qt.LogicalCoordinates) → QRectF

sourceChanged(self, flags: QGraphicsEffect.ChangeFlags | QGraphicsEffect.ChangeFlag)

sourceIsPixmap(self) → bool

sourcePixmap(self, system: Qt.CoordinateSystem = Qt.LogicalCoordinates, mode: QGraphicsEffect.PixmapPadMode = QGraphicsEffect.PadToEffectiveBoundingRect)

timerEvent(self, a0: QTimerEvent | None)

updateBoundingRect(self)