API reference - Class QPaintEngineState

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QPaintEngineState

Public constructors

new QPaintEngineStatenewConstructor QPaintEngineState::QPaintEngineState()

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const QPaintEngineState other)Assigns another object to self
[const]QBrushbackgroundBrushMethod QBrush QPaintEngineState::backgroundBrush()
[const]Qt_BGModebackgroundModeMethod Qt::BGMode QPaintEngineState::backgroundMode()
[const]QBrushbrushMethod QBrush QPaintEngineState::brush()
[const]boolbrushNeedsResolvingMethod bool QPaintEngineState::brushNeedsResolving()
[const]QPointFbrushOriginMethod QPointF QPaintEngineState::brushOrigin()
[const]Qt_ClipOperationclipOperationMethod Qt::ClipOperation QPaintEngineState::clipOperation()
[const]QPainterPathclipPathMethod QPainterPath QPaintEngineState::clipPath()
[const]QRegionclipRegionMethod QRegion QPaintEngineState::clipRegion()
[const]QPainter_CompositionModecompositionModeMethod QPainter::CompositionMode QPaintEngineState::compositionMode()
[const]new QPaintEngineState ptrdupCreates a copy of self
[const]QFontfontMethod QFont QPaintEngineState::font()
[const]boolisClipEnabled?Method bool QPaintEngineState::isClipEnabled()
[const]QMatrixmatrixMethod QMatrix QPaintEngineState::matrix()
[const]doubleopacityMethod double QPaintEngineState::opacity()
[const]QPainter ptrpainterMethod QPainter *QPaintEngineState::painter()
[const]QPenpenMethod QPen QPaintEngineState::pen()
[const]boolpenNeedsResolvingMethod bool QPaintEngineState::penNeedsResolving()
[const]QPainter_QFlags_RenderHintrenderHintsMethod QFlags<QPainter::RenderHint> QPaintEngineState::renderHints()
[const]QPaintEngine_QFlags_DirtyFlagstateMethod QFlags<QPaintEngine::DirtyFlag> QPaintEngineState::state()
[const]QTransformtransformMethod QTransform QPaintEngineState::transform()

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: void assign (const QPaintEngineState other)

Description: Assigns another object to self

backgroundBrush

Signature: [const] QBrush backgroundBrush

Description: Method QBrush QPaintEngineState::backgroundBrush()

backgroundMode

Signature: [const] Qt_BGMode backgroundMode

Description: Method Qt::BGMode QPaintEngineState::backgroundMode()

brush

Signature: [const] QBrush brush

Description: Method QBrush QPaintEngineState::brush()

brushNeedsResolving

Signature: [const] bool brushNeedsResolving

Description: Method bool QPaintEngineState::brushNeedsResolving()

brushOrigin

Signature: [const] QPointF brushOrigin

Description: Method QPointF QPaintEngineState::brushOrigin()

clipOperation

Signature: [const] Qt_ClipOperation clipOperation

Description: Method Qt::ClipOperation QPaintEngineState::clipOperation()

clipPath

Signature: [const] QPainterPath clipPath

Description: Method QPainterPath QPaintEngineState::clipPath()

clipRegion

Signature: [const] QRegion clipRegion

Description: Method QRegion QPaintEngineState::clipRegion()

compositionMode

Signature: [const] QPainter_CompositionMode compositionMode

Description: Method QPainter::CompositionMode QPaintEngineState::compositionMode()

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QPaintEngineState ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

font

Signature: [const] QFont font

Description: Method QFont QPaintEngineState::font()

isClipEnabled?

Signature: [const] bool isClipEnabled?

Description: Method bool QPaintEngineState::isClipEnabled()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

matrix

Signature: [const] QMatrix matrix

Description: Method QMatrix QPaintEngineState::matrix()

new

Signature: [static] new QPaintEngineState new

Description: Constructor QPaintEngineState::QPaintEngineState()

This method creates an object of class QPaintEngineState.

Python specific notes:
This method is the default initializer of the object.

opacity

Signature: [const] double opacity

Description: Method double QPaintEngineState::opacity()

painter

Signature: [const] QPainter ptr painter

Description: Method QPainter *QPaintEngineState::painter()

pen

Signature: [const] QPen pen

Description: Method QPen QPaintEngineState::pen()

penNeedsResolving

Signature: [const] bool penNeedsResolving

Description: Method bool QPaintEngineState::penNeedsResolving()

renderHints

Signature: [const] QPainter_QFlags_RenderHint renderHints

Description: Method QFlags<QPainter::RenderHint> QPaintEngineState::renderHints()

state

Signature: [const] QPaintEngine_QFlags_DirtyFlag state

Description: Method QFlags<QPaintEngine::DirtyFlag> QPaintEngineState::state()

transform

Signature: [const] QTransform transform

Description: Method QTransform QPaintEngineState::transform()