API reference - Class QColor

!=

Signature: [const] bool != (const QColor c)

Description: Method bool QColor::operator!=(const QColor &c)

==

Signature: [const] bool == (const QColor c)

Description: Method bool QColor::operator==(const QColor &c)

Cmyk

Signature: [static,const] QColor_Spec Cmyk

Description: Enum constant QColor::Cmyk

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

HexArgb

Signature: [static,const] QColor_NameFormat HexArgb

Description: Enum constant QColor::HexArgb

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

HexRgb

Signature: [static,const] QColor_NameFormat HexRgb

Description: Enum constant QColor::HexRgb

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

Hsl

Signature: [static,const] QColor_Spec Hsl

Description: Enum constant QColor::Hsl

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

Hsv

Signature: [static,const] QColor_Spec Hsv

Description: Enum constant QColor::Hsv

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

Invalid

Signature: [static,const] QColor_Spec Invalid

Description: Enum constant QColor::Invalid

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

Rgb

Signature: [static,const] QColor_Spec Rgb

Description: Enum constant QColor::Rgb

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

_assign

Signature: void _assign (const QColor other)

Description: Assigns another object to self

_const_cast

Signature: [const] QColor 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.

alpha

Signature: [const] int alpha

Description: Method int QColor::alpha()

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

alpha=

Signature: void alpha= (int alpha)

Description: Method void QColor::setAlpha(int alpha)

Python specific notes:
The object exposes a writable attribute 'alpha'. This is the setter.

alphaF

Signature: [const] double alphaF

Description: Method double QColor::alphaF()

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

alphaF=

Signature: void alphaF= (double alpha)

Description: Method void QColor::setAlphaF(double alpha)

Python specific notes:
The object exposes a writable attribute 'alphaF'. This is the setter.

assign

(1) Signature: QColor assign (const QColor arg1)

Description: Method QColor &QColor::operator=(const QColor &)

(2) Signature: QColor assign (const Qt_GlobalColor color)

Description: Method QColor &QColor::operator=(Qt::GlobalColor color)

black

Signature: [const] int black

Description: Method int QColor::black()

blackF

Signature: [const] double blackF

Description: Method double QColor::blackF()

blue

Signature: [const] int blue

Description: Method int QColor::blue()

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

blue=

Signature: void blue= (int blue)

Description: Method void QColor::setBlue(int blue)

Python specific notes:
The object exposes a writable attribute 'blue'. This is the setter.

blueF

Signature: [const] double blueF

Description: Method double QColor::blueF()

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

blueF=

Signature: void blueF= (double blue)

Description: Method void QColor::setBlueF(double blue)

Python specific notes:
The object exposes a writable attribute 'blueF'. This is the setter.

colorNames

Signature: [static] string[] colorNames

Description: Static method QStringList QColor::colorNames()

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

convertTo

Signature: [const] QColor convertTo (const QColor_Spec colorSpec)

Description: Method QColor QColor::convertTo(QColor::Spec colorSpec)

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.

cyan

Signature: [const] int cyan

Description: Method int QColor::cyan()

cyanF

Signature: [const] double cyanF

Description: Method double QColor::cyanF()

dark

Signature: [const] QColor dark (int f = 200)

Description: Method QColor QColor::dark(int f)

darker

Signature: [const] QColor darker (int f = 200)

Description: Method QColor QColor::darker(int f)

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

Description: Creates a copy of self

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

fromCmyk

Signature: [static] QColor fromCmyk (int c, int m, int y, int k, int a = 255)

Description: Static method QColor QColor::fromCmyk(int c, int m, int y, int k, int a)

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

fromCmykF

Signature: [static] QColor fromCmykF (double c, double m, double y, double k, double a = 1.0)

Description: Static method QColor QColor::fromCmykF(double c, double m, double y, double k, double a)

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

fromHsl

Signature: [static] QColor fromHsl (int h, int s, int l, int a = 255)

Description: Static method QColor QColor::fromHsl(int h, int s, int l, int a)

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

fromHslF

Signature: [static] QColor fromHslF (double h, double s, double l, double a = 1.0)

Description: Static method QColor QColor::fromHslF(double h, double s, double l, double a)

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

fromHsv

Signature: [static] QColor fromHsv (int h, int s, int v, int a = 255)

Description: Static method QColor QColor::fromHsv(int h, int s, int v, int a)

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

fromHsvF

Signature: [static] QColor fromHsvF (double h, double s, double v, double a = 1.0)

Description: Static method QColor QColor::fromHsvF(double h, double s, double v, double a)

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

fromRgb

(1) Signature: [static] QColor fromRgb (unsigned int rgb)

Description: Static method QColor QColor::fromRgb(unsigned int rgb)

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

(2) Signature: [static] QColor fromRgb (int r, int g, int b, int a = 255)

Description: Static method QColor QColor::fromRgb(int r, int g, int b, int a)

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

fromRgbF

Signature: [static] QColor fromRgbF (double r, double g, double b, double a = 1.0)

Description: Static method QColor QColor::fromRgbF(double r, double g, double b, double a)

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

fromRgba

Signature: [static] QColor fromRgba (unsigned int rgba)

Description: Static method QColor QColor::fromRgba(unsigned int rgba)

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

fromRgba64

(1) Signature: [static] QColor fromRgba64 (unsigned short r, unsigned short g, unsigned short b, unsigned short a = USHRT_MAX)

Description: Static method QColor QColor::fromRgba64(unsigned short int r, unsigned short int g, unsigned short int b, unsigned short int a)

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

(2) Signature: [static] QColor fromRgba64 (QRgba64 rgba)

Description: Static method QColor QColor::fromRgba64(QRgba64 rgba)

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

getCmyk

Signature: void getCmyk (int ptr c, int ptr m, int ptr y, int ptr k, int ptr a = nullptr)

Description: Method void QColor::getCmyk(int *c, int *m, int *y, int *k, int *a)

getCmykF

Signature: void getCmykF (double ptr c, double ptr m, double ptr y, double ptr k, double ptr a = nullptr)

Description: Method void QColor::getCmykF(double *c, double *m, double *y, double *k, double *a)

getHsl

Signature: [const] void getHsl (int ptr h, int ptr s, int ptr l, int ptr a = nullptr)

Description: Method void QColor::getHsl(int *h, int *s, int *l, int *a)

getHslF

Signature: [const] void getHslF (double ptr h, double ptr s, double ptr l, double ptr a = nullptr)

Description: Method void QColor::getHslF(double *h, double *s, double *l, double *a)

getHsv

Signature: [const] void getHsv (int ptr h, int ptr s, int ptr v, int ptr a = nullptr)

Description: Method void QColor::getHsv(int *h, int *s, int *v, int *a)

getHsvF

Signature: [const] void getHsvF (double ptr h, double ptr s, double ptr v, double ptr a = nullptr)

Description: Method void QColor::getHsvF(double *h, double *s, double *v, double *a)

getRgb

Signature: [const] void getRgb (int ptr r, int ptr g, int ptr b, int ptr a = nullptr)

Description: Method void QColor::getRgb(int *r, int *g, int *b, int *a)

getRgbF

Signature: [const] void getRgbF (double ptr r, double ptr g, double ptr b, double ptr a = nullptr)

Description: Method void QColor::getRgbF(double *r, double *g, double *b, double *a)

green

Signature: [const] int green

Description: Method int QColor::green()

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

green=

Signature: void green= (int green)

Description: Method void QColor::setGreen(int green)

Python specific notes:
The object exposes a writable attribute 'green'. This is the setter.

greenF

Signature: [const] double greenF

Description: Method double QColor::greenF()

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

greenF=

Signature: void greenF= (double green)

Description: Method void QColor::setGreenF(double green)

Python specific notes:
The object exposes a writable attribute 'greenF'. This is the setter.

hslHue

Signature: [const] int hslHue

Description: Method int QColor::hslHue()

hslHueF

Signature: [const] double hslHueF

Description: Method double QColor::hslHueF()

hslSaturation

Signature: [const] int hslSaturation

Description: Method int QColor::hslSaturation()

hslSaturationF

Signature: [const] double hslSaturationF

Description: Method double QColor::hslSaturationF()

hsvHue

Signature: [const] int hsvHue

Description: Method int QColor::hsvHue()

hsvHueF

Signature: [const] double hsvHueF

Description: Method double QColor::hsvHueF()

hsvSaturation

Signature: [const] int hsvSaturation

Description: Method int QColor::hsvSaturation()

hsvSaturationF

Signature: [const] double hsvSaturationF

Description: Method double QColor::hsvSaturationF()

hue

Signature: [const] int hue

Description: Method int QColor::hue()

hueF

Signature: [const] double hueF

Description: Method double QColor::hueF()

isValid?

Signature: [const] bool isValid?

Description: Method bool QColor::isValid()

isValidColor?

Signature: [static] bool isValidColor? (string name)

Description: Static method bool QColor::isValidColor(const QString &name)

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.

light

Signature: [const] QColor light (int f = 150)

Description: Method QColor QColor::light(int f)

lighter

Signature: [const] QColor lighter (int f = 150)

Description: Method QColor QColor::lighter(int f)

lightness

Signature: [const] int lightness

Description: Method int QColor::lightness()

lightnessF

Signature: [const] double lightnessF

Description: Method double QColor::lightnessF()

magenta

Signature: [const] int magenta

Description: Method int QColor::magenta()

magentaF

Signature: [const] double magentaF

Description: Method double QColor::magentaF()

name

(1) Signature: [const] string name

Description: Method QString QColor::name()

(2) Signature: [const] string name (const QColor_NameFormat format)

Description: Method QString QColor::name(QColor::NameFormat format)

new

(1) Signature: [static] new QColor new

Description: Constructor QColor::QColor()

This method creates an object of class QColor.

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

(2) Signature: [static] new QColor new (const Qt_GlobalColor color)

Description: Constructor QColor::QColor(Qt::GlobalColor color)

This method creates an object of class QColor.

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

(3) Signature: [static] new QColor new (int r, int g, int b, int a = 255)

Description: Constructor QColor::QColor(int r, int g, int b, int a)

This method creates an object of class QColor.

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

(4) Signature: [static] new QColor new (unsigned int rgb)

Description: Constructor QColor::QColor(unsigned int rgb)

This method creates an object of class QColor.

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

(5) Signature: [static] new QColor new (QRgba64 rgba64)

Description: Constructor QColor::QColor(QRgba64 rgba64)

This method creates an object of class QColor.

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

(6) Signature: [static] new QColor new (string aname)

Description: Constructor QColor::QColor(const char *aname)

This method creates an object of class QColor.

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

(7) Signature: [static] new QColor new (const QColor_Spec spec)

Description: Constructor QColor::QColor(QColor::Spec spec)

This method creates an object of class QColor.

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

(8) Signature: [static] new QColor new (const QColor color)

Description: Constructor QColor::QColor(const QColor &color)

This method creates an object of class QColor.

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

red

Signature: [const] int red

Description: Method int QColor::red()

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

red=

Signature: void red= (int red)

Description: Method void QColor::setRed(int red)

Python specific notes:
The object exposes a writable attribute 'red'. This is the setter.

redF

Signature: [const] double redF

Description: Method double QColor::redF()

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

redF=

Signature: void redF= (double red)

Description: Method void QColor::setRedF(double red)

Python specific notes:
The object exposes a writable attribute 'redF'. This is the setter.

rgb

Signature: [const] unsigned int rgb

Description: Method unsigned int QColor::rgb()

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

rgb=

Signature: void rgb= (unsigned int rgb)

Description: Method void QColor::setRgb(unsigned int rgb)

Python specific notes:
The object exposes a writable attribute 'rgb'. This is the setter.

rgba

Signature: [const] unsigned int rgba

Description: Method unsigned int QColor::rgba()

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

rgba64

Signature: [const] QRgba64 rgba64

Description: Method QRgba64 QColor::rgba64()

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

rgba64=

Signature: void rgba64= (QRgba64 rgba)

Description: Method void QColor::setRgba64(QRgba64 rgba)

Python specific notes:
The object exposes a writable attribute 'rgba64'. This is the setter.

rgba=

Signature: void rgba= (unsigned int rgba)

Description: Method void QColor::setRgba(unsigned int rgba)

Python specific notes:
The object exposes a writable attribute 'rgba'. This is the setter.

saturation

Signature: [const] int saturation

Description: Method int QColor::saturation()

saturationF

Signature: [const] double saturationF

Description: Method double QColor::saturationF()

setAlpha

Signature: void setAlpha (int alpha)

Description: Method void QColor::setAlpha(int alpha)

Python specific notes:
The object exposes a writable attribute 'alpha'. This is the setter.

setAlphaF

Signature: void setAlphaF (double alpha)

Description: Method void QColor::setAlphaF(double alpha)

Python specific notes:
The object exposes a writable attribute 'alphaF'. This is the setter.

setBlue

Signature: void setBlue (int blue)

Description: Method void QColor::setBlue(int blue)

Python specific notes:
The object exposes a writable attribute 'blue'. This is the setter.

setBlueF

Signature: void setBlueF (double blue)

Description: Method void QColor::setBlueF(double blue)

Python specific notes:
The object exposes a writable attribute 'blueF'. This is the setter.

setCmyk

Signature: void setCmyk (int c, int m, int y, int k, int a = 255)

Description: Method void QColor::setCmyk(int c, int m, int y, int k, int a)

setCmykF

Signature: void setCmykF (double c, double m, double y, double k, double a = 1.0)

Description: Method void QColor::setCmykF(double c, double m, double y, double k, double a)

setGreen

Signature: void setGreen (int green)

Description: Method void QColor::setGreen(int green)

Python specific notes:
The object exposes a writable attribute 'green'. This is the setter.

setGreenF

Signature: void setGreenF (double green)

Description: Method void QColor::setGreenF(double green)

Python specific notes:
The object exposes a writable attribute 'greenF'. This is the setter.

setHsl

Signature: void setHsl (int h, int s, int l, int a = 255)

Description: Method void QColor::setHsl(int h, int s, int l, int a)

setHslF

Signature: void setHslF (double h, double s, double l, double a = 1.0)

Description: Method void QColor::setHslF(double h, double s, double l, double a)

setHsv

Signature: void setHsv (int h, int s, int v, int a = 255)

Description: Method void QColor::setHsv(int h, int s, int v, int a)

setHsvF

Signature: void setHsvF (double h, double s, double v, double a = 1.0)

Description: Method void QColor::setHsvF(double h, double s, double v, double a)

setNamedColor

Signature: void setNamedColor (string name)

Description: Method void QColor::setNamedColor(const QString &name)

setRed

Signature: void setRed (int red)

Description: Method void QColor::setRed(int red)

Python specific notes:
The object exposes a writable attribute 'red'. This is the setter.

setRedF

Signature: void setRedF (double red)

Description: Method void QColor::setRedF(double red)

Python specific notes:
The object exposes a writable attribute 'redF'. This is the setter.

setRgb

(1) Signature: void setRgb (int r, int g, int b, int a = 255)

Description: Method void QColor::setRgb(int r, int g, int b, int a)

(2) Signature: void setRgb (unsigned int rgb)

Description: Method void QColor::setRgb(unsigned int rgb)

Python specific notes:
The object exposes a writable attribute 'rgb'. This is the setter.

setRgbF

Signature: void setRgbF (double r, double g, double b, double a = 1.0)

Description: Method void QColor::setRgbF(double r, double g, double b, double a)

setRgba

Signature: void setRgba (unsigned int rgba)

Description: Method void QColor::setRgba(unsigned int rgba)

Python specific notes:
The object exposes a writable attribute 'rgba'. This is the setter.

setRgba64

Signature: void setRgba64 (QRgba64 rgba)

Description: Method void QColor::setRgba64(QRgba64 rgba)

Python specific notes:
The object exposes a writable attribute 'rgba64'. This is the setter.

spec

Signature: [const] QColor_Spec spec

Description: Method QColor::Spec QColor::spec()

toCmyk

Signature: [const] QColor toCmyk

Description: Method QColor QColor::toCmyk()

toHsl

Signature: [const] QColor toHsl

Description: Method QColor QColor::toHsl()

toHsv

Signature: [const] QColor toHsv

Description: Method QColor QColor::toHsv()

toRgb

Signature: [const] QColor toRgb

Description: Method QColor QColor::toRgb()

value

Signature: [const] int value

Description: Method int QColor::value()

valueF

Signature: [const] double valueF

Description: Method double QColor::valueF()

yellow

Signature: [const] int yellow

Description: Method int QColor::yellow()

yellowF

Signature: [const] double yellowF

Description: Method double QColor::yellowF()