KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QImage::Format

Notation used in Ruby API documentation

Module: QtGui

Description: This class represents the QImage::Format enum

This class is equivalent to the class QImage_Format

Public constructors

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

Public methods

[const]bool!=(const QImage_Format other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QImage_Format 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 QImage_Format other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]QImage_Format 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 QImage_Format other)Assigns another object to self
[const]new QImage_Format 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]QImage_QFlags_Format|(const QImage_Format other)Creates a flag set by combining the two flags
[const]QImage_QFlags_Format|(const QImage_QFlags_Format other)Combines the flag and the flag set

Public static methods and constants

[static,const]QImage_FormatFormat_A2BGR30_PremultipliedEnum constant QImage::Format_A2BGR30_Premultiplied
[static,const]QImage_FormatFormat_A2RGB30_PremultipliedEnum constant QImage::Format_A2RGB30_Premultiplied
[static,const]QImage_FormatFormat_ARGB32Enum constant QImage::Format_ARGB32
[static,const]QImage_FormatFormat_ARGB32_PremultipliedEnum constant QImage::Format_ARGB32_Premultiplied
[static,const]QImage_FormatFormat_ARGB4444_PremultipliedEnum constant QImage::Format_ARGB4444_Premultiplied
[static,const]QImage_FormatFormat_ARGB6666_PremultipliedEnum constant QImage::Format_ARGB6666_Premultiplied
[static,const]QImage_FormatFormat_ARGB8555_PremultipliedEnum constant QImage::Format_ARGB8555_Premultiplied
[static,const]QImage_FormatFormat_ARGB8565_PremultipliedEnum constant QImage::Format_ARGB8565_Premultiplied
[static,const]QImage_FormatFormat_Alpha8Enum constant QImage::Format_Alpha8
[static,const]QImage_FormatFormat_BGR30Enum constant QImage::Format_BGR30
[static,const]QImage_FormatFormat_Grayscale8Enum constant QImage::Format_Grayscale8
[static,const]QImage_FormatFormat_Indexed8Enum constant QImage::Format_Indexed8
[static,const]QImage_FormatFormat_InvalidEnum constant QImage::Format_Invalid
[static,const]QImage_FormatFormat_MonoEnum constant QImage::Format_Mono
[static,const]QImage_FormatFormat_MonoLSBEnum constant QImage::Format_MonoLSB
[static,const]QImage_FormatFormat_RGB16Enum constant QImage::Format_RGB16
[static,const]QImage_FormatFormat_RGB30Enum constant QImage::Format_RGB30
[static,const]QImage_FormatFormat_RGB32Enum constant QImage::Format_RGB32
[static,const]QImage_FormatFormat_RGB444Enum constant QImage::Format_RGB444
[static,const]QImage_FormatFormat_RGB555Enum constant QImage::Format_RGB555
[static,const]QImage_FormatFormat_RGB666Enum constant QImage::Format_RGB666
[static,const]QImage_FormatFormat_RGB888Enum constant QImage::Format_RGB888
[static,const]QImage_FormatFormat_RGBA64Enum constant QImage::Format_RGBA64
[static,const]QImage_FormatFormat_RGBA64_PremultipliedEnum constant QImage::Format_RGBA64_Premultiplied
[static,const]QImage_FormatFormat_RGBA8888Enum constant QImage::Format_RGBA8888
[static,const]QImage_FormatFormat_RGBA8888_PremultipliedEnum constant QImage::Format_RGBA8888_Premultiplied
[static,const]QImage_FormatFormat_RGBX64Enum constant QImage::Format_RGBX64
[static,const]QImage_FormatFormat_RGBX8888Enum constant QImage::Format_RGBX8888
[static,const]QImage_FormatNImageFormatsEnum constant QImage::NImageFormats

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

Description: Compares two enums

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

Description: Compares an enum with an integer value

Format_A2BGR30_Premultiplied

Signature: [static,const] QImage_Format Format_A2BGR30_Premultiplied

Description: Enum constant QImage::Format_A2BGR30_Premultiplied

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

Format_A2RGB30_Premultiplied

Signature: [static,const] QImage_Format Format_A2RGB30_Premultiplied

Description: Enum constant QImage::Format_A2RGB30_Premultiplied

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

Format_ARGB32

Signature: [static,const] QImage_Format Format_ARGB32

Description: Enum constant QImage::Format_ARGB32

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

Format_ARGB32_Premultiplied

Signature: [static,const] QImage_Format Format_ARGB32_Premultiplied

Description: Enum constant QImage::Format_ARGB32_Premultiplied

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

Format_ARGB4444_Premultiplied

Signature: [static,const] QImage_Format Format_ARGB4444_Premultiplied

Description: Enum constant QImage::Format_ARGB4444_Premultiplied

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

Format_ARGB6666_Premultiplied

Signature: [static,const] QImage_Format Format_ARGB6666_Premultiplied

Description: Enum constant QImage::Format_ARGB6666_Premultiplied

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

Format_ARGB8555_Premultiplied

Signature: [static,const] QImage_Format Format_ARGB8555_Premultiplied

Description: Enum constant QImage::Format_ARGB8555_Premultiplied

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

Format_ARGB8565_Premultiplied

Signature: [static,const] QImage_Format Format_ARGB8565_Premultiplied

Description: Enum constant QImage::Format_ARGB8565_Premultiplied

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

Format_Alpha8

Signature: [static,const] QImage_Format Format_Alpha8

Description: Enum constant QImage::Format_Alpha8

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

Format_BGR30

Signature: [static,const] QImage_Format Format_BGR30

Description: Enum constant QImage::Format_BGR30

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

Format_Grayscale8

Signature: [static,const] QImage_Format Format_Grayscale8

Description: Enum constant QImage::Format_Grayscale8

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

Format_Indexed8

Signature: [static,const] QImage_Format Format_Indexed8

Description: Enum constant QImage::Format_Indexed8

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

Format_Invalid

Signature: [static,const] QImage_Format Format_Invalid

Description: Enum constant QImage::Format_Invalid

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

Format_Mono

Signature: [static,const] QImage_Format Format_Mono

Description: Enum constant QImage::Format_Mono

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

Format_MonoLSB

Signature: [static,const] QImage_Format Format_MonoLSB

Description: Enum constant QImage::Format_MonoLSB

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

Format_RGB16

Signature: [static,const] QImage_Format Format_RGB16

Description: Enum constant QImage::Format_RGB16

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

Format_RGB30

Signature: [static,const] QImage_Format Format_RGB30

Description: Enum constant QImage::Format_RGB30

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

Format_RGB32

Signature: [static,const] QImage_Format Format_RGB32

Description: Enum constant QImage::Format_RGB32

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

Format_RGB444

Signature: [static,const] QImage_Format Format_RGB444

Description: Enum constant QImage::Format_RGB444

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

Format_RGB555

Signature: [static,const] QImage_Format Format_RGB555

Description: Enum constant QImage::Format_RGB555

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

Format_RGB666

Signature: [static,const] QImage_Format Format_RGB666

Description: Enum constant QImage::Format_RGB666

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

Format_RGB888

Signature: [static,const] QImage_Format Format_RGB888

Description: Enum constant QImage::Format_RGB888

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

Format_RGBA64

Signature: [static,const] QImage_Format Format_RGBA64

Description: Enum constant QImage::Format_RGBA64

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

Format_RGBA64_Premultiplied

Signature: [static,const] QImage_Format Format_RGBA64_Premultiplied

Description: Enum constant QImage::Format_RGBA64_Premultiplied

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

Format_RGBA8888

Signature: [static,const] QImage_Format Format_RGBA8888

Description: Enum constant QImage::Format_RGBA8888

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

Format_RGBA8888_Premultiplied

Signature: [static,const] QImage_Format Format_RGBA8888_Premultiplied

Description: Enum constant QImage::Format_RGBA8888_Premultiplied

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

Format_RGBX64

Signature: [static,const] QImage_Format Format_RGBX64

Description: Enum constant QImage::Format_RGBX64

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

Format_RGBX8888

Signature: [static,const] QImage_Format Format_RGBX8888

Description: Enum constant QImage::Format_RGBX8888

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

NImageFormats

Signature: [static,const] QImage_Format NImageFormats

Description: Enum constant QImage::NImageFormats

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

_const_cast

Signature: [const] QImage_Format 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 QImage_Format 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 QImage_Format 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 QImage_Format 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 QImage_Format 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] QImage_QFlags_Format | (const QImage_Format other)

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set