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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KColorUtils</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KColorUtils Namespace Reference</h1>
<code>from PyKDE4.kdeui.KColorUtils import *</code>
<p>
<h2>Detailed Description</h2>
<p>A set of methods used to work with colors.
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#contrastRatio">contrastRatio</a> (QColor a0, QColor a1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QColor </td><td class="memItemRight" valign="bottom"><a class="el" href="#darken">darken</a> (QColor a0, float amount=0.5, float chromaGain=1.0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QColor </td><td class="memItemRight" valign="bottom"><a class="el" href="#lighten">lighten</a> (QColor a0, float amount=0.5, float chromaInverseGain=1.0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#luma">luma</a> (QColor a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QColor </td><td class="memItemRight" valign="bottom"><a class="el" href="#mix">mix</a> (QColor c1, QColor c2, float bias=0.5)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QColor </td><td class="memItemRight" valign="bottom"><a class="el" href="#overlayColors">overlayColors</a> (QColor base, QColor paint, QPainter::CompositionMode comp=QPainter.CompositionMode_SourceOver)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QColor </td><td class="memItemRight" valign="bottom"><a class="el" href="#shade">shade</a> (QColor a0, float lumaAmount, float chromaAmount=0.0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QColor </td><td class="memItemRight" valign="bottom"><a class="el" href="#tint">tint</a> (QColor base, QColor color, float amount=0.3)</td></tr>
</table>
<hr><h2>Function Documentation</h2><a class="anchor" name="contrastRatio"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">float contrastRatio</td>
<td>(</td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>a0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>a1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Calculate the contrast ratio between two colors, according to the
W3C/WCAG2.0 algorithm, (Lmax + 0.05)/(Lmin + 0.05), where Lmax and Lmin
are the luma values of the lighter color and the darker color,
respectively.
</p>
<p>
A contrast ration of 5:1 (result == 5.0) is the minimum for "normal"
text to be considered readable (large text can go as low as 3:1). The
ratio ranges from 1:1 (result == 1.0) to 21:1 (result == 21.0).
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KColorUtils.luma
</dd></dl>
</p></div></div><a class="anchor" name="darken"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QColor darken</td>
<td>(</td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>a0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>amount=0.5</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>chromaGain=1.0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Adjust the luma of a color by changing its distance from black.
</p>
<p>
<li> amount == 1.0 gives black </li>
<li> amount == 0.5 results in a color whose luma is halfway between 0.0 </li>
and that of the original color
<li> amount == 0.0 gives the original color </li>
<li> amount == -1.0 gives a color that is 'twice as far from black' as </li>
the original color, that is luma(result) == 2*luma(color)
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>amount</em> </td><td> factor by which to adjust the luma component of the color
<tr><td></td><td valign="top"><em>chromaGain</em> </td><td> (optional) factor by which to adjust the chroma
component of the color; 1.0 means no change, 0.0 minimizes chroma
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> KColorUtils.shade
</dd></dl>
</p></div></div><a class="anchor" name="lighten"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QColor lighten</td>
<td>(</td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>a0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>amount=0.5</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>chromaInverseGain=1.0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Adjust the luma of a color by changing its distance from white.
</p>
<p>
<li> amount == 1.0 gives white </li>
<li> amount == 0.5 results in a color whose luma is halfway between 1.0 </li>
and that of the original color
<li> amount == 0.0 gives the original color </li>
<li> amount == -1.0 gives a color that is 'twice as far from white' as </li>
the original color, that is luma(result) == 1.0 - 2*(1.0 - luma(color))
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>amount</em> </td><td> factor by which to adjust the luma component of the color
<tr><td></td><td valign="top"><em>chromaInverseGain</em> </td><td> (optional) factor by which to adjust the chroma
component of the color; 1.0 means no change, 0.0 maximizes chroma
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> KColorUtils.shade
</dd></dl>
</p></div></div><a class="anchor" name="luma"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">float luma</td>
<td>(</td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Calculate the luma of a color. Luma is weighted sum of gamma-adjusted
R'G'B' components of a color. The result is similar to qGray. The range
is from 0.0 (black) to 1.0 (white).
</p>
<p>
KColorUtils.darken(), KColorUtils.lighten() and KColorUtils.shade()
operate on the luma of a color.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> http://en.wikipedia.org/wiki/Luma_(video)
</dd></dl>
</p></div></div><a class="anchor" name="mix"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QColor mix</td>
<td>(</td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>c1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>c2</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>bias=0.5</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Blend two colors into a new color by linear combination.
<pre class="fragment">
QColor lighter = KColorUtils.mix(myColor, Qt.white)
</pre>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>c1</em> </td><td> first color.
<tr><td></td><td valign="top"><em>c2</em> </td><td> second color.
<tr><td></td><td valign="top"><em>bias</em> </td><td> weight to be used for the mix. <b>bias</b> <= 0 gives <b>c1,</b>
<b>bias</b> >= 1 gives <b>c2.</b> <b>bias</b> == 0.5 gives a 50% blend of <b>c1</b>
and <b>c2.</b>
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="overlayColors"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QColor overlayColors</td>
<td>(</td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>paint</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QPainter::CompositionMode </td>
<td class="paramname"><em>comp=QPainter.CompositionMode_SourceOver</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Blend two colors into a new color by painting the second color over the
first using the specified composition mode.
<pre class="fragment">
QColor white(Qt.white);
white.setAlphaF(0.5);
QColor lighter = KColorUtils.overlayColors(myColor, white);
</pre>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>base</em> </td><td> the base color (alpha channel is ignored).
<tr><td></td><td valign="top"><em>paint</em> </td><td> the color to be overlayed onto the base color.
<tr><td></td><td valign="top"><em>comp</em> </td><td> the CompositionMode used to do the blending.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="shade"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QColor shade</td>
<td>(</td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>a0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>lumaAmount</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>chromaAmount=0.0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Adjust the luma and chroma components of a color. The amount is added
to the corresponding component.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>lumaAmount</em> </td><td> amount by which to adjust the luma component of the
color; 0.0 results in no change, -1.0 turns anything black, 1.0 turns
anything white
<tr><td></td><td valign="top"><em>chromaAmount</em> </td><td> (optional) amount by which to adjust the chroma
component of the color; 0.0 results in no change, -1.0 minimizes chroma,
1.0 maximizes chroma
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> KColorUtils.luma
</dd></dl>
</p></div></div><a class="anchor" name="tint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QColor tint</td>
<td>(</td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>color</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>amount=0.3</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Create a new color by tinting one color with another. This function is
meant for creating additional colors withing the same class (background,
foreground) from colors in a different class. Therefore when <b>amount</b>
is low, the luma of <b>base</b> is mostly preserved, while the hue and
chroma of <b>color</b> is mostly inherited.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>base</em> </td><td> color to be tinted
<tr><td></td><td valign="top"><em>color</em> </td><td> color with which to tint
<tr><td></td><td valign="top"><em>amount</em> </td><td> how strongly to tint the base; 0.0 gives <b>base,</b>
1.0 gives <b>color</b>
</td></tr>
</table></dl>
<p>
</p></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
|
