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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
|
<?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">
<refentry id="RBSource">
<refmeta>
<refentrytitle role="top_of_page" id="RBSource.top_of_page">RBSource</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>RBSource</refname>
<refpurpose>base class for sources</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="RBSource.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="RBSource-struct">RBSource</link>;
<link linkend="RBSourceClass">RBSourceClass</link>;
enum <link linkend="RBSourceEOFType">RBSourceEOFType</link>;
#define <link linkend="RB-SOURCE-ICON-SIZE:CAPS">RB_SOURCE_ICON_SIZE</link>
<link linkend="void">void</link> <link linkend="rb-source-notify-filter-changed">rb_source_notify_filter_changed</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-source-notify-status-changed">rb_source_notify_status_changed</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-source-update-play-statistics">rb_source_update_play_statistics</link> (<link linkend="RBSource">RBSource</link> *source,
<link linkend="RhythmDB">RhythmDB</link> *db,
<link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);
<link linkend="void">void</link> <link linkend="rb-source-set-pixbuf">rb_source_set_pixbuf</link> (<link linkend="RBSource">RBSource</link> *source,
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);
<link linkend="void">void</link> <link linkend="rb-source-get-status">rb_source_get_status</link> (<link linkend="RBSource">RBSource</link> *source,
<link linkend="char">char</link> **text,
<link linkend="char">char</link> **progress_text,
<link linkend="float">float</link> *progress);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-can-browse">rb_source_can_browse</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="char">char</link>* <link linkend="rb-source-get-browser-key">rb_source_get_browser_key</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-source-browser-toggled">rb_source_browser_toggled</link> (<link linkend="RBSource">RBSource</link> *source,
<link linkend="gboolean">gboolean</link> enabled);
<link linkend="RBEntryView">RBEntryView</link>* <link linkend="rb-source-get-entry-view">rb_source_get_entry_view</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="GList">GList</link>* <link linkend="rb-source-get-property-views">rb_source_get_property_views</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-can-rename">rb_source_can_rename</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-can-search">rb_source_can_search</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-source-search">rb_source_search</link> (<link linkend="RBSource">RBSource</link> *source,
const <link linkend="char">char</link> *text);
<link linkend="void">void</link> <link linkend="rb-source-reset-filters">rb_source_reset_filters</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="rb-source-get-config-widget">rb_source_get_config_widget</link> (<link linkend="RBSource">RBSource</link> *source,
<link linkend="RBShellPreferences">RBShellPreferences</link> *prefs);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-can-cut">rb_source_can_cut</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-can-delete">rb_source_can_delete</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-can-move-to-trash">rb_source_can_move_to_trash</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-can-copy">rb_source_can_copy</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-can-paste">rb_source_can_paste</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-can-add-to-queue">rb_source_can_add_to_queue</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-can-show-properties">rb_source_can_show_properties</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="GList">GList</link>* <link linkend="rb-source-cut">rb_source_cut</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="GList">GList</link>* <link linkend="rb-source-copy">rb_source_copy</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-source-paste">rb_source_paste</link> (<link linkend="RBSource">RBSource</link> *source,
<link linkend="GList">GList</link> *entries);
<link linkend="void">void</link> <link linkend="rb-source-delete">rb_source_delete</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-source-add-to-queue">rb_source_add_to_queue</link> (<link linkend="RBSource">RBSource</link> *source,
<link linkend="RBSource">RBSource</link> *queue);
<link linkend="void">void</link> <link linkend="rb-source-move-to-trash">rb_source_move_to_trash</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-source-song-properties">rb_source_song_properties</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-try-playlist">rb_source_try_playlist</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="guint">guint</link> <link linkend="rb-source-want-uri">rb_source_want_uri</link> (<link linkend="RBSource">RBSource</link> *source,
const <link linkend="char">char</link> *uri);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-uri-is-source">rb_source_uri_is_source</link> (<link linkend="RBSource">RBSource</link> *source,
const <link linkend="char">char</link> *uri);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-add-uri">rb_source_add_uri</link> (<link linkend="RBSource">RBSource</link> *source,
const <link linkend="char">char</link> *uri,
const <link linkend="char">char</link> *title,
const <link linkend="char">char</link> *genre);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-can-pause">rb_source_can_pause</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="RBSourceEOFType">RBSourceEOFType</link> <link linkend="rb-source-handle-eos">rb_source_handle_eos</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-receive-drag">rb_source_receive_drag</link> (<link linkend="RBSource">RBSource</link> *source,
<link linkend="GtkSelectionData">GtkSelectionData</link> *data);
<link linkend="gboolean">gboolean</link> <link linkend="rb-source-show-popup">rb_source_show_popup</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-source-delete-thyself">rb_source_delete_thyself</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-source-activate">rb_source_activate</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-source-deactivate">rb_source_deactivate</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="GList">GList</link>* <link linkend="rb-source-get-ui-actions">rb_source_get_ui_actions</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="GList">GList</link>* <link linkend="rb-source-get-search-actions">rb_source_get_search_actions</link> (<link linkend="RBSource">RBSource</link> *source);
<link linkend="GList">GList</link>* <link linkend="rb-source-gather-selected-properties">rb_source_gather_selected_properties</link>
(<link linkend="RBSource">RBSource</link> *source,
<link linkend="RhythmDBPropType">RhythmDBPropType</link> prop);
<link linkend="void">void</link> <link linkend="rb-source-set-hidden-when-empty">rb_source_set_hidden_when_empty</link> (<link linkend="RBSource">RBSource</link> *source,
<link linkend="gboolean">gboolean</link> hidden);
</synopsis>
</refsynopsisdiv>
<refsect1 id="RBSource.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBox">GtkBox</link>
+----<link linkend="GtkHBox">GtkHBox</link>
+----RBSource
+----<link linkend="RBPlaylistSource">RBPlaylistSource</link>
+----<link linkend="RBBrowserSource">RBBrowserSource</link>
+----<link linkend="RBImportErrorsSource">RBImportErrorsSource</link>
+----<link linkend="RBMissingFilesSource">RBMissingFilesSource</link>
</synopsis>
</refsect1>
<refsect1 id="RBSource.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
RBSource implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="RBSource.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="RBSource--base-query-model">base-query-model</link>" <link linkend="RhythmDBQueryModel">RhythmDBQueryModel</link>* : Read
"<link linkend="RBSource--entry-type">entry-type</link>" <link linkend="RhythmDBEntryType">RhythmDBEntryType</link>* : Read / Write / Construct Only
"<link linkend="RBSource--hidden-when-empty">hidden-when-empty</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="RBSource--icon">icon</link>" <link linkend="GdkPixbuf">GdkPixbuf</link>* : Read / Write
"<link linkend="RBSource--name">name</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="RBSource--play-order">play-order</link>" <link linkend="RBPlayOrder">RBPlayOrder</link>* : Read
"<link linkend="RBSource--plugin">plugin</link>" <link linkend="RBPlugin">RBPlugin</link>* : Read / Write
"<link linkend="RBSource--query-model">query-model</link>" <link linkend="RhythmDBQueryModel">RhythmDBQueryModel</link>* : Read / Write
"<link linkend="RBSource--shell">shell</link>" <link linkend="RBShell">RBShell</link>* : Read / Write / Construct Only
"<link linkend="RBSource--source-group">source-group</link>" <link linkend="RBSourceGroup">RBSourceGroup</link>* : Read / Write / Construct Only
"<link linkend="RBSource--ui-manager">ui-manager</link>" <link linkend="GtkUIManager">GtkUIManager</link>* : Read
"<link linkend="RBSource--visibility">visibility</link>" <link linkend="gboolean">gboolean</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 id="RBSource.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="RBSource-deleted">deleted</link>" : Run Last
"<link linkend="RBSource-filter-changed">filter-changed</link>" : Run Last
"<link linkend="RBSource-status-changed">status-changed</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 id="RBSource.description" role="desc">
<title role="desc.title">Description</title>
<para>
This class provides methods for requesting information
about the UI capabilities of the source, and defines the
expectations that apply to all sources - that they will
provide <link linkend="RBEntryView"><type>RBEntryView</type></link> and <link linkend="RhythmDBQueryModel"><type>RhythmDBQueryModel</type></link> objects, mostly.
</para>
<para>
Many of the methods on this class come in can_do_x and do_x
pairs. When can_do_x always returns FALSE, the class does not
need to implement the do_x method.
</para>
<para>
Useful subclasses include <link linkend="RBBrowserSource"><type>RBBrowserSource</type></link>, which includes a <link linkend="RBLibraryBrowser"><type>RBLibraryBrowser</type></link>
and takes care of constructing an <link linkend="RBEntryView"><type>RBEntryView</type></link> too; <link linkend="RBRemovableMediaSource"><type>RBRemovableMediaSource</type></link>,
which takes care of many aspects of implementing a source that represents a
removable device; and <link linkend="RBPlaylistSource"><type>RBPlaylistSource</type></link>, which provides functionality for
playlist-like sources.</para>
<para>
</para>
</refsect1>
<refsect1 id="RBSource.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBSource-struct" role="struct">
<title>RBSource</title>
<indexterm zone="RBSource-struct"><primary>RBSource</primary></indexterm><programlisting>typedef struct _RBSource RBSource;</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBSourceClass" role="struct">
<title>RBSourceClass</title>
<indexterm zone="RBSourceClass"><primary>RBSourceClass</primary></indexterm><programlisting>typedef struct {
GtkHBoxClass parent;
/* signals */
void (*status_changed) (RBSource *source);
void (*filter_changed) (RBSource *source);
void (*deleted) (RBSource *source);
void (*artistalbum_changed) (RBSource *source);
/* methods */
void (*impl_get_status) (RBSource *source, char **text, char **progress_text, float *progress);
gboolean (*impl_can_browse) (RBSource *source);
char * (*impl_get_browser_key) (RBSource *source);
void (*impl_browser_toggled) (RBSource *source, gboolean enabled);
RBEntryView * (*impl_get_entry_view) (RBSource *source);
GList * (*impl_get_property_views) (RBSource *source);
gboolean (*impl_can_rename) (RBSource *source);
gboolean (*impl_can_search) (RBSource *source);
void (*impl_search) (RBSource *source, const char *text);
void (*impl_reset_filters) (RBSource *source);
GtkWidget * (*impl_get_config_widget)(RBSource *source, RBShellPreferences *prefs);
gboolean (*impl_can_cut) (RBSource *source);
gboolean (*impl_can_delete) (RBSource *source);
gboolean (*impl_can_move_to_trash) (RBSource *source);
gboolean (*impl_can_copy) (RBSource *source);
gboolean (*impl_can_paste) (RBSource *source);
gboolean (*impl_can_add_to_queue)(RBSource *source);
GList * (*impl_cut) (RBSource *source);
GList * (*impl_copy) (RBSource *source);
void (*impl_paste) (RBSource *source, GList *entries);
void (*impl_delete) (RBSource *source);
void (*impl_add_to_queue) (RBSource *source, RBSource *queue);
void (*impl_move_to_trash) (RBSource *source);
void (*impl_song_properties) (RBSource *source);
gboolean (*impl_try_playlist) (RBSource *source);
guint (*impl_want_uri) (RBSource *source, const char *uri);
gboolean (*impl_add_uri) (RBSource *source, const char *uri, const char *title, const char *genre);
gboolean (*impl_uri_is_source) (RBSource *source, const char *uri);
gboolean (*impl_can_pause) (RBSource *source);
RBSourceEOFType (*impl_handle_eos) (RBSource *source);
gboolean (*impl_have_url) (RBSource *source);
gboolean (*impl_receive_drag) (RBSource *source, GtkSelectionData *data);
gboolean (*impl_show_popup) (RBSource *source);
void (*impl_delete_thyself) (RBSource *source);
void (*impl_activate) (RBSource *source);
void (*impl_deactivate) (RBSource *source);
GList * (*impl_get_ui_actions) (RBSource *source);
GList * (*impl_get_search_actions) (RBSource *source);
} RBSourceClass;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBSourceEOFType" role="enum">
<title>enum RBSourceEOFType</title>
<indexterm zone="RBSourceEOFType"><primary>RBSourceEOFType</primary></indexterm><programlisting>typedef enum {
RB_SOURCE_EOF_ERROR,
RB_SOURCE_EOF_STOP,
RB_SOURCE_EOF_RETRY,
RB_SOURCE_EOF_NEXT,
} RBSourceEOFType;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="RB-SOURCE-ICON-SIZE:CAPS" role="macro">
<title>RB_SOURCE_ICON_SIZE</title>
<indexterm zone="RB-SOURCE-ICON-SIZE:CAPS"><primary>RB_SOURCE_ICON_SIZE</primary></indexterm><programlisting>#define RB_SOURCE_ICON_SIZE GTK_ICON_SIZE_LARGE_TOOLBAR
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-source-notify-filter-changed" role="function">
<title>rb_source_notify_filter_changed ()</title>
<indexterm zone="rb-source-notify-filter-changed"><primary>rb_source_notify_filter_changed</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_notify_filter_changed (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Source implementations call this when their filter state changes</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-notify-status-changed" role="function">
<title>rb_source_notify_status_changed ()</title>
<indexterm zone="rb-source-notify-status-changed"><primary>rb_source_notify_status_changed</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_notify_status_changed (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Source implementations call this when their status bar information
changes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-update-play-statistics" role="function">
<title>rb_source_update_play_statistics ()</title>
<indexterm zone="rb-source-update-play-statistics"><primary>rb_source_update_play_statistics</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_update_play_statistics (<link linkend="RBSource">RBSource</link> *source,
<link linkend="RhythmDB">RhythmDB</link> *db,
<link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);</programlisting>
<para>
Updates play count and play time statistics for a database entry.
Sources containing entries that do not normally reach EOS should
call this for an entry when it is no longer being played.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>db</parameter> :</term>
<listitem><simpara> the <link linkend="RhythmDB"><type>RhythmDB</type></link> instance
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry</parameter> :</term>
<listitem><simpara> the <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> to update
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-set-pixbuf" role="function">
<title>rb_source_set_pixbuf ()</title>
<indexterm zone="rb-source-set-pixbuf"><primary>rb_source_set_pixbuf</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_set_pixbuf (<link linkend="RBSource">RBSource</link> *source,
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);</programlisting>
<para>
Sets the pixbuf for the source.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixbuf</parameter> :</term>
<listitem><simpara> new GdkPixbuf for the source
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-get-status" role="function">
<title>rb_source_get_status ()</title>
<indexterm zone="rb-source-get-status"><primary>rb_source_get_status</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_get_status (<link linkend="RBSource">RBSource</link> *source,
<link linkend="char">char</link> **text,
<link linkend="char">char</link> **progress_text,
<link linkend="float">float</link> *progress);</programlisting>
<para>
Retrieves the details to display in the status bar for the source.
If the progress value returned is less than zero, the progress bar
will pulse. If the progress value is greater than or equal to 1,
the progress bar will be hidden.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> holds the returned status text (allocated)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>progress_text</parameter> :</term>
<listitem><simpara> holds the returned text for the progress bar (allocated)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>progress</parameter> :</term>
<listitem><simpara> holds the progress value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-can-browse" role="function">
<title>rb_source_can_browse ()</title>
<indexterm zone="rb-source-can-browse"><primary>rb_source_can_browse</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_can_browse (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if this source has a browser
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-get-browser-key" role="function">
<title>rb_source_get_browser_key ()</title>
<indexterm zone="rb-source-get-browser-key"><primary>rb_source_get_browser_key</primary></indexterm><programlisting><link linkend="char">char</link>* rb_source_get_browser_key (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the GConf key that determines browser visibility
for this source (allocated)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-browser-toggled" role="function">
<title>rb_source_browser_toggled ()</title>
<indexterm zone="rb-source-browser-toggled"><primary>rb_source_browser_toggled</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_browser_toggled (<link linkend="RBSource">RBSource</link> *source,
<link linkend="gboolean">gboolean</link> enabled);</programlisting>
<para>
Called when the visibility of the browser changes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>enabled</parameter> :</term>
<listitem><simpara> TRUE if the browser should be visible
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-get-entry-view" role="function">
<title>rb_source_get_entry_view ()</title>
<indexterm zone="rb-source-get-entry-view"><primary>rb_source_get_entry_view</primary></indexterm><programlisting><link linkend="RBEntryView">RBEntryView</link>* rb_source_get_entry_view (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="RBEntryView"><type>RBEntryView</type></link> instance for the source
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-get-property-views" role="function">
<title>rb_source_get_property_views ()</title>
<indexterm zone="rb-source-get-property-views"><primary>rb_source_get_property_views</primary></indexterm><programlisting><link linkend="GList">GList</link>* rb_source_get_property_views (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a list containing the <link linkend="RBPropertyView"><type>RBPropertyView</type></link><!-- -->s that
make up the browser for this source, if any.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-can-rename" role="function">
<title>rb_source_can_rename ()</title>
<indexterm zone="rb-source-can-rename"><primary>rb_source_can_rename</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_can_rename (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if this source can be renamed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-can-search" role="function">
<title>rb_source_can_search ()</title>
<indexterm zone="rb-source-can-search"><primary>rb_source_can_search</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_can_search (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the source can be searched using
the search box
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-search" role="function">
<title>rb_source_search ()</title>
<indexterm zone="rb-source-search"><primary>rb_source_search</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_search (<link linkend="RBSource">RBSource</link> *source,
const <link linkend="char">char</link> *text);</programlisting>
<para>
Updates the source with new search text. The source
should recreate the database query that feeds into the
browser (if any).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> new search text
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-reset-filters" role="function">
<title>rb_source_reset_filters ()</title>
<indexterm zone="rb-source-reset-filters"><primary>rb_source_reset_filters</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_reset_filters (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Clears all filters (browser selections, etc.) in this source.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-get-config-widget" role="function">
<title>rb_source_get_config_widget ()</title>
<indexterm zone="rb-source-get-config-widget"><primary>rb_source_get_config_widget</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* rb_source_get_config_widget (<link linkend="RBSource">RBSource</link> *source,
<link linkend="RBShellPreferences">RBShellPreferences</link> *prefs);</programlisting>
<para>
Source implementations can use this to return an optional
configuration widget. The widget will be displayed in a
page in the preferences dialog.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prefs</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPreferences"><type>RBShellPreferences</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> configuration widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-can-cut" role="function">
<title>rb_source_can_cut ()</title>
<indexterm zone="rb-source-can-cut"><primary>rb_source_can_cut</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_can_cut (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the source supports the typical cut
(as in cut-and-paste) operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-can-delete" role="function">
<title>rb_source_can_delete ()</title>
<indexterm zone="rb-source-can-delete"><primary>rb_source_can_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_can_delete (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the source allows the user to delete
a selected set of entries.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-can-move-to-trash" role="function">
<title>rb_source_can_move_to_trash ()</title>
<indexterm zone="rb-source-can-move-to-trash"><primary>rb_source_can_move_to_trash</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_can_move_to_trash (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the source allows the user to trash
the files backing a selected set of entries.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-can-copy" role="function">
<title>rb_source_can_copy ()</title>
<indexterm zone="rb-source-can-copy"><primary>rb_source_can_copy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_can_copy (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the source supports the copy part
of a copy-and-paste operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-can-paste" role="function">
<title>rb_source_can_paste ()</title>
<indexterm zone="rb-source-can-paste"><primary>rb_source_can_paste</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_can_paste (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the source supports the typical paste
(as in cut-and-paste) operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-can-add-to-queue" role="function">
<title>rb_source_can_add_to_queue ()</title>
<indexterm zone="rb-source-can-add-to-queue"><primary>rb_source_can_add_to_queue</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_can_add_to_queue (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if this source can add the current selected
set of entries to the play queue
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-can-show-properties" role="function">
<title>rb_source_can_show_properties ()</title>
<indexterm zone="rb-source-can-show-properties"><primary>rb_source_can_show_properties</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_can_show_properties (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the source can display a properties
window for the currently selected entry (or set of entries)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-cut" role="function">
<title>rb_source_cut ()</title>
<indexterm zone="rb-source-cut"><primary>rb_source_cut</primary></indexterm><programlisting><link linkend="GList">GList</link>* rb_source_cut (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Removes the currently selected entries from the source and
returns them so they can be pasted into another source.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a list of <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> objects cut from
the source.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-copy" role="function">
<title>rb_source_copy ()</title>
<indexterm zone="rb-source-copy"><primary>rb_source_copy</primary></indexterm><programlisting><link linkend="GList">GList</link>* rb_source_copy (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a list containing the currently selected entries from
the source.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-paste" role="function">
<title>rb_source_paste ()</title>
<indexterm zone="rb-source-paste"><primary>rb_source_paste</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_paste (<link linkend="RBSource">RBSource</link> *source,
<link linkend="GList">GList</link> *entries);</programlisting>
<para>
Adds a list of entries previously cut or copied from another
source.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entries</parameter> :</term>
<listitem><simpara> a list of <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> objects to paste in
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-delete" role="function">
<title>rb_source_delete ()</title>
<indexterm zone="rb-source-delete"><primary>rb_source_delete</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_delete (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Deletes the currently selected entries from the source.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-add-to-queue" role="function">
<title>rb_source_add_to_queue ()</title>
<indexterm zone="rb-source-add-to-queue"><primary>rb_source_add_to_queue</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_add_to_queue (<link linkend="RBSource">RBSource</link> *source,
<link linkend="RBSource">RBSource</link> *queue);</programlisting>
<para>
Adds the currently selected entries to the end of the
play queue.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>queue</parameter> :</term>
<listitem><simpara> the <link linkend="RBSource"><type>RBSource</type></link> for the play queue
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-move-to-trash" role="function">
<title>rb_source_move_to_trash ()</title>
<indexterm zone="rb-source-move-to-trash"><primary>rb_source_move_to_trash</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_move_to_trash (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Trashes the files backing the currently selected set of entries.
In general, this should use <link linkend="rhythmdb-entry-move-to-trash"><type>rhythmdb_entry_move_to_trash</type></link> to
perform the actual trash operation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-song-properties" role="function">
<title>rb_source_song_properties ()</title>
<indexterm zone="rb-source-song-properties"><primary>rb_source_song_properties</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_song_properties (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Displays a properties window for the currently selected entries.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-try-playlist" role="function">
<title>rb_source_try_playlist ()</title>
<indexterm zone="rb-source-try-playlist"><primary>rb_source_try_playlist</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_try_playlist (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the playback URIs for entries in the source
should be parsed as playlists, rather than just played.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-want-uri" role="function">
<title>rb_source_want_uri ()</title>
<indexterm zone="rb-source-want-uri"><primary>rb_source_want_uri</primary></indexterm><programlisting><link linkend="guint">guint</link> rb_source_want_uri (<link linkend="RBSource">RBSource</link> *source,
const <link linkend="char">char</link> *uri);</programlisting>
<para>
Returns an indication of how much the source wants to handle
the specified URI. 100 is the highest usual value, and should
only be used when the URI can only be associated with this source.
0 should be used when the URI does not match the source at all.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> a URI for the source to consider
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> value from 0 to 100 indicating how much the
source wants this URI.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-uri-is-source" role="function">
<title>rb_source_uri_is_source ()</title>
<indexterm zone="rb-source-uri-is-source"><primary>rb_source_uri_is_source</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_uri_is_source (<link linkend="RBSource">RBSource</link> *source,
const <link linkend="char">char</link> *uri);</programlisting>
<para>
Checks if the URI matches the source itself. A source
should return TRUE here if the URI points to the device that
the source represents, for example.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> a URI for the source to consider
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the URI identifies the source itself.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-add-uri" role="function">
<title>rb_source_add_uri ()</title>
<indexterm zone="rb-source-add-uri"><primary>rb_source_add_uri</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_add_uri (<link linkend="RBSource">RBSource</link> *source,
const <link linkend="char">char</link> *uri,
const <link linkend="char">char</link> *title,
const <link linkend="char">char</link> *genre);</programlisting>
<para>
Adds an entry corresponding to the URI to the source. The
<parameter>title</parameter> and <parameter>genre</parameter> parameters are not really used.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> a URI to add
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>title</parameter> :</term>
<listitem><simpara> theoretically, the title of the entity the URI points to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>genre</parameter> :</term>
<listitem><simpara> theoretically, the genre of the entity the URI points to
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the URI was successfully added to the source
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-can-pause" role="function">
<title>rb_source_can_pause ()</title>
<indexterm zone="rb-source-can-pause"><primary>rb_source_can_pause</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_can_pause (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if playback of entries from the source can be paused.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-handle-eos" role="function">
<title>rb_source_handle_eos ()</title>
<indexterm zone="rb-source-handle-eos"><primary>rb_source_handle_eos</primary></indexterm><programlisting><link linkend="RBSourceEOFType">RBSourceEOFType</link> rb_source_handle_eos (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> how EOS events should be handled for entries from this source
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-receive-drag" role="function">
<title>rb_source_receive_drag ()</title>
<indexterm zone="rb-source-receive-drag"><primary>rb_source_receive_drag</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_receive_drag (<link linkend="RBSource">RBSource</link> *source,
<link linkend="GtkSelectionData">GtkSelectionData</link> *data);</programlisting>
<para>
This is called when the user drags something to the source.
Depending on the drag data type, the data might be a list of
<link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> objects, a list of URIs, or a list of album
or artist or genre names.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> the selection data
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the source accepted the drag data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-show-popup" role="function">
<title>rb_source_show_popup ()</title>
<indexterm zone="rb-source-show-popup"><primary>rb_source_show_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_source_show_popup (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Called when the user performs an action (such as right-clicking)
that should result in a popup menu being displayed for the source.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the source managed to display a popup
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-delete-thyself" role="function">
<title>rb_source_delete_thyself ()</title>
<indexterm zone="rb-source-delete-thyself"><primary>rb_source_delete_thyself</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_delete_thyself (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
This is called when the source should delete itself.
The 'deleted' signal will be emitted, which removes the source
from the source list. This will not actually dispose of the
source object, so reference counting must still be handled
correctly.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-activate" role="function">
<title>rb_source_activate ()</title>
<indexterm zone="rb-source-activate"><primary>rb_source_activate</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_activate (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Called when the source is selected in the source list.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-deactivate" role="function">
<title>rb_source_deactivate ()</title>
<indexterm zone="rb-source-deactivate"><primary>rb_source_deactivate</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_deactivate (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Called when the source is deselected in the source list.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-get-ui-actions" role="function">
<title>rb_source_get_ui_actions ()</title>
<indexterm zone="rb-source-get-ui-actions"><primary>rb_source_get_ui_actions</primary></indexterm><programlisting><link linkend="GList">GList</link>* rb_source_get_ui_actions (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Returns a list of UI action names. Items for
these actions will be added to the toolbar.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> list of action names
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-get-search-actions" role="function">
<title>rb_source_get_search_actions ()</title>
<indexterm zone="rb-source-get-search-actions"><primary>rb_source_get_search_actions</primary></indexterm><programlisting><link linkend="GList">GList</link>* rb_source_get_search_actions (<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Returns a list of UI action names. Buttons for these
actions will be added to the search bar. The source
must identify the selected search action when constructing
a database query for searching</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> list of search actions
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-gather-selected-properties" role="function">
<title>rb_source_gather_selected_properties ()</title>
<indexterm zone="rb-source-gather-selected-properties"><primary>rb_source_gather_selected_properties</primary></indexterm><programlisting><link linkend="GList">GList</link>* rb_source_gather_selected_properties
(<link linkend="RBSource">RBSource</link> *source,
<link linkend="RhythmDBPropType">RhythmDBPropType</link> prop);</programlisting>
<para>
Returns a list containing the values of the specified
property from the selected entries in the source.
This is used to implement the 'browse this artist' (etc.)
actions.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prop</parameter> :</term>
<listitem><simpara> property for which to gather selection
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> list of property values
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-set-hidden-when-empty" role="function">
<title>rb_source_set_hidden_when_empty ()</title>
<indexterm zone="rb-source-set-hidden-when-empty"><primary>rb_source_set_hidden_when_empty</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_set_hidden_when_empty (<link linkend="RBSource">RBSource</link> *source,
<link linkend="gboolean">gboolean</link> hidden);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hidden</parameter> :</term>
<listitem><simpara> if TRUE, the source should not be displayed in
the source list when there are no entries in it
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="RBSource.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="RBSource--base-query-model"><title>The <literal>"base-query-model"</literal> property</title>
<indexterm zone="RBSource--base-query-model"><primary>RBSource:base-query-model</primary></indexterm><programlisting> "base-query-model" <link linkend="RhythmDBQueryModel">RhythmDBQueryModel</link>* : Read</programlisting>
<para>
The unfiltered query model for the source, containing all entries in the source.
Source classes should override this if they perform filtering based on the search
box or a browser.</para>
<para>
</para></refsect2>
<refsect2 id="RBSource--entry-type"><title>The <literal>"entry-type"</literal> property</title>
<indexterm zone="RBSource--entry-type"><primary>RBSource:entry-type</primary></indexterm><programlisting> "entry-type" <link linkend="RhythmDBEntryType">RhythmDBEntryType</link>* : Read / Write / Construct Only</programlisting>
<para>
Entry type for entries in this source.</para>
<para>
</para></refsect2>
<refsect2 id="RBSource--hidden-when-empty"><title>The <literal>"hidden-when-empty"</literal> property</title>
<indexterm zone="RBSource--hidden-when-empty"><primary>RBSource:hidden-when-empty</primary></indexterm><programlisting> "hidden-when-empty" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>
If TRUE, the source will not be displayed in the source list
when it contains no entries.</para>
<para>
</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="RBSource--icon"><title>The <literal>"icon"</literal> property</title>
<indexterm zone="RBSource--icon"><primary>RBSource:icon</primary></indexterm><programlisting> "icon" <link linkend="GdkPixbuf">GdkPixbuf</link>* : Read / Write</programlisting>
<para>
Icon to display in the source list</para>
<para>
</para></refsect2>
<refsect2 id="RBSource--name"><title>The <literal>"name"</literal> property</title>
<indexterm zone="RBSource--name"><primary>RBSource:name</primary></indexterm><programlisting> "name" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>
Source name as displayed in the source list</para>
<para>
</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="RBSource--play-order"><title>The <literal>"play-order"</literal> property</title>
<indexterm zone="RBSource--play-order"><primary>RBSource:play-order</primary></indexterm><programlisting> "play-order" <link linkend="RBPlayOrder">RBPlayOrder</link>* : Read</programlisting>
<para>
If the source provides its own play order, it can override this property.</para>
<para>
</para></refsect2>
<refsect2 id="RBSource--plugin"><title>The <literal>"plugin"</literal> property</title>
<indexterm zone="RBSource--plugin"><primary>RBSource:plugin</primary></indexterm><programlisting> "plugin" <link linkend="RBPlugin">RBPlugin</link>* : Read / Write</programlisting>
<para>
The plugin that created this source.</para>
<para>
</para></refsect2>
<refsect2 id="RBSource--query-model"><title>The <literal>"query-model"</literal> property</title>
<indexterm zone="RBSource--query-model"><primary>RBSource:query-model</primary></indexterm><programlisting> "query-model" <link linkend="RhythmDBQueryModel">RhythmDBQueryModel</link>* : Read / Write</programlisting>
<para>
The current query model for the source. This is used in
various places, including the play order, to find the
set of entries within the source.</para>
<para>
</para></refsect2>
<refsect2 id="RBSource--shell"><title>The <literal>"shell"</literal> property</title>
<indexterm zone="RBSource--shell"><primary>RBSource:shell</primary></indexterm><programlisting> "shell" <link linkend="RBShell">RBShell</link>* : Read / Write / Construct Only</programlisting>
<para>
The rhythmbox shell object</para>
<para>
</para></refsect2>
<refsect2 id="RBSource--source-group"><title>The <literal>"source-group"</literal> property</title>
<indexterm zone="RBSource--source-group"><primary>RBSource:source-group</primary></indexterm><programlisting> "source-group" <link linkend="RBSourceGroup">RBSourceGroup</link>* : Read / Write / Construct Only</programlisting>
<para>
Source group in which to display the source</para>
<para>
</para></refsect2>
<refsect2 id="RBSource--ui-manager"><title>The <literal>"ui-manager"</literal> property</title>
<indexterm zone="RBSource--ui-manager"><primary>RBSource:ui-manager</primary></indexterm><programlisting> "ui-manager" <link linkend="GtkUIManager">GtkUIManager</link>* : Read</programlisting>
<para>
The Gtk UIManager object</para>
<para>
</para></refsect2>
<refsect2 id="RBSource--visibility"><title>The <literal>"visibility"</literal> property</title>
<indexterm zone="RBSource--visibility"><primary>RBSource:visibility</primary></indexterm><programlisting> "visibility" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>
If FALSE, the source will not be displayed in the source list</para>
<para>
</para><para>Default value: TRUE</para>
</refsect2>
</refsect1>
<refsect1 id="RBSource.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="RBSource-deleted"><title>The <literal>"deleted"</literal> signal</title>
<indexterm zone="RBSource-deleted"><primary>RBSource::deleted</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBSource">RBSource</link> *source,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when the source is being deleted.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBSource-filter-changed"><title>The <literal>"filter-changed"</literal> signal</title>
<indexterm zone="RBSource-filter-changed"><primary>RBSource::filter-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBSource">RBSource</link> *rbsource,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rbsource</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBSource-status-changed"><title>The <literal>"status-changed"</literal> signal</title>
<indexterm zone="RBSource-status-changed"><primary>RBSource::status-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBSource">RBSource</link> *rbsource,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rbsource</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
