QtBase  v6.3.1
Public Member Functions | Protected Attributes | Friends | List of all members
QPaintEngineState Class Reference

The QPaintEngineState class provides information about the active paint engine's current state. \reentrant. More...

#include <qpaintengine.h>

Inheritance diagram for QPaintEngineState:
Inheritance graph
[legend]

Public Member Functions

QPaintEngine::DirtyFlags state () const
 
QPen pen () const
 
QBrush brush () const
 
QPointF brushOrigin () const
 
QBrush backgroundBrush () const
 
Qt::BGMode backgroundMode () const
 
QFont font () const
 
QTransform transform () const
 
Qt::ClipOperation clipOperation () const
 
QRegion clipRegion () const
 
QPainterPath clipPath () const
 
bool isClipEnabled () const
 
QPainter::RenderHints renderHints () const
 
QPainter::CompositionMode compositionMode () const
 
qreal opacity () const
 
QPainter * painter () const
 
bool brushNeedsResolving () const
 
bool penNeedsResolving () const
 

Protected Attributes

QPaintEngine::DirtyFlags dirtyFlags
 

Friends

class QPaintEngine
 
class QRasterPaintEngine
 
class QWidget
 
class QPainter
 
class QPainterPrivate
 
class QMacPrintEnginePrivate
 

Detailed Description

The QPaintEngineState class provides information about the active paint engine's current state. \reentrant.

Since
4.1 \inmodule QtGui

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:

\target GetFunction

\table \header

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.

See also
QPaintEngine

Definition at line 267 of file qpaintengine.h.

Member Function Documentation

◆ backgroundBrush()

QBrush QPaintEngineState::backgroundBrush ( ) const

Returns the background brush in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyBackground flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7656 of file qpainter.cpp.

Here is the caller graph for this function:

◆ backgroundMode()

Qt::BGMode QPaintEngineState::backgroundMode ( ) const

Returns the background mode in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyBackgroundMode flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7671 of file qpainter.cpp.

Here is the caller graph for this function:

◆ brush()

QBrush QPaintEngineState::brush ( ) const

Returns the brush in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyBrush flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7628 of file qpainter.cpp.

Here is the caller graph for this function:

◆ brushNeedsResolving()

bool QPaintEngineState::brushNeedsResolving ( ) const
Since
4.3

Returns whether the coordinate of the fill have been specified as bounded by the current rendering operation and have to be resolved (about the currently rendered primitive).

Definition at line 7734 of file qpainter.cpp.

◆ brushOrigin()

QPointF QPaintEngineState::brushOrigin ( ) const

Returns the brush origin in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyBrushOrigin flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7642 of file qpainter.cpp.

Here is the caller graph for this function:

◆ clipOperation()

Qt::ClipOperation QPaintEngineState::clipOperation ( ) const

Returns the clip operation in the current paint engine state.

This variable should only be used when the state() returns a combination which includes either the QPaintEngine::DirtyClipPath or the QPaintEngine::DirtyClipRegion flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7722 of file qpainter.cpp.

Here is the caller graph for this function:

◆ clipPath()

QPainterPath QPaintEngineState::clipPath ( ) const

Returns the clip path in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyClipPath flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7777 of file qpainter.cpp.

Here is the caller graph for this function:

◆ clipRegion()

QRegion QPaintEngineState::clipRegion ( ) const

Returns the clip region in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyClipRegion flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7763 of file qpainter.cpp.

Here is the caller graph for this function:

◆ compositionMode()

QPainter::CompositionMode QPaintEngineState::compositionMode ( ) const

Returns the composition mode in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyCompositionMode flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7823 of file qpainter.cpp.

Here is the caller graph for this function:

◆ font()

QFont QPaintEngineState::font ( ) const

Returns the font in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyFont flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7686 of file qpainter.cpp.

Here is the caller graph for this function:

◆ isClipEnabled()

bool QPaintEngineState::isClipEnabled ( ) const

Returns whether clipping is enabled or not in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyClipEnabled flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7793 of file qpainter.cpp.

Here is the caller graph for this function:

◆ opacity()

qreal QPaintEngineState::opacity ( ) const
Since
4.2

Returns the opacity in the current paint engine state.

Definition at line 7846 of file qpainter.cpp.

Here is the caller graph for this function:

◆ painter()

QPainter * QPaintEngineState::painter ( ) const

Returns a pointer to the painter currently updating the paint engine.

Definition at line 7834 of file qpainter.cpp.

Here is the caller graph for this function:

◆ pen()

QPen QPaintEngineState::pen ( ) const

Returns the pen in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyPen flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7614 of file qpainter.cpp.

Here is the caller graph for this function:

◆ penNeedsResolving()

bool QPaintEngineState::penNeedsResolving ( ) const
Since
4.3

Returns whether the coordinate of the stroke have been specified as bounded by the current rendering operation and have to be resolved (about the currently rendered primitive).

Definition at line 7748 of file qpainter.cpp.

Here is the call graph for this function:

◆ renderHints()

QPainter::RenderHints QPaintEngineState::renderHints ( ) const

Returns the render hints in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyHints flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7808 of file qpainter.cpp.

Here is the caller graph for this function:

◆ state()

QPaintEngine::DirtyFlags QPaintEngineState::state ( ) const
inline

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 QPaintEngine::updateState() function).

See also
QPaintEngine::updateState()

Definition at line 270 of file qpaintengine.h.

Here is the caller graph for this function:

◆ transform()

QTransform QPaintEngineState::transform ( ) const
Since
4.3

Returns the matrix in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyTransform flag.

See also
state(), QPaintEngine::updateState()

Definition at line 7703 of file qpainter.cpp.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ QMacPrintEnginePrivate

friend class QMacPrintEnginePrivate
friend

Definition at line 300 of file qpaintengine.h.

◆ QPaintEngine

friend class QPaintEngine
friend

Definition at line 295 of file qpaintengine.h.

◆ QPainter

friend class QPainter
friend

Definition at line 298 of file qpaintengine.h.

◆ QPainterPrivate

friend class QPainterPrivate
friend

Definition at line 299 of file qpaintengine.h.

◆ QRasterPaintEngine

friend class QRasterPaintEngine
friend

Definition at line 296 of file qpaintengine.h.

◆ QWidget

friend class QWidget
friend

Definition at line 297 of file qpaintengine.h.

Member Data Documentation

◆ dirtyFlags

QPaintEngine::DirtyFlags QPaintEngineState::dirtyFlags
protected

Definition at line 302 of file qpaintengine.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.1