← Back to branch summary

~ubuntu-branches/ubuntu/utopic/rhythmbox/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/reference/html/rhythmbox-rhythmdb-query-model.html

Tags: upstream-0.9.2
Import upstream version 0.9.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/rhythmbox-rhythmdb-query-model.html
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>rhythmdb-query-model</title>
 
5
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<link rel="start" href="index.html" title="Rhythmbox Development Reference Manual">
 
7
<link rel="up" href="ch05.html" title="RhythmDB">
 
8
<link rel="prev" href="rhythmbox-rhythmdb-property-model.html" title="rhythmdb-property-model">
 
9
<link rel="next" href="rhythmbox-rhythmdb-tree.html" title="rhythmdb-tree">
 
10
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
 
11
<link rel="stylesheet" href="style.css" type="text/css">
 
12
<link rel="chapter" href="ch01.html" title="IRadio UI">
 
13
<link rel="chapter" href="ch02.html" title="Lib">
 
14
<link rel="chapter" href="ch03.html" title="Metadata">
 
15
<link rel="chapter" href="ch04.html" title="Player">
 
16
<link rel="chapter" href="ch05.html" title="RhythmDB">
 
17
<link rel="chapter" href="ch06.html" title="Shell">
 
18
<link rel="chapter" href="ch07.html" title="Sources">
 
19
<link rel="chapter" href="ch08.html" title="Widgets">
 
20
</head>
 
21
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
22
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
 
23
<td><a accesskey="p" href="rhythmbox-rhythmdb-property-model.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
25
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
26
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
 
27
<td><a accesskey="n" href="rhythmbox-rhythmdb-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
28
</tr></table>
 
29
<div class="refentry" lang="en">
 
30
<a name="rhythmbox-rhythmdb-query-model"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle">rhythmdb-query-model</span></h2>
 
34
<p>rhythmdb-query-model &#8212; </p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<h2>Synopsis</h2>
 
40
<pre class="synopsis">
 
41
 
 
42
 
 
43
 
 
44
typedef     <a href="rhythmbox-rhythmdb-query-model.html#RhythmDBQueryModelPrivate">RhythmDBQueryModelPrivate</a>;
 
45
#define     <a href="rhythmbox-rhythmdb-query-model.html#RHYTHMDB-QUERY-MODEL-SUGGESTED-UPDATE-CHUNK:CAPS">RHYTHMDB_QUERY_MODEL_SUGGESTED_UPDATE_CHUNK</a>
 
46
RhythmDBQueryModel* <a href="rhythmbox-rhythmdb-query-model.html#rhythmdb-query-model-new">rhythmdb_query_model_new</a>
 
47
                                            (RhythmDB *db,
 
48
                                             GPtrArray *query,
 
49
                                             GCompareDataFunc sort_func,
 
50
                                             gpointer user_data);
 
51
RhythmDBQueryModel* <a href="rhythmbox-rhythmdb-query-model.html#rhythmdb-query-model-new-empty">rhythmdb_query_model_new_empty</a>
 
52
                                            (RhythmDB *db);
 
53
void        <a href="rhythmbox-rhythmdb-query-model.html#rhythmdb-query-model-add-entry">rhythmdb_query_model_add_entry</a>  (RhythmDBQueryModel *model,
 
54
                                             <a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a> *entry);
 
55
void        <a href="rhythmbox-rhythmdb-query-model.html#rhythmdb-query-model-add-entries">rhythmdb_query_model_add_entries</a>
 
56
                                            (RhythmDBQueryModel *model,
 
57
                                             GPtrArray *entries);
 
58
gboolean    <a href="rhythmbox-rhythmdb-query-model.html#rhythmdb-query-model-remove-entry">rhythmdb_query_model_remove_entry</a>
 
59
                                            (RhythmDBQueryModel *model,
 
60
                                             <a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a> *entry);
 
61
void        <a href="rhythmbox-rhythmdb-query-model.html#rhythmdb-query-model-set-connected">rhythmdb_query_model_set_connected</a>
 
62
                                            (RhythmDBQueryModel *model,
 
63
                                             gboolean connected);
 
64
void        <a href="rhythmbox-rhythmdb-query-model.html#rhythmdb-query-model-signal-complete">rhythmdb_query_model_signal_complete</a>
 
65
                                            (RhythmDBQueryModel *model);
 
66
GnomeVFSFileSize <a href="rhythmbox-rhythmdb-query-model.html#rhythmdb-query-model-get-size">rhythmdb_query_model_get_size</a>
 
67
                                            (RhythmDBQueryModel *model);
 
68
long        <a href="rhythmbox-rhythmdb-query-model.html#rhythmdb-query-model-get-duration">rhythmdb_query_model_get_duration</a>
 
69
                                            (RhythmDBQueryModel *model);
 
70
gboolean    <a href="rhythmbox-rhythmdb-query-model.html#rhythmdb-query-model-entry-to-iter">rhythmdb_query_model_entry_to_iter</a>
 
71
                                            (RhythmDBQueryModel *model,
 
72
                                             <a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a> *entry,
 
73
                                             GtkTreeIter *iter);
 
74
gboolean    <a href="rhythmbox-rhythmdb-query-model.html#rhythmdb-query-model-has-pending-changes">rhythmdb_query_model_has_pending_changes</a>
 
75
                                            (RhythmDBQueryModel *model);
 
76
 
 
77
</pre>
 
78
</div>
 
79
<div class="refsect1" lang="en">
 
80
<a name="id2535622"></a><h2>Description</h2>
 
81
<p>
 
82
 
 
83
</p>
 
84
</div>
 
85
<div class="refsect1" lang="en">
 
86
<a name="id2535633"></a><h2>Details</h2>
 
87
<div class="refsect2" lang="en">
 
88
<a name="id2535639"></a><h3>
 
89
<a name="RhythmDBQueryModelPrivate"></a>RhythmDBQueryModelPrivate</h3>
 
90
<a class="indexterm" name="id2535648"></a><pre class="programlisting">typedef struct RhythmDBQueryModelPrivate RhythmDBQueryModelPrivate;
 
91
</pre>
 
92
<p>
 
93
 
 
94
</p>
 
95
</div>
 
96
<hr>
 
97
<div class="refsect2" lang="en">
 
98
<a name="id2535664"></a><h3>
 
99
<a name="RHYTHMDB-QUERY-MODEL-SUGGESTED-UPDATE-CHUNK:CAPS"></a>RHYTHMDB_QUERY_MODEL_SUGGESTED_UPDATE_CHUNK</h3>
 
100
<a class="indexterm" name="id2535676"></a><pre class="programlisting">#define RHYTHMDB_QUERY_MODEL_SUGGESTED_UPDATE_CHUNK 32
 
101
</pre>
 
102
<p>
 
103
 
 
104
</p>
 
105
</div>
 
106
<hr>
 
107
<div class="refsect2" lang="en">
 
108
<a name="id2567794"></a><h3>
 
109
<a name="rhythmdb-query-model-new"></a>rhythmdb_query_model_new ()</h3>
 
110
<a class="indexterm" name="id2567802"></a><pre class="programlisting">RhythmDBQueryModel* rhythmdb_query_model_new
 
111
                                            (RhythmDB *db,
 
112
                                             GPtrArray *query,
 
113
                                             GCompareDataFunc sort_func,
 
114
                                             gpointer user_data);</pre>
 
115
<p>
 
116
 
 
117
</p>
 
118
<div class="variablelist"><table border="0">
 
119
<col align="left" valign="top">
 
120
<tbody>
 
121
<tr>
 
122
<td>
 
123
<span class="term"><em class="parameter"><code>db</code></em>&#160;:</span></td>
 
124
<td>
 
125
</td>
 
126
</tr>
 
127
<tr>
 
128
<td>
 
129
<span class="term"><em class="parameter"><code>query</code></em>&#160;:</span></td>
 
130
<td>
 
131
</td>
 
132
</tr>
 
133
<tr>
 
134
<td>
 
135
<span class="term"><em class="parameter"><code>sort_func</code></em>&#160;:</span></td>
 
136
<td>
 
137
</td>
 
138
</tr>
 
139
<tr>
 
140
<td>
 
141
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
142
<td>
 
143
</td>
 
144
</tr>
 
145
<tr>
 
146
<td>
 
147
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
148
<td>
 
149
 
 
150
 
 
151
</td>
 
152
</tr>
 
153
</tbody>
 
154
</table></div>
 
155
</div>
 
156
<hr>
 
157
<div class="refsect2" lang="en">
 
158
<a name="id2567923"></a><h3>
 
159
<a name="rhythmdb-query-model-new-empty"></a>rhythmdb_query_model_new_empty ()</h3>
 
160
<a class="indexterm" name="id2567933"></a><pre class="programlisting">RhythmDBQueryModel* rhythmdb_query_model_new_empty
 
161
                                            (RhythmDB *db);</pre>
 
162
<p>
 
163
 
 
164
</p>
 
165
<div class="variablelist"><table border="0">
 
166
<col align="left" valign="top">
 
167
<tbody>
 
168
<tr>
 
169
<td>
 
170
<span class="term"><em class="parameter"><code>db</code></em>&#160;:</span></td>
 
171
<td>
 
172
</td>
 
173
</tr>
 
174
<tr>
 
175
<td>
 
176
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
177
<td>
 
178
 
 
179
 
 
180
</td>
 
181
</tr>
 
182
</tbody>
 
183
</table></div>
 
184
</div>
 
185
<hr>
 
186
<div class="refsect2" lang="en">
 
187
<a name="id2567991"></a><h3>
 
188
<a name="rhythmdb-query-model-add-entry"></a>rhythmdb_query_model_add_entry ()</h3>
 
189
<a class="indexterm" name="id2568002"></a><pre class="programlisting">void        rhythmdb_query_model_add_entry  (RhythmDBQueryModel *model,
 
190
                                             <a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a> *entry);</pre>
 
191
<p>
 
192
 
 
193
</p>
 
194
<div class="variablelist"><table border="0">
 
195
<col align="left" valign="top">
 
196
<tbody>
 
197
<tr>
 
198
<td>
 
199
<span class="term"><em class="parameter"><code>model</code></em>&#160;:</span></td>
 
200
<td>
 
201
</td>
 
202
</tr>
 
203
<tr>
 
204
<td>
 
205
<span class="term"><em class="parameter"><code>entry</code></em>&#160;:</span></td>
 
206
<td>
 
207
 
 
208
 
 
209
</td>
 
210
</tr>
 
211
</tbody>
 
212
</table></div>
 
213
</div>
 
214
<hr>
 
215
<div class="refsect2" lang="en">
 
216
<a name="id2564571"></a><h3>
 
217
<a name="rhythmdb-query-model-add-entries"></a>rhythmdb_query_model_add_entries ()</h3>
 
218
<a class="indexterm" name="id2564582"></a><pre class="programlisting">void        rhythmdb_query_model_add_entries
 
219
                                            (RhythmDBQueryModel *model,
 
220
                                             GPtrArray *entries);</pre>
 
221
<p>
 
222
 
 
223
</p>
 
224
<div class="variablelist"><table border="0">
 
225
<col align="left" valign="top">
 
226
<tbody>
 
227
<tr>
 
228
<td>
 
229
<span class="term"><em class="parameter"><code>model</code></em>&#160;:</span></td>
 
230
<td>
 
231
</td>
 
232
</tr>
 
233
<tr>
 
234
<td>
 
235
<span class="term"><em class="parameter"><code>entries</code></em>&#160;:</span></td>
 
236
<td>
 
237
 
 
238
 
 
239
</td>
 
240
</tr>
 
241
</tbody>
 
242
</table></div>
 
243
</div>
 
244
<hr>
 
245
<div class="refsect2" lang="en">
 
246
<a name="id2564650"></a><h3>
 
247
<a name="rhythmdb-query-model-remove-entry"></a>rhythmdb_query_model_remove_entry ()</h3>
 
248
<a class="indexterm" name="id2564662"></a><pre class="programlisting">gboolean    rhythmdb_query_model_remove_entry
 
249
                                            (RhythmDBQueryModel *model,
 
250
                                             <a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a> *entry);</pre>
 
251
<p>
 
252
 
 
253
</p>
 
254
<div class="variablelist"><table border="0">
 
255
<col align="left" valign="top">
 
256
<tbody>
 
257
<tr>
 
258
<td>
 
259
<span class="term"><em class="parameter"><code>model</code></em>&#160;:</span></td>
 
260
<td>
 
261
</td>
 
262
</tr>
 
263
<tr>
 
264
<td>
 
265
<span class="term"><em class="parameter"><code>entry</code></em>&#160;:</span></td>
 
266
<td>
 
267
</td>
 
268
</tr>
 
269
<tr>
 
270
<td>
 
271
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
272
<td>
 
273
 
 
274
 
 
275
</td>
 
276
</tr>
 
277
</tbody>
 
278
</table></div>
 
279
</div>
 
280
<hr>
 
281
<div class="refsect2" lang="en">
 
282
<a name="id2564740"></a><h3>
 
283
<a name="rhythmdb-query-model-set-connected"></a>rhythmdb_query_model_set_connected ()</h3>
 
284
<a class="indexterm" name="id2564752"></a><pre class="programlisting">void        rhythmdb_query_model_set_connected
 
285
                                            (RhythmDBQueryModel *model,
 
286
                                             gboolean connected);</pre>
 
287
<p>
 
288
 
 
289
</p>
 
290
<div class="variablelist"><table border="0">
 
291
<col align="left" valign="top">
 
292
<tbody>
 
293
<tr>
 
294
<td>
 
295
<span class="term"><em class="parameter"><code>model</code></em>&#160;:</span></td>
 
296
<td>
 
297
</td>
 
298
</tr>
 
299
<tr>
 
300
<td>
 
301
<span class="term"><em class="parameter"><code>connected</code></em>&#160;:</span></td>
 
302
<td>
 
303
 
 
304
 
 
305
</td>
 
306
</tr>
 
307
</tbody>
 
308
</table></div>
 
309
</div>
 
310
<hr>
 
311
<div class="refsect2" lang="en">
 
312
<a name="id2564820"></a><h3>
 
313
<a name="rhythmdb-query-model-signal-complete"></a>rhythmdb_query_model_signal_complete ()</h3>
 
314
<a class="indexterm" name="id2568876"></a><pre class="programlisting">void        rhythmdb_query_model_signal_complete
 
315
                                            (RhythmDBQueryModel *model);</pre>
 
316
<p>
 
317
 
 
318
</p>
 
319
<div class="variablelist"><table border="0">
 
320
<col align="left" valign="top">
 
321
<tbody><tr>
 
322
<td>
 
323
<span class="term"><em class="parameter"><code>model</code></em>&#160;:</span></td>
 
324
<td>
 
325
 
 
326
 
 
327
</td>
 
328
</tr></tbody>
 
329
</table></div>
 
330
</div>
 
331
<hr>
 
332
<div class="refsect2" lang="en">
 
333
<a name="id2568918"></a><h3>
 
334
<a name="rhythmdb-query-model-get-size"></a>rhythmdb_query_model_get_size ()</h3>
 
335
<a class="indexterm" name="id2568928"></a><pre class="programlisting">GnomeVFSFileSize rhythmdb_query_model_get_size
 
336
                                            (RhythmDBQueryModel *model);</pre>
 
337
<p>
 
338
 
 
339
</p>
 
340
<div class="variablelist"><table border="0">
 
341
<col align="left" valign="top">
 
342
<tbody>
 
343
<tr>
 
344
<td>
 
345
<span class="term"><em class="parameter"><code>model</code></em>&#160;:</span></td>
 
346
<td>
 
347
</td>
 
348
</tr>
 
349
<tr>
 
350
<td>
 
351
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
352
<td>
 
353
 
 
354
 
 
355
</td>
 
356
</tr>
 
357
</tbody>
 
358
</table></div>
 
359
</div>
 
360
<hr>
 
361
<div class="refsect2" lang="en">
 
362
<a name="id2568980"></a><h3>
 
363
<a name="rhythmdb-query-model-get-duration"></a>rhythmdb_query_model_get_duration ()</h3>
 
364
<a class="indexterm" name="id2568991"></a><pre class="programlisting">long        rhythmdb_query_model_get_duration
 
365
                                            (RhythmDBQueryModel *model);</pre>
 
366
<p>
 
367
 
 
368
</p>
 
369
<div class="variablelist"><table border="0">
 
370
<col align="left" valign="top">
 
371
<tbody>
 
372
<tr>
 
373
<td>
 
374
<span class="term"><em class="parameter"><code>model</code></em>&#160;:</span></td>
 
375
<td>
 
376
</td>
 
377
</tr>
 
378
<tr>
 
379
<td>
 
380
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
381
<td>
 
382
 
 
383
 
 
384
</td>
 
385
</tr>
 
386
</tbody>
 
387
</table></div>
 
388
</div>
 
389
<hr>
 
390
<div class="refsect2" lang="en">
 
391
<a name="id2569045"></a><h3>
 
392
<a name="rhythmdb-query-model-entry-to-iter"></a>rhythmdb_query_model_entry_to_iter ()</h3>
 
393
<a class="indexterm" name="id2569056"></a><pre class="programlisting">gboolean    rhythmdb_query_model_entry_to_iter
 
394
                                            (RhythmDBQueryModel *model,
 
395
                                             <a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a> *entry,
 
396
                                             GtkTreeIter *iter);</pre>
 
397
<p>
 
398
 
 
399
</p>
 
400
<div class="variablelist"><table border="0">
 
401
<col align="left" valign="top">
 
402
<tbody>
 
403
<tr>
 
404
<td>
 
405
<span class="term"><em class="parameter"><code>model</code></em>&#160;:</span></td>
 
406
<td>
 
407
</td>
 
408
</tr>
 
409
<tr>
 
410
<td>
 
411
<span class="term"><em class="parameter"><code>entry</code></em>&#160;:</span></td>
 
412
<td>
 
413
</td>
 
414
</tr>
 
415
<tr>
 
416
<td>
 
417
<span class="term"><em class="parameter"><code>iter</code></em>&#160;:</span></td>
 
418
<td>
 
419
</td>
 
420
</tr>
 
421
<tr>
 
422
<td>
 
423
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
424
<td>
 
425
 
 
426
 
 
427
</td>
 
428
</tr>
 
429
</tbody>
 
430
</table></div>
 
431
</div>
 
432
<hr>
 
433
<div class="refsect2" lang="en">
 
434
<a name="id2569156"></a><h3>
 
435
<a name="rhythmdb-query-model-has-pending-changes"></a>rhythmdb_query_model_has_pending_changes ()</h3>
 
436
<a class="indexterm" name="id2569167"></a><pre class="programlisting">gboolean    rhythmdb_query_model_has_pending_changes
 
437
                                            (RhythmDBQueryModel *model);</pre>
 
438
<p>
 
439
 
 
440
</p>
 
441
<div class="variablelist"><table border="0">
 
442
<col align="left" valign="top">
 
443
<tbody>
 
444
<tr>
 
445
<td>
 
446
<span class="term"><em class="parameter"><code>model</code></em>&#160;:</span></td>
 
447
<td>
 
448
</td>
 
449
</tr>
 
450
<tr>
 
451
<td>
 
452
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
453
<td>
 
454
 
 
455
 
 
456
</td>
 
457
</tr>
 
458
</tbody>
 
459
</table></div>
 
460
</div>
 
461
</div>
 
462
</div>
 
463
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
 
464
<td align="left"><a accesskey="p" href="rhythmbox-rhythmdb-property-model.html"><b>&lt;&lt;&#160;rhythmdb-property-model</b></a></td>
 
465
<td align="right"><a accesskey="n" href="rhythmbox-rhythmdb-tree.html"><b>rhythmdb-tree&#160;&gt;&gt;</b></a></td>
 
466
</tr></table>
 
467
</body>
 
468
</html>