Debian Codegraph @

doc/reference/html/OobsList.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>OobsList</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="Liboobs (System configuration management) Reference Manual">
8 <link rel="up" href="ch01.html" title="Common API">
9 <link rel="prev" href="OobsObject.html" title="OobsObject">
10 <link rel="next" href="liboobs-OobsError.html" title="OobsError">
11 <meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="OobsObject.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Liboobs (System configuration management) Reference Manual</th>
21 <td><a accesskey="n" href="liboobs-OobsError.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#OobsList.synopsis" class="shortcut">Top</a>
25  | 
26 <a href="#OobsList.description" class="shortcut">Description</a>
27  | 
28 <a href="#OobsList.object-hierarchy" class="shortcut">Object Hierarchy</a>
29  | 
30 <a href="#OobsList.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry" title="OobsList">
34 <a name="OobsList"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="OobsList.top_of_page"></a>OobsList</span></h2>
38 <p>OobsList — Object to deal with several configuration elements</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv" title="Synopsis">
43 <a name="OobsList.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis">#define <a class="link" href="OobsList.html#OOBS-TYPE-LIST-ITER:CAPS" title="OOBS_TYPE_LIST_ITER">OOBS_TYPE_LIST_ITER</a>
45 <a class="link" href="OobsList.html#OobsList-struct" title="OobsList">OobsList</a>;
46 <a class="link" href="OobsList.html#OobsListClass" title="OobsListClass">OobsListClass</a>;
47 <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter">OobsListIter</a>;
48 <span class="returnvalue">GType</span> <a class="link" href="OobsList.html#oobs-list-iter-get-type" title="oobs_list_iter_get_type ()">oobs_list_iter_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
49 <span class="returnvalue">gboolean</span> <a class="link" href="OobsList.html#oobs-list-get-iter-first" title="oobs_list_get_iter_first ()">oobs_list_get_iter_first</a> (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
50 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);
51 <span class="returnvalue">gboolean</span> <a class="link" href="OobsList.html#oobs-list-iter-next" title="oobs_list_iter_next ()">oobs_list_iter_next</a> (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
52 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);
53 <span class="returnvalue">gboolean</span> <a class="link" href="OobsList.html#oobs-list-remove" title="oobs_list_remove ()">oobs_list_remove</a> (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
54 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);
55 <span class="returnvalue">void</span> <a class="link" href="OobsList.html#oobs-list-append" title="oobs_list_append ()">oobs_list_append</a> (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
56 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);
57 <span class="returnvalue">void</span> <a class="link" href="OobsList.html#oobs-list-prepend" title="oobs_list_prepend ()">oobs_list_prepend</a> (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
58 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);
59 <span class="returnvalue">void</span> <a class="link" href="OobsList.html#oobs-list-insert-after" title="oobs_list_insert_after ()">oobs_list_insert_after</a> (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
60 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *anchor</code></em>,
61 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);
62 <span class="returnvalue">void</span> <a class="link" href="OobsList.html#oobs-list-insert-before" title="oobs_list_insert_before ()">oobs_list_insert_before</a> (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
63 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *anchor</code></em>,
64 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);
65 <span class="returnvalue">GObject</span>* <a class="link" href="OobsList.html#oobs-list-get" title="oobs_list_get ()">oobs_list_get</a> (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
66 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);
67 <span class="returnvalue">void</span> <a class="link" href="OobsList.html#oobs-list-set" title="oobs_list_set ()">oobs_list_set</a> (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
68 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>,
69 <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
70 <span class="returnvalue">void</span> <a class="link" href="OobsList.html#oobs-list-clear" title="oobs_list_clear ()">oobs_list_clear</a> (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>);
71 <span class="returnvalue">gint</span> <a class="link" href="OobsList.html#oobs-list-get-n-items" title="oobs_list_get_n_items ()">oobs_list_get_n_items</a> (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>);
72 <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="returnvalue">OobsListIter</span></a> * <a class="link" href="OobsList.html#oobs-list-iter-copy" title="oobs_list_iter_copy ()">oobs_list_iter_copy</a> (<em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);
73 <span class="returnvalue">void</span> <a class="link" href="OobsList.html#oobs-list-iter-free" title="oobs_list_iter_free ()">oobs_list_iter_free</a> (<em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);
74 </pre>
75 </div>
76 <div class="refsect1" title="Object Hierarchy">
77 <a name="OobsList.object-hierarchy"></a><h2>Object Hierarchy</h2>
78 <pre class="synopsis">
79 GObject
80 +----OobsList
81 </pre>
82 </div>
83 <div class="refsect1" title="Properties">
84 <a name="OobsList.properties"></a><h2>Properties</h2>
85 <pre class="synopsis">
86 "<a class="link" href="OobsList.html#OobsList--contained-type" title='The "contained-type" property'>contained-type</a>" <span class="type">gpointer</span> : Write / Construct Only
87 </pre>
88 </div>
89 <div class="refsect1" title="Description">
90 <a name="OobsList.description"></a><h2>Description</h2>
91 </div>
92 <div class="refsect1" title="Details">
93 <a name="OobsList.details"></a><h2>Details</h2>
94 <div class="refsect2" title="OOBS_TYPE_LIST_ITER">
95 <a name="OOBS-TYPE-LIST-ITER:CAPS"></a><h3>OOBS_TYPE_LIST_ITER</h3>
96 <pre class="programlisting">#define OOBS_TYPE_LIST_ITER (oobs_list_iter_get_type ())
97 </pre>
98 <p>
99 </p>
100 </div>
101 <hr>
102 <div class="refsect2" title="OobsList">
103 <a name="OobsList-struct"></a><h3>OobsList</h3>
104 <pre class="programlisting">typedef struct _OobsList OobsList;</pre>
105 <p>
106 </p>
107 </div>
108 <hr>
109 <div class="refsect2" title="OobsListClass">
110 <a name="OobsListClass"></a><h3>OobsListClass</h3>
111 <pre class="programlisting">typedef struct {
112 GObjectClass parent_class;
113
114 void (*_oobs_padding1) (void);
115 void (*_oobs_padding2) (void);
116 } OobsListClass;
117 </pre>
118 <p>
119 </p>
120 </div>
121 <hr>
122 <div class="refsect2" title="OobsListIter">
123 <a name="OobsListIter"></a><h3>OobsListIter</h3>
124 <pre class="programlisting">typedef struct {
125 guint stamp;
126 gpointer data;
127 } OobsListIter;
128 </pre>
129 <p>
130 </p>
131 </div>
132 <hr>
133 <div class="refsect2" title="oobs_list_iter_get_type ()">
134 <a name="oobs-list-iter-get-type"></a><h3>oobs_list_iter_get_type ()</h3>
135 <pre class="programlisting"><span class="returnvalue">GType</span> oobs_list_iter_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
136 <p>
137 </p>
138 <div class="variablelist"><table border="0">
139 <col align="left" valign="top">
140 <tbody><tr>
141 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
142 <td>
143 </td>
144 </tr></tbody>
145 </table></div>
146 </div>
147 <hr>
148 <div class="refsect2" title="oobs_list_get_iter_first ()">
149 <a name="oobs-list-get-iter-first"></a><h3>oobs_list_get_iter_first ()</h3>
150 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_list_get_iter_first (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
151 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);</pre>
152 <p>
153 Initializes <em class="parameter"><code>iter</code></em> the iterator pointing to the
154 first element in <em class="parameter"><code>list</code></em>. if <em class="parameter"><code>list</code></em> is empty, then FALSE
155 is returned, and <em class="parameter"><code>iter</code></em> is not initialized.
156 </p>
157 <div class="variablelist"><table border="0">
158 <col align="left" valign="top">
159 <tbody>
160 <tr>
161 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
162 <td>An <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>
163 </td>
164 </tr>
165 <tr>
166 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
167 <td>An uninitialized <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a>
168 </td>
169 </tr>
170 <tr>
171 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
172 <td> <span class="type">TRUE</span> if <em class="parameter"><code>iter</code></em> was set
173 </td>
174 </tr>
175 </tbody>
176 </table></div>
177 </div>
178 <hr>
179 <div class="refsect2" title="oobs_list_iter_next ()">
180 <a name="oobs-list-iter-next"></a><h3>oobs_list_iter_next ()</h3>
181 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_list_iter_next (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
182 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);</pre>
183 <p>
184 Sets <em class="parameter"><code>iter</code></em> to point to the element following it. If there's
185 no next <em class="parameter"><code>iter</code></em>, of if <em class="parameter"><code>iter</code></em> was invalid for <em class="parameter"><code>list</code></em>, <span class="type">FALSE</span> is
186 returned, and <em class="parameter"><code>iter</code></em> is set to invalid.
187 </p>
188 <div class="variablelist"><table border="0">
189 <col align="left" valign="top">
190 <tbody>
191 <tr>
192 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
193 <td>An <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>
194 </td>
195 </tr>
196 <tr>
197 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
198 <td>A valid <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> pointing to an element in <em class="parameter"><code>list</code></em>
199 </td>
200 </tr>
201 <tr>
202 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
203 <td> <span class="type">TRUE</span> if iter has been correctly changed to the next element
204 </td>
205 </tr>
206 </tbody>
207 </table></div>
208 </div>
209 <hr>
210 <div class="refsect2" title="oobs_list_remove ()">
211 <a name="oobs-list-remove"></a><h3>oobs_list_remove ()</h3>
212 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_list_remove (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
213 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);</pre>
214 <p>
215 Removes an element pointed by <em class="parameter"><code>iter</code></em> from <em class="parameter"><code>list</code></em>. This function will not
216 be effective if <em class="parameter"><code>list</code></em> is locked, or if <em class="parameter"><code>iter</code></em> doesn't point to an element
217 contained in <em class="parameter"><code>list</code></em>.
218 </p>
219 <div class="variablelist"><table border="0">
220 <col align="left" valign="top">
221 <tbody>
222 <tr>
223 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
224 <td>An <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>
225 </td>
226 </tr>
227 <tr>
228 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
229 <td>A valid <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> pointing to an element in <em class="parameter"><code>list</code></em>
230 </td>
231 </tr>
232 <tr>
233 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
234 <td> <span class="type">TRUE</span> if the element was correctly removed
235 </td>
236 </tr>
237 </tbody>
238 </table></div>
239 </div>
240 <hr>
241 <div class="refsect2" title="oobs_list_append ()">
242 <a name="oobs-list-append"></a><h3>oobs_list_append ()</h3>
243 <pre class="programlisting"><span class="returnvalue">void</span> oobs_list_append (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
244 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);</pre>
245 <p>
246 Appends a new element to <em class="parameter"><code>list</code></em>. <em class="parameter"><code>iter</code></em> will be changed
247 to point to this element, to fill in values, you need to call
248 <a class="link" href="OobsList.html#oobs-list-set" title="oobs_list_set ()"><code class="function">oobs_list_set()</code></a>.
249 </p>
250 <div class="variablelist"><table border="0">
251 <col align="left" valign="top">
252 <tbody>
253 <tr>
254 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
255 <td>An <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>
256 </td>
257 </tr>
258 <tr>
259 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
260 <td>An unset <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> to set to the new element
261 </td>
262 </tr>
263 </tbody>
264 </table></div>
265 </div>
266 <hr>
267 <div class="refsect2" title="oobs_list_prepend ()">
268 <a name="oobs-list-prepend"></a><h3>oobs_list_prepend ()</h3>
269 <pre class="programlisting"><span class="returnvalue">void</span> oobs_list_prepend (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
270 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);</pre>
271 <p>
272 Prepends a new element to <em class="parameter"><code>list</code></em>. <em class="parameter"><code>iter</code></em> will be changed
273 to point to this element, to fill in values, you need to call
274 <a class="link" href="OobsList.html#oobs-list-set" title="oobs_list_set ()"><code class="function">oobs_list_set()</code></a>.
275 </p>
276 <div class="variablelist"><table border="0">
277 <col align="left" valign="top">
278 <tbody>
279 <tr>
280 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
281 <td>An <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>
282 </td>
283 </tr>
284 <tr>
285 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
286 <td>An unset <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> to set to the new element
287 </td>
288 </tr>
289 </tbody>
290 </table></div>
291 </div>
292 <hr>
293 <div class="refsect2" title="oobs_list_insert_after ()">
294 <a name="oobs-list-insert-after"></a><h3>oobs_list_insert_after ()</h3>
295 <pre class="programlisting"><span class="returnvalue">void</span> oobs_list_insert_after (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
296 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *anchor</code></em>,
297 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);</pre>
298 <p>
299 Inserts a new element after <em class="parameter"><code>anchor</code></em>. <em class="parameter"><code>iter</code></em> will be changed
300 to point to this element, to fill in values, you need to call
301 <a class="link" href="OobsList.html#oobs-list-set" title="oobs_list_set ()"><code class="function">oobs_list_set()</code></a>.
302 </p>
303 <div class="variablelist"><table border="0">
304 <col align="left" valign="top">
305 <tbody>
306 <tr>
307 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
308 <td>An <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>
309 </td>
310 </tr>
311 <tr>
312 <td><p><span class="term"><em class="parameter"><code>anchor</code></em> :</span></p></td>
313 <td>A valid <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a>
314 </td>
315 </tr>
316 <tr>
317 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
318 <td>An unset <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> to set to the new element
319 </td>
320 </tr>
321 </tbody>
322 </table></div>
323 </div>
324 <hr>
325 <div class="refsect2" title="oobs_list_insert_before ()">
326 <a name="oobs-list-insert-before"></a><h3>oobs_list_insert_before ()</h3>
327 <pre class="programlisting"><span class="returnvalue">void</span> oobs_list_insert_before (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
328 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *anchor</code></em>,
329 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);</pre>
330 <p>
331 Inserts a new element before <em class="parameter"><code>anchor</code></em>. <em class="parameter"><code>iter</code></em> will be changed
332 to point to this element, to fill in values, you need to call
333 <a class="link" href="OobsList.html#oobs-list-set" title="oobs_list_set ()"><code class="function">oobs_list_set()</code></a>.
334 </p>
335 <div class="variablelist"><table border="0">
336 <col align="left" valign="top">
337 <tbody>
338 <tr>
339 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
340 <td>An <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>
341 </td>
342 </tr>
343 <tr>
344 <td><p><span class="term"><em class="parameter"><code>anchor</code></em> :</span></p></td>
345 <td>A valid <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a>
346 </td>
347 </tr>
348 <tr>
349 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
350 <td>An unset <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> to set to the new element
351 </td>
352 </tr>
353 </tbody>
354 </table></div>
355 </div>
356 <hr>
357 <div class="refsect2" title="oobs_list_get ()">
358 <a name="oobs-list-get"></a><h3>oobs_list_get ()</h3>
359 <pre class="programlisting"><span class="returnvalue">GObject</span>* oobs_list_get (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
360 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);</pre>
361 <p>
362 Retrieves a reference to the element
363 referenced by <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a>.
364 </p>
365 <div class="variablelist"><table border="0">
366 <col align="left" valign="top">
367 <tbody>
368 <tr>
369 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
370 <td>an <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>
371 </td>
372 </tr>
373 <tr>
374 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
375 <td>a valid <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> for the element being get
376 </td>
377 </tr>
378 <tr>
379 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
380 <td> the element referenced by <em class="parameter"><code>iter</code></em>
381 </td>
382 </tr>
383 </tbody>
384 </table></div>
385 </div>
386 <hr>
387 <div class="refsect2" title="oobs_list_set ()">
388 <a name="oobs-list-set"></a><h3>oobs_list_set ()</h3>
389 <pre class="programlisting"><span class="returnvalue">void</span> oobs_list_set (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>,
390 <em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>,
391 <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
392 <p>
393 Sets the data for the element referenced by <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a>.
394 This function will not be effective if the list is locked, or
395 if <em class="parameter"><code>data</code></em> GType is different to the data contained in <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>.
396 </p>
397 <div class="variablelist"><table border="0">
398 <col align="left" valign="top">
399 <tbody>
400 <tr>
401 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
402 <td>an <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>
403 </td>
404 </tr>
405 <tr>
406 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
407 <td>a valid <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> for the element being set
408 </td>
409 </tr>
410 <tr>
411 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
412 <td>a pointer to the data being set
413 </td>
414 </tr>
415 </tbody>
416 </table></div>
417 </div>
418 <hr>
419 <div class="refsect2" title="oobs_list_clear ()">
420 <a name="oobs-list-clear"></a><h3>oobs_list_clear ()</h3>
421 <pre class="programlisting"><span class="returnvalue">void</span> oobs_list_clear (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>);</pre>
422 <p>
423 Removes all contents from an <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>. This function will
424 not be effective if the list is locked.
425 </p>
426 <div class="variablelist"><table border="0">
427 <col align="left" valign="top">
428 <tbody><tr>
429 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
430 <td>an <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>
431 </td>
432 </tr></tbody>
433 </table></div>
434 </div>
435 <hr>
436 <div class="refsect2" title="oobs_list_get_n_items ()">
437 <a name="oobs-list-get-n-items"></a><h3>oobs_list_get_n_items ()</h3>
438 <pre class="programlisting"><span class="returnvalue">gint</span> oobs_list_get_n_items (<em class="parameter"><code><a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> *list</code></em>);</pre>
439 <p>
440 Returns the number of elements that the list contains.
441 </p>
442 <div class="variablelist"><table border="0">
443 <col align="left" valign="top">
444 <tbody>
445 <tr>
446 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
447 <td>An <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>.
448 </td>
449 </tr>
450 <tr>
451 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
452 <td> the number of elements.
453 </td>
454 </tr>
455 </tbody>
456 </table></div>
457 </div>
458 <hr>
459 <div class="refsect2" title="oobs_list_iter_copy ()">
460 <a name="oobs-list-iter-copy"></a><h3>oobs_list_iter_copy ()</h3>
461 <pre class="programlisting"><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="returnvalue">OobsListIter</span></a> * oobs_list_iter_copy (<em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);</pre>
462 <p>
463 Returns a newly allocated copy of the given iterator. This function is not
464 intended for use in applications, because you can just copy the structs by
465 value (OobsListIter new_iter = iter;). You must free this iter with
466 <a class="link" href="OobsList.html#oobs-list-iter-free" title="oobs_list_iter_free ()"><code class="function">oobs_list_iter_free()</code></a>.
467 </p>
468 <div class="variablelist"><table border="0">
469 <col align="left" valign="top">
470 <tbody>
471 <tr>
472 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
473 <td>An <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a>.
474 </td>
475 </tr>
476 <tr>
477 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
478 <td> A newly allocated iterator.
479 </td>
480 </tr>
481 </tbody>
482 </table></div>
483 </div>
484 <hr>
485 <div class="refsect2" title="oobs_list_iter_free ()">
486 <a name="oobs-list-iter-free"></a><h3>oobs_list_iter_free ()</h3>
487 <pre class="programlisting"><span class="returnvalue">void</span> oobs_list_iter_free (<em class="parameter"><code><a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a> *iter</code></em>);</pre>
488 <p>
489 Frees an iterator that has been allocated in the heap.
490 </p>
491 <div class="variablelist"><table border="0">
492 <col align="left" valign="top">
493 <tbody><tr>
494 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
495 <td>An <a class="link" href="OobsList.html#OobsListIter" title="OobsListIter"><span class="type">OobsListIter</span></a>.
496 </td>
497 </tr></tbody>
498 </table></div>
499 </div>
500 </div>
501 <div class="refsect1" title="Property Details">
502 <a name="OobsList.property-details"></a><h2>Property Details</h2>
503 <div class="refsect2" title='The "contained-type" property'>
504 <a name="OobsList--contained-type"></a><h3>The <code class="literal">"contained-type"</code> property</h3>
505 <pre class="programlisting"> "contained-type" <span class="type">gpointer</span> : Write / Construct Only</pre>
506 <p>GType contained in the list.</p>
507 </div>
508 </div>
509 <div class="refsect1" title="See Also">
510 <a name="OobsList.see-also"></a><h2>See Also</h2>
511 <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
512 </div>
513 </div>
514 <div class="footer">
515 <hr>
516 Generated by GTK-Doc V1.15</div>
517 </body>
518 </html>