API reference - Class QColormap

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QColormap

Sub-classes: Mode, QFlags_Mode

Public constructors

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

Public methods

void_assign(const QColormap other)Assigns another object 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.
QColormapassign(const QColormap colormap)Method QColormap &QColormap::operator=(const QColormap &colormap)
[const]QColorcolorAt(unsigned int pixel)Method const QColor QColormap::colorAt(unsigned int pixel)
[const][]colormapMethod const QVector<QColor> QColormap::colormap()
[const]intdepthMethod int QColormap::depth()
[const]new QColormap ptrdupCreates a copy of self
[const]QColormap_ModemodeMethod QColormap::Mode QColormap::mode()
[const]unsigned intpixel(const QColor color)Method unsigned int QColormap::pixel(const QColor &color)
[const]intsizeMethod int QColormap::size()

Public static methods and constants

[static,const]QColormap_ModeDirectEnum constant QColormap::Direct
[static,const]QColormap_ModeGrayEnum constant QColormap::Gray
[static,const]QColormap_ModeIndexedEnum constant QColormap::Indexed
voidcleanupStatic method void QColormap::cleanup()
QColormapinstance(int screen = -1)Static method QColormap QColormap::instance(int screen)

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

Direct

Signature: [static,const] QColormap_Mode Direct

Description: Enum constant QColormap::Direct

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

Gray

Signature: [static,const] QColormap_Mode Gray

Description: Enum constant QColormap::Gray

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

Indexed

Signature: [static,const] QColormap_Mode Indexed

Description: Enum constant QColormap::Indexed

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

_assign

Signature: void _assign (const QColormap other)

Description: Assigns another object to self

_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: QColormap assign (const QColormap colormap)

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

cleanup

Signature: [static] void cleanup

Description: Static method void QColormap::cleanup()

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

colorAt

Signature: [const] QColor colorAt (unsigned int pixel)

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

colormap

Signature: [const] [] colormap

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

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.

depth

Signature: [const] int depth

Description: Method int QColormap::depth()

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

Description: Creates a copy of self

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

instance

Signature: [static] QColormap instance (int screen = -1)

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

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

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.

mode

Signature: [const] QColormap_Mode mode

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

new

Signature: [static] new QColormap new (const QColormap colormap)

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

This method creates an object of class QColormap.

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

pixel

Signature: [const] unsigned int pixel (const QColor color)

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

size

Signature: [const] int size

Description: Method int QColormap::size()

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