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

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-entry-view.xml

Tags: upstream-0.9.2cvs20060102
ImportĀ upstreamĀ versionĀ 0.9.2cvs20060102

Show diffs side-by-side

added added

removed removed

Lines of Context:
21
21
enum        <link linkend="RBEntryViewColumn">RBEntryViewColumn</link>;
22
22
typedef     <link linkend="RBEntryViewPrivate">RBEntryViewPrivate</link>;
23
23
<link linkend="RBEntryView">RBEntryView</link>* <link linkend="rb-entry-view-new">rb_entry_view_new</link>              (<link linkend="RhythmDB">RhythmDB</link> *db,
 
24
                                             <link linkend="GObject">GObject</link> *shell_player,
24
25
                                             const <link linkend="char">char</link> *sort_key,
25
26
                                             <link linkend="gboolean">gboolean</link> drag_source,
26
27
                                             <link linkend="gboolean">gboolean</link> drag_dest);
38
39
                                             <link linkend="gboolean">gboolean</link> clickable);
39
40
<link linkend="void">void</link>        <link linkend="rb-entry-view-set-model">rb_entry_view_set_model</link>         (<link linkend="RBEntryView">RBEntryView</link> *view,
40
41
                                             <link linkend="RhythmDBQueryModel">RhythmDBQueryModel</link> *model);
41
 
<link linkend="gboolean">gboolean</link>    <link linkend="rb-entry-view-busy">rb_entry_view_busy</link>              (<link linkend="RBEntryView">RBEntryView</link> *view);
42
 
<link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> <link linkend="rb-entry-view-get-total-size">rb_entry_view_get_total_size</link>
43
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view);
44
 
<link linkend="glong">glong</link>       <link linkend="rb-entry-view-get-duration">rb_entry_view_get_duration</link>      (<link linkend="RBEntryView">RBEntryView</link> *view);
45
 
<link linkend="void">void</link>        <link linkend="rb-entry-view-set-playing">rb_entry_view_set_playing</link>       (<link linkend="RBEntryView">RBEntryView</link> *view,
46
 
                                             <link linkend="gboolean">gboolean</link> playing);
47
 
<link linkend="void">void</link>        <link linkend="rb-entry-view-set-playing-entry">rb_entry_view_set_playing_entry</link> (<link linkend="RBEntryView">RBEntryView</link> *view,
48
 
                                             <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);
49
 
<link linkend="RhythmDBEntry">RhythmDBEntry</link>* <link linkend="rb-entry-view-get-playing-entry">rb_entry_view_get_playing_entry</link>
50
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view);
51
 
<link linkend="RhythmDBEntry">RhythmDBEntry</link>* <link linkend="rb-entry-view-get-first-entry">rb_entry_view_get_first_entry</link>
52
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view);
53
 
<link linkend="RhythmDBEntry">RhythmDBEntry</link>* <link linkend="rb-entry-view-get-next-entry">rb_entry_view_get_next_entry</link> (<link linkend="RBEntryView">RBEntryView</link> *view);
54
 
<link linkend="RhythmDBEntry">RhythmDBEntry</link>* <link linkend="rb-entry-view-get-previous-entry">rb_entry_view_get_previous_entry</link>
55
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view);
56
 
<link linkend="RhythmDBEntry">RhythmDBEntry</link>* <link linkend="rb-entry-view-get-next-from-entry">rb_entry_view_get_next_from_entry</link>
57
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view,
58
 
                                             <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);
59
 
<link linkend="RhythmDBEntry">RhythmDBEntry</link>* <link linkend="rb-entry-view-get-previous-from-entry">rb_entry_view_get_previous_from_entry</link>
60
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view,
61
 
                                             <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);
62
42
<link linkend="gboolean">gboolean</link>    <link linkend="rb-entry-view-have-selection">rb_entry_view_have_selection</link>    (<link linkend="RBEntryView">RBEntryView</link> *view);
63
43
<link linkend="GList">GList</link>*      <link linkend="rb-entry-view-get-selected-entries">rb_entry_view_get_selected_entries</link>
64
44
                                            (<link linkend="RBEntryView">RBEntryView</link> *view);
66
46
<link linkend="void">void</link>        <link linkend="rb-entry-view-select-none">rb_entry_view_select_none</link>       (<link linkend="RBEntryView">RBEntryView</link> *view);
67
47
<link linkend="void">void</link>        <link linkend="rb-entry-view-select-entry">rb_entry_view_select_entry</link>      (<link linkend="RBEntryView">RBEntryView</link> *view,
68
48
                                             <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);
69
 
<link linkend="guint">guint</link>       <link linkend="rb-entry-view-get-num-entries">rb_entry_view_get_num_entries</link>   (<link linkend="RBEntryView">RBEntryView</link> *view);
70
49
<link linkend="gboolean">gboolean</link>    <link linkend="rb-entry-view-get-entry-contained">rb_entry_view_get_entry_contained</link>
71
50
                                            (<link linkend="RBEntryView">RBEntryView</link> *view,
72
51
                                             <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);
78
57
                                            (<link linkend="RBEntryView">RBEntryView</link> *view,
79
58
                                             const <link linkend="GtkTargetEntry">GtkTargetEntry</link> *targets,
80
59
                                             <link linkend="int">int</link> n_targets);
81
 
<link linkend="RhythmDBEntry">RhythmDBEntry</link>* <link linkend="rb-entry-view-get-random-entry">rb_entry_view_get_random_entry</link>
82
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view);
83
60
<link linkend="void">void</link>        <link linkend="rb-entry-view-get-sorting-order">rb_entry_view_get_sorting_order</link> (<link linkend="RBEntryView">RBEntryView</link> *view,
84
61
                                             const <link linkend="char">char</link> **column_name,
85
62
                                             <link linkend="gint">gint</link> *sort_order);
89
66
const <link linkend="char">char</link>* <link linkend="rb-entry-view-get-sorting-type">rb_entry_view_get_sorting_type</link>  (<link linkend="RBEntryView">RBEntryView</link> *view);
90
67
<link linkend="void">void</link>        <link linkend="rb-entry-view-set-sorting-type">rb_entry_view_set_sorting_type</link>  (<link linkend="RBEntryView">RBEntryView</link> *view,
91
68
                                             const <link linkend="char">char</link> *sorttype);
92
 
<link linkend="void">void</link>        <link linkend="rb-entry-view-set-resorting">rb_entry_view_set_resorting</link>     (<link linkend="RBEntryView">RBEntryView</link> *view);
93
69
 
94
70
</synopsis>
95
71
</refsynopsisdiv>
141
117
<refsect2>
142
118
<title><anchor id="rb-entry-view-new"/>rb_entry_view_new ()</title>
143
119
<indexterm><primary>rb_entry_view_new</primary></indexterm><programlisting><link linkend="RBEntryView">RBEntryView</link>* rb_entry_view_new              (<link linkend="RhythmDB">RhythmDB</link> *db,
 
120
                                             <link linkend="GObject">GObject</link> *shell_player,
144
121
                                             const <link linkend="char">char</link> *sort_key,
145
122
                                             <link linkend="gboolean">gboolean</link> drag_source,
146
123
                                             <link linkend="gboolean">gboolean</link> drag_dest);</programlisting>
150
127
<varlistentry><term><parameter>db</parameter>&nbsp;:</term>
151
128
<listitem><simpara>
152
129
</simpara></listitem></varlistentry>
 
130
<varlistentry><term><parameter>shell_player</parameter>&nbsp;:</term>
 
131
<listitem><simpara>
 
132
</simpara></listitem></varlistentry>
153
133
<varlistentry><term><parameter>sort_key</parameter>&nbsp;:</term>
154
134
<listitem><simpara>
155
135
</simpara></listitem></varlistentry>
247
227
</simpara></listitem></varlistentry>
248
228
</variablelist></refsect2>
249
229
<refsect2>
250
 
<title><anchor id="rb-entry-view-busy"/>rb_entry_view_busy ()</title>
251
 
<indexterm><primary>rb_entry_view_busy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_entry_view_busy              (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
252
 
<para>
253
 
 
254
 
</para><variablelist role="params">
255
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
256
 
<listitem><simpara>
257
 
</simpara></listitem></varlistentry>
258
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
259
 
 
260
 
 
261
 
</simpara></listitem></varlistentry>
262
 
</variablelist></refsect2>
263
 
<refsect2>
264
 
<title><anchor id="rb-entry-view-get-total-size"/>rb_entry_view_get_total_size ()</title>
265
 
<indexterm><primary>rb_entry_view_get_total_size</primary></indexterm><programlisting><link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> rb_entry_view_get_total_size
266
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
267
 
<para>
268
 
 
269
 
</para><variablelist role="params">
270
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
271
 
<listitem><simpara>
272
 
</simpara></listitem></varlistentry>
273
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
274
 
 
275
 
 
276
 
</simpara></listitem></varlistentry>
277
 
</variablelist></refsect2>
278
 
<refsect2>
279
 
<title><anchor id="rb-entry-view-get-duration"/>rb_entry_view_get_duration ()</title>
280
 
<indexterm><primary>rb_entry_view_get_duration</primary></indexterm><programlisting><link linkend="glong">glong</link>       rb_entry_view_get_duration      (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
281
 
<para>
282
 
 
283
 
</para><variablelist role="params">
284
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
285
 
<listitem><simpara>
286
 
</simpara></listitem></varlistentry>
287
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
288
 
 
289
 
 
290
 
</simpara></listitem></varlistentry>
291
 
</variablelist></refsect2>
292
 
<refsect2>
293
 
<title><anchor id="rb-entry-view-set-playing"/>rb_entry_view_set_playing ()</title>
294
 
<indexterm><primary>rb_entry_view_set_playing</primary></indexterm><programlisting><link linkend="void">void</link>        rb_entry_view_set_playing       (<link linkend="RBEntryView">RBEntryView</link> *view,
295
 
                                             <link linkend="gboolean">gboolean</link> playing);</programlisting>
296
 
<para>
297
 
 
298
 
</para><variablelist role="params">
299
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
300
 
<listitem><simpara>
301
 
</simpara></listitem></varlistentry>
302
 
<varlistentry><term><parameter>playing</parameter>&nbsp;:</term>
303
 
<listitem><simpara>
304
 
 
305
 
 
306
 
</simpara></listitem></varlistentry>
307
 
</variablelist></refsect2>
308
 
<refsect2>
309
 
<title><anchor id="rb-entry-view-set-playing-entry"/>rb_entry_view_set_playing_entry ()</title>
310
 
<indexterm><primary>rb_entry_view_set_playing_entry</primary></indexterm><programlisting><link linkend="void">void</link>        rb_entry_view_set_playing_entry (<link linkend="RBEntryView">RBEntryView</link> *view,
311
 
                                             <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);</programlisting>
312
 
<para>
313
 
 
314
 
</para><variablelist role="params">
315
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
316
 
<listitem><simpara>
317
 
</simpara></listitem></varlistentry>
318
 
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
319
 
<listitem><simpara>
320
 
 
321
 
 
322
 
</simpara></listitem></varlistentry>
323
 
</variablelist></refsect2>
324
 
<refsect2>
325
 
<title><anchor id="rb-entry-view-get-playing-entry"/>rb_entry_view_get_playing_entry ()</title>
326
 
<indexterm><primary>rb_entry_view_get_playing_entry</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_entry_view_get_playing_entry
327
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
328
 
<para>
329
 
 
330
 
</para><variablelist role="params">
331
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
332
 
<listitem><simpara>
333
 
</simpara></listitem></varlistentry>
334
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
335
 
 
336
 
 
337
 
</simpara></listitem></varlistentry>
338
 
</variablelist></refsect2>
339
 
<refsect2>
340
 
<title><anchor id="rb-entry-view-get-first-entry"/>rb_entry_view_get_first_entry ()</title>
341
 
<indexterm><primary>rb_entry_view_get_first_entry</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_entry_view_get_first_entry
342
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
343
 
<para>
344
 
 
345
 
</para><variablelist role="params">
346
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
347
 
<listitem><simpara>
348
 
</simpara></listitem></varlistentry>
349
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
350
 
 
351
 
 
352
 
</simpara></listitem></varlistentry>
353
 
</variablelist></refsect2>
354
 
<refsect2>
355
 
<title><anchor id="rb-entry-view-get-next-entry"/>rb_entry_view_get_next_entry ()</title>
356
 
<indexterm><primary>rb_entry_view_get_next_entry</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_entry_view_get_next_entry (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
357
 
<para>
358
 
 
359
 
</para><variablelist role="params">
360
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
361
 
<listitem><simpara>
362
 
</simpara></listitem></varlistentry>
363
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
364
 
 
365
 
 
366
 
</simpara></listitem></varlistentry>
367
 
</variablelist></refsect2>
368
 
<refsect2>
369
 
<title><anchor id="rb-entry-view-get-previous-entry"/>rb_entry_view_get_previous_entry ()</title>
370
 
<indexterm><primary>rb_entry_view_get_previous_entry</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_entry_view_get_previous_entry
371
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
372
 
<para>
373
 
 
374
 
</para><variablelist role="params">
375
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
376
 
<listitem><simpara>
377
 
</simpara></listitem></varlistentry>
378
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
379
 
 
380
 
 
381
 
</simpara></listitem></varlistentry>
382
 
</variablelist></refsect2>
383
 
<refsect2>
384
 
<title><anchor id="rb-entry-view-get-next-from-entry"/>rb_entry_view_get_next_from_entry ()</title>
385
 
<indexterm><primary>rb_entry_view_get_next_from_entry</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_entry_view_get_next_from_entry
386
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view,
387
 
                                             <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);</programlisting>
388
 
<para>
389
 
 
390
 
</para><variablelist role="params">
391
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
392
 
<listitem><simpara>
393
 
</simpara></listitem></varlistentry>
394
 
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
395
 
<listitem><simpara>
396
 
</simpara></listitem></varlistentry>
397
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
398
 
 
399
 
 
400
 
</simpara></listitem></varlistentry>
401
 
</variablelist></refsect2>
402
 
<refsect2>
403
 
<title><anchor id="rb-entry-view-get-previous-from-entry"/>rb_entry_view_get_previous_from_entry ()</title>
404
 
<indexterm><primary>rb_entry_view_get_previous_from_entry</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_entry_view_get_previous_from_entry
405
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view,
406
 
                                             <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);</programlisting>
407
 
<para>
408
 
 
409
 
</para><variablelist role="params">
410
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
411
 
<listitem><simpara>
412
 
</simpara></listitem></varlistentry>
413
 
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
414
 
<listitem><simpara>
415
 
</simpara></listitem></varlistentry>
416
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
417
 
 
418
 
 
419
 
</simpara></listitem></varlistentry>
420
 
</variablelist></refsect2>
421
 
<refsect2>
422
230
<title><anchor id="rb-entry-view-have-selection"/>rb_entry_view_have_selection ()</title>
423
231
<indexterm><primary>rb_entry_view_have_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_entry_view_have_selection    (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
424
232
<para>
488
296
</simpara></listitem></varlistentry>
489
297
</variablelist></refsect2>
490
298
<refsect2>
491
 
<title><anchor id="rb-entry-view-get-num-entries"/>rb_entry_view_get_num_entries ()</title>
492
 
<indexterm><primary>rb_entry_view_get_num_entries</primary></indexterm><programlisting><link linkend="guint">guint</link>       rb_entry_view_get_num_entries   (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
493
 
<para>
494
 
 
495
 
</para><variablelist role="params">
496
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
497
 
<listitem><simpara>
498
 
</simpara></listitem></varlistentry>
499
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
500
 
 
501
 
 
502
 
</simpara></listitem></varlistentry>
503
 
</variablelist></refsect2>
504
 
<refsect2>
505
299
<title><anchor id="rb-entry-view-get-entry-contained"/>rb_entry_view_get_entry_contained ()</title>
506
300
<indexterm><primary>rb_entry_view_get_entry_contained</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_entry_view_get_entry_contained
507
301
                                            (<link linkend="RBEntryView">RBEntryView</link> *view,
576
370
</simpara></listitem></varlistentry>
577
371
</variablelist></refsect2>
578
372
<refsect2>
579
 
<title><anchor id="rb-entry-view-get-random-entry"/>rb_entry_view_get_random_entry ()</title>
580
 
<indexterm><primary>rb_entry_view_get_random_entry</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_entry_view_get_random_entry
581
 
                                            (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
582
 
<para>
583
 
 
584
 
</para><variablelist role="params">
585
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
586
 
<listitem><simpara>
587
 
</simpara></listitem></varlistentry>
588
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
589
 
 
590
 
 
591
 
</simpara></listitem></varlistentry>
592
 
</variablelist></refsect2>
593
 
<refsect2>
594
373
<title><anchor id="rb-entry-view-get-sorting-order"/>rb_entry_view_get_sorting_order ()</title>
595
374
<indexterm><primary>rb_entry_view_get_sorting_order</primary></indexterm><programlisting><link linkend="void">void</link>        rb_entry_view_get_sorting_order (<link linkend="RBEntryView">RBEntryView</link> *view,
596
375
                                             const <link linkend="char">char</link> **column_name,
660
439
 
661
440
</simpara></listitem></varlistentry>
662
441
</variablelist></refsect2>
663
 
<refsect2>
664
 
<title><anchor id="rb-entry-view-set-resorting"/>rb_entry_view_set_resorting ()</title>
665
 
<indexterm><primary>rb_entry_view_set_resorting</primary></indexterm><programlisting><link linkend="void">void</link>        rb_entry_view_set_resorting     (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
666
 
<para>
667
 
 
668
 
</para><variablelist role="params">
669
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
670
 
<listitem><simpara>
671
 
 
672
 
 
673
 
</simpara></listitem></varlistentry>
674
 
</variablelist></refsect2>
675
442
 
676
443
</refsect1>
677
444