KLayout Manual: Main Index » Class Index » API reference - Class QImage_Format

API reference - Class QImage_Format

Notation used in Ruby API documentation

Description: This class represents the QImage::Format enum

Public constructors

new QImage_Formatnew(unsigned int arg1)Creates the enum object from an integer

Public methods

[const]bool==(QImage_Format other)Compares the enum class against an enum of it's own type
[const]bool==(unsigned int other)Compares the enum class against an integer
[const]voidassign(const QImage_Format other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QImage_FormatdupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]unsigned intto_iConverts the enum class to an integer
[const]stringto_sConverts the enum class to a string

Public static methods and constants

new QImage_FormatFormat_ARGB32Enum constant QImage::Format_ARGB32
new QImage_FormatFormat_ARGB32_PremultipliedEnum constant QImage::Format_ARGB32_Premultiplied
new QImage_FormatFormat_ARGB4444_PremultipliedEnum constant QImage::Format_ARGB4444_Premultiplied
new QImage_FormatFormat_ARGB6666_PremultipliedEnum constant QImage::Format_ARGB6666_Premultiplied
new QImage_FormatFormat_ARGB8555_PremultipliedEnum constant QImage::Format_ARGB8555_Premultiplied
new QImage_FormatFormat_ARGB8565_PremultipliedEnum constant QImage::Format_ARGB8565_Premultiplied
new QImage_FormatFormat_Indexed8Enum constant QImage::Format_Indexed8
new QImage_FormatFormat_InvalidEnum constant QImage::Format_Invalid
new QImage_FormatFormat_MonoEnum constant QImage::Format_Mono
new QImage_FormatFormat_MonoLSBEnum constant QImage::Format_MonoLSB
new QImage_FormatFormat_RGB16Enum constant QImage::Format_RGB16
new QImage_FormatFormat_RGB32Enum constant QImage::Format_RGB32
new QImage_FormatFormat_RGB444Enum constant QImage::Format_RGB444
new QImage_FormatFormat_RGB555Enum constant QImage::Format_RGB555
new QImage_FormatFormat_RGB666Enum constant QImage::Format_RGB666
new QImage_FormatFormat_RGB888Enum constant QImage::Format_RGB888
new QImage_FormatNImageFormatsEnum constant QImage::NImageFormats

Detailed description

[const] bool ==(QImage_Format other)

Description: Compares the enum class against an enum of it's own type

[const] bool ==(unsigned int other)

Description: Compares the enum class against an integer

[static] new QImage_Format Format_ARGB32

Description: Enum constant QImage::Format_ARGB32

[static] new QImage_Format Format_ARGB32_Premultiplied

Description: Enum constant QImage::Format_ARGB32_Premultiplied

[static] new QImage_Format Format_ARGB4444_Premultiplied

Description: Enum constant QImage::Format_ARGB4444_Premultiplied

[static] new QImage_Format Format_ARGB6666_Premultiplied

Description: Enum constant QImage::Format_ARGB6666_Premultiplied

[static] new QImage_Format Format_ARGB8555_Premultiplied

Description: Enum constant QImage::Format_ARGB8555_Premultiplied

[static] new QImage_Format Format_ARGB8565_Premultiplied

Description: Enum constant QImage::Format_ARGB8565_Premultiplied

[static] new QImage_Format Format_Indexed8

Description: Enum constant QImage::Format_Indexed8

[static] new QImage_Format Format_Invalid

Description: Enum constant QImage::Format_Invalid

[static] new QImage_Format Format_Mono

Description: Enum constant QImage::Format_Mono

[static] new QImage_Format Format_MonoLSB

Description: Enum constant QImage::Format_MonoLSB

[static] new QImage_Format Format_RGB16

Description: Enum constant QImage::Format_RGB16

[static] new QImage_Format Format_RGB32

Description: Enum constant QImage::Format_RGB32

[static] new QImage_Format Format_RGB444

Description: Enum constant QImage::Format_RGB444

[static] new QImage_Format Format_RGB555

Description: Enum constant QImage::Format_RGB555

[static] new QImage_Format Format_RGB666

Description: Enum constant QImage::Format_RGB666

[static] new QImage_Format Format_RGB888

Description: Enum constant QImage::Format_RGB888

[static] new QImage_Format NImageFormats

Description: Enum constant QImage::NImageFormats

[const] void assign(const QImage_Format other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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.

void destroy

Description: Explicitly destroy the object

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

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

[const] QImage_Format dup

Description: Creates a copy of self

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

[static] new QImage_Format new(unsigned int arg1)

Description: Creates the enum object from an integer

[const] unsigned int to_i

Description: Converts the enum class to an integer

[const] string to_s

Description: Converts the enum class to a string