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:

Collaboration diagram for QPaintEngineState:

Public Member Functions
QPaintEngine::DirtyFlags	state () const
	Returns a combination of flags identifying the set of properties that need to be updated when updating the paint engine's state (i.e.
QPen	pen () const
	Returns the pen in the current paint engine state.
QBrush	brush () const
	Returns the brush in the current paint engine state.
QPointF	brushOrigin () const
	Returns the brush origin in the current paint engine state.
QBrush	backgroundBrush () const
	Returns the background brush in the current paint engine state.
Qt::BGMode	backgroundMode () const
	Returns the background mode in the current paint engine state.
QFont	font () const
	Returns the font in the current paint engine state.
QTransform	transform () const
Qt::ClipOperation	clipOperation () const
	Returns the clip operation in the current paint engine state.
QRegion	clipRegion () const
	Returns the clip region in the current paint engine state.
QPainterPath	clipPath () const
	Returns the clip path in the current paint engine state.
bool	isClipEnabled () const
	Returns whether clipping is enabled or not in the current paint engine state.
QPainter::RenderHints	renderHints () const
	Returns the render hints in the current paint engine state.
QPainter::CompositionMode	compositionMode () const
	Returns the composition mode in the current paint engine state.
qreal	opacity () const
QPainter *	painter () const
	Returns a pointer to the painter currently updating the paint engine.
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

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

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 231 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 7782 of file qpainter.cpp.

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 7797 of file qpainter.cpp.

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 7754 of file qpainter.cpp.

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 7860 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 7768 of file qpainter.cpp.

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 7848 of file qpainter.cpp.

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 7903 of file qpainter.cpp.

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 7889 of file qpainter.cpp.

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 7949 of file qpainter.cpp.

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 7812 of file qpainter.cpp.

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 7919 of file qpainter.cpp.

opacity()

qreal QPaintEngineState::opacity

(

)

const

Since

4.2

Returns the opacity in the current paint engine state.

Definition at line 7972 of file qpainter.cpp.

painter()

QPainter * QPaintEngineState::painter

(

)

const

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

Definition at line 7960 of file qpainter.cpp.

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 7740 of file qpainter.cpp.

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 7874 of file qpainter.cpp.

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 7934 of file qpainter.cpp.

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 234 of file qpaintengine.h.

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 7829 of file qpainter.cpp.

Friends And Related Symbol Documentation

QMacPrintEnginePrivate

friend class QMacPrintEnginePrivate

friend

Definition at line 264 of file qpaintengine.h.

QPaintEngine

friend class QPaintEngine

friend

Definition at line 259 of file qpaintengine.h.

QPainter

friend class QPainter

friend

Definition at line 262 of file qpaintengine.h.

QPainterPrivate

friend class QPainterPrivate

friend

Definition at line 263 of file qpaintengine.h.

QRasterPaintEngine

friend class QRasterPaintEngine

friend

Definition at line 260 of file qpaintengine.h.

QWidget

friend class QWidget

friend

Definition at line 261 of file qpaintengine.h.

Member Data Documentation

dirtyFlags

QPaintEngine::DirtyFlags QPaintEngineState::dirtyFlags

protected

Definition at line 266 of file qpaintengine.h.

---

The documentation for this class was generated from the following files:

• qtbase/src/gui/painting/qpaintengine.h (05fc3aef53348fb58be6308076e000825b704e58)
• qtbase/src/gui/painting/qpainter.cpp (fe3129ed4119754a10820407330e7d5f9d04adb0)