File: GDataGenerator.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 (265 lines) | stat: -rw-r--r-- 16,692 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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GDataGenerator</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="ch04.html" title="Atom API">
<link rel="prev" href="GDataCategory.html" title="GDataCategory">
<link rel="next" href="GDataLink.html" title="GDataLink">
<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="GDataCategory.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.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="GDataLink.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GDataGenerator.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GDataGenerator.description" class="shortcut">Description</a>
                   | 
                  <a href="#GDataGenerator.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GDataGenerator.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="GDataGenerator">
<a name="GDataGenerator"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataGenerator.top_of_page"></a>GDataGenerator</span></h2>
<p>GDataGenerator — Atom generator element</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="GDataGenerator.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GDataGenerator.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gdata/atom/gdata-generator.h&gt;

                    <a class="link" href="GDataGenerator.html#GDataGenerator-struct" title="GDataGenerator">GDataGenerator</a>;
                    <a class="link" href="GDataGenerator.html#GDataGeneratorClass" title="GDataGeneratorClass">GDataGeneratorClass</a>;
<a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="GDataGenerator.html#gdata-generator-compare" title="gdata_generator_compare ()">gdata_generator_compare</a>             (<em class="parameter"><code>const <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *a</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *b</code></em>);
const <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="GDataGenerator.html#gdata-generator-get-name" title="gdata_generator_get_name ()">gdata_generator_get_name</a>            (<em class="parameter"><code><a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *self</code></em>);
const <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="GDataGenerator.html#gdata-generator-get-uri" title="gdata_generator_get_uri ()">gdata_generator_get_uri</a>             (<em class="parameter"><code><a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *self</code></em>);
const <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="GDataGenerator.html#gdata-generator-get-version" title="gdata_generator_get_version ()">gdata_generator_get_version</a>         (<em class="parameter"><code><a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *self</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GDataGenerator.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="GDataParsable.html" title="GDataParsable">GDataParsable</a>
         +----GDataGenerator
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="GDataGenerator.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GDataGenerator.html#GDataGenerator--name" title='The "name" property'>name</a>"                     <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  "<a class="link" href="GDataGenerator.html#GDataGenerator--uri" title='The "uri" property'>uri</a>"                      <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  "<a class="link" href="GDataGenerator.html#GDataGenerator--version" title='The "version" property'>version</a>"                  <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GDataGenerator.description"></a><h2>Description</h2>
<p>
<a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> represents a "generator" element from the
<a class="ulink" href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php" target="_top">Atom specification</a>.
</p>
</div>
<div class="refsect1" title="Details">
<a name="GDataGenerator.details"></a><h2>Details</h2>
<div class="refsect2" title="GDataGenerator">
<a name="GDataGenerator-struct"></a><h3>GDataGenerator</h3>
<pre class="programlisting">typedef struct _GDataGenerator GDataGenerator;</pre>
<p>
All the fields in the <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> structure are private and should never be accessed directly.
</p>
</div>
<hr>
<div class="refsect2" title="GDataGeneratorClass">
<a name="GDataGeneratorClass"></a><h3>GDataGeneratorClass</h3>
<pre class="programlisting">typedef struct {
} GDataGeneratorClass;
</pre>
<p>
All the fields in the <a class="link" href="GDataGenerator.html#GDataGeneratorClass" title="GDataGeneratorClass"><span class="type">GDataGeneratorClass</span></a> structure are private and should never be accessed directly.
</p>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2" title="gdata_generator_compare ()">
<a name="gdata-generator-compare"></a><h3>gdata_generator_compare ()</h3>
<pre class="programlisting"><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                gdata_generator_compare             (<em class="parameter"><code>const <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *a</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *b</code></em>);</pre>
<p>
Compares the two generators in a <code class="function">strcmp()</code> fashion. <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> values are handled gracefully, with
<code class="code">0</code> returned if both <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> are <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, <code class="code">-1</code> if <em class="parameter"><code>a</code></em> is <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
and <code class="code">1</code> if <em class="parameter"><code>b</code></em> is <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<p>
The comparison of non-<a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> values is done on the basis of the <em class="parameter"><code>name</code></em> property of the <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a>s.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
<td>a <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
<td>another <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="code">0</code> if <em class="parameter"><code>a</code></em> equals <em class="parameter"><code>b</code></em>, <code class="code">-1</code> or <code class="code">1</code> as
appropriate otherwise

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2" title="gdata_generator_get_name ()">
<a name="gdata-generator-get-name"></a><h3>gdata_generator_get_name ()</h3>
<pre class="programlisting">const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gdata_generator_get_name            (<em class="parameter"><code><a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *self</code></em>);</pre>
<p>
Gets the <a class="link" href="GDataGenerator.html#GDataGenerator--name" title='The "name" property'><span class="type">"name"</span></a> property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the generator's name

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2" title="gdata_generator_get_uri ()">
<a name="gdata-generator-get-uri"></a><h3>gdata_generator_get_uri ()</h3>
<pre class="programlisting">const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gdata_generator_get_uri             (<em class="parameter"><code><a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *self</code></em>);</pre>
<p>
Gets the <a class="link" href="GDataGenerator.html#GDataGenerator--uri" title='The "uri" property'><span class="type">"uri"</span></a> property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the generator's URI, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2" title="gdata_generator_get_version ()">
<a name="gdata-generator-get-version"></a><h3>gdata_generator_get_version ()</h3>
<pre class="programlisting">const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gdata_generator_get_version         (<em class="parameter"><code><a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a> *self</code></em>);</pre>
<p>
Gets the <a class="link" href="GDataGenerator.html#GDataGenerator--version" title='The "version" property'><span class="type">"version"</span></a> property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataGenerator.html" title="GDataGenerator"><span class="type">GDataGenerator</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the generator's version, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.0</p>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="GDataGenerator.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "name" property'>
<a name="GDataGenerator--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting">  "name"                     <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
<p>
A human-readable name for the generating agent.
</p>
<p>
For more information, see the
<a class="ulink" href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php#element.generator" target="_top">Atom specification</a>.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2" title='The "uri" property'>
<a name="GDataGenerator--uri"></a><h3>The <code class="literal">"uri"</code> property</h3>
<pre class="programlisting">  "uri"                      <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
<p>
An IRI reference that is relevant to the agent.
</p>
<p>
For more information, see the
<a class="ulink" href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php#element.generator" target="_top">Atom specification</a>.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2" title='The "version" property'>
<a name="GDataGenerator--version"></a><h3>The <code class="literal">"version"</code> property</h3>
<pre class="programlisting">  "version"                  <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
<p>
Indicates the version of the generating agent.
</p>
<p>
For more information, see the
<a class="ulink" href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php#element.generator" target="_top">Atom specification</a>.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.4.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>