File: gdata-GData-Types.html

package info (click to toggle)
libgdata 0.6.4-2%2Bsqueeze1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 8,836 kB
  • ctags: 5,010
  • sloc: ansic: 26,815; sh: 10,319; makefile: 539; xml: 247
file content (162 lines) | stat: -rw-r--r-- 9,380 bytes parent folder | download 
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
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GData Types</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch02.html" title="Core API">
<link rel="prev" href="GDataEntry.html" title="GDataEntry">
<link rel="next" href="GDataParsable.html" title="GDataParsable">
<meta name="generator" content="GTK-Doc V1.14 (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="GDataEntry.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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">GData Reference Manual</th>
<td><a accesskey="n" href="GDataParsable.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gdata-GData-Types.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gdata-GData-Types.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="GData Types">
<a name="gdata-GData-Types"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdata-GData-Types.top_of_page"></a>GData Types</span></h2>
<p>GData Types — miscellaneous data types</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="gdata-GData-Types.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="gdata-GData-Types.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gdata/gdata-types.h&gt;

                    <a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor">GDataColor</a>;
<a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gdata-GData-Types.html#gdata-color-from-hexadecimal" title="gdata_color_from_hexadecimal ()">gdata_color_from_hexadecimal</a>        (<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hexadecimal</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);
<a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="gdata-GData-Types.html#gdata-color-to-hexadecimal" title="gdata_color_to_hexadecimal ()">gdata_color_to_hexadecimal</a>          (<em class="parameter"><code><a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="gdata-GData-Types.description"></a><h2>Description</h2>
<p>
The structures here are used haphazardly across the library, describing
various small data types.
</p>
</div>
<div class="refsect1" title="Details">
<a name="gdata-GData-Types.details"></a><h2>Details</h2>
<div class="refsect2" title="GDataColor">
<a name="GDataColor"></a><h3>GDataColor</h3>
<pre class="programlisting">typedef struct {
	guint16 red;
	guint16 green;
	guint16 blue;
} GDataColor;
</pre>
<p>
Describes a color, such as used in the Google Calendar interface to
differentiate calendars.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> <em class="structfield"><code><a name="GDataColor.red"></a>red</code></em>;</span></p></td>
<td>red color intensity, from 0–255
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> <em class="structfield"><code><a name="GDataColor.green"></a>green</code></em>;</span></p></td>
<td>green color intensity, from 0–255
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> <em class="structfield"><code><a name="GDataColor.blue"></a>blue</code></em>;</span></p></td>
<td>blue color intensity, from 0–255
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdata_color_from_hexadecimal ()">
<a name="gdata-color-from-hexadecimal"></a><h3>gdata_color_from_hexadecimal ()</h3>
<pre class="programlisting"><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gdata_color_from_hexadecimal        (<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hexadecimal</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);</pre>
<p>
Parses <em class="parameter"><code>hexadecimal</code></em> and returns a <a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor"><span class="type">GDataColor</span></a> describing it in <em class="parameter"><code>color</code></em>.
</p>
<p>
<em class="parameter"><code>hexadecimal</code></em> should be in the form <code class="literal">#<em class="replaceable"><code>rr</code></em><em class="replaceable"><code>gg</code></em><em class="replaceable"><code>bb</code></em></code>,
where <em class="replaceable"><code>rr</code></em> is a two-digit hexadecimal red intensity value, <em class="replaceable"><code>gg</code></em> is green
and <em class="replaceable"><code>bb</code></em> is blue. The hash is optional.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hexadecimal</code></em> :</span></p></td>
<td>a hexadecimal color string
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
<td>a <a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor"><span class="type">GDataColor</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gdata_color_to_hexadecimal ()">
<a name="gdata-color-to-hexadecimal"></a><h3>gdata_color_to_hexadecimal ()</h3>
<pre class="programlisting"><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gdata_color_to_hexadecimal          (<em class="parameter"><code><a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);</pre>
<p>
Returns a string describing <em class="parameter"><code>color</code></em> in hexadecimal form; in the form <code class="literal">#<em class="replaceable"><code>rr</code></em><em class="replaceable"><code>gg</code></em>
<em class="replaceable"><code>bb</code></em></code>, where <em class="replaceable"><code>rr</code></em> is a two-digit hexadecimal red intensity value,
<em class="replaceable"><code>gg</code></em> is green and <em class="replaceable"><code>bb</code></em> is blue. The hash is always present.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
<td>a <a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor"><span class="type">GDataColor</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the color string; free with <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>