API reference - Class QPaintEngine_DirtyFlag

Notation used in Ruby API documentation

Module: QtGui

Description: This class represents the QPaintEngine::DirtyFlag enum

This class is equivalent to the class QPaintEngine::DirtyFlag

Public constructors

new QPaintEngine_DirtyFlag ptrnew(int i)Creates an enum from an integer value
new QPaintEngine_DirtyFlag ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const QPaintEngine_DirtyFlag other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QPaintEngine_DirtyFlag other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const QPaintEngine_DirtyFlag other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
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 QPaintEngine_DirtyFlag other)Assigns another object to self
[const]new QPaintEngine_DirtyFlag ptrdupCreates a copy of self
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum
[const]QPaintEngine_QFlags_DirtyFlag|(const QPaintEngine_DirtyFlag other)Creates a flag set by combining the two flags
[const]QPaintEngine_QFlags_DirtyFlag|(const QPaintEngine_QFlags_DirtyFlag other)Combines the flag and the flag set

Public static methods and constants

[static,const]QPaintEngine_DirtyFlagAllDirtyEnum constant QPaintEngine::AllDirty
[static,const]QPaintEngine_DirtyFlagDirtyBackgroundEnum constant QPaintEngine::DirtyBackground
[static,const]QPaintEngine_DirtyFlagDirtyBackgroundModeEnum constant QPaintEngine::DirtyBackgroundMode
[static,const]QPaintEngine_DirtyFlagDirtyBrushEnum constant QPaintEngine::DirtyBrush
[static,const]QPaintEngine_DirtyFlagDirtyBrushOriginEnum constant QPaintEngine::DirtyBrushOrigin
[static,const]QPaintEngine_DirtyFlagDirtyClipEnabledEnum constant QPaintEngine::DirtyClipEnabled
[static,const]QPaintEngine_DirtyFlagDirtyClipPathEnum constant QPaintEngine::DirtyClipPath
[static,const]QPaintEngine_DirtyFlagDirtyClipRegionEnum constant QPaintEngine::DirtyClipRegion
[static,const]QPaintEngine_DirtyFlagDirtyCompositionModeEnum constant QPaintEngine::DirtyCompositionMode
[static,const]QPaintEngine_DirtyFlagDirtyFontEnum constant QPaintEngine::DirtyFont
[static,const]QPaintEngine_DirtyFlagDirtyHintsEnum constant QPaintEngine::DirtyHints
[static,const]QPaintEngine_DirtyFlagDirtyOpacityEnum constant QPaintEngine::DirtyOpacity
[static,const]QPaintEngine_DirtyFlagDirtyPenEnum constant QPaintEngine::DirtyPen
[static,const]QPaintEngine_DirtyFlagDirtyTransformEnum constant QPaintEngine::DirtyTransform

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

!=

(1) Signature: [const] bool != (const QPaintEngine_DirtyFlag other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const QPaintEngine_DirtyFlag other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const QPaintEngine_DirtyFlag other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

AllDirty

Signature: [static,const] QPaintEngine_DirtyFlag AllDirty

Description: Enum constant QPaintEngine::AllDirty

Python specific notes:
The object exposes a readable attribute 'AllDirty'. This is the getter.

DirtyBackground

Signature: [static,const] QPaintEngine_DirtyFlag DirtyBackground

Description: Enum constant QPaintEngine::DirtyBackground

Python specific notes:
The object exposes a readable attribute 'DirtyBackground'. This is the getter.

DirtyBackgroundMode

Signature: [static,const] QPaintEngine_DirtyFlag DirtyBackgroundMode

Description: Enum constant QPaintEngine::DirtyBackgroundMode

Python specific notes:
The object exposes a readable attribute 'DirtyBackgroundMode'. This is the getter.

DirtyBrush

Signature: [static,const] QPaintEngine_DirtyFlag DirtyBrush

Description: Enum constant QPaintEngine::DirtyBrush

Python specific notes:
The object exposes a readable attribute 'DirtyBrush'. This is the getter.

DirtyBrushOrigin

Signature: [static,const] QPaintEngine_DirtyFlag DirtyBrushOrigin

Description: Enum constant QPaintEngine::DirtyBrushOrigin

Python specific notes:
The object exposes a readable attribute 'DirtyBrushOrigin'. This is the getter.

DirtyClipEnabled

Signature: [static,const] QPaintEngine_DirtyFlag DirtyClipEnabled

Description: Enum constant QPaintEngine::DirtyClipEnabled

Python specific notes:
The object exposes a readable attribute 'DirtyClipEnabled'. This is the getter.

DirtyClipPath

Signature: [static,const] QPaintEngine_DirtyFlag DirtyClipPath

Description: Enum constant QPaintEngine::DirtyClipPath

Python specific notes:
The object exposes a readable attribute 'DirtyClipPath'. This is the getter.

DirtyClipRegion

Signature: [static,const] QPaintEngine_DirtyFlag DirtyClipRegion

Description: Enum constant QPaintEngine::DirtyClipRegion

Python specific notes:
The object exposes a readable attribute 'DirtyClipRegion'. This is the getter.

DirtyCompositionMode

Signature: [static,const] QPaintEngine_DirtyFlag DirtyCompositionMode

Description: Enum constant QPaintEngine::DirtyCompositionMode

Python specific notes:
The object exposes a readable attribute 'DirtyCompositionMode'. This is the getter.

DirtyFont

Signature: [static,const] QPaintEngine_DirtyFlag DirtyFont

Description: Enum constant QPaintEngine::DirtyFont

Python specific notes:
The object exposes a readable attribute 'DirtyFont'. This is the getter.

DirtyHints

Signature: [static,const] QPaintEngine_DirtyFlag DirtyHints

Description: Enum constant QPaintEngine::DirtyHints

Python specific notes:
The object exposes a readable attribute 'DirtyHints'. This is the getter.

DirtyOpacity

Signature: [static,const] QPaintEngine_DirtyFlag DirtyOpacity

Description: Enum constant QPaintEngine::DirtyOpacity

Python specific notes:
The object exposes a readable attribute 'DirtyOpacity'. This is the getter.

DirtyPen

Signature: [static,const] QPaintEngine_DirtyFlag DirtyPen

Description: Enum constant QPaintEngine::DirtyPen

Python specific notes:
The object exposes a readable attribute 'DirtyPen'. This is the getter.

DirtyTransform

Signature: [static,const] QPaintEngine_DirtyFlag DirtyTransform

Description: Enum constant QPaintEngine::DirtyTransform

Python specific notes:
The object exposes a readable attribute 'DirtyTransform'. This is the getter.

_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 QPaintEngine_DirtyFlag other)

Description: Assigns another object to self

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 QPaintEngine_DirtyFlag ptr dup

Description: Creates a copy of self

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

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

Python specific notes:
This method is also available as 'repr(object)'.

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.

new

(1) Signature: [static] new QPaintEngine_DirtyFlag ptr new (int i)

Description: Creates an enum from an integer value

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

(2) Signature: [static] new QPaintEngine_DirtyFlag ptr new (string s)

Description: Creates an enum from a string value

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

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

Python specific notes:
This method is also available as 'str(object)'.

|

(1) Signature: [const] QPaintEngine_QFlags_DirtyFlag | (const QPaintEngine_DirtyFlag other)

Description: Creates a flag set by combining the two flags

(2) Signature: [const] QPaintEngine_QFlags_DirtyFlag | (const QPaintEngine_QFlags_DirtyFlag other)

Description: Combines the flag and the flag set