blob: bfb1281902fe4f37e1a344545a0b01584611fff1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gdkcolormap">
<refnamediv>
<refname>gtk.gdk.Colormap</refname>
<refpurpose>a table of color display component values</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.gdk.Colormap</classname></ooclass>
<ooclass><classname><link
linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link
linkend="constructor-gdkcolormap">gtk.gdk.Colormap</link></methodname>
<methodparam><parameter
role="keyword">visual</parameter></methodparam>
<methodparam><parameter
role="keyword">allocate</parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gdkcolormap--alloc-color">alloc_color</link></methodname>
<methodparam><parameter
role="keyword">color</parameter></methodparam>
<methodparam><parameter
role="keyword">writeable</parameter>
<initializer>False</initializer></methodparam>
<methodparam><parameter
role="keyword">best_match</parameter>
<initializer>True</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gdkcolormap--alloc-color2">alloc_color</link></methodname>
<methodparam><parameter
role="keyword">spec</parameter></methodparam>
<methodparam><parameter
role="keyword">writeable</parameter>
<initializer>False</initializer></methodparam>
<methodparam><parameter
role="keyword">best_match</parameter>
<initializer>True</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gdkcolormap--alloc-color3">alloc_color</link></methodname>
<methodparam><parameter
role="keyword">red</parameter></methodparam>
<methodparam><parameter
role="keyword">green</parameter></methodparam>
<methodparam><parameter
role="keyword">blue</parameter></methodparam>
<methodparam><parameter
role="keyword">writeable</parameter>
<initializer>False</initializer></methodparam>
<methodparam><parameter
role="keyword">best_match</parameter>
<initializer>True</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gdkcolormap--get-visual">get_visual</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gdkcolormap--get-screen">get_screen</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gdkcolormap--query-color">query_color</link></methodname>
<methodparam><parameter role="keyword">pixel</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<programlisting>
<emphasis role="bold">Functions</emphasis>
<methodsynopsis language="python">
<methodname><link linkend="function-gdk--colormap-get-system">gtk.gdk.colormap_get_system</link></methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gdkcolormap">gtk.gdk.Colormap</link>
</synopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>A <link
linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
contains a table mapping index values to the RGB color component values used
to display the colors. The index value corresponds to the pixel value of a
<link linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
object and the RGB component values correspond to the <link
linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> red,
green and blue values. The <link
linkend="method-gtkwidget--get-colormap"><methodname>gtk.Widget.get_colormap</methodname>()</link>
method is used to retrieve the colormap used by a widget. The default system
colormap is retrieved by using the <link
linkend="function-gdk--colormap-get-system"><methodname>gtk.gdk.colormap_get_system</methodname>()</link>
function. The <link
linkend="method-gdkcolormap--alloc-color"><methodname>alloc_color</methodname>()</link>
method has three signatures to allow the color specification using an
unallocated <link
linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>, a
string or a RGB trio.</para>
</refsect1>
<refsect1 id="constructor-gdkcolormap">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.gdk.Colormap</methodname>
<methodparam><parameter
role="keyword">visual</parameter></methodparam>
<methodparam><parameter
role="keyword">allocate</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">visual</parameter> :</term>
<listitem><simpara>the <link
linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> to
use</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">allocate</parameter> :</term>
<listitem><simpara>if <literal>True</literal>, the newly created
colormap will be a private colormap, and all colors in it will be allocated
for the applications use.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link
linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
object</simpara></listitem>
</varlistentry>
</variablelist>
<para>Creates a new <link
linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
for the <link
linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
specified by <parameter>visual</parameter>. If
<parameter>allocate</parameter> is <literal>True</literal> the colormap will
be a private colormap for the sole use of the application.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gdkcolormap--alloc-color">
<title>gtk.gdk.Colormap.alloc_color</title>
<programlisting><methodsynopsis language="python">
<methodname>alloc_color</methodname>
<methodparam><parameter
role="keyword">color</parameter></methodparam>
<methodparam><parameter role="keyword">writeable</parameter>
<initializer>False</initializer></methodparam>
<methodparam><parameter role="keyword">best_match</parameter>
<initializer>True</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">color</parameter> :</term>
<listitem><simpara>an unallocated <link
linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
role="keyword">writeable</parameter> :</term>
<listitem><simpara>if <literal>True</literal> the colormap entry
is writeable.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
role="keyword">best_match</parameter> :</term>
<listitem><simpara>if <literal>True</literal> a best match to the
requested color can be used if needed.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
object</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>alloc_color</methodname>() method allocates the
color specified by <parameter>color</parameter> in the colormap. The value
of color should be an unallocated <link
linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>. If
<parameter>writeable</parameter> is <literal>True</literal> the color is
allocated writeable which means it can be changed after allocation but
cannot be shared with another application. If
<parameter>best_match</parameter> is <literal>True</literal> the closest
match to the color will be returned if the request could not be satisfied
exactly.</para>
<para>This method raises:</para>
<itemizedlist>
<listitem>
<simpara>the ValueError (TypeError prior to PyGTK 2.4) exception if
unable to parse the color specification</simpara>
</listitem>
<listitem>
<simpara>the RuntimeError exception if the color could not be
allocated</simpara>
</listitem>
</itemizedlist>
<para></para>
</refsect2>
<refsect2 id="method-gdkcolormap--alloc-color2">
<title>gtk.gdk.Colormap.alloc_color</title>
<programlisting><methodsynopsis language="python">
<methodname>alloc_color</methodname>
<methodparam><parameter
role="keyword">spec</parameter></methodparam>
<methodparam><parameter role="keyword">writeable</parameter>
<initializer>False</initializer></methodparam>
<methodparam><parameter role="keyword">best_match</parameter>
<initializer>True</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">spec</parameter> :</term>
<listitem><simpara>a string containing a color
specification</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
role="keyword">writeable</parameter> :</term>
<listitem><simpara>if <literal>True</literal> the colormap entry
is writeable.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
role="keyword">best_match</parameter> :</term>
<listitem><simpara>if <literal>True</literal> a best match to the
requested color can be used if needed.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link
linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
object</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>alloc_color</methodname>() method allocates the
color specified by <parameter>spec</parameter> in the colormap. The format
of <parameter>spec</parameter> is a string containing the specification of
the color either as a name (e.g. "navajowhite") as specified in the X11
<filename>rgb.txt</filename> file or as a hexadecimal string (e.g.
"#FF0078"). The hexadecimal string must start with '#' and must contain 3
sets of hexadecimal digits of the same length (i.e. 1, 2 ,3 or 4 digits).
For example the following specify the same color value: "#F0A", "#FF00AA",
"#FFF000AAA" and "#FFFF0000AAAA". If <parameter>writeable</parameter> is
<literal>True</literal> the color is allocated writeable which means it can
be changed after allocation but cannot be shared with another application.
If <parameter>best_match</parameter> is <literal>True</literal> the closest
match to the color will be returned if the request could not be satisfied
exactly.</para>
<para>This method raises:</para>
<itemizedlist>
<listitem>
<simpara>the ValueError (TypeError prior to PyGTK 2.4) exception if
unable to parse the color specification</simpara>
</listitem>
<listitem>
<simpara>the RuntimeError exception if the color could not be
allocated</simpara>
</listitem>
</itemizedlist>
<para></para>
</refsect2>
<refsect2 id="method-gdkcolormap--alloc-color3">
<title>gtk.gdk.Colormap.alloc_color</title>
<programlisting><methodsynopsis language="python">
<methodname>alloc_color</methodname>
<methodparam><parameter role="keyword">red</parameter></methodparam>
<methodparam><parameter role="keyword">green</parameter></methodparam>
<methodparam><parameter role="keyword">blue</parameter></methodparam>
<methodparam><parameter role="keyword">writeable</parameter>
<initializer>False</initializer></methodparam>
<methodparam><parameter role="keyword">best_match</parameter>
<initializer>True</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">red</parameter> :</term>
<listitem><simpara>the red component of the color in the range 0-65535</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">green</parameter> :</term>
<listitem><simpara>the green component of the color in the range 0-65535</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">blue</parameter> :</term>
<listitem><simpara>the blue component of the color in the range 0-65535</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">writeable</parameter> :</term>
<listitem><simpara>a gboolean</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">best_match</parameter> :</term>
<listitem><simpara>a gboolean</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> object</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>alloc_color</methodname>() method allocates the
color specified by the component values <parameter>red</parameter>,
<parameter>green</parameter> and <parameter>blue</parameter>. If
<parameter>writeable</parameter> is <literal>True</literal> the color is
allocated writeable which means it can be changed after allocation but
cannot be shared with another application. If
<parameter>best_match</parameter> is <literal>True</literal> the closest
match to the color will be returned if the request could not be satisfied
exactly.</para>
<para>This method raises:</para>
<itemizedlist>
<listitem>
<simpara>the ValueError (TypeError prior to PyGTK 2.4) exception if
unable to parse the color specification</simpara>
</listitem>
<listitem>
<simpara>the RuntimeError exception if the color could not be
allocated</simpara>
</listitem>
</itemizedlist>
<para></para>
</refsect2>
<refsect2 id="method-gdkcolormap--get-visual">
<title>gtk.gdk.Colormap.get_visual</title>
<programlisting><methodsynopsis language="python">
<methodname>get_visual</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link
linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_visual</methodname>() method returns the
visual the colormap was created for. See the <link
linkend="constructor-gdkcolormap">gtk.gdk.Colormap</link>
constructor.</para>
</refsect2>
<refsect2 id="method-gdkcolormap--get-screen">
<title>gtk.gdk.Colormap.get_screen</title>
<programlisting><methodsynopsis language="python">
<methodname>get_screen</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link
linkend="class-gdkvisual"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_screen</methodname>() method returns the
<link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
the colormap was created for.</para>
</refsect2>
<refsect2 id="method-gdkcolormap--query-color">
<title>gtk.gdk.Colormap.query_color</title>
<programlisting><methodsynopsis language="python">
<methodname>query_color</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">pixel</parameter> :</term>
<listitem><simpara>a pixel value</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the <link
linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
corresponding to <parameter>pixel</parameter></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>query_color</methodname>() method returns the
<link linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
corresponding to the hardware pixel value specified by
<parameter>pixel</parameter>. <parameter>pixel</parameter> must be a valid
pixel in the colormap. It's a programmer error to call this method with a
pixel which is not in the colormap. Hardware pixels are normally obtained
from the <link
linkend="method-gdkcolormap--alloc-color"><methodname>alloc_color</methodname>()</link>
method, or from a <link
linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>
object. (A <link
linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>
contains image data in hardware format while a <link
linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
contains image data in a canonical 24-bit RGB format.)</para>
</refsect2>
</refsect1>
<refsect1>
<title>Functions</title>
<refsect2 id="function-gdk--colormap-get-system">
<title>gtk.gdk.colormap_get_system</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.gdk.colormap_get_system</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the system' default
colormap</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>gtk.gdk.colormap_get_system</methodname>()
method returns the default colormap used by the system on the default
screen. See the <link
linkend="method-gdkscreen--get-system-colormap"><methodname>gtk.gdk.Screen.get_system_colormap</methodname>()</link>
method for more information.</para>
</refsect2>
</refsect1>
</refentry>
|
