KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QPainter_CompositionMode

Notation used in Ruby API documentation

Module: QtGui

Description: This class represents the QPainter::CompositionMode enum

This class is equivalent to the class QPainter::CompositionMode

Public constructors

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

Public methods

[const]bool!=(const QPainter_CompositionMode other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QPainter_CompositionMode 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 QPainter_CompositionMode other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]QPainter_CompositionMode ptr_const_castReturns a non-const reference to self.
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 QPainter_CompositionMode other)Assigns another object to self
[const]new QPainter_CompositionMode ptrdupCreates a copy of self
[const]inthashGets the hash value from the enum
[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]QPainter_QFlags_CompositionMode|(const QPainter_CompositionMode other)Creates a flag set by combining the two flags
[const]QPainter_QFlags_CompositionMode|(const QPainter_QFlags_CompositionMode other)Combines the flag and the flag set

Public static methods and constants

[static,const]QPainter_CompositionModeCompositionMode_ClearEnum constant QPainter::CompositionMode_Clear
[static,const]QPainter_CompositionModeCompositionMode_ColorBurnEnum constant QPainter::CompositionMode_ColorBurn
[static,const]QPainter_CompositionModeCompositionMode_ColorDodgeEnum constant QPainter::CompositionMode_ColorDodge
[static,const]QPainter_CompositionModeCompositionMode_DarkenEnum constant QPainter::CompositionMode_Darken
[static,const]QPainter_CompositionModeCompositionMode_DestinationEnum constant QPainter::CompositionMode_Destination
[static,const]QPainter_CompositionModeCompositionMode_DestinationAtopEnum constant QPainter::CompositionMode_DestinationAtop
[static,const]QPainter_CompositionModeCompositionMode_DestinationInEnum constant QPainter::CompositionMode_DestinationIn
[static,const]QPainter_CompositionModeCompositionMode_DestinationOutEnum constant QPainter::CompositionMode_DestinationOut
[static,const]QPainter_CompositionModeCompositionMode_DestinationOverEnum constant QPainter::CompositionMode_DestinationOver
[static,const]QPainter_CompositionModeCompositionMode_DifferenceEnum constant QPainter::CompositionMode_Difference
[static,const]QPainter_CompositionModeCompositionMode_ExclusionEnum constant QPainter::CompositionMode_Exclusion
[static,const]QPainter_CompositionModeCompositionMode_HardLightEnum constant QPainter::CompositionMode_HardLight
[static,const]QPainter_CompositionModeCompositionMode_LightenEnum constant QPainter::CompositionMode_Lighten
[static,const]QPainter_CompositionModeCompositionMode_MultiplyEnum constant QPainter::CompositionMode_Multiply
[static,const]QPainter_CompositionModeCompositionMode_OverlayEnum constant QPainter::CompositionMode_Overlay
[static,const]QPainter_CompositionModeCompositionMode_PlusEnum constant QPainter::CompositionMode_Plus
[static,const]QPainter_CompositionModeCompositionMode_ScreenEnum constant QPainter::CompositionMode_Screen
[static,const]QPainter_CompositionModeCompositionMode_SoftLightEnum constant QPainter::CompositionMode_SoftLight
[static,const]QPainter_CompositionModeCompositionMode_SourceEnum constant QPainter::CompositionMode_Source
[static,const]QPainter_CompositionModeCompositionMode_SourceAtopEnum constant QPainter::CompositionMode_SourceAtop
[static,const]QPainter_CompositionModeCompositionMode_SourceInEnum constant QPainter::CompositionMode_SourceIn
[static,const]QPainter_CompositionModeCompositionMode_SourceOutEnum constant QPainter::CompositionMode_SourceOut
[static,const]QPainter_CompositionModeCompositionMode_SourceOverEnum constant QPainter::CompositionMode_SourceOver
[static,const]QPainter_CompositionModeCompositionMode_XorEnum constant QPainter::CompositionMode_Xor
[static,const]QPainter_CompositionModeRasterOp_ClearDestinationEnum constant QPainter::RasterOp_ClearDestination
[static,const]QPainter_CompositionModeRasterOp_NotDestinationEnum constant QPainter::RasterOp_NotDestination
[static,const]QPainter_CompositionModeRasterOp_NotSourceEnum constant QPainter::RasterOp_NotSource
[static,const]QPainter_CompositionModeRasterOp_NotSourceAndDestinationEnum constant QPainter::RasterOp_NotSourceAndDestination
[static,const]QPainter_CompositionModeRasterOp_NotSourceAndNotDestinationEnum constant QPainter::RasterOp_NotSourceAndNotDestination
[static,const]QPainter_CompositionModeRasterOp_NotSourceOrDestinationEnum constant QPainter::RasterOp_NotSourceOrDestination
[static,const]QPainter_CompositionModeRasterOp_NotSourceOrNotDestinationEnum constant QPainter::RasterOp_NotSourceOrNotDestination
[static,const]QPainter_CompositionModeRasterOp_NotSourceXorDestinationEnum constant QPainter::RasterOp_NotSourceXorDestination
[static,const]QPainter_CompositionModeRasterOp_SetDestinationEnum constant QPainter::RasterOp_SetDestination
[static,const]QPainter_CompositionModeRasterOp_SourceAndDestinationEnum constant QPainter::RasterOp_SourceAndDestination
[static,const]QPainter_CompositionModeRasterOp_SourceAndNotDestinationEnum constant QPainter::RasterOp_SourceAndNotDestination
[static,const]QPainter_CompositionModeRasterOp_SourceOrDestinationEnum constant QPainter::RasterOp_SourceOrDestination
[static,const]QPainter_CompositionModeRasterOp_SourceOrNotDestinationEnum constant QPainter::RasterOp_SourceOrNotDestination
[static,const]QPainter_CompositionModeRasterOp_SourceXorDestinationEnum constant QPainter::RasterOp_SourceXorDestination

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 QPainter_CompositionMode 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 QPainter_CompositionMode 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 QPainter_CompositionMode other)

Description: Compares two enums

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

Description: Compares an enum with an integer value

CompositionMode_Clear

Signature: [static,const] QPainter_CompositionMode CompositionMode_Clear

Description: Enum constant QPainter::CompositionMode_Clear

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

CompositionMode_ColorBurn

Signature: [static,const] QPainter_CompositionMode CompositionMode_ColorBurn

Description: Enum constant QPainter::CompositionMode_ColorBurn

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

CompositionMode_ColorDodge

Signature: [static,const] QPainter_CompositionMode CompositionMode_ColorDodge

Description: Enum constant QPainter::CompositionMode_ColorDodge

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

CompositionMode_Darken

Signature: [static,const] QPainter_CompositionMode CompositionMode_Darken

Description: Enum constant QPainter::CompositionMode_Darken

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

CompositionMode_Destination

Signature: [static,const] QPainter_CompositionMode CompositionMode_Destination

Description: Enum constant QPainter::CompositionMode_Destination

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

CompositionMode_DestinationAtop

Signature: [static,const] QPainter_CompositionMode CompositionMode_DestinationAtop

Description: Enum constant QPainter::CompositionMode_DestinationAtop

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

CompositionMode_DestinationIn

Signature: [static,const] QPainter_CompositionMode CompositionMode_DestinationIn

Description: Enum constant QPainter::CompositionMode_DestinationIn

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

CompositionMode_DestinationOut

Signature: [static,const] QPainter_CompositionMode CompositionMode_DestinationOut

Description: Enum constant QPainter::CompositionMode_DestinationOut

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

CompositionMode_DestinationOver

Signature: [static,const] QPainter_CompositionMode CompositionMode_DestinationOver

Description: Enum constant QPainter::CompositionMode_DestinationOver

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

CompositionMode_Difference

Signature: [static,const] QPainter_CompositionMode CompositionMode_Difference

Description: Enum constant QPainter::CompositionMode_Difference

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

CompositionMode_Exclusion

Signature: [static,const] QPainter_CompositionMode CompositionMode_Exclusion

Description: Enum constant QPainter::CompositionMode_Exclusion

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

CompositionMode_HardLight

Signature: [static,const] QPainter_CompositionMode CompositionMode_HardLight

Description: Enum constant QPainter::CompositionMode_HardLight

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

CompositionMode_Lighten

Signature: [static,const] QPainter_CompositionMode CompositionMode_Lighten

Description: Enum constant QPainter::CompositionMode_Lighten

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

CompositionMode_Multiply

Signature: [static,const] QPainter_CompositionMode CompositionMode_Multiply

Description: Enum constant QPainter::CompositionMode_Multiply

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

CompositionMode_Overlay

Signature: [static,const] QPainter_CompositionMode CompositionMode_Overlay

Description: Enum constant QPainter::CompositionMode_Overlay

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

CompositionMode_Plus

Signature: [static,const] QPainter_CompositionMode CompositionMode_Plus

Description: Enum constant QPainter::CompositionMode_Plus

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

CompositionMode_Screen

Signature: [static,const] QPainter_CompositionMode CompositionMode_Screen

Description: Enum constant QPainter::CompositionMode_Screen

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

CompositionMode_SoftLight

Signature: [static,const] QPainter_CompositionMode CompositionMode_SoftLight

Description: Enum constant QPainter::CompositionMode_SoftLight

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

CompositionMode_Source

Signature: [static,const] QPainter_CompositionMode CompositionMode_Source

Description: Enum constant QPainter::CompositionMode_Source

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

CompositionMode_SourceAtop

Signature: [static,const] QPainter_CompositionMode CompositionMode_SourceAtop

Description: Enum constant QPainter::CompositionMode_SourceAtop

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

CompositionMode_SourceIn

Signature: [static,const] QPainter_CompositionMode CompositionMode_SourceIn

Description: Enum constant QPainter::CompositionMode_SourceIn

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

CompositionMode_SourceOut

Signature: [static,const] QPainter_CompositionMode CompositionMode_SourceOut

Description: Enum constant QPainter::CompositionMode_SourceOut

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

CompositionMode_SourceOver

Signature: [static,const] QPainter_CompositionMode CompositionMode_SourceOver

Description: Enum constant QPainter::CompositionMode_SourceOver

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

CompositionMode_Xor

Signature: [static,const] QPainter_CompositionMode CompositionMode_Xor

Description: Enum constant QPainter::CompositionMode_Xor

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

RasterOp_ClearDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_ClearDestination

Description: Enum constant QPainter::RasterOp_ClearDestination

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

RasterOp_NotDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_NotDestination

Description: Enum constant QPainter::RasterOp_NotDestination

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

RasterOp_NotSource

Signature: [static,const] QPainter_CompositionMode RasterOp_NotSource

Description: Enum constant QPainter::RasterOp_NotSource

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

RasterOp_NotSourceAndDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_NotSourceAndDestination

Description: Enum constant QPainter::RasterOp_NotSourceAndDestination

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

RasterOp_NotSourceAndNotDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_NotSourceAndNotDestination

Description: Enum constant QPainter::RasterOp_NotSourceAndNotDestination

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

RasterOp_NotSourceOrDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_NotSourceOrDestination

Description: Enum constant QPainter::RasterOp_NotSourceOrDestination

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

RasterOp_NotSourceOrNotDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_NotSourceOrNotDestination

Description: Enum constant QPainter::RasterOp_NotSourceOrNotDestination

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

RasterOp_NotSourceXorDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_NotSourceXorDestination

Description: Enum constant QPainter::RasterOp_NotSourceXorDestination

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

RasterOp_SetDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_SetDestination

Description: Enum constant QPainter::RasterOp_SetDestination

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

RasterOp_SourceAndDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_SourceAndDestination

Description: Enum constant QPainter::RasterOp_SourceAndDestination

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

RasterOp_SourceAndNotDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_SourceAndNotDestination

Description: Enum constant QPainter::RasterOp_SourceAndNotDestination

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

RasterOp_SourceOrDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_SourceOrDestination

Description: Enum constant QPainter::RasterOp_SourceOrDestination

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

RasterOp_SourceOrNotDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_SourceOrNotDestination

Description: Enum constant QPainter::RasterOp_SourceOrNotDestination

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

RasterOp_SourceXorDestination

Signature: [static,const] QPainter_CompositionMode RasterOp_SourceXorDestination

Description: Enum constant QPainter::RasterOp_SourceXorDestination

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

_const_cast

Signature: [const] QPainter_CompositionMode ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_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 QPainter_CompositionMode 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 QPainter_CompositionMode ptr dup

Description: Creates a copy of self

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

hash

Signature: [const] int hash

Description: Gets the hash value from the enum

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

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 QPainter_CompositionMode 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 QPainter_CompositionMode 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

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

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] QPainter_QFlags_CompositionMode | (const QPainter_CompositionMode other)

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set