Struct qt_gui::QPaintEngineState

#[repr(C)]pub struct QPaintEngineState { /* fields omitted */ }

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

C++ class: QPaintEngineState.

C++ documentation:

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

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.

Methods

impl QPaintEngineState

pub unsafe fn background_brush(&self) -> CppBox<QBrush>

Returns the background brush in the current paint engine state.

Calls C++ function: QBrush QPaintEngineState::backgroundBrush() const.

C++ documentation:

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

pub unsafe fn background_mode(&self) -> BGMode

Returns the background mode in the current paint engine state.

Calls C++ function: Qt::BGMode QPaintEngineState::backgroundMode() const.

C++ documentation:

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

pub unsafe fn brush(&self) -> CppBox<QBrush>

Returns the brush in the current paint engine state.

Calls C++ function: QBrush QPaintEngineState::brush() const.

C++ documentation:

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

pub unsafe fn brush_needs_resolving(&self) -> bool

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).

Calls C++ function: bool QPaintEngineState::brushNeedsResolving() const.

C++ documentation:

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).

This function was introduced in Qt 4.3.

pub unsafe fn brush_origin(&self) -> CppBox<QPointF>

Returns the brush origin in the current paint engine state.

Calls C++ function: QPointF QPaintEngineState::brushOrigin() const.

C++ documentation:

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

pub unsafe fn clip_operation(&self) -> ClipOperation

Returns the clip operation in the current paint engine state.

Calls C++ function: Qt::ClipOperation QPaintEngineState::clipOperation() const.

C++ documentation:

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

pub unsafe fn clip_path(&self) -> CppBox<QPainterPath>

Returns the clip path in the current paint engine state.

Calls C++ function: QPainterPath QPaintEngineState::clipPath() const.

C++ documentation:

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

pub unsafe fn clip_region(&self) -> CppBox<QRegion>

Returns the clip region in the current paint engine state.

Calls C++ function: QRegion QPaintEngineState::clipRegion() const.

C++ documentation:

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

pub unsafe fn composition_mode(&self) -> CompositionMode

Returns the composition mode in the current paint engine state.

Calls C++ function: QPainter::CompositionMode QPaintEngineState::compositionMode() const.

C++ documentation:

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

pub unsafe fn copy_from(
    &self,
    other: impl CastInto<Ref<QPaintEngineState>>
) -> Ref<QPaintEngineState>

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

Calls C++ function: QPaintEngineState& QPaintEngineState::operator=(const QPaintEngineState& other).

C++ documentation:

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

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.

pub unsafe fn font(&self) -> CppBox<QFont>

Returns the font in the current paint engine state.

Calls C++ function: QFont QPaintEngineState::font() const.

C++ documentation:

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

pub unsafe fn is_clip_enabled(&self) -> bool

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

Calls C++ function: bool QPaintEngineState::isClipEnabled() const.

C++ documentation:

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

pub unsafe fn matrix(&self) -> CppBox<QMatrix>

Returns the matrix in the current paint engine state.

Calls C++ function: QMatrix QPaintEngineState::matrix() const.

C++ documentation:

Returns the matrix in the current paint engine state.

Note: It is advisable to use transform() instead of this function to preserve the properties of perspective transformations.

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

This function was introduced in Qt 4.2.

See also state() and QPaintEngine::updateState().

pub unsafe fn new() -> CppBox<QPaintEngineState>

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

Calls C++ function: [constructor] void QPaintEngineState::QPaintEngineState().

C++ documentation:

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

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.

pub unsafe fn new_copy(
    other: impl CastInto<Ref<QPaintEngineState>>
) -> CppBox<QPaintEngineState>

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

Calls C++ function: [constructor] void QPaintEngineState::QPaintEngineState(const QPaintEngineState& other).

C++ documentation:

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

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.

pub unsafe fn opacity(&self) -> c_double

Returns the opacity in the current paint engine state.

Calls C++ function: double QPaintEngineState::opacity() const.

C++ documentation:

Returns the opacity in the current paint engine state.

This function was introduced in Qt 4.2.

pub unsafe fn painter(&self) -> Ptr<QPainter>

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

Calls C++ function: QPainter* QPaintEngineState::painter() const.

C++ documentation:

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

pub unsafe fn pen(&self) -> CppBox<QPen>

Returns the pen in the current paint engine state.

Calls C++ function: QPen QPaintEngineState::pen() const.

C++ documentation:

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

pub unsafe fn pen_needs_resolving(&self) -> bool

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).

Calls C++ function: bool QPaintEngineState::penNeedsResolving() const.

C++ documentation:

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).

This function was introduced in Qt 4.3.

pub unsafe fn render_hints(&self) -> QFlags<RenderHint>

Returns the render hints in the current paint engine state.

Calls C++ function: QFlags<QPainter::RenderHint> QPaintEngineState::renderHints() const.

C++ documentation:

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

pub unsafe fn state(&self) -> QFlags<DirtyFlag>

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).

Calls C++ function: QFlags<QPaintEngine::DirtyFlag> QPaintEngineState::state() const.

C++ documentation:

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().

pub unsafe fn transform(&self) -> CppBox<QTransform>

Returns the matrix in the current paint engine state.

Calls C++ function: QTransform QPaintEngineState::transform() const.

C++ documentation:

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.

This function was introduced in Qt 4.3.

See also state() and QPaintEngine::updateState().

Trait Implementations

impl CppDeletable for QPaintEngineState

unsafe fn delete(&self)

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

Calls C++ function: [destructor] void QPaintEngineState::~QPaintEngineState().

C++ documentation:

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

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.