~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.Color</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="prev" href="class-gdkcairocontext.html" title="gtk.gdk.CairoContext"><link rel="next" href="class-gdkcolormap.html" title="gtk.gdk.Colormap"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.gdk.Color</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkcairocontext.html">Prev</a> </td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gdkcolormap.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gdkcolor"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.Color</h2><p>gtk.gdk.Color — an object holding color information</p></div><div class="refsect1" lang="en"><a name="id2908877"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.Color</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):

<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.Color</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="prev" href="class-gdkcairocontext.html" title="gtk.gdk.CairoContext"><link rel="next" href="class-gdkcolormap.html" title="gtk.gdk.Colormap"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.gdk.Color</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkcairocontext.html">Prev</a> </td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gdkcolormap.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.gdk.Color"><a name="class-gdkcolor"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.Color</h2><p>gtk.gdk.Color — an object holding color information</p></div><div class="refsect1" title="Synopsis"><a name="id3339229"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.Color</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):

<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gdkcolor.html#constructor-gdkcolor" title="Constructor">gtk.gdk.Color</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>red</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>green</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>blue</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixel</code></strong></span><span class="initializer">=0</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkcolor.html#method-gdkcolor--to-string" title="gtk.gdk.Color.to_string">to_string</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><pre class="programlisting">

<span class="bold"><strong>Functions</strong></span>

<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkcolor.html#function-gdk--color-parse" title="gtk.gdk.color_parse">gtk.gdk.color_parse</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>spec</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkcolor.html#function-gdk--color-from-hsv" title="gtk.gdk.color_from_hsv">gtk.gdk.color_from_hsv</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hue</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>saturation</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id2908714"></a><h2>Attributes</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Floating-point and HSV attributes are available in PyGTK 2.16 and above.</p></div><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"pixel"</td><td valign="top">Read-Write</td><td valign="top">The pixel value of the color</td></tr><tr valign="top"><td valign="top">"red"</td><td valign="top">Read-Write</td><td valign="top">The value of the red component of the color</td></tr><tr valign="top"><td valign="top">"green"</td><td valign="top">Read-Write</td><td valign="top">The value of the green component of the color</td></tr><tr valign="top"><td valign="top">"blue"</td><td valign="top">Read-Write</td><td valign="top">The value of the blue component of the color</td></tr><tr valign="top"><td valign="top">"red_float"</td><td valign="top">Read-Write</td><td valign="top">The value of the red component of the color as a float in the range 0.0--1.0</td></tr><tr valign="top"><td valign="top">"green_float"</td><td valign="top">Read-Write</td><td valign="top">The value of the green component of the color as a float in the range 0.0--1.0</td></tr><tr valign="top"><td valign="top">"blue_float"</td><td valign="top">Read-Write</td><td valign="top">The value of the blue component of the color as a float in the range 0.0--1.0</td></tr><tr valign="top"><td valign="top">"hue"</td><td valign="top">Read</td><td valign="top">The hue (in HSV colorspace) of the color as a float in the range 0.0--1.0</td></tr><tr valign="top"><td valign="top">"saturation"</td><td valign="top">Read</td><td valign="top">The saturation (in HSV colorspace) of the color as a float in the range 0.0--1.0</td></tr><tr valign="top"><td valign="top">"value"</td><td valign="top">Read</td><td valign="top">The value (in HSV colorspace) of the color as a float in the range 0.0--1.0</td></tr></tbody></table></div></td></tr></table></div><p>For details on how assignment to <code class="literal">*_float</code> attributes work,

see <a class="link" href="class-gdkcolor.html#constructor-gdkcolor" title="Constructor">constructor documentation</a>.</p></div><div class="refsect1" lang="en"><a name="id3282923"></a><h2>Description</h2><p>A <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a>

<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkcolor.html#function-gdk--color-parse" title="gtk.gdk.color_parse">gtk.gdk.color_parse</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>spec</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkcolor.html#function-gdk--color-from-hsv" title="gtk.gdk.color_from_hsv">gtk.gdk.color_from_hsv</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hue</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>saturation</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>)</code></pre></div><div class="refsect1" title="Attributes"><a name="id3339045"></a><h2>Attributes</h2><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Floating-point and HSV attributes are available in PyGTK 2.16 and above.</p></div><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"pixel"</td><td valign="top">Read-Write</td><td valign="top">The pixel value of the color</td></tr><tr valign="top"><td valign="top">"red"</td><td valign="top">Read-Write</td><td valign="top">The value of the red component of the color</td></tr><tr valign="top"><td valign="top">"green"</td><td valign="top">Read-Write</td><td valign="top">The value of the green component of the color</td></tr><tr valign="top"><td valign="top">"blue"</td><td valign="top">Read-Write</td><td valign="top">The value of the blue component of the color</td></tr><tr valign="top"><td valign="top">"red_float"</td><td valign="top">Read-Write</td><td valign="top">The value of the red component of the color as a float in the range 0.0--1.0</td></tr><tr valign="top"><td valign="top">"green_float"</td><td valign="top">Read-Write</td><td valign="top">The value of the green component of the color as a float in the range 0.0--1.0</td></tr><tr valign="top"><td valign="top">"blue_float"</td><td valign="top">Read-Write</td><td valign="top">The value of the blue component of the color as a float in the range 0.0--1.0</td></tr><tr valign="top"><td valign="top">"hue"</td><td valign="top">Read</td><td valign="top">The hue (in HSV colorspace) of the color as a float in the range 0.0--1.0</td></tr><tr valign="top"><td valign="top">"saturation"</td><td valign="top">Read</td><td valign="top">The saturation (in HSV colorspace) of the color as a float in the range 0.0--1.0</td></tr><tr valign="top"><td valign="top">"value"</td><td valign="top">Read</td><td valign="top">The value (in HSV colorspace) of the color as a float in the range 0.0--1.0</td></tr></tbody></table></div></td></tr></table></div><p>For details on how assignment to <code class="literal">*_float</code> attributes work,

see <a class="link" href="class-gdkcolor.html#constructor-gdkcolor" title="Constructor">constructor documentation</a>.</p></div><div class="refsect1" title="Description"><a name="id3380403"></a><h2>Description</h2><p>A <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a>

contains the values of a color that may or may not be allocated. The red,

green and blue attributes are specified by an unsigned integer in the range

0-65535. The pixel value is an index into the colormap that has allocated

you could end with a computed value slightly larger than maximum or a little smaller

than minimum valid value. To simplify using new features, such "slightly off"

values are just clamped without any warning.

</p></div><div class="refsect1" lang="en"><a name="constructor-gdkcolor"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.gdk.Color</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>red</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>green</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>blue</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixel</code></strong></span><span class="initializer">=0</span></span>)</code></pre><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.gdk.Color</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>spec</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>red</code></strong> :</span></p></td><td>The red color component in the range

</p></div><div class="refsect1" title="Constructor"><a name="constructor-gdkcolor"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.gdk.Color</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>red</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>green</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>blue</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixel</code></strong></span><span class="initializer">=0</span></span>)</code></pre><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.gdk.Color</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>spec</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>red</code></strong> :</span></p></td><td>The red color component in the range

0-65535</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>green</code></strong> :</span></p></td><td>The green color component in the range

0-65535</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>blue</code></strong> :</span></p></td><td>The blue color component in the range

0-65535</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>pixel</code></strong> :</span></p></td><td>The index of the color when allocated in its

colormap</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>spec</code></strong> :</span></p></td><td>String containing color specification</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a>

object</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Second form of the constructor is available in PyGTK 2.14 and above.</p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p><em class="parameter"><code>red</code></em>, <em class="parameter"><code>green</code></em>

object</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Second form of the constructor is available in PyGTK 2.14 and above.</p></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p><em class="parameter"><code>red</code></em>, <em class="parameter"><code>green</code></em>

and <em class="parameter"><code>blue</code></em> can be floating-point numbers since PyGTK

2.16.</p></div><p>Creates a new <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a> object

with the color component values specified by <em class="parameter"><code>red</code></em>,

gtk.gdk.Color(0, 65535, 0)

gtk.gdk.Color(green=1.0)

gtk.gdk.Color('#0f0')

</pre></div><div class="refsect1" lang="en"><a name="id3282488"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gdkcolor--to-string"></a><h3>gtk.gdk.Color.to_string</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">to_string</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a string</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.12 and above.</p></div><p>

</pre></div><div class="refsect1" title="Methods"><a name="id3379972"></a><h2>Methods</h2><div class="refsect2" title="gtk.gdk.Color.to_string"><a name="method-gdkcolor--to-string"></a><h3>gtk.gdk.Color.to_string</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">to_string</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a string</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.12 and above.</p></div><p>

The <code class="methodname">to_string</code>() method returns a textual

specification of color in the hexadecimal form #rrrrggggbbbb,

where r, g and b are hex digits representing the red,

green and blue components respectively.

</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Starting with PyGTK 2.14 you can also

</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Starting with PyGTK 2.14 you can also

use <code class="literal">str(color)</code> code. However, that can return a

shorter (3, 6 or 12 hexadecimal digits) string if shorter version means

the same for the constructor.</p></div></div></div><div class="refsect1" lang="en"><a name="id2900454"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gdk--color-parse"></a><h3>gtk.gdk.color_parse</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.color_parse</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>spec</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>spec</code></strong> :</span></p></td><td>a string containing a color

the same for the constructor.</p></div></div></div><div class="refsect1" title="Functions"><a name="id3591196"></a><h2>Functions</h2><div class="refsect2" title="gtk.gdk.color_parse"><a name="function-gdk--color-parse"></a><h3>gtk.gdk.color_parse</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.color_parse</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>spec</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>spec</code></strong> :</span></p></td><td>a string containing a color

specification</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a>

object</td></tr></tbody></table><p>The <code class="function">gtk.gdk.color_parse</code>() method returns

the <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a>

For example the following specify the same color value: "#F0A", "#FF00AA",

"#FFF000AAA" and "#FFFF0000AAAA". The <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a> is

<span class="emphasis"><em>not</em></span> allocated.</p><p>This function raise the ValueError (TypeError prior to PyGTK

2.4) exception if unable to parse the color specification</p></div><div class="refsect2" lang="en"><a name="function-gdk--color-from-hsv"></a><h3>gtk.gdk.color_from_hsv</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.color_from_hsv</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hue</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>saturation</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>hue</code></strong> :</span></p></td><td>Hue of the desired color as a float in range

2.4) exception if unable to parse the color specification</p></div><div class="refsect2" title="gtk.gdk.color_from_hsv"><a name="function-gdk--color-from-hsv"></a><h3>gtk.gdk.color_from_hsv</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.color_from_hsv</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hue</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>saturation</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>hue</code></strong> :</span></p></td><td>Hue of the desired color as a float in range

0.0--1.0</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>saturation</code></strong> :</span></p></td><td>Saturation of the desired color as a float in range

0.0--1.0</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>value</code></strong> :</span></p></td><td>Value of the desired color as a float in range

0.0--1.0</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a>

object</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.16 and above.</p></div><p>The <code class="function">gtk.gdk.color_from_hsv</code>() method returns

object</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.16 and above.</p></div><p>The <code class="function">gtk.gdk.color_from_hsv</code>() method returns

the <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a>

specified by the HSV parameters. All three parameters are mandatory and should be

floats from 0.0 to 1.0. The range requirement, however, is not strict, see

Older »