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

API reference - Class QColormap

Notation used in Ruby API documentation

Description: Binding of QColormap

Public constructors

new QColormapnew(const QColormap colormap)Constructor QColormap::QColormap(const QColormap &colormap)

Public methods

QColormapassign(const QColormap colormap)Method QColormap & QColormap::operator=(const QColormap &colormap)
[const]voidassign(const QColormap other)Assign the contents of another object to self
[const]QColorcolorAt(unsigned int pixel)Method const QColor QColormap::colorAt(int unsigned pixel)
[const]QColor[]colormapMethod const QVector<class QColor> QColormap::colormap()
voidcreateEnsures the C++ object is created
[const]intdepthMethod int QColormap::depth()
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QColormapdupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]QColormap_ModemodeMethod QColormap::Mode QColormap::mode()
[const]unsigned intpixel(const QColor color)Method int unsigned QColormap::pixel(const QColor &color)
[const]intsizeMethod int QColormap::size()

Public static methods and constants

QColormap_ModeDirectEnum constant enum QColormap::Direct
QColormap_ModeGrayEnum constant enum QColormap::Gray
QColormap_ModeIndexedEnum constant enum QColormap::Indexed
voidcleanupStatic method void QColormap::cleanup()
QColormapinstanceStatic method QColormap QColormap::instance(int screen)
QColormapinstance(int screen)Static method QColormap QColormap::instance(int screen)

Detailed description

[static] QColormap_Mode Direct

Description: Enum constant enum QColormap::Direct

[static] QColormap_Mode Gray

Description: Enum constant enum QColormap::Gray

[static] QColormap_Mode Indexed

Description: Enum constant enum QColormap::Indexed

QColormap assign(const QColormap colormap)

Description: Method QColormap & QColormap::operator=(const QColormap &colormap)

[const] void assign(const QColormap 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.

[static] void cleanup

Description: Static method void QColormap::cleanup()

This method is static and can be called without an instance.

[const] QColor colorAt(unsigned int pixel)

Description: Method const QColor QColormap::colorAt(int unsigned pixel)

[const] QColor[] colormap

Description: Method const QVector<class QColor> QColormap::colormap()

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.

[const] int depth

Description: Method int QColormap::depth()

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] QColormap dup

Description: Creates a copy of self

[static] QColormap instance

Description: Static method QColormap QColormap::instance(int screen)

This method is static and can be called without an instance.

[static] QColormap instance(int screen)

Description: Static method QColormap QColormap::instance(int screen)

This method is static and can be called without an instance.

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

[const] QColormap_Mode mode

Description: Method QColormap::Mode QColormap::mode()

[static] new QColormap new(const QColormap colormap)

Description: Constructor QColormap::QColormap(const QColormap &colormap)

This method creates an object of class QColormap.

[const] unsigned int pixel(const QColor color)

Description: Method int unsigned QColormap::pixel(const QColor &color)

[const] int size

Description: Method int QColormap::size()