Class: QgsPreviewEffect

class qgis.gui.QgsPreviewEffect

Bases: PyQt5.QtWidgets.QGraphicsEffect

A graphics effect which can be applied to a widget to simulate various printing and color blindness modes.

PreviewDeuteranope = 3
PreviewGrayscale = 0
class PreviewMode

Bases: int

PreviewMono = 1
PreviewProtanope = 2
PreviewTritanope = 4
childEvent(self, a0: QChildEvent | None)
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
mode(self) → QgsPreviewEffect.PreviewMode

Returns the mode used for the preview effect.

Return type:

QgsPreviewEffect.PreviewMode

Returns:

PreviewMode currently used by the effect

See also

setMode()

receivers(self, signal: PYQT_SIGNAL) → int
sender(self) → QObject | None
senderSignalIndex(self) → int
setMode(self, mode: QgsPreviewEffect.PreviewMode)

Sets the mode for the preview effect, which controls how the effect modifies a widgets appearance.

Parameters:

mode (QgsPreviewEffect.PreviewMode) – PreviewMode to use to draw the widget

See also

mode()

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)