← Back to branch summary

~ubuntu-branches/ubuntu/natty/libgdata/natty-updates

« back to all changes in this revision

Viewing changes to docs/reference/html/gdata-GData-Types.html

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2011-01-05 11:09:00 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20110105110900-gkjnbslnr18s45us
Tags: 0.8.0-0ubuntu1
* New upstream release
* debian/control:
  - Use gir1.2 packages
  - Use standards version 3.9.1
  - Add Vcs-Bzr link
  - Rename libgdata10 to libgdata11
* debian/rules:
  - Drop simple-patchsys.mk
* debian/source:
  - Use source version 3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/gdata-GData-Types.html
24
24
<a href="#gdata-GData-Types.synopsis" class="shortcut">Top</a>
25
25
                   | 
26
26
                  <a href="#gdata-GData-Types.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#gdata-GData-Types.object-hierarchy" class="shortcut">Object Hierarchy</a>
27
29
</td></tr>
28
30
</table>
29
31
<div class="refentry">
41
43
</div>
42
44
<div class="refsynopsisdiv">
43
45
<a name="gdata-GData-Types.synopsis"></a><h2>Synopsis</h2>
44
 
<pre class="synopsis">
 
46
<a name="GDataColor"></a><pre class="synopsis">
45
47
#include &lt;gdata/gdata-types.h&gt;
46
48
 
47
 
                    <a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor">GDataColor</a>;
48
 
<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>,
49
 
                                                         <em class="parameter"><code><a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);
50
 
<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>const <a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);
 
49
                    <a class="link" href="gdata-GData-Types.html#GDataColor-struct" title="GDataColor">GDataColor</a>;
 
50
<a href="/opt/gnome3/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/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hexadecimal</code></em>,
 
51
                                                         <em class="parameter"><code><a class="link" href="gdata-GData-Types.html#GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);
 
52
<a href="/opt/gnome3/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>const <a class="link" href="gdata-GData-Types.html#GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);
 
53
</pre>
 
54
</div>
 
55
<div class="refsect1">
 
56
<a name="gdata-GData-Types.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
57
<pre class="synopsis">
 
58
  GBoxed
 
59
   +----GDataColor
51
60
</pre>
52
61
</div>
53
62
<div class="refsect1">
60
69
<div class="refsect1">
61
70
<a name="gdata-GData-Types.details"></a><h2>Details</h2>
62
71
<div class="refsect2">
63
 
<a name="GDataColor"></a><h3>GDataColor</h3>
64
 
<pre class="programlisting">typedef struct {
65
 
        guint16 red;
66
 
        guint16 green;
67
 
        guint16 blue;
68
 
} GDataColor;
69
 
</pre>
 
72
<a name="GDataColor-struct"></a><h3>GDataColor</h3>
 
73
<pre class="programlisting">typedef struct _GDataColor GDataColor;</pre>
70
74
<p>
71
75
Describes a color, such as used in the Google Calendar interface to
72
76
differentiate calendars.
73
77
</p>
74
78
<div class="variablelist"><table border="0">
75
79
<col align="left" valign="top">
76
 
<tbody>
77
 
<tr>
78
 
<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>
79
 
<td>red color intensity, from 0–255</td>
80
 
</tr>
81
 
<tr>
82
 
<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>
83
 
<td>green color intensity, from 0–255</td>
84
 
</tr>
85
 
<tr>
86
 
<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>
87
 
<td>blue color intensity, from 0–255</td>
88
 
</tr>
89
 
</tbody>
 
80
<tbody></tbody>
90
81
</table></div>
91
82
</div>
92
83
<hr>
93
84
<div class="refsect2">
94
85
<a name="gdata-color-from-hexadecimal"></a><h3>gdata_color_from_hexadecimal ()</h3>
95
 
<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>,
96
 
                                                         <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>
 
86
<pre class="programlisting"><a href="/opt/gnome3/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/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hexadecimal</code></em>,
 
87
                                                         <em class="parameter"><code><a class="link" href="gdata-GData-Types.html#GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);</pre>
97
88
<p>
98
 
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>.
 
89
Parses <em class="parameter"><code>hexadecimal</code></em> and returns a <a class="link" href="gdata-GData-Types.html#GDataColor"><span class="type">GDataColor</span></a> describing it in <em class="parameter"><code>color</code></em>.
99
90
</p>
100
91
<p>
101
92
<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>,
111
102
</tr>
112
103
<tr>
113
104
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
114
 
<td>a <a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor"><span class="type">GDataColor</span></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym> caller-allocates]</span>
 
105
<td>a <a class="link" href="gdata-GData-Types.html#GDataColor"><span class="type">GDataColor</span></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym> caller-allocates]</span>
115
106
</td>
116
107
</tr>
117
108
<tr>
118
109
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
119
110
<td>
120
 
<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>
 
111
<a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
121
112
</tr>
122
113
</tbody>
123
114
</table></div>
125
116
<hr>
126
117
<div class="refsect2">
127
118
<a name="gdata-color-to-hexadecimal"></a><h3>gdata_color_to_hexadecimal ()</h3>
128
 
<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>const <a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);</pre>
 
119
<pre class="programlisting"><a href="/opt/gnome3/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>const <a class="link" href="gdata-GData-Types.html#GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);</pre>
129
120
<p>
130
121
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>
131
122
<em class="replaceable"><code>bb</code></em></code>, where <em class="replaceable"><code>rr</code></em> is a two-digit hexadecimal red intensity value,
136
127
<tbody>
137
128
<tr>
138
129
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
139
 
<td>a <a class="link" href="gdata-GData-Types.html#GDataColor" title="GDataColor"><span class="type">GDataColor</span></a>
 
130
<td>a <a class="link" href="gdata-GData-Types.html#GDataColor"><span class="type">GDataColor</span></a>
140
131
</td>
141
132
</tr>
142
133
<tr>
143
134
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
144
 
<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>
 
135
<td>the color string; free with <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
145
136
</td>
146
137
</tr>
147
138
</tbody>