2006-12-12 James Livingston <doclivingston@gmail.com>
[rhythmbox.git] / doc / reference / tmpl / rhythmbox-unused.sgml
blobf9068ea62b92f8ca69fe428f6264a6a3cae944fa
1 <!-- ##### TYPEDEF CDDBDisclosurePrivate ##### -->
2 <para>
4 </para>
7 <!-- ##### MACRO CDDB_DISCLOSURE ##### -->
8 <para>
10 </para>
12 @obj:
14 <!-- ##### MACRO CDDB_DISCLOSURE_CLASS ##### -->
15 <para>
17 </para>
19 @klass:
21 <!-- ##### MACRO CDDB_DISCLOSURE_TYPE ##### -->
22 <para>
24 </para>
27 <!-- ##### MACRO CONF_AUTO_RATE ##### -->
28 <para>
30 </para>
33 <!-- ##### MACRO CONF_UI_SOURCELIST_HIDDEN ##### -->
34 <para>
36 </para>
39 <!-- ##### STRUCT EggNotificationBubbleData ##### -->
40 <para>
42 </para>
45 <!-- ##### MACRO IS_CDDB_DISCLOSURE ##### -->
46 <para>
48 </para>
50 @obj:
52 <!-- ##### MACRO IS_CDDB_DISCLOSURE_CLASS ##### -->
53 <para>
55 </para>
57 @klass:
59 <!-- ##### TYPEDEF RBDAAPmDNSBrowser ##### -->
60 <para>
62 </para>
65 <!-- ##### USER_FUNCTION RBDAAPmDNSBrowserCallback ##### -->
66 <para>
68 </para>
70 @browser:
71 @status:
72 @service_name:
73 @user_data:
75 <!-- ##### ENUM RBDAAPmDNSBrowserStatus ##### -->
76 <para>
78 </para>
80 @RB_DAAP_MDNS_BROWSER_ADD_SERVICE:
81 @RB_DAAP_MDNS_BROWSER_REMOVE_SERVICE:
83 <!-- ##### TYPEDEF RBDAAPmDNSPublisher ##### -->
84 <para>
86 </para>
89 <!-- ##### USER_FUNCTION RBDAAPmDNSPublisherCallback ##### -->
90 <para>
92 </para>
94 @publisher:
95 @status:
96 @user_data:
97 @Returns:
99 <!-- ##### ENUM RBDAAPmDNSPublisherStatus ##### -->
100 <para>
102 </para>
104 @RB_DAAP_MDNS_PUBLISHER_STARTED:
105 @RB_DAAP_MDNS_PUBLISHER_COLLISION:
107 <!-- ##### TYPEDEF RBDAAPmDNSResolver ##### -->
108 <para>
110 </para>
113 <!-- ##### USER_FUNCTION RBDAAPmDNSResolverCallback ##### -->
114 <para>
116 </para>
118 @resolver:
119 @status:
120 @service_name:
121 @name:
122 @host:
123 @port:
124 @password_protected:
125 @user_data:
127 <!-- ##### ENUM RBDAAPmDNSResolverStatus ##### -->
128 <para>
130 </para>
132 @RB_DAAP_MDNS_RESOLVER_FOUND:
133 @RB_DAAP_MDNS_RESOLVER_TIMEOUT:
135 <!-- ##### ENUM RBDirection ##### -->
136 <para>
138 </para>
140 @RB_DIRECTION_UP:
141 @RB_DIRECTION_DOWN:
143 <!-- ##### TYPEDEF RBLoadFailureDialogPrivate ##### -->
144 <para>
146 </para>
149 <!-- ##### TYPEDEF RBPlayerPrivate ##### -->
150 <para>
152 </para>
155 <!-- ##### ENUM RBQueryCreatorLimitType ##### -->
156 <para>
158 </para>
160 @RB_QUERY_CREATOR_LIMIT_COUNT:
161 @RB_QUERY_CREATOR_LIMIT_MB:
162 @RB_QUERY_CREATOR_LIMIT_SECONDS:
164 <!-- ##### ENUM RBShellError ##### -->
165 <para>
167 </para>
169 @RB_SHELL_ERROR_NO_SUCH_URI:
170 @RB_SHELL_ERROR_NO_SUCH_PROPERTY:
171 @RB_SHELL_ERROR_IMMUTABLE_PROPERTY:
172 @RB_SHELL_ERROR_INVALID_PROPERTY_TYPE:
174 <!-- ##### TYPEDEF RBSongDisplayBoxPrivate ##### -->
175 <para>
177 </para>
180 <!-- ##### TYPEDEF RBSourceListModelPriv ##### -->
181 <para>
183 </para>
186 <!-- ##### TYPEDEF RBSourceListPriv ##### -->
187 <para>
189 </para>
192 <!-- ##### TYPEDEF RBTreeModelSortPrivate ##### -->
193 <para>
195 </para>
198 <!-- ##### MACRO RB_PLAYER_TICK_HZ ##### -->
199 <para>
201 </para>
204 <!-- ##### MACRO RB_SONG_DISPLAY_BOX ##### -->
205 <para>
207 </para>
209 @obj:
211 <!-- ##### MACRO RB_STOCK_ALBUM ##### -->
212 <para>
214 </para>
217 <!-- ##### MACRO RB_STOCK_AUDIOCD ##### -->
218 <para>
220 </para>
223 <!-- ##### MACRO RB_STOCK_AUTOMATIC_PLAYLIST ##### -->
224 <para>
226 </para>
229 <!-- ##### MACRO RB_STOCK_DND_ICON ##### -->
230 <para>
232 </para>
235 <!-- ##### MACRO RB_STOCK_IPOD ##### -->
236 <para>
238 </para>
241 <!-- ##### MACRO RB_STOCK_IRADIO ##### -->
242 <para>
244 </para>
247 <!-- ##### MACRO RB_STOCK_LIBRARY ##### -->
248 <para>
250 </para>
253 <!-- ##### MACRO RB_STOCK_NO_STAR ##### -->
254 <para>
256 </para>
259 <!-- ##### MACRO RB_STOCK_PAUSED ##### -->
260 <para>
262 </para>
265 <!-- ##### MACRO RB_STOCK_PLAYBACK_ERROR ##### -->
266 <para>
268 </para>
271 <!-- ##### MACRO RB_STOCK_PLAYING ##### -->
272 <para>
274 </para>
277 <!-- ##### MACRO RB_STOCK_PLAYLIST ##### -->
278 <para>
280 </para>
283 <!-- ##### MACRO RB_STOCK_PLAYLIST_MENU ##### -->
284 <para>
286 </para>
289 <!-- ##### MACRO RB_STOCK_REPEAT ##### -->
290 <para>
292 </para>
295 <!-- ##### MACRO RB_STOCK_SET_STAR ##### -->
296 <para>
298 </para>
301 <!-- ##### MACRO RB_STOCK_SHUFFLE ##### -->
302 <para>
304 </para>
307 <!-- ##### MACRO RB_STOCK_TRAY_ICON ##### -->
308 <para>
310 </para>
313 <!-- ##### MACRO RB_STOCK_UNSET_STAR ##### -->
314 <para>
316 </para>
319 <!-- ##### MACRO RB_STOCK_VISUALS ##### -->
320 <para>
322 </para>
325 <!-- ##### MACRO RB_STOCK_VOLUME_MAX ##### -->
326 <para>
328 </para>
331 <!-- ##### MACRO RB_STOCK_VOLUME_MEDIUM ##### -->
332 <para>
334 </para>
337 <!-- ##### MACRO RB_STOCK_VOLUME_MIN ##### -->
338 <para>
340 </para>
343 <!-- ##### MACRO RB_STOCK_VOLUME_MUTE ##### -->
344 <para>
346 </para>
349 <!-- ##### MACRO RB_STOCK_VOLUME_ZERO ##### -->
350 <para>
352 </para>
355 <!-- ##### MACRO RB_TYPE_SONG_DISPLAY_BOX ##### -->
356 <para>
358 </para>
361 <!-- ##### MACRO RHYTHMDB_ENTRY_TYPE_IRADIO_STATION ##### -->
362 <para>
364 </para>
367 <!-- ##### MACRO RHYTHMDB_TYPE_PROP ##### -->
368 <para>
370 </para>
373 <!-- ##### FUNCTION cddb_disclosure_get_type ##### -->
374 <para>
376 </para>
378 @Returns:
380 <!-- ##### FUNCTION cddb_disclosure_new ##### -->
381 <para>
383 </para>
385 @shown:
386 @hidden:
387 @Returns:
389 <!-- ##### FUNCTION cddb_disclosure_set_container ##### -->
390 <para>
392 </para>
394 @cddb:
395 @widget:
397 <!-- ##### FUNCTION cddb_disclosure_set_labels ##### -->
398 <para>
400 </para>
402 @cddb:
403 @label_when_shown:
404 @label_when_hidden:
406 <!-- ##### FUNCTION egg_notification_bubble_attach ##### -->
407 <para>
409 </para>
411 @bubble:
412 @widget:
414 <!-- ##### FUNCTION egg_notification_bubble_get_info_from_tip_window ##### -->
415 <para>
417 </para>
419 @window:
420 @bubble:
421 @current_widget:
422 @Returns:
424 <!-- ##### FUNCTION egg_notification_bubble_hide ##### -->
425 <para>
427 </para>
429 @bubble:
431 <!-- ##### FUNCTION egg_notification_bubble_new ##### -->
432 <para>
434 </para>
436 @Returns:
438 <!-- ##### FUNCTION egg_notification_bubble_set ##### -->
439 <para>
441 </para>
443 @bubble:
444 @notification_header:
445 @icon:
446 @notification_body:
448 <!-- ##### FUNCTION egg_notification_bubble_show ##### -->
449 <para>
451 </para>
453 @bubble:
454 @timeout:
456 <!-- ##### FUNCTION g_str_equal ##### -->
457 <para>
459 </para>
461 @Returns:
463 <!-- ##### FUNCTION g_str_hash ##### -->
464 <para>
466 </para>
468 @Returns:
470 <!-- ##### FUNCTION rb_daap_connection_destroy ##### -->
471 <para>
473 </para>
475 @connection:
477 <!-- ##### FUNCTION rb_daap_mdns_browse ##### -->
478 <para>
480 </para>
482 @browser:
483 @callback:
484 @data:
485 @Returns:
487 <!-- ##### FUNCTION rb_daap_mdns_browse_cancel ##### -->
488 <para>
490 </para>
492 @browser:
494 <!-- ##### FUNCTION rb_daap_mdns_publish ##### -->
495 <para>
497 </para>
499 @publisher:
500 @name:
501 @port:
502 @callback:
503 @user_data:
504 @Returns:
506 <!-- ##### FUNCTION rb_daap_mdns_publish_cancel ##### -->
507 <para>
509 </para>
511 @publisher:
513 <!-- ##### FUNCTION rb_daap_mdns_resolve ##### -->
514 <para>
516 </para>
518 @resolver:
519 @name:
520 @callback:
521 @data:
522 @Returns:
524 <!-- ##### FUNCTION rb_daap_mdns_resolve_cancel ##### -->
525 <para>
527 </para>
529 @resolver:
531 <!-- ##### FUNCTION rb_daap_password_dialog_new_run ##### -->
532 <para>
534 </para>
536 @parent:
537 @name:
538 @Returns:
540 <!-- ##### FUNCTION rb_daap_source_find_for_uri ##### -->
541 <para>
543 </para>
545 @uri:
546 @Returns:
548 <!-- ##### FUNCTION rb_daap_sources_init ##### -->
549 <para>
551 </para>
553 @shell:
554 @Returns:
556 <!-- ##### FUNCTION rb_daap_sources_shutdown ##### -->
557 <para>
559 </para>
561 @shell:
563 <!-- ##### FUNCTION rb_daap_src_init ##### -->
564 <para>
566 </para>
569 <!-- ##### FUNCTION rb_daap_src_shutdown ##### -->
570 <para>
572 </para>
575 <!-- ##### FUNCTION rb_druid_show ##### -->
576 <para>
578 </para>
580 @druid:
582 <!-- ##### FUNCTION rb_entry_view_busy ##### -->
583 <para>
585 </para>
587 @view:
588 @Returns:
590 <!-- ##### FUNCTION rb_entry_view_get_duration ##### -->
591 <para>
593 </para>
595 @view:
596 @Returns:
598 <!-- ##### FUNCTION rb_entry_view_get_first_entry ##### -->
599 <para>
601 </para>
603 @view:
604 @Returns:
606 <!-- ##### FUNCTION rb_entry_view_get_next_entry ##### -->
607 <para>
609 </para>
611 @view:
612 @Returns:
614 <!-- ##### FUNCTION rb_entry_view_get_next_from_entry ##### -->
615 <para>
617 </para>
619 @view:
620 @entry:
621 @Returns:
623 <!-- ##### FUNCTION rb_entry_view_get_num_entries ##### -->
624 <para>
626 </para>
628 @view:
629 @Returns:
631 <!-- ##### FUNCTION rb_entry_view_get_playing_entry ##### -->
632 <para>
634 </para>
636 @view:
637 @Returns:
639 <!-- ##### FUNCTION rb_entry_view_get_previous_entry ##### -->
640 <para>
642 </para>
644 @view:
645 @Returns:
647 <!-- ##### FUNCTION rb_entry_view_get_previous_from_entry ##### -->
648 <para>
650 </para>
652 @view:
653 @entry:
654 @Returns:
656 <!-- ##### FUNCTION rb_entry_view_get_random_entry ##### -->
657 <para>
659 </para>
661 @view:
662 @Returns:
664 <!-- ##### FUNCTION rb_entry_view_get_total_size ##### -->
665 <para>
667 </para>
669 @view:
670 @Returns:
672 <!-- ##### FUNCTION rb_entry_view_poll_model ##### -->
673 <para>
675 </para>
677 @view:
678 @Returns:
680 <!-- ##### FUNCTION rb_entry_view_set_playing ##### -->
681 <para>
683 </para>
685 @view:
686 @playing:
688 <!-- ##### FUNCTION rb_entry_view_set_playing_entry ##### -->
689 <para>
691 </para>
693 @view:
694 @entry:
696 <!-- ##### FUNCTION rb_entry_view_set_resorting ##### -->
697 <para>
699 </para>
701 @view:
703 <!-- ##### FUNCTION rb_get_sort_key ##### -->
704 <para>
706 </para>
708 @string:
709 @Returns:
711 <!-- ##### FUNCTION rb_header_set_show_artist_album ##### -->
712 <para>
714 </para>
716 @player:
717 @show:
719 <!-- ##### FUNCTION rb_header_set_title ##### -->
720 <para>
722 </para>
724 @header:
725 @title:
727 <!-- ##### FUNCTION rb_header_set_urldata ##### -->
728 <para>
730 </para>
732 @player:
733 @urltext:
734 @urllink:
736 <!-- ##### FUNCTION rb_library_source_class_add_actions ##### -->
737 <para>
739 </para>
741 @shell:
742 @uimgr:
744 <!-- ##### FUNCTION rb_library_source_get_paned_key ##### -->
745 <para>
747 </para>
749 @source:
750 @Returns:
752 <!-- ##### FUNCTION rb_load_failure_dialog_add ##### -->
753 <para>
755 </para>
757 @dlg:
758 @uri:
759 @error:
761 <!-- ##### FUNCTION rb_load_failure_dialog_new ##### -->
762 <para>
764 </para>
766 @Returns:
768 <!-- ##### FUNCTION rb_play_order_get_entry_view ##### -->
769 <para>
771 </para>
773 @porder:
774 @Returns:
776 <!-- ##### FUNCTION rb_play_order_ref_entry_swapped ##### -->
777 <para>
779 </para>
781 @entry:
782 @db:
784 <!-- ##### FUNCTION rb_play_order_unref_entry_swapped ##### -->
785 <para>
787 </para>
789 @entry:
790 @db:
792 <!-- ##### FUNCTION rb_playlist_manager_load_legacy_playlists ##### -->
793 <para>
795 </para>
797 @mgr:
799 <!-- ##### FUNCTION rb_playlist_manager_set_source ##### -->
800 <para>
802 </para>
804 @mgr:
805 @player:
807 <!-- ##### FUNCTION rb_playlist_source_add_entry ##### -->
808 <para>
810 </para>
812 @source:
813 @entry:
815 <!-- ##### FUNCTION rb_playlist_source_add_location ##### -->
816 <para>
818 </para>
820 @source:
821 @location:
823 <!-- ##### FUNCTION rb_playlist_source_add_locations ##### -->
824 <para>
826 </para>
828 @source:
829 @locations:
831 <!-- ##### FUNCTION rb_playlist_source_burn_playlist ##### -->
832 <para>
834 </para>
836 @source:
838 <!-- ##### FUNCTION rb_playlist_source_delete ##### -->
839 <para>
841 </para>
843 @source:
845 <!-- ##### FUNCTION rb_playlist_source_get_query ##### -->
846 <para>
848 </para>
850 @source:
851 @query:
852 @limit_count:
853 @limit_mb:
854 @limit_time:
855 @sort_key:
856 @sort_order:
858 <!-- ##### FUNCTION rb_playlist_source_new ##### -->
859 <para>
861 </para>
863 @shell:
864 @smart:
865 @local:
866 @entry_type:
867 @Returns:
869 <!-- ##### FUNCTION rb_playlist_source_remove_entry ##### -->
870 <para>
872 </para>
874 @source:
875 @entry:
877 <!-- ##### FUNCTION rb_playlist_source_remove_location ##### -->
878 <para>
880 </para>
882 @source:
883 @location:
885 <!-- ##### FUNCTION rb_playlist_source_set_query ##### -->
886 <para>
888 </para>
890 @source:
891 @query:
892 @limit_count:
893 @limit_mb:
894 @limit_time:
895 @sort_key:
896 @sort_order:
898 <!-- ##### FUNCTION rb_refstring_new_full ##### -->
899 <para>
901 </para>
903 @init:
904 @compute_sortdata:
905 @Returns:
907 <!-- ##### FUNCTION rb_removable_media_manager_load_media ##### -->
908 <para>
910 </para>
912 @mgr:
913 @Returns:
915 <!-- ##### FUNCTION rb_shell_construct ##### -->
916 <para>
918 </para>
920 @shell:
922 <!-- ##### FUNCTION rb_shell_guess_type_for_uri ##### -->
923 <para>
925 </para>
927 @shell:
928 @uri:
929 @Returns:
931 <!-- ##### FUNCTION rb_shell_player_get_mm_player ##### -->
932 <para>
934 </para>
936 @shell_player:
937 @Returns:
939 <!-- ##### FUNCTION rb_shell_player_handle_key ##### -->
940 <para>
942 </para>
944 @player:
945 @keyval:
946 @Returns:
948 <!-- ##### FUNCTION rb_shell_player_sync_buttons ##### -->
949 <para>
951 </para>
953 @player:
955 <!-- ##### FUNCTION rb_song_display_box_get_type ##### -->
956 <para>
958 </para>
960 @Returns:
962 <!-- ##### FUNCTION rb_song_display_box_new ##### -->
963 <para>
965 </para>
967 @Returns:
969 <!-- ##### FUNCTION rb_source_disconnect ##### -->
970 <para>
972 </para>
974 @source:
975 @Returns:
977 <!-- ##### FUNCTION rb_source_get_extra_views ##### -->
978 <para>
980 </para>
982 @source:
983 @Returns:
985 <!-- ##### FUNCTION rb_source_get_pixbuf ##### -->
986 <para>
988 </para>
990 @source:
991 @Returns:
993 <!-- ##### FUNCTION rb_source_have_url ##### -->
994 <para>
996 </para>
998 @source:
999 @Returns:
1001 <!-- ##### FUNCTION rb_statusbar_sync_state ##### -->
1002 <para>
1004 </para>
1006 @statusbar:
1008 <!-- ##### FUNCTION rb_string_helpers_init ##### -->
1009 <para>
1011 </para>
1014 <!-- ##### FUNCTION rb_string_helpers_shutdown ##### -->
1015 <para>
1017 </para>
1020 <!-- ##### FUNCTION rb_tree_model_sort_new ##### -->
1021 <para>
1023 </para>
1025 @child_model:
1026 @Returns:
1028 <!-- ##### FUNCTION rb_unicodify ##### -->
1029 <para>
1031 </para>
1033 @str:
1034 @Returns:
1036 <!-- ##### FUNCTION rb_utf8_strncasecmp ##### -->
1037 <para>
1039 </para>
1041 @a:
1042 @b:
1043 @Returns:
1045 <!-- ##### FUNCTION rhythmdb_entry_destroy ##### -->
1046 <para>
1048 </para>
1050 @db:
1051 @entry:
1053 <!-- ##### FUNCTION rhythmdb_entry_icecast_get_type ##### -->
1054 <para>
1056 </para>
1058 @Returns:
1060 <!-- ##### FUNCTION rhythmdb_entry_iradio_get_type ##### -->
1061 <para>
1063 </para>
1065 @Returns:
1067 <!-- ##### FUNCTION rhythmdb_entry_set_nonotify ##### -->
1068 <para>
1070 </para>
1072 @db:
1073 @entry:
1074 @propid:
1075 @value:
1077 <!-- ##### FUNCTION rhythmdb_entry_set_uninserted ##### -->
1078 <para>
1080 </para>
1082 @db:
1083 @entry:
1084 @propid:
1085 @value:
1087 <!-- ##### FUNCTION rhythmdb_entry_sync_mirrored ##### -->
1088 <para>
1090 </para>
1092 @db:
1093 @entry:
1094 @propid:
1096 <!-- ##### FUNCTION rhythmdb_prop_get_type ##### -->
1097 <para>
1099 </para>
1101 @Returns:
1103 <!-- ##### FUNCTION rhythmdb_query_cancel ##### -->
1104 <para>
1106 </para>
1108 @db:
1109 @query_model:
1111 <!-- ##### FUNCTION rhythmdb_query_model_add_entries ##### -->
1112 <para>
1114 </para>
1116 @model:
1117 @entries:
1119 <!-- ##### FUNCTION rhythmdb_query_model_cancel ##### -->
1120 <para>
1122 </para>
1124 @model:
1126 <!-- ##### FUNCTION rhythmdb_query_model_poll ##### -->
1127 <para>
1129 </para>
1131 @model:
1132 @timeout:
1133 @Returns:
1135 <!-- ##### FUNCTION rhythmdb_query_model_set_connected ##### -->
1136 <para>
1138 </para>
1140 @model:
1141 @connected:
1143 <!-- ##### FUNCTION rhythmdb_query_model_signal_complete ##### -->
1144 <para>
1146 </para>
1148 @model: