QColor¶

Inheritance diagram of QColor

Synopsis¶

Functions¶

def __eq__ (c)
def __ne__ (c)
def __reduce__ ()
def __repr__ ()
def __setstate__ (arg__1)
def __str__ ()
def alpha ()
def alphaF ()
def black ()
def blackF ()
def blue ()
def blueF ()
def convertTo (colorSpec)
def cyan ()
def cyanF ()
def darker ([f=200])
def getCmyk ()
def getCmykF ()
def getHsl ()
def getHslF ()
def getHsv ()
def getHsvF ()
def getRgb ()
def getRgbF ()
def green ()
def greenF ()
def hslHue ()
def hslHueF ()
def hslSaturation ()
def hslSaturationF ()
def hsvHue ()
def hsvHueF ()
def hsvSaturation ()
def hsvSaturationF ()
def hue ()
def hueF ()
def invalidate ()
def isValid ()
def lighter ([f=150])
def lightness ()
def lightnessF ()
def magenta ()
def magentaF ()
def name ()
def red ()
def redF ()
def rgb ()
def rgba ()
def saturation ()
def saturationF ()
def setAlpha (alpha)
def setAlphaF (alpha)
def setBlue (blue)
def setBlueF (blue)
def setCmyk (c, m, y, k[, a=255])
def setCmykF (c, m, y, k[, a=1.0])
def setColorFromString (name)
def setGreen (green)
def setGreenF (green)
def setHsl (h, s, l[, a=255])
def setHslF (h, s, l[, a=1.0])
def setHsv (h, s, v[, a=255])
def setHsvF (h, s, v[, a=1.0])
def setNamedColor (name)
def setRed (red)
def setRedF (red)
def setRgb (r, g, b[, a=255])
def setRgb (rgb)
def setRgbF (r, g, b[, a=1.0])
def setRgba (rgba)
def spec ()
def toCmyk ()
def toHsl ()
def toHsv ()
def toRgb ()
def toTuple ()
def value ()
def valueF ()
def yellow ()
def yellowF ()

Static functions¶

def allowX11ColorNames ()
def colorNames ()
def fromCmyk (c, m, y, k[, a=255])
def fromCmykF (c, m, y, k[, a=1.0])
def fromHsl (h, s, l[, a=255])
def fromHslF (h, s, l[, a=1.0])
def fromHsv (h, s, v[, a=255])
def fromHsvF (h, s, v[, a=1.0])
def fromRgb (r, g, b[, a=255])
def fromRgb (rgb)
def fromRgbF (r, g, b[, a=1.0])
def fromRgba (rgba)
def isValidColor (name)
def setAllowX11ColorNames (enabled)

Detailed Description¶

The PySide.QtGui.QColor class provides colors based on RGB, HSV or CMYK values.

A color is normally specified in terms of RGB (red, green, and blue) components, but it is also possible to specify it in terms of HSV (hue, saturation, and value) and CMYK (cyan, magenta, yellow and black) components. In addition a color can be specified using a color name. The color name can be any of the SVG 1.0 color names.

RGB HSV CMYK

The PySide.QtGui.QColor constructor creates the color based on RGB values. To create a PySide.QtGui.QColor based on either HSV or CMYK values, use the PySide.QtGui.QColor.toHsv() and PySide.QtGui.QColor.toCmyk() functions respectively. These functions return a copy of the color using the desired format. In addition the static PySide.QtGui.QColor.fromRgb() , PySide.QtGui.QColor.fromHsv() and PySide.QtGui.QColor.fromCmyk() functions create colors from the specified values. Alternatively, a color can be converted to any of the three formats using the PySide.QtGui.QColor.convertTo() function (returning a copy of the color in the desired format), or any of the PySide.QtGui.QColor.setRgb() , PySide.QtGui.QColor.setHsv() and PySide.QtGui.QColor.setCmyk() functions altering this color’s format. The PySide.QtGui.QColor.spec() function tells how the color was specified.

A color can be set by passing an RGB string (such as “#112233”), or a color name (such as “blue”), to the PySide.QtGui.QColor.setNamedColor() function. The color names are taken from the SVG 1.0 color names. The PySide.QtGui.QColor.name() function returns the name of the color in the format “#RRGGBB”. Colors can also be set using PySide.QtGui.QColor.setRgb() , PySide.QtGui.QColor.setHsv() and PySide.QtGui.QColor.setCmyk() . To get a lighter or darker color use the PySide.QtGui.QColor.lighter() and PySide.QtGui.QColor.darker() functions respectively.

The PySide.QtGui.QColor.isValid() function indicates whether a PySide.QtGui.QColor is legal at all. For example, a RGB color with RGB values out of range is illegal. For performance reasons, PySide.QtGui.QColor mostly disregards illegal colors, and for that reason, the result of using an invalid color is undefined.

The color components can be retrieved individually, e.g with PySide.QtGui.QColor.red() , PySide.QtGui.QColor.hue() and PySide.QtGui.QColor.cyan() . The values of the color components can also be retrieved in one go using the PySide.QtGui.QColor.getRgb() , PySide.QtGui.QColor.getHsv() and PySide.QtGui.QColor.getCmyk() functions. Using the RGB color model, the color components can in addition be accessed with PySide.QtGui.QColor.rgb() .

There are several related non-members: QRgb is a typdef for an unsigned int representing the RGB value triplet (r, g, b). Note that it also can hold a value for the alpha-channel (for more information, see the Alpha-Blended Drawing section). The qRed() , qBlue() and qGreen() functions return the respective component of the given QRgb value, while the qRgb() and qRgba() functions create and return the QRgb triplet based on the given component values. Finally, the qAlpha() function returns the alpha component of the provided QRgb , and the qGray() function calculates and return a gray value based on the given value.

PySide.QtGui.QColor is platform and device independent. The QColormap class maps the color to the hardware.

For more information about painting in general, see the Paint System documentation.

Integer vs. Floating Point Precision¶

PySide.QtGui.QColor supports floating point precision and provides floating point versions of all the color components functions, e.g. PySide.QtGui.QColor.getRgbF() , PySide.QtGui.QColor.hueF() and PySide.QtGui.QColor.fromCmykF() . Note that since the components are stored using 16-bit integers, there might be minor deviations between the values set using, for example, PySide.QtGui.QColor.setRgbF() and the values returned by the PySide.QtGui.QColor.getRgbF() function due to rounding.

While the integer based functions take values in the range 0-255 (except PySide.QtGui.QColor.hue() which must have values within the range 0-359), the floating point functions accept values in the range 0.0 - 1.0.

Alpha-Blended Drawing¶

PySide.QtGui.QColor also support alpha-blended outlining and filling. The alpha channel of a color specifies the transparency effect, 0 represents a fully transparent color, while 255 represents a fully opaque color. For example:
# Specify semi-transparent red
painter.setBrush(QColor(255, 0, 0, 127))
painter.drawRect(0, 0, self.width()/2, self.height())

# Specify semi-transparent blue
painter.setBrush(QColor(0, 0, 255, 127))
painter.drawRect(0, 0, self.width(), self.height()/2)
The code above produces the following output:

Alpha-blended drawing is supported on Windows, Mac OS X, and on X11 systems that have the X Render extension installed.

The alpha channel of a color can be retrieved and set using the PySide.QtGui.QColor.alpha() and PySide.QtGui.QColor.setAlpha() functions if its value is an integer, and PySide.QtGui.QColor.alphaF() and PySide.QtGui.QColor.setAlphaF() if its value is qreal (double). By default, the alpha-channel is set to 255 (opaque). To retrieve and set all the RGB color components (including the alpha-channel) in one go, use the PySide.QtGui.QColor.rgba() and PySide.QtGui.QColor.setRgba() functions.

Predefined Colors¶

There are 20 predefined QColors described by the Qt.GlobalColor enum, including black, white, primary and secondary colors, darker versions of these colors and three shades of gray. PySide.QtGui.QColor also recognizes a variety of color names; the static PySide.QtGui.QColor.colorNames() function returns a PySide.QtCore.QStringList color names that PySide.QtGui.QColor knows about.

Additionally, the Qt.color0 , Qt.color1 and Qt.transparent colors are used for special purposes.

Qt.color0 (zero pixel value) and Qt.color1 (non-zero pixel value) are special colors for drawing in QBitmaps. Painting with Qt.color0 sets the bitmap bits to 0 (transparent; i.e., background), and painting with Qt.color1 sets the bits to 1 (opaque; i.e., foreground).

Qt.transparent is used to indicate a transparent pixel. When painting with this value, a pixel value will be used that is appropriate for the underlying pixel format in use.

The HSV Color Model¶

The RGB model is hardware-oriented. Its representation is close to what most monitors show. In contrast, HSV represents color in a way more suited to the human perception of color. For example, the relationships “stronger than”, “darker than”, and “the opposite of” are easily expressed in HSV but are much harder to express in RGB.

HSV, like RGB, has three components:

H, for hue, is in the range 0 to 359 if the color is chromatic (not gray), or meaningless if it is gray. It represents degrees on the color wheel familiar to most people. Red is 0 (degrees), green is 120, and blue is 240.

S, for saturation, is in the range 0 to 255, and the bigger it is, the stronger the color is. Grayish colors have saturation near 0; very strong colors have saturation near 255.

V, for value, is in the range 0 to 255 and represents lightness or brightness of the color. 0 is black; 255 is as far from black as possible.

Here are some examples: pure red is H=0, S=255, V=255; a dark red, moving slightly towards the magenta, could be H=350 (equivalent to -10), S=255, V=180; a grayish light red could have H about 0 (say 350-359 or 0-10), S about 50-100, and S=255.

Qt returns a hue value of -1 for achromatic colors. If you pass a hue value that is too large, Qt forces it into range. Hue 360 or 720 is treated as 0; hue 540 is treated as 180.

In addition to the standard HSV model, Qt provides an alpha-channel to feature alpha-blended drawing .

The HSL Color Model¶

HSL is similar to HSV. Instead of value parameter from HSV, HSL has the lightness parameter. The lightness parameter goes from black to color and from color to white. If you go outside at the night its black or dark gray. At day its colorful but if you look in a really strong light a things they are going to white and wash out.

The CMYK Color Model¶

While the RGB and HSV color models are used for display on computer monitors, the CMYK model is used in the four-color printing process of printing presses and some hard-copy devices.

CMYK has four components, all in the range 0-255: cyan (C), magenta (M), yellow (Y) and black (K). Cyan, magenta and yellow are called subtractive colors; the CMYK color model creates color by starting with a white surface and then subtracting color by applying the appropriate components. While combining cyan, magenta and yellow gives the color black, subtracting one or more will yield any other color. When combined in various percentages, these three colors can create the entire spectrum of colors.

Mixing 100 percent of cyan, magenta and yellow does produce black, but the result is unsatisfactory since it wastes ink, increases drying time, and gives a muddy colour when printing. For that reason, black is added in professional printing to provide a solid black tone; hence the term ‘four color process’.

In addition to the standard CMYK model, Qt provides an alpha-channel to feature alpha-blended drawing .

See also

PySide.QtGui.QPalette PySide.QtGui.QBrush QApplication.setColorSpec()

class PySide.QtGui.QColor¶

class PySide.QtGui.QColor(arg__1)

class PySide.QtGui.QColor(color)

class PySide.QtGui.QColor(name)

class PySide.QtGui.QColor(r, g, b[, a=255])

class PySide.QtGui.QColor(rgb)

Parameters:	g – `PySide.QtCore.int` rgb – long r – `PySide.QtCore.int` a – `PySide.QtCore.int` name – unicode b – `PySide.QtCore.int` arg__1 – object color – `PySide.QtCore.Qt.GlobalColor`

Constructs an invalid color with the RGB value (0, 0, 0). An invalid color is a color that is not properly set up for the underlying window system.

The alpha value of an invalid color is unspecified.

See also

PySide.QtGui.QColor.isValid()

Constructs a color that is a copy of color .

See also

PySide.QtGui.QColor.isValid()

Constructs a named color in the same way as PySide.QtGui.QColor.setNamedColor() using the given name .

The color is left invalid if the name cannot be parsed.

Constructs a color with the RGB value r , g , b , and the alpha-channel (transparency) value of a .

The color is left invalid if any of the arguments are invalid.

PySide.QtGui.QColor.Spec¶

The type of color specified, either RGB, HSV, CMYK or HSL.

Constant	Description
QColor.Rgb
QColor.Hsv
QColor.Cmyk
QColor.Hsl
QColor.Invalid

PySide.QtGui.QColor.__reduce__()¶

Return type:	`PyObject`

PySide.QtGui.QColor.__repr__()¶

Return type:	`PyObject`

PySide.QtGui.QColor.__setstate__(arg__1)¶

Parameters:	arg__1 – `PyObject`
Return type:	`PyObject`

PySide.QtGui.QColor.__str__()¶

Return type:	`PyObject`

static PySide.QtGui.QColor.allowX11ColorNames()¶

Return type:	`PySide.QtCore.bool`

Returns true if PySide.QtGui.QColor.setNamedColor() is allowed to look up colors in the X11 color database. By default, this function returns false.

Note

This function is only available on the X11 platform.

PySide.QtGui.QColor.alpha()¶

Return type:	`PySide.QtCore.int`

Returns the alpha color component of this color.

PySide.QtGui.QColor.alphaF()¶

Return type:	`PySide.QtCore.qreal`

Returns the alpha color component of this color.

PySide.QtGui.QColor.black()¶

Return type:	`PySide.QtCore.int`

Returns the black color component of this color.

PySide.QtGui.QColor.blackF()¶

Return type:	`PySide.QtCore.qreal`

Returns the black color component of this color.

PySide.QtGui.QColor.blue()¶

Return type:	`PySide.QtCore.int`

Returns the blue color component of this color.

PySide.QtGui.QColor.blueF()¶

Return type:	`PySide.QtCore.qreal`

Returns the blue color component of this color.

static PySide.QtGui.QColor.colorNames()¶

Return type:	list of strings

Returns a PySide.QtCore.QStringList containing the color names Qt knows about.

See also

Predefined Colors

PySide.QtGui.QColor.convertTo(colorSpec)¶

Parameters:	colorSpec – `PySide.QtGui.QColor.Spec`
Return type:	`PySide.QtGui.QColor`

Creates a copy of this color in the format specified by colorSpec .

PySide.QtGui.QColor.cyan()¶

Return type:	`PySide.QtCore.int`

Returns the cyan color component of this color.

PySide.QtGui.QColor.cyanF()¶

Return type:	`PySide.QtCore.qreal`

Returns the cyan color component of this color.

PySide.QtGui.QColor.darker([f=200])¶

Parameters:	f – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QColor`

Returns a darker (or lighter) color, but does not change this object.

If the factor is greater than 100, this functions returns a darker color. Setting factor to 300 returns a color that has one-third the brightness. If the factor is less than 100, the return color is lighter, but we recommend using the PySide.QtGui.QColor.lighter() function for this purpose. If the factor is 0 or negative, the return value is unspecified.

The function converts the current RGB color to HSV, divides the value (V) component by factor and converts the color back to RGB.

static PySide.QtGui.QColor.fromCmyk(c, m, y, k[, a=255])¶

Parameters:	c – `PySide.QtCore.int` m – `PySide.QtCore.int` y – `PySide.QtCore.int` k – `PySide.QtCore.int` a – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QColor`

Static convenience function that returns a PySide.QtGui.QColor constructed from the given CMYK color values: c (cyan), m (magenta), y (yellow), k (black), and a (alpha-channel, i.e. transparency).

All the values must be in the range 0-255.

static PySide.QtGui.QColor.fromCmykF(c, m, y, k[, a=1.0])¶

Parameters:	c – `PySide.QtCore.qreal` m – `PySide.QtCore.qreal` y – `PySide.QtCore.qreal` k – `PySide.QtCore.qreal` a – `PySide.QtCore.qreal`
Return type:	`PySide.QtGui.QColor`

This is an overloaded function.

Static convenience function that returns a PySide.QtGui.QColor constructed from the given CMYK color values: c (cyan), m (magenta), y (yellow), k (black), and a (alpha-channel, i.e. transparency).

All the values must be in the range 0.0-1.0.

static PySide.QtGui.QColor.fromHsl(h, s, l[, a=255])¶

Parameters:	h – `PySide.QtCore.int` s – `PySide.QtCore.int` l – `PySide.QtCore.int` a – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QColor`

Static convenience function that returns a PySide.QtGui.QColor constructed from the HSV color values, h (hue), s (saturation), l (lightness), and a (alpha-channel, i.e. transparency).

The value of s , l , and a must all be in the range 0-255; the value of h must be in the range 0-359.

static PySide.QtGui.QColor.fromHslF(h, s, l[, a=1.0])¶

Parameters:	h – `PySide.QtCore.qreal` s – `PySide.QtCore.qreal` l – `PySide.QtCore.qreal` a – `PySide.QtCore.qreal`
Return type:	`PySide.QtGui.QColor`

This is an overloaded function.

Static convenience function that returns a PySide.QtGui.QColor constructed from the HSV color values, h (hue), s (saturation), l (lightness), and a (alpha-channel, i.e. transparency).

All the values must be in the range 0.0-1.0.

static PySide.QtGui.QColor.fromHsv(h, s, v[, a=255])¶

Parameters:	h – `PySide.QtCore.int` s – `PySide.QtCore.int` v – `PySide.QtCore.int` a – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QColor`

Static convenience function that returns a PySide.QtGui.QColor constructed from the HSV color values, h (hue), s (saturation), v (value), and a (alpha-channel, i.e. transparency).

The value of s , v , and a must all be in the range 0-255; the value of h must be in the range 0-359.

static PySide.QtGui.QColor.fromHsvF(h, s, v[, a=1.0])¶

Parameters:	h – `PySide.QtCore.qreal` s – `PySide.QtCore.qreal` v – `PySide.QtCore.qreal` a – `PySide.QtCore.qreal`
Return type:	`PySide.QtGui.QColor`

This is an overloaded function.

Static convenience function that returns a PySide.QtGui.QColor constructed from the HSV color values, h (hue), s (saturation), v (value), and a (alpha-channel, i.e. transparency).

All the values must be in the range 0.0-1.0.

static PySide.QtGui.QColor.fromRgb(r, g, b[, a=255])¶

Parameters:	r – `PySide.QtCore.int` g – `PySide.QtCore.int` b – `PySide.QtCore.int` a – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QColor`

Static convenience function that returns a PySide.QtGui.QColor constructed from the RGB color values, r (red), g (green), b (blue), and a (alpha-channel, i.e. transparency).

All the values must be in the range 0-255.

static PySide.QtGui.QColor.fromRgb(rgb)

Parameters:	rgb – long
Return type:	`PySide.QtGui.QColor`

static PySide.QtGui.QColor.fromRgbF(r, g, b[, a=1.0])¶

Parameters:	r – `PySide.QtCore.qreal` g – `PySide.QtCore.qreal` b – `PySide.QtCore.qreal` a – `PySide.QtCore.qreal`
Return type:	`PySide.QtGui.QColor`

Static convenience function that returns a PySide.QtGui.QColor constructed from the RGB color values, r (red), g (green), b (blue), and a (alpha-channel, i.e. transparency).

All the values must be in the range 0.0-1.0.

static PySide.QtGui.QColor.fromRgba(rgba)¶

Parameters:	rgba – long
Return type:	`PySide.QtGui.QColor`

PySide.QtGui.QColor.getCmyk()¶

Sets the contents pointed to by c , m , y , k , and a , to the cyan, magenta, yellow, black, and alpha-channel (transparency) components of the color’s CMYK value.

These components can be retrieved individually using the PySide.QtGui.QColor.cyan() , PySide.QtGui.QColor.magenta() , PySide.QtGui.QColor.yellow() , PySide.QtGui.QColor.black() and PySide.QtGui.QColor.alpha() functions.

See also

PySide.QtGui.QColor.setCmyk() The CMYK Color Model

PySide.QtGui.QColor.getCmykF()¶

Sets the contents pointed to by c , m , y , k , and a , to the cyan, magenta, yellow, black, and alpha-channel (transparency) components of the color’s CMYK value.

These components can be retrieved individually using the PySide.QtGui.QColor.cyanF() , PySide.QtGui.QColor.magentaF() , PySide.QtGui.QColor.yellowF() , PySide.QtGui.QColor.blackF() and PySide.QtGui.QColor.alphaF() functions.

See also

PySide.QtGui.QColor.setCmykF() The CMYK Color Model

PySide.QtGui.QColor.getHsl()¶

Sets the contents pointed to by h , s , l , and a , to the hue, saturation, lightness, and alpha-channel (transparency) components of the color’s HSL value.

These components can be retrieved individually using the hueHsl(), saturationHsl(), PySide.QtGui.QColor.lightness() and PySide.QtGui.QColor.alpha() functions.

See also

PySide.QtGui.QColor.setHsl()

PySide.QtGui.QColor.getHslF()¶

Sets the contents pointed to by h , s , l , and a , to the hue, saturation, lightness, and alpha-channel (transparency) components of the color’s HSL value.

These components can be retrieved individually using the hueHslF(), saturationHslF(), PySide.QtGui.QColor.lightnessF() and PySide.QtGui.QColor.alphaF() functions.

See also

PySide.QtGui.QColor.setHsl()

PySide.QtGui.QColor.getHsv()¶

Sets the contents pointed to by h , s , v , and a , to the hue, saturation, value, and alpha-channel (transparency) components of the color’s HSV value.

These components can be retrieved individually using the PySide.QtGui.QColor.hue() , PySide.QtGui.QColor.saturation() , PySide.QtGui.QColor.value() and PySide.QtGui.QColor.alpha() functions.

See also

PySide.QtGui.QColor.setHsv() The HSV Color Model

PySide.QtGui.QColor.getHsvF()¶

Sets the contents pointed to by h , s , v , and a , to the hue, saturation, value, and alpha-channel (transparency) components of the color’s HSV value.

These components can be retrieved individually using the PySide.QtGui.QColor.hueF() , PySide.QtGui.QColor.saturationF() , PySide.QtGui.QColor.valueF() and PySide.QtGui.QColor.alphaF() functions.

See also

PySide.QtGui.QColor.setHsv() The HSV Color Model

PySide.QtGui.QColor.getRgb()¶

Sets the contents pointed to by r , g , b , and a , to the red, green, blue, and alpha-channel (transparency) components of the color’s RGB value.

These components can be retrieved individually using the PySide.QtGui.QColor.red() , PySide.QtGui.QColor.green() , PySide.QtGui.QColor.blue() and PySide.QtGui.QColor.alpha() functions.

PySide.QtGui.QColor.getRgbF()¶

Sets the contents pointed to by r , g , b , and a , to the red, green, blue, and alpha-channel (transparency) components of the color’s RGB value.

These components can be retrieved individually using the PySide.QtGui.QColor.redF() , PySide.QtGui.QColor.greenF() , PySide.QtGui.QColor.blueF() and PySide.QtGui.QColor.alphaF() functions.

PySide.QtGui.QColor.green()¶

Return type:	`PySide.QtCore.int`

Returns the green color component of this color.

PySide.QtGui.QColor.greenF()¶

Return type:	`PySide.QtCore.qreal`

Returns the green color component of this color.

PySide.QtGui.QColor.hslHue()¶

Return type:	`PySide.QtCore.int`

Returns the hue color component of this color.

PySide.QtGui.QColor.hslHueF()¶

Return type:	`PySide.QtCore.qreal`

Returns the hue color component of this color.

PySide.QtGui.QColor.hslSaturation()¶

Return type:	`PySide.QtCore.int`

Returns the saturation color component of this color.

PySide.QtGui.QColor.hslSaturationF()¶

Return type:	`PySide.QtCore.qreal`

Returns the saturation color component of this color.

PySide.QtGui.QColor.hsvHue()¶

Return type:	`PySide.QtCore.int`

Returns the hue color component of this color.

PySide.QtGui.QColor.hsvHueF()¶

Return type:	`PySide.QtCore.qreal`

Returns the hue color component of this color.

PySide.QtGui.QColor.hsvSaturation()¶

Return type:	`PySide.QtCore.int`

Returns the saturation color component of this color.

PySide.QtGui.QColor.hsvSaturationF()¶

Return type:	`PySide.QtCore.qreal`

Returns the saturation color component of this color.

PySide.QtGui.QColor.hue()¶

Return type:	`PySide.QtCore.int`

Returns the hue color component of this color.

The color is implicitly converted to HSV.

PySide.QtGui.QColor.hueF()¶

Return type:	`PySide.QtCore.qreal`

Returns the hue color component of this color.

The color is implicitly converted to HSV.

PySide.QtGui.QColor.invalidate()¶

PySide.QtGui.QColor.isValid()¶

Return type:	`PySide.QtCore.bool`

Returns true if the color is valid; otherwise returns false.

static PySide.QtGui.QColor.isValidColor(name)¶

Parameters:	name – unicode
Return type:	`PySide.QtCore.bool`

Returns true if the name is a valid color name and can be used to construct a valid PySide.QtGui.QColor object, otherwise returns false.

It uses the same algorithm used in PySide.QtGui.QColor.setNamedColor() .

See also

PySide.QtGui.QColor.setNamedColor()

PySide.QtGui.QColor.lighter([f=150])¶

Parameters:	f – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QColor`

Returns a lighter (or darker) color, but does not change this object.

If the factor is greater than 100, this functions returns a lighter color. Setting factor to 150 returns a color that is 50% brighter. If the factor is less than 100, the return color is darker, but we recommend using the PySide.QtGui.QColor.darker() function for this purpose. If the factor is 0 or negative, the return value is unspecified.

The function converts the current RGB color to HSV, multiplies the value (V) component by factor and converts the color back to RGB.

PySide.QtGui.QColor.lightness()¶

Return type:	`PySide.QtCore.int`

Returns the lightness color component of this color.

PySide.QtGui.QColor.lightnessF()¶

Return type:	`PySide.QtCore.qreal`

Returns the lightness color component of this color.

PySide.QtGui.QColor.magenta()¶

Return type:	`PySide.QtCore.int`

Returns the magenta color component of this color.

PySide.QtGui.QColor.magentaF()¶

Return type:	`PySide.QtCore.qreal`

Returns the magenta color component of this color.

PySide.QtGui.QColor.name()¶

Return type:	unicode

Returns the name of the color in the format “#RRGGBB”; i.e. a “#” character followed by three two-digit hexadecimal numbers.

See also

PySide.QtGui.QColor.setNamedColor()

PySide.QtGui.QColor.__ne__(c)¶

Parameters:	c – `PySide.QtGui.QColor`
Return type:	`PySide.QtCore.bool`

Returns true if this color has a different RGB and alpha values from color ; otherwise returns false.

PySide.QtGui.QColor.__eq__(c)¶

Parameters:	c – `PySide.QtGui.QColor`
Return type:	`PySide.QtCore.bool`

Returns true if this color has the same RGB and alpha values as color ; otherwise returns false.

PySide.QtGui.QColor.red()¶

Return type:	`PySide.QtCore.int`

Returns the red color component of this color.

PySide.QtGui.QColor.redF()¶

Return type:	`PySide.QtCore.qreal`

Returns the red color component of this color.

PySide.QtGui.QColor.rgb()¶

Return type:	long

Returns the RGB value of the color. The alpha value is opaque.

PySide.QtGui.QColor.rgba()¶

Return type:	long

Returns the RGB value of the color, including its alpha.

For an invalid color, the alpha value of the returned color is unspecified.

PySide.QtGui.QColor.saturation()¶

Return type:	`PySide.QtCore.int`

Returns the saturation color component of this color.

The color is implicitly converted to HSV.

PySide.QtGui.QColor.saturationF()¶

Return type:	`PySide.QtCore.qreal`

Returns the saturation color component of this color.

The color is implicitly converted to HSV.

static PySide.QtGui.QColor.setAllowX11ColorNames(enabled)¶

Parameters:	enabled – `PySide.QtCore.bool`

Allow PySide.QtGui.QColor.setNamedColor() to look up colors in the X11 color database if enabled . By default, PySide.QtGui.QColor.setNamedColor() does not look up colors in the X11 color database.

Note

This function is only available on the X11 platform.

PySide.QtGui.QColor.setAlpha(alpha)¶

Parameters:	alpha – `PySide.QtCore.int`

Sets the alpha of this color to alpha . Integer alpha is specified in the range 0-255.

PySide.QtGui.QColor.setAlphaF(alpha)¶

Parameters:	alpha – `PySide.QtCore.qreal`

Sets the alpha of this color to alpha . qreal alpha is specified in the range 0.0-1.0.

PySide.QtGui.QColor.setBlue(blue)¶

Parameters:	blue – `PySide.QtCore.int`

Sets the blue color component of this color to blue . Integer components are specified in the range 0-255.

PySide.QtGui.QColor.setBlueF(blue)¶

Parameters:	blue – `PySide.QtCore.qreal`

Sets the blue color component of this color to blue . Float components are specified in the range 0.0-1.0.

PySide.QtGui.QColor.setCmyk(c, m, y, k[, a=255])¶

Parameters:	c – `PySide.QtCore.int` m – `PySide.QtCore.int` y – `PySide.QtCore.int` k – `PySide.QtCore.int` a – `PySide.QtCore.int`

Sets the color to CMYK values, c (cyan), m (magenta), y (yellow), k (black), and a (alpha-channel, i.e. transparency).

All the values must be in the range 0-255.

PySide.QtGui.QColor.setCmykF(c, m, y, k[, a=1.0])¶

Parameters:	c – `PySide.QtCore.qreal` m – `PySide.QtCore.qreal` y – `PySide.QtCore.qreal` k – `PySide.QtCore.qreal` a – `PySide.QtCore.qreal`

This is an overloaded function.

Sets the color to CMYK values, c (cyan), m (magenta), y (yellow), k (black), and a (alpha-channel, i.e. transparency).

All the values must be in the range 0.0-1.0.

PySide.QtGui.QColor.setColorFromString(name)¶

Parameters:	name – unicode
Return type:	`PySide.QtCore.bool`

PySide.QtGui.QColor.setGreen(green)¶

Parameters:	green – `PySide.QtCore.int`

Sets the green color component of this color to green . Integer components are specified in the range 0-255.

PySide.QtGui.QColor.setGreenF(green)¶

Parameters:	green – `PySide.QtCore.qreal`

Sets the green color component of this color to green . Float components are specified in the range 0.0-1.0.

PySide.QtGui.QColor.setHsl(h, s, l[, a=255])¶

Parameters:	h – `PySide.QtCore.int` s – `PySide.QtCore.int` l – `PySide.QtCore.int` a – `PySide.QtCore.int`

Sets a HSL color value; h is the hue, s is the saturation, l is the lightness and a is the alpha component of the HSL color.

The saturation, value and alpha-channel values must be in the range 0-255, and the hue value must be greater than -1.

PySide.QtGui.QColor.setHslF(h, s, l[, a=1.0])¶

Parameters:	h – `PySide.QtCore.qreal` s – `PySide.QtCore.qreal` l – `PySide.QtCore.qreal` a – `PySide.QtCore.qreal`

Sets a HSL color lightness; h is the hue, s is the saturation, l is the lightness and a is the alpha component of the HSL color.

All the values must be in the range 0.0-1.0.

PySide.QtGui.QColor.setHsv(h, s, v[, a=255])¶

Parameters:	h – `PySide.QtCore.int` s – `PySide.QtCore.int` v – `PySide.QtCore.int` a – `PySide.QtCore.int`

Sets a HSV color value; h is the hue, s is the saturation, v is the value and a is the alpha component of the HSV color.

The saturation, value and alpha-channel values must be in the range 0-255, and the hue value must be greater than -1.

See also

hsv() PySide.QtGui.QColor.getHsv() PySide.QtGui.QColor.setHsvF() The HSV Color Model

PySide.QtGui.QColor.setHsvF(h, s, v[, a=1.0])¶

Parameters:	h – `PySide.QtCore.qreal` s – `PySide.QtCore.qreal` v – `PySide.QtCore.qreal` a – `PySide.QtCore.qreal`

Sets a HSV color value; h is the hue, s is the saturation, v is the value and a is the alpha component of the HSV color.

All the values must be in the range 0.0-1.0.

PySide.QtGui.QColor.setNamedColor(name)¶

Parameters:	name – unicode

Sets the RGB value of this PySide.QtGui.QColor to name , which may be in one of these formats:

#RGB (each of R, G, and B is a single hex digit)
#RRGGBB
#RRRGGGBBB
#RRRRGGGGBBBB
A name from the list of colors defined in the list of SVG color keyword names provided by the World Wide Web Consortium; for example, “steelblue” or “gainsboro”. These color names work on all platforms. Note that these color names are not the same as defined by the Qt.GlobalColor enums, e.g. “green” and Qt.green does not refer to the same color.
transparent - representing the absence of a color.
X11 only: If PySide.QtGui.QColor.allowX11ColorNames() returns true, any valid X11 color name. See the documentation for XParseColor() for information about valid X11 color names.

The color is invalid if name cannot be parsed.

PySide.QtGui.QColor.setRed(red)¶

Parameters:	red – `PySide.QtCore.int`

Sets the red color component of this color to red . Integer components are specified in the range 0-255.

PySide.QtGui.QColor.setRedF(red)¶

Parameters:	red – `PySide.QtCore.qreal`

Sets the red color component of this color to red . Float components are specified in the range 0.0-1.0.

PySide.QtGui.QColor.setRgb(rgb)¶

Parameters:	rgb – long

PySide.QtGui.QColor.setRgb(r, g, b[, a=255])

Parameters:	r – `PySide.QtCore.int` g – `PySide.QtCore.int` b – `PySide.QtCore.int` a – `PySide.QtCore.int`

Sets the RGB value to r , g , b and the alpha value to a .

All the values must be in the range 0-255.

PySide.QtGui.QColor.setRgbF(r, g, b[, a=1.0])¶

Parameters:	r – `PySide.QtCore.qreal` g – `PySide.QtCore.qreal` b – `PySide.QtCore.qreal` a – `PySide.QtCore.qreal`

Sets the color channels of this color to r (red), g (green), b (blue) and a (alpha, transparency).

All values must be in the range 0.0-1.0.

PySide.QtGui.QColor.setRgba(rgba)¶

Parameters:	rgba – long

PySide.QtGui.QColor.spec()¶

Return type:	`PySide.QtGui.QColor.Spec`

Returns how the color was specified.

PySide.QtGui.QColor.toCmyk()¶

Return type:	`PySide.QtGui.QColor`

Creates and returns a CMYK PySide.QtGui.QColor based on this color.

PySide.QtGui.QColor.toHsl()¶

Return type:	`PySide.QtGui.QColor`

Creates and returns an HSL PySide.QtGui.QColor based on this color.

PySide.QtGui.QColor.toHsv()¶

Return type:	`PySide.QtGui.QColor`

Creates and returns an HSV PySide.QtGui.QColor based on this color.

PySide.QtGui.QColor.toRgb()¶

Return type:	`PySide.QtGui.QColor`

Create and returns an RGB PySide.QtGui.QColor based on this color.

PySide.QtGui.QColor.toTuple()¶

Return type:	`PyObject`

PySide.QtGui.QColor.value()¶

Return type:	`PySide.QtCore.int`

Returns the value color component of this color.

PySide.QtGui.QColor.valueF()¶

Return type:	`PySide.QtCore.qreal`

Returns the value color component of this color.

PySide.QtGui.QColor.yellow()¶

Return type:	`PySide.QtCore.int`

Returns the yellow color component of this color.

PySide.QtGui.QColor.yellowF()¶

Return type:	`PySide.QtCore.qreal`

Returns the yellow color component of this color.

Table Of Contents

Previous topic

Next topic

QColor¶

Synopsis¶

Functions¶

Static functions¶

Detailed Description¶

Integer vs. Floating Point Precision¶

Alpha-Blended Drawing¶

Predefined Colors¶

The HSV Color Model¶

The HSL Color Model¶

The CMYK Color Model¶

Table Of Contents

Previous topic

Next topic

Quick search

QColor¶

Synopsis¶

Functions¶

Static functions¶

Detailed Description¶

Integer vs. Floating Point Precision¶

Alpha-Blended Drawing¶

Predefined Colors¶

The HSV Color Model¶

The HSL Color Model¶

The CMYK Color Model¶