← Back to branch summary

~ubuntu-branches/ubuntu/precise/rhythmbox/precise-201203091205

« back to all changes in this revision

Viewing changes to doc/reference/xml/gsequence.xml

Tags: upstream-0.9.5
Import upstream version 0.9.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/gsequence.xml
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="rhythmbox-gsequence">
5
5
<refmeta>
6
 
<refentrytitle>gsequence</refentrytitle>
 
6
<refentrytitle id="top_of_page">gsequence</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
9
9
</refmeta>
10
10
 
11
11
<refnamediv>
12
 
<refname>gsequence</refname><refpurpose></refpurpose>
 
12
<refname>gsequence</refname>
 
13
<refpurpose></refpurpose>
 
14
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
13
15
</refnamediv>
14
16
 
15
 
<refsynopsisdiv><title>Synopsis</title>
 
17
<refsynopsisdiv id="synopsis">
 
18
<title id="synopsis.title">Synopsis</title>
16
19
 
17
20
<synopsis>
18
21
 
77
80
 
78
81
 
79
82
 
80
 
<refsect1>
81
 
<title>Description</title>
 
83
<refsect1 id="desc">
 
84
<title id="desc.title">Description</title>
82
85
<para>
83
86
 
84
87
</para>
85
88
</refsect1>
86
89
 
87
 
<refsect1>
88
 
<title>Details</title>
 
90
<refsect1 id="details">
 
91
<title id="details.title">Details</title>
89
92
<refsect2>
90
 
<title><anchor id="GSequence"/>GSequence</title>
 
93
<title><anchor id="GSequence" role="struct"/>GSequence</title>
91
94
<indexterm><primary>GSequence</primary></indexterm><programlisting>typedef struct _GSequence GSequence;</programlisting>
92
95
<para>
93
96
 
94
97
</para></refsect2>
95
98
<refsect2>
96
 
<title><anchor id="GSequencePtr"/>GSequencePtr</title>
 
99
<title><anchor id="GSequencePtr" role="typedef"/>GSequencePtr</title>
97
100
<indexterm><primary>GSequencePtr</primary></indexterm><programlisting>typedef struct _GSequenceNode *GSequencePtr;
98
101
</programlisting>
99
102
<para>
100
103
 
101
104
</para></refsect2>
102
105
<refsect2>
103
 
<title><anchor id="g-sequence-new"/>g_sequence_new ()</title>
 
106
<title><anchor id="g-sequence-new" role="function"/>g_sequence_new ()</title>
104
107
<indexterm><primary>g_sequence_new</primary></indexterm><programlisting><link linkend="GSequence">GSequence</link>*  g_sequence_new                  (<link linkend="GDestroyNotify">GDestroyNotify</link> data_destroy);</programlisting>
105
108
<para>
106
109
 
114
117
</simpara></listitem></varlistentry>
115
118
</variablelist></refsect2>
116
119
<refsect2>
117
 
<title><anchor id="g-sequence-free"/>g_sequence_free ()</title>
 
120
<title><anchor id="g-sequence-free" role="function"/>g_sequence_free ()</title>
118
121
<indexterm><primary>g_sequence_free</primary></indexterm><programlisting><link linkend="void">void</link>        g_sequence_free                 (<link linkend="GSequence">GSequence</link> *seq);</programlisting>
119
122
<para>
120
123
 
126
129
</simpara></listitem></varlistentry>
127
130
</variablelist></refsect2>
128
131
<refsect2>
129
 
<title><anchor id="g-sequence-sort"/>g_sequence_sort ()</title>
 
132
<title><anchor id="g-sequence-sort" role="function"/>g_sequence_sort ()</title>
130
133
<indexterm><primary>g_sequence_sort</primary></indexterm><programlisting><link linkend="void">void</link>        g_sequence_sort                 (<link linkend="GSequence">GSequence</link> *seq,
131
134
                                             <link linkend="GCompareDataFunc">GCompareDataFunc</link> cmp_func,
132
135
                                             <link linkend="gpointer">gpointer</link> cmp_data);</programlisting>
146
149
</simpara></listitem></varlistentry>
147
150
</variablelist></refsect2>
148
151
<refsect2>
149
 
<title><anchor id="g-sequence-append"/>g_sequence_append ()</title>
 
152
<title><anchor id="g-sequence-append" role="function"/>g_sequence_append ()</title>
150
153
<indexterm><primary>g_sequence_append</primary></indexterm><programlisting><link linkend="void">void</link>        g_sequence_append               (<link linkend="GSequence">GSequence</link> *seq,
151
154
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
152
155
<para>
162
165
</simpara></listitem></varlistentry>
163
166
</variablelist></refsect2>
164
167
<refsect2>
165
 
<title><anchor id="g-sequence-prepend"/>g_sequence_prepend ()</title>
 
168
<title><anchor id="g-sequence-prepend" role="function"/>g_sequence_prepend ()</title>
166
169
<indexterm><primary>g_sequence_prepend</primary></indexterm><programlisting><link linkend="void">void</link>        g_sequence_prepend              (<link linkend="GSequence">GSequence</link> *seq,
167
170
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
168
171
<para>
178
181
</simpara></listitem></varlistentry>
179
182
</variablelist></refsect2>
180
183
<refsect2>
181
 
<title><anchor id="g-sequence-insert"/>g_sequence_insert ()</title>
 
184
<title><anchor id="g-sequence-insert" role="function"/>g_sequence_insert ()</title>
182
185
<indexterm><primary>g_sequence_insert</primary></indexterm><programlisting><link linkend="void">void</link>        g_sequence_insert               (<link linkend="GSequencePtr">GSequencePtr</link> ptr,
183
186
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
184
187
<para>
194
197
</simpara></listitem></varlistentry>
195
198
</variablelist></refsect2>
196
199
<refsect2>
197
 
<title><anchor id="g-sequence-remove"/>g_sequence_remove ()</title>
 
200
<title><anchor id="g-sequence-remove" role="function"/>g_sequence_remove ()</title>
198
201
<indexterm><primary>g_sequence_remove</primary></indexterm><programlisting><link linkend="void">void</link>        g_sequence_remove               (<link linkend="GSequencePtr">GSequencePtr</link> ptr);</programlisting>
199
202
<para>
200
203
 
206
209
</simpara></listitem></varlistentry>
207
210
</variablelist></refsect2>
208
211
<refsect2>
209
 
<title><anchor id="g-sequence-insert-sorted"/>g_sequence_insert_sorted ()</title>
 
212
<title><anchor id="g-sequence-insert-sorted" role="function"/>g_sequence_insert_sorted ()</title>
210
213
<indexterm><primary>g_sequence_insert_sorted</primary></indexterm><programlisting><link linkend="GSequencePtr">GSequencePtr</link> g_sequence_insert_sorted       (<link linkend="GSequence">GSequence</link> *seq,
211
214
                                             <link linkend="gpointer">gpointer</link> data,
212
215
                                             <link linkend="GCompareDataFunc">GCompareDataFunc</link> cmp_func,
232
235
</simpara></listitem></varlistentry>
233
236
</variablelist></refsect2>
234
237
<refsect2>
235
 
<title><anchor id="g-sequence-insert-sequence"/>g_sequence_insert_sequence ()</title>
 
238
<title><anchor id="g-sequence-insert-sequence" role="function"/>g_sequence_insert_sequence ()</title>
236
239
<indexterm><primary>g_sequence_insert_sequence</primary></indexterm><programlisting><link linkend="void">void</link>        g_sequence_insert_sequence      (<link linkend="GSequencePtr">GSequencePtr</link> ptr,
237
240
                                             <link linkend="GSequence">GSequence</link> *other_seq);</programlisting>
238
241
<para>
248
251
</simpara></listitem></varlistentry>
249
252
</variablelist></refsect2>
250
253
<refsect2>
251
 
<title><anchor id="g-sequence-concatenate"/>g_sequence_concatenate ()</title>
 
254
<title><anchor id="g-sequence-concatenate" role="function"/>g_sequence_concatenate ()</title>
252
255
<indexterm><primary>g_sequence_concatenate</primary></indexterm><programlisting><link linkend="void">void</link>        g_sequence_concatenate          (<link linkend="GSequence">GSequence</link> *seq1,
253
256
                                             <link linkend="GSequence">GSequence</link> *seq);</programlisting>
254
257
<para>
264
267
</simpara></listitem></varlistentry>
265
268
</variablelist></refsect2>
266
269
<refsect2>
267
 
<title><anchor id="g-sequence-remove-range"/>g_sequence_remove_range ()</title>
 
270
<title><anchor id="g-sequence-remove-range" role="function"/>g_sequence_remove_range ()</title>
268
271
<indexterm><primary>g_sequence_remove_range</primary></indexterm><programlisting><link linkend="void">void</link>        g_sequence_remove_range         (<link linkend="GSequencePtr">GSequencePtr</link> begin,
269
272
                                             <link linkend="GSequencePtr">GSequencePtr</link> end,
270
273
                                             <link linkend="GSequence">GSequence</link> **removed);</programlisting>
284
287
</simpara></listitem></varlistentry>
285
288
</variablelist></refsect2>
286
289
<refsect2>
287
 
<title><anchor id="g-sequence-get-length"/>g_sequence_get_length ()</title>
 
290
<title><anchor id="g-sequence-get-length" role="function"/>g_sequence_get_length ()</title>
288
291
<indexterm><primary>g_sequence_get_length</primary></indexterm><programlisting><link linkend="gint">gint</link>        g_sequence_get_length           (<link linkend="GSequence">GSequence</link> *seq);</programlisting>
289
292
<para>
290
293
 
298
301
</simpara></listitem></varlistentry>
299
302
</variablelist></refsect2>
300
303
<refsect2>
301
 
<title><anchor id="g-sequence-get-end-ptr"/>g_sequence_get_end_ptr ()</title>
 
304
<title><anchor id="g-sequence-get-end-ptr" role="function"/>g_sequence_get_end_ptr ()</title>
302
305
<indexterm><primary>g_sequence_get_end_ptr</primary></indexterm><programlisting><link linkend="GSequencePtr">GSequencePtr</link> g_sequence_get_end_ptr         (<link linkend="GSequence">GSequence</link> *seq);</programlisting>
303
306
<para>
304
307
 
312
315
</simpara></listitem></varlistentry>
313
316
</variablelist></refsect2>
314
317
<refsect2>
315
 
<title><anchor id="g-sequence-get-begin-ptr"/>g_sequence_get_begin_ptr ()</title>
 
318
<title><anchor id="g-sequence-get-begin-ptr" role="function"/>g_sequence_get_begin_ptr ()</title>
316
319
<indexterm><primary>g_sequence_get_begin_ptr</primary></indexterm><programlisting><link linkend="GSequencePtr">GSequencePtr</link> g_sequence_get_begin_ptr       (<link linkend="GSequence">GSequence</link> *seq);</programlisting>
317
320
<para>
318
321
 
326
329
</simpara></listitem></varlistentry>
327
330
</variablelist></refsect2>
328
331
<refsect2>
329
 
<title><anchor id="g-sequence-get-ptr-at-pos"/>g_sequence_get_ptr_at_pos ()</title>
 
332
<title><anchor id="g-sequence-get-ptr-at-pos" role="function"/>g_sequence_get_ptr_at_pos ()</title>
330
333
<indexterm><primary>g_sequence_get_ptr_at_pos</primary></indexterm><programlisting><link linkend="GSequencePtr">GSequencePtr</link> g_sequence_get_ptr_at_pos      (<link linkend="GSequence">GSequence</link> *seq,
331
334
                                             <link linkend="gint">gint</link> pos);</programlisting>
332
335
<para>
344
347
</simpara></listitem></varlistentry>
345
348
</variablelist></refsect2>
346
349
<refsect2>
347
 
<title><anchor id="g-sequence-ptr-is-end"/>g_sequence_ptr_is_end ()</title>
 
350
<title><anchor id="g-sequence-ptr-is-end" role="function"/>g_sequence_ptr_is_end ()</title>
348
351
<indexterm><primary>g_sequence_ptr_is_end</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    g_sequence_ptr_is_end           (<link linkend="GSequencePtr">GSequencePtr</link> ptr);</programlisting>
349
352
<para>
350
353
 
358
361
</simpara></listitem></varlistentry>
359
362
</variablelist></refsect2>
360
363
<refsect2>
361
 
<title><anchor id="g-sequence-ptr-is-begin"/>g_sequence_ptr_is_begin ()</title>
 
364
<title><anchor id="g-sequence-ptr-is-begin" role="function"/>g_sequence_ptr_is_begin ()</title>
362
365
<indexterm><primary>g_sequence_ptr_is_begin</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    g_sequence_ptr_is_begin         (<link linkend="GSequencePtr">GSequencePtr</link> ptr);</programlisting>
363
366
<para>
364
367
 
372
375
</simpara></listitem></varlistentry>
373
376
</variablelist></refsect2>
374
377
<refsect2>
375
 
<title><anchor id="g-sequence-ptr-get-position"/>g_sequence_ptr_get_position ()</title>
 
378
<title><anchor id="g-sequence-ptr-get-position" role="function"/>g_sequence_ptr_get_position ()</title>
376
379
<indexterm><primary>g_sequence_ptr_get_position</primary></indexterm><programlisting><link linkend="gint">gint</link>        g_sequence_ptr_get_position     (<link linkend="GSequencePtr">GSequencePtr</link> ptr);</programlisting>
377
380
<para>
378
381
 
386
389
</simpara></listitem></varlistentry>
387
390
</variablelist></refsect2>
388
391
<refsect2>
389
 
<title><anchor id="g-sequence-ptr-next"/>g_sequence_ptr_next ()</title>
 
392
<title><anchor id="g-sequence-ptr-next" role="function"/>g_sequence_ptr_next ()</title>
390
393
<indexterm><primary>g_sequence_ptr_next</primary></indexterm><programlisting><link linkend="GSequencePtr">GSequencePtr</link> g_sequence_ptr_next            (<link linkend="GSequencePtr">GSequencePtr</link> ptr);</programlisting>
391
394
<para>
392
395
 
400
403
</simpara></listitem></varlistentry>
401
404
</variablelist></refsect2>
402
405
<refsect2>
403
 
<title><anchor id="g-sequence-ptr-prev"/>g_sequence_ptr_prev ()</title>
 
406
<title><anchor id="g-sequence-ptr-prev" role="function"/>g_sequence_ptr_prev ()</title>
404
407
<indexterm><primary>g_sequence_ptr_prev</primary></indexterm><programlisting><link linkend="GSequencePtr">GSequencePtr</link> g_sequence_ptr_prev            (<link linkend="GSequencePtr">GSequencePtr</link> ptr);</programlisting>
405
408
<para>
406
409
 
414
417
</simpara></listitem></varlistentry>
415
418
</variablelist></refsect2>
416
419
<refsect2>
417
 
<title><anchor id="g-sequence-ptr-move"/>g_sequence_ptr_move ()</title>
 
420
<title><anchor id="g-sequence-ptr-move" role="function"/>g_sequence_ptr_move ()</title>
418
421
<indexterm><primary>g_sequence_ptr_move</primary></indexterm><programlisting><link linkend="GSequencePtr">GSequencePtr</link> g_sequence_ptr_move            (<link linkend="GSequencePtr">GSequencePtr</link> ptr,
419
422
                                             <link linkend="guint">guint</link> leap);</programlisting>
420
423
<para>
432
435
</simpara></listitem></varlistentry>
433
436
</variablelist></refsect2>
434
437
<refsect2>
435
 
<title><anchor id="g-sequence-ptr-sort-changed"/>g_sequence_ptr_sort_changed ()</title>
 
438
<title><anchor id="g-sequence-ptr-sort-changed" role="function"/>g_sequence_ptr_sort_changed ()</title>
436
439
<indexterm><primary>g_sequence_ptr_sort_changed</primary></indexterm><programlisting><link linkend="void">void</link>        g_sequence_ptr_sort_changed     (<link linkend="GSequencePtr">GSequencePtr</link> ptr,
437
440
                                             <link linkend="GCompareDataFunc">GCompareDataFunc</link> cmp_func,
438
441
                                             <link linkend="gpointer">gpointer</link> cmp_data);</programlisting>
452
455
</simpara></listitem></varlistentry>
453
456
</variablelist></refsect2>
454
457
<refsect2>
455
 
<title><anchor id="g-sequence-ptr-get-data"/>g_sequence_ptr_get_data ()</title>
 
458
<title><anchor id="g-sequence-ptr-get-data" role="function"/>g_sequence_ptr_get_data ()</title>
456
459
<indexterm><primary>g_sequence_ptr_get_data</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>    g_sequence_ptr_get_data         (<link linkend="GSequencePtr">GSequencePtr</link> ptr);</programlisting>
457
460
<para>
458
461
 
466
469
</simpara></listitem></varlistentry>
467
470
</variablelist></refsect2>
468
471
<refsect2>
469
 
<title><anchor id="GSequenceSearchFunc"/>GSequenceSearchFunc ()</title>
 
472
<title><anchor id="GSequenceSearchFunc" role="function"/>GSequenceSearchFunc ()</title>
470
473
<indexterm><primary>GSequenceSearchFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    (*GSequenceSearchFunc)          (<link linkend="GSequencePtr">GSequencePtr</link> begin,
471
474
                                             <link linkend="GSequencePtr">GSequencePtr</link> end,
472
475
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
488
491
</simpara></listitem></varlistentry>
489
492
</variablelist></refsect2>
490
493
<refsect2>
491
 
<title><anchor id="g-sequence-search"/>g_sequence_search ()</title>
 
494
<title><anchor id="g-sequence-search" role="function"/>g_sequence_search ()</title>
492
495
<indexterm><primary>g_sequence_search</primary></indexterm><programlisting><link linkend="void">void</link>        g_sequence_search               (<link linkend="GSequence">GSequence</link> *seq,
493
496
                                             <link linkend="GSequenceSearchFunc">GSequenceSearchFunc</link> f,
494
497
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
508
511
</simpara></listitem></varlistentry>
509
512
</variablelist></refsect2>
510
513
<refsect2>
511
 
<title><anchor id="g-sequence-calc-tree-height"/>g_sequence_calc_tree_height ()</title>
 
514
<title><anchor id="g-sequence-calc-tree-height" role="function"/>g_sequence_calc_tree_height ()</title>
512
515
<indexterm><primary>g_sequence_calc_tree_height</primary></indexterm><programlisting><link linkend="gint">gint</link>        g_sequence_calc_tree_height     (<link linkend="GSequence">GSequence</link> *seq);</programlisting>
513
516
<para>
514
517