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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="OobsList">
<refmeta>
<refentrytitle role="top_of_page" id="OobsList.top_of_page">OobsList</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsList</refname>
<refpurpose>Object to deal with several configuration elements.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsList.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#define <link linkend="OOBS-TYPE-LIST-ITER:CAPS">OOBS_TYPE_LIST_ITER</link>
<link linkend="OobsListIter">OobsListIter</link>;
<link linkend="OobsList-struct">OobsList</link>;
<link linkend="gboolean">gboolean</link> <link linkend="oobs-list-get-iter-first">oobs_list_get_iter_first</link> (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter);
<link linkend="gboolean">gboolean</link> <link linkend="oobs-list-iter-next">oobs_list_iter_next</link> (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter);
<link linkend="gboolean">gboolean</link> <link linkend="oobs-list-remove">oobs_list_remove</link> (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter);
<link linkend="void">void</link> <link linkend="oobs-list-append">oobs_list_append</link> (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter);
<link linkend="void">void</link> <link linkend="oobs-list-prepend">oobs_list_prepend</link> (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter);
<link linkend="void">void</link> <link linkend="oobs-list-insert-after">oobs_list_insert_after</link> (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *anchor,
<link linkend="OobsListIter">OobsListIter</link> *iter);
<link linkend="void">void</link> <link linkend="oobs-list-insert-before">oobs_list_insert_before</link> (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *anchor,
<link linkend="OobsListIter">OobsListIter</link> *iter);
<link linkend="GObject">GObject</link>* <link linkend="oobs-list-get">oobs_list_get</link> (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter);
<link linkend="void">void</link> <link linkend="oobs-list-set">oobs_list_set</link> (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter,
<link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link> <link linkend="oobs-list-clear">oobs_list_clear</link> (<link linkend="OobsList">OobsList</link> *list);
<link linkend="OobsListIter">OobsListIter</link>* <link linkend="oobs-list-iter-copy">oobs_list_iter_copy</link> (<link linkend="OobsListIter">OobsListIter</link> *iter);
<link linkend="void">void</link> <link linkend="oobs-list-iter-free">oobs_list_iter_free</link> (<link linkend="OobsListIter">OobsListIter</link> *iter);
<link linkend="gint">gint</link> <link linkend="oobs-list-get-n-items">oobs_list_get_n_items</link> (<link linkend="OobsList">OobsList</link> *list);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsList.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----OobsList
</synopsis>
</refsect1>
<refsect1 id="OobsList.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsList--contained-type">contained-type</link>" <link linkend="gpointer">gpointer</link> : Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="OobsList.description" role="desc">
<title role="desc.title">Description</title>
<para>
OobsList is a list object designed to store configuration elements. it provides "security" mechanisms to avoid elements corruption when i.e. underlying configuration is updated. OobsLists are created only by configuration objects, API users are only allowed to modify it.
</para>
<para>
Some configuration objects (for example, <link linkend="OobsServicesConfig"><type>OobsServicesConfig</type></link>) will provide a locked down list, users will be able to modify the contained elements, but not to add/delete elements, nor to modify the list element at that position with <link linkend="oobs-list-set"><function>oobs_list_set()</function></link>.
</para>
</refsect1>
<refsect1 id="OobsList.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OOBS-TYPE-LIST-ITER:CAPS" role="macro">
<title>OOBS_TYPE_LIST_ITER</title>
<indexterm zone="OOBS-TYPE-LIST-ITER:CAPS"><primary>OOBS_TYPE_LIST_ITER</primary></indexterm><programlisting>#define OOBS_TYPE_LIST_ITER (oobs_list_iter_get_type ())
</programlisting>
<para>
</para></refsect2>
<refsect2 id="OobsListIter" role="struct">
<title>OobsListIter</title>
<indexterm zone="OobsListIter"><primary>OobsListIter</primary></indexterm><programlisting>typedef struct {
guint stamp;
gpointer data;
} OobsListIter;
</programlisting>
<para>
OobsListIter is the element used to iterate through lists and to get/modify elements in it. Fields are not supposed to be modified by the user.
</para><variablelist role="struct">
<varlistentry>
<term><link linkend="guint">guint</link> <structfield>stamp</structfield>;</term>
<listitem><simpara>stamp to catch invalid iterators.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gpointer">gpointer</link> <structfield>data</structfield>;</term>
<listitem><simpara>iterator data.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="OobsList-struct" role="struct">
<title>OobsList</title>
<indexterm zone="OobsList-struct"><primary>OobsList</primary></indexterm><programlisting>typedef struct _OobsList OobsList;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-list-get-iter-first" role="function">
<title>oobs_list_get_iter_first ()</title>
<indexterm zone="oobs-list-get-iter-first"><primary>oobs_list_get_iter_first</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> oobs_list_get_iter_first (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter);</programlisting>
<para>
Initializes <parameter>iter</parameter> the iterator pointing to the
first element in <parameter>list</parameter>. if <parameter>list</parameter> is empty, then FALSE
is returned, and <parameter>iter</parameter> is not initialized.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> An <link linkend="OobsList"><type>OobsList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> An uninitialized <link linkend="OobsListIter"><type>OobsListIter</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if <parameter>iter</parameter> was set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-list-iter-next" role="function">
<title>oobs_list_iter_next ()</title>
<indexterm zone="oobs-list-iter-next"><primary>oobs_list_iter_next</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> oobs_list_iter_next (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter);</programlisting>
<para>
Sets <parameter>iter</parameter> to point to the element following it. If there's
no next <parameter>iter</parameter>, of if <parameter>iter</parameter> was invalid for <parameter>list</parameter>, <link linkend="FALSE:CAPS"><type>FALSE</type></link> is
returned, and <parameter>iter</parameter> is set to invalid.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> An <link linkend="OobsList"><type>OobsList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> A valid <link linkend="OobsListIter"><type>OobsListIter</type></link> pointing to an element in <parameter>list</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if iter has been correctly changed to the next element
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-list-remove" role="function">
<title>oobs_list_remove ()</title>
<indexterm zone="oobs-list-remove"><primary>oobs_list_remove</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> oobs_list_remove (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter);</programlisting>
<para>
Removes an element pointed by <parameter>iter</parameter> from <parameter>list</parameter>. This function will not
be effective if <parameter>list</parameter> is locked, or if <parameter>iter</parameter> doesn't point to an element
contained in <parameter>list</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> An <link linkend="OobsList"><type>OobsList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> A valid <link linkend="OobsListIter"><type>OobsListIter</type></link> pointing to an element in <parameter>list</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if the element was correctly removed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-list-append" role="function">
<title>oobs_list_append ()</title>
<indexterm zone="oobs-list-append"><primary>oobs_list_append</primary></indexterm><programlisting><link linkend="void">void</link> oobs_list_append (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter);</programlisting>
<para>
Appends a new element to <parameter>list</parameter>. <parameter>iter</parameter> will be changed
to point to this element, to fill in values, you need to call
<link linkend="oobs-list-set"><function>oobs_list_set()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> An <link linkend="OobsList"><type>OobsList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> An unset <link linkend="OobsListIter"><type>OobsListIter</type></link> to set to the new element
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-list-prepend" role="function">
<title>oobs_list_prepend ()</title>
<indexterm zone="oobs-list-prepend"><primary>oobs_list_prepend</primary></indexterm><programlisting><link linkend="void">void</link> oobs_list_prepend (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter);</programlisting>
<para>
Prepends a new element to <parameter>list</parameter>. <parameter>iter</parameter> will be changed
to point to this element, to fill in values, you need to call
<link linkend="oobs-list-set"><function>oobs_list_set()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> An <link linkend="OobsList"><type>OobsList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> An unset <link linkend="OobsListIter"><type>OobsListIter</type></link> to set to the new element
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-list-insert-after" role="function">
<title>oobs_list_insert_after ()</title>
<indexterm zone="oobs-list-insert-after"><primary>oobs_list_insert_after</primary></indexterm><programlisting><link linkend="void">void</link> oobs_list_insert_after (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *anchor,
<link linkend="OobsListIter">OobsListIter</link> *iter);</programlisting>
<para>
Inserts a new element after <parameter>anchor</parameter>. <parameter>iter</parameter> will be changed
to point to this element, to fill in values, you need to call
<link linkend="oobs-list-set"><function>oobs_list_set()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> An <link linkend="OobsList"><type>OobsList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>anchor</parameter> :</term>
<listitem><simpara> A valid <link linkend="OobsListIter"><type>OobsListIter</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> An unset <link linkend="OobsListIter"><type>OobsListIter</type></link> to set to the new element
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-list-insert-before" role="function">
<title>oobs_list_insert_before ()</title>
<indexterm zone="oobs-list-insert-before"><primary>oobs_list_insert_before</primary></indexterm><programlisting><link linkend="void">void</link> oobs_list_insert_before (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *anchor,
<link linkend="OobsListIter">OobsListIter</link> *iter);</programlisting>
<para>
Inserts a new element before <parameter>anchor</parameter>. <parameter>iter</parameter> will be changed
to point to this element, to fill in values, you need to call
<link linkend="oobs-list-set"><function>oobs_list_set()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> An <link linkend="OobsList"><type>OobsList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>anchor</parameter> :</term>
<listitem><simpara> A valid <link linkend="OobsListIter"><type>OobsListIter</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> An unset <link linkend="OobsListIter"><type>OobsListIter</type></link> to set to the new element
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-list-get" role="function">
<title>oobs_list_get ()</title>
<indexterm zone="oobs-list-get"><primary>oobs_list_get</primary></indexterm><programlisting><link linkend="GObject">GObject</link>* oobs_list_get (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter);</programlisting>
<para>
Retrieves a reference to the element
referenced by <link linkend="OobsListIter"><type>OobsListIter</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> an <link linkend="OobsList"><type>OobsList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> a valid <link linkend="OobsListIter"><type>OobsListIter</type></link> for the element being get
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the element referenced by <parameter>iter</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-list-set" role="function">
<title>oobs_list_set ()</title>
<indexterm zone="oobs-list-set"><primary>oobs_list_set</primary></indexterm><programlisting><link linkend="void">void</link> oobs_list_set (<link linkend="OobsList">OobsList</link> *list,
<link linkend="OobsListIter">OobsListIter</link> *iter,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Sets the data for the element referenced by <link linkend="OobsListIter"><type>OobsListIter</type></link>.
This function will not be effective if the list is locked, or
if <parameter>data</parameter> GType is different to the data contained in <link linkend="OobsList"><type>OobsList</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> an <link linkend="OobsList"><type>OobsList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> a valid <link linkend="OobsListIter"><type>OobsListIter</type></link> for the element being set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> a pointer to the data being set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-list-clear" role="function">
<title>oobs_list_clear ()</title>
<indexterm zone="oobs-list-clear"><primary>oobs_list_clear</primary></indexterm><programlisting><link linkend="void">void</link> oobs_list_clear (<link linkend="OobsList">OobsList</link> *list);</programlisting>
<para>
Removes all contents from an <link linkend="OobsList"><type>OobsList</type></link>. This function will
not be effective if the list is locked.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> an <link linkend="OobsList"><type>OobsList</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-list-iter-copy" role="function">
<title>oobs_list_iter_copy ()</title>
<indexterm zone="oobs-list-iter-copy"><primary>oobs_list_iter_copy</primary></indexterm><programlisting><link linkend="OobsListIter">OobsListIter</link>* oobs_list_iter_copy (<link linkend="OobsListIter">OobsListIter</link> *iter);</programlisting>
<para>
Returns a newly allocated copy of the given iterator. This function is not
intended for use in applications, because you can just copy the structs by
value (OobsListIter new_iter = iter;). You must free this iter with
<link linkend="oobs-list-iter-free"><function>oobs_list_iter_free()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> An <link linkend="OobsListIter"><type>OobsListIter</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated iterator.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-list-iter-free" role="function">
<title>oobs_list_iter_free ()</title>
<indexterm zone="oobs-list-iter-free"><primary>oobs_list_iter_free</primary></indexterm><programlisting><link linkend="void">void</link> oobs_list_iter_free (<link linkend="OobsListIter">OobsListIter</link> *iter);</programlisting>
<para>
Frees an iterator that has been allocated in the heap.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> An <link linkend="OobsListIter"><type>OobsListIter</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-list-get-n-items" role="function">
<title>oobs_list_get_n_items ()</title>
<indexterm zone="oobs-list-get-n-items"><primary>oobs_list_get_n_items</primary></indexterm><programlisting><link linkend="gint">gint</link> oobs_list_get_n_items (<link linkend="OobsList">OobsList</link> *list);</programlisting>
<para>
Returns the number of elements that the list contains.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> An <link linkend="OobsList"><type>OobsList</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of elements.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsList.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsList--contained-type"><title>The <literal>"contained-type"</literal> property</title>
<indexterm zone="OobsList--contained-type"><primary>OobsList:contained-type</primary></indexterm><programlisting> "contained-type" <link linkend="gpointer">gpointer</link> : Write / Construct Only</programlisting>
<para>GType contained in the list.</para></refsect2>
</refsect1>
</refentry>
|
