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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>cr-rgb</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Libcroco Reference Manual">
<link rel="up" href="ch01.html" title="Extensive APIs description">
<link rel="prev" href="libcroco-cr-pseudo.html" title="cr-pseudo">
<link rel="next" href="libcroco-cr-sel-eng.html" title="cr-sel-eng">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libcroco-cr-pseudo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libcroco Reference Manual</th>
<td><a accesskey="n" href="libcroco-cr-sel-eng.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libcroco-cr-rgb.synopsis" class="shortcut">Top</a>
|
<a href="#libcroco-cr-rgb.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libcroco-cr-rgb"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libcroco-cr-rgb.top_of_page"></a>cr-rgb</span></h2>
<p>cr-rgb</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libcroco-cr-rgb.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb">CRRgb</a>;
enum <span class="returnvalue">CRStatus</span> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-compute-from-percentage" title="cr_rgb_compute_from_percentage ()">cr_rgb_compute_from_percentage</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>);
enum <span class="returnvalue">CRStatus</span> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-copy" title="cr_rgb_copy ()">cr_rgb_copy</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_dest</code></em>,
<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_src</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-destroy" title="cr_rgb_destroy ()">cr_rgb_destroy</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-dump" title="cr_rgb_dump ()">cr_rgb_dump</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_this</code></em>,
<em class="parameter"><code><span class="type">FILE</span> *a_fp</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-is-set-to-inherit" title="cr_rgb_is_set_to_inherit ()">cr_rgb_is_set_to_inherit</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_this</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-is-set-to-transparent" title="cr_rgb_is_set_to_transparent ()">cr_rgb_is_set_to_transparent</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_this</code></em>);
<a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="returnvalue">CRRgb</span></a> * <a class="link" href="libcroco-cr-rgb.html#cr-rgb-new" title="cr_rgb_new ()">cr_rgb_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="returnvalue">CRRgb</span></a> * <a class="link" href="libcroco-cr-rgb.html#cr-rgb-new-with-vals" title="cr_rgb_new_with_vals ()">cr_rgb_new_with_vals</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_red</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_green</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_blue</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> a_is_percentage</code></em>);
<a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="returnvalue">CRRgb</span></a> * <a class="link" href="libcroco-cr-rgb.html#cr-rgb-parse-from-buf" title="cr_rgb_parse_from_buf ()">cr_rgb_parse_from_buf</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *a_str</code></em>,
<em class="parameter"><code><span class="type">enum CREncoding</span> a_enc</code></em>);
enum <span class="returnvalue">CRStatus</span> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-set" title="cr_rgb_set ()">cr_rgb_set</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_red</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_green</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_blue</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> a_is_percentage</code></em>);
enum <span class="returnvalue">CRStatus</span> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-set-from-hex-str" title="cr_rgb_set_from_hex_str ()">cr_rgb_set_from_hex_str</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *a_hex_value</code></em>);
enum <span class="returnvalue">CRStatus</span> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-set-from-name" title="cr_rgb_set_from_name ()">cr_rgb_set_from_name</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *a_color_name</code></em>);
enum <span class="returnvalue">CRStatus</span> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-set-from-rgb" title="cr_rgb_set_from_rgb ()">cr_rgb_set_from_rgb</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_rgb</code></em>);
enum <span class="returnvalue">CRStatus</span> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-set-from-term" title="cr_rgb_set_from_term ()">cr_rgb_set_from_term</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code>const <span class="type">struct _CRTerm</span> *a_value</code></em>);
enum <span class="returnvalue">CRStatus</span> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-set-to-inherit" title="cr_rgb_set_to_inherit ()">cr_rgb_set_to_inherit</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> a_inherit</code></em>);
enum <span class="returnvalue">CRStatus</span> <a class="link" href="libcroco-cr-rgb.html#cr-rgb-set-to-transparent" title="cr_rgb_set_to_transparent ()">cr_rgb_set_to_transparent</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> a_is_transparent</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> * <a class="link" href="libcroco-cr-rgb.html#cr-rgb-to-string" title="cr_rgb_to_string ()">cr_rgb_to_string</a> (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_this</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libcroco-cr-rgb.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libcroco-cr-rgb.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CRRgb"></a><h3>struct CRRgb</h3>
<pre class="programlisting">struct CRRgb {
/*
*the unit of the rgb.
*Either NO_UNIT (integer) or
*UNIT_PERCENTAGE (percentage).
*/
const guchar *name ;
glong red ;
glong green ;
glong blue ;
gboolean is_percentage ;
gboolean inherit ;
gboolean is_transparent ;
CRParsingLocation location ;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-compute-from-percentage"></a><h3>cr_rgb_compute_from_percentage ()</h3>
<pre class="programlisting">enum <span class="returnvalue">CRStatus</span> cr_rgb_compute_from_percentage (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>);</pre>
<p>
If the rgb values are expressed in percentage,
compute their real value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>CR_OK upon successful completion, an error code otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-copy"></a><h3>cr_rgb_copy ()</h3>
<pre class="programlisting">enum <span class="returnvalue">CRStatus</span> cr_rgb_copy (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_dest</code></em>,
<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_src</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-destroy"></a><h3>cr_rgb_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> cr_rgb_destroy (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>);</pre>
<p>
Destructor of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the "this pointer" of the
current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-dump"></a><h3>cr_rgb_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> cr_rgb_dump (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_this</code></em>,
<em class="parameter"><code><span class="type">FILE</span> *a_fp</code></em>);</pre>
<p>
Dumps the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>
to a file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the "this pointer" of
the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_fp</code></em> :</span></p></td>
<td>the destination file pointer.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-is-set-to-inherit"></a><h3>cr_rgb_is_set_to_inherit ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> cr_rgb_is_set_to_inherit (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_this</code></em>);</pre>
<p>
<em class="parameter"><code>a_this</code></em>: the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the rgb is set to the value "inherit", FALSE otherwise.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-is-set-to-transparent"></a><h3>cr_rgb_is_set_to_transparent ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> cr_rgb_is_set_to_transparent (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_this</code></em>);</pre>
<p>
Tests if the the rgb is set to the
value "transparent" or not.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the current instance of
<a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the rgb has been set to
transparent, FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-new"></a><h3>cr_rgb_new ()</h3>
<pre class="programlisting"><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="returnvalue">CRRgb</span></a> * cr_rgb_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
The default constructor of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the newly built instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-new-with-vals"></a><h3>cr_rgb_new_with_vals ()</h3>
<pre class="programlisting"><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="returnvalue">CRRgb</span></a> * cr_rgb_new_with_vals (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_red</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_green</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_blue</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> a_is_percentage</code></em>);</pre>
<p>
A constructor of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_red</code></em> :</span></p></td>
<td>the red component of the color.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_green</code></em> :</span></p></td>
<td>the green component of the color.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_blue</code></em> :</span></p></td>
<td>the blue component of the color.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the newly built instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-parse-from-buf"></a><h3>cr_rgb_parse_from_buf ()</h3>
<pre class="programlisting"><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="returnvalue">CRRgb</span></a> * cr_rgb_parse_from_buf (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *a_str</code></em>,
<em class="parameter"><code><span class="type">enum CREncoding</span> a_enc</code></em>);</pre>
<p>
Parses a text buffer that contains a rgb color
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_str</code></em> :</span></p></td>
<td>a string that contains a color description</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_enc</code></em> :</span></p></td>
<td>the encoding of a_str</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the parsed color, or NULL in case of error</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set"></a><h3>cr_rgb_set ()</h3>
<pre class="programlisting">enum <span class="returnvalue">CRStatus</span> cr_rgb_set (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_red</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_green</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_blue</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> a_is_percentage</code></em>);</pre>
<p>
Sets rgb values to the RGB.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_red</code></em> :</span></p></td>
<td>the red value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_green</code></em> :</span></p></td>
<td>the green value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_blue</code></em> :</span></p></td>
<td>the blue value.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>CR_OK upon successful completion, an error code
otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set-from-hex-str"></a><h3>cr_rgb_set_from_hex_str ()</h3>
<pre class="programlisting">enum <span class="returnvalue">CRStatus</span> cr_rgb_set_from_hex_str (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *a_hex_value</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>CR_OK upon successful completion.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set-from-name"></a><h3>cr_rgb_set_from_name ()</h3>
<pre class="programlisting">enum <span class="returnvalue">CRStatus</span> cr_rgb_set_from_name (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *a_color_name</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_color_name</code></em> :</span></p></td>
<td>the color name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>CR_OK upon successful completion, an error code otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set-from-rgb"></a><h3>cr_rgb_set_from_rgb ()</h3>
<pre class="programlisting">enum <span class="returnvalue">CRStatus</span> cr_rgb_set_from_rgb (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_rgb</code></em>);</pre>
<p>
Sets the rgb from an other one.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_rgb</code></em> :</span></p></td>
<td>the rgb to "copy"</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>CR_OK upon successful completion, an error code otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set-from-term"></a><h3>cr_rgb_set_from_term ()</h3>
<pre class="programlisting">enum <span class="returnvalue">CRStatus</span> cr_rgb_set_from_term (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code>const <span class="type">struct _CRTerm</span> *a_value</code></em>);</pre>
<p>
Set the rgb from a terminal symbol
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> to set</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_value</code></em> :</span></p></td>
<td>the terminal from which to set</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>CR_OK upon successful completion, an error code otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set-to-inherit"></a><h3>cr_rgb_set_to_inherit ()</h3>
<pre class="programlisting">enum <span class="returnvalue">CRStatus</span> cr_rgb_set_to_inherit (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> a_inherit</code></em>);</pre>
<p>
sets the value of the rgb to inherit.
Look at the css spec from chapter 6.1 to 6.2 to understand
the meaning of "inherit".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>CR_OK upon succesful completion, an error code otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set-to-transparent"></a><h3>cr_rgb_set_to_transparent ()</h3>
<pre class="programlisting">enum <span class="returnvalue">CRStatus</span> cr_rgb_set_to_transparent (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> a_is_transparent</code></em>);</pre>
<p>
Sets the rgb to the "transparent" value (or not)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_is_transparent</code></em> :</span></p></td>
<td>set to transparent or not.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>CR_OK upon successfull completion, an error code otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-to-string"></a><h3>cr_rgb_to_string ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> * cr_rgb_to_string (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_this</code></em>);</pre>
<p>
Serializes the rgb into a zero terminated string.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> to serialize.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the zero terminated string containing the serialized
rgb. MUST BE FREED by the caller using <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|
