Skip to content

PythonQt.QtGui.QPaintEngineState

QPaintEngineState

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

Detailed Description

QPaintEngineState records which properties that have changed since the last time the paint engine was updated, as well as their current value.

Which properties that have changed can at any time be retrieved using the state() function. This function returns an instance of the QPaintEngine::DirtyFlags type which stores an OR combination of QPaintEngine::DirtyFlag values. The QPaintEngine::DirtyFlag enum defines whether a property has changed since the last update or not.

If a property is marked with a dirty flag, its current value can be retrieved using the corresponding get function:

Property Flag Current Property Value
QPaintEngine::DirtyBackground backgroundBrush()
QPaintEngine::DirtyBackgroundMode backgroundMode()
QPaintEngine::DirtyBrush brush()
QPaintEngine::DirtyBrushOrigin brushOrigin()
QPaintEngine::DirtyClipRegion or QPaintEngine::DirtyClipPath clipOperation()
QPaintEngine::DirtyClipPath clipPath()
QPaintEngine::DirtyClipRegion clipRegion()
QPaintEngine::DirtyCompositionMode compositionMode()
QPaintEngine::DirtyFont font()
QPaintEngine::DirtyTransform transform()
QPaintEngine::DirtyClipEnabled isClipEnabled()
QPaintEngine::DirtyPen pen()
QPaintEngine::DirtyHints renderHints()

The QPaintEngineState class also provide the painter() function which returns a pointer to the painter that is currently updating the paint engine.

An instance of this class, representing the current state of the active paint engine, is passed as argument to the QPaintEngine::updateState() function. The only situation in which you will have to use this class directly is when implementing your own paint engine.

Source: https://doc.qt.io/archives/qt-5.15/qpaintenginestate.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
backgroundBrush function (self) -> Any X.backgroundBrush() -> PythonQt.QtGui.QBrush
backgroundMode function (self) -> Any Returns the background mode in the current paint engine state.
brush function (self) -> Any X.brush() -> PythonQt.QtGui.QBrush
brushNeedsResolving function (self) -> bool X.brushNeedsResolving() -> bool
brushOrigin function (self) -> Any X.brushOrigin() -> PythonQt.QtCore.QPointF
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
clipOperation function (self) -> Any Returns the clip operation in the current paint engine state.
clipPath function (self) -> Any X.clipPath() -> PythonQt.QtGui.QPainterPath
clipRegion function (self) -> Any X.clipRegion() -> PythonQt.QtGui.QRegion
compositionMode function (self) -> Any Returns the composition mode in the current paint engine state.
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
font function (self) -> Any X.font() -> PythonQt.QtGui.QFont
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
isClipEnabled function (self) -> bool X.isClipEnabled() -> bool
matrix function (self) -> Any X.matrix() -> PythonQt.QtGui.QMatrix
opacity function (self) -> float X.opacity() -> float
painter function (self) -> Any X.painter() -> PythonQt.QtGui.QPainter
pen function (self) -> Any X.pen() -> PythonQt.QtGui.QPen
penNeedsResolving function (self) -> bool X.penNeedsResolving() -> bool
renderHints function (self) -> Any Returns the render hints in the current paint engine state.
state function (self) -> Any Returns a combination of flags identifying the set of properties that need to be updated when updating the paint engine's state (i.e. during a call to the…
transform function (self) -> Any X.transform() -> PythonQt.QtGui.QTransform