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
|
<?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="rhythmbox-RBSourceGroup">
<refmeta>
<refentrytitle role="top_of_page" id="rhythmbox-RBSourceGroup.top_of_page">RBSourceGroup</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>RBSourceGroup</refname>
<refpurpose>Source list grouping</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="rhythmbox-RBSourceGroup.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="RBSourceGroupCategory">RBSourceGroupCategory</link>;
typedef <link linkend="RBSourceGroup">RBSourceGroup</link>;
#define <link linkend="RB-SOURCE-GROUP-LIBRARY:CAPS">RB_SOURCE_GROUP_LIBRARY</link>
#define <link linkend="RB-SOURCE-GROUP-PLAYLISTS:CAPS">RB_SOURCE_GROUP_PLAYLISTS</link>
#define <link linkend="RB-SOURCE-GROUP-DEVICES:CAPS">RB_SOURCE_GROUP_DEVICES</link>
#define <link linkend="RB-SOURCE-GROUP-SHARED:CAPS">RB_SOURCE_GROUP_SHARED</link>
<link linkend="void">void</link> <link linkend="rb-source-group-init">rb_source_group_init</link> (void);
<link linkend="RBSourceGroup">RBSourceGroup</link>* <link linkend="rb-source-group-get-by-name">rb_source_group_get_by_name</link> (const <link linkend="char">char</link> *name);
<link linkend="RBSourceGroup">RBSourceGroup</link>* <link linkend="rb-source-group-register">rb_source_group_register</link> (const <link linkend="char">char</link> *name,
const <link linkend="char">char</link> *display_name,
<link linkend="RBSourceGroupCategory">RBSourceGroupCategory</link> category);
<link linkend="RBSourceGroup">RBSourceGroup</link>* <link linkend="rb-source-group-library-get-type">rb_source_group_library_get_type</link> (void);
<link linkend="RBSourceGroup">RBSourceGroup</link>* <link linkend="rb-source-group-playlists-get-type">rb_source_group_playlists_get_type</link> (void);
<link linkend="RBSourceGroup">RBSourceGroup</link>* <link linkend="rb-source-group-devices-get-type">rb_source_group_devices_get_type</link> (void);
<link linkend="RBSourceGroup">RBSourceGroup</link>* <link linkend="rb-source-group-shared-get-type">rb_source_group_shared_get_type</link> (void);
</synopsis>
</refsynopsisdiv>
<refsect1 id="rhythmbox-RBSourceGroup.description" role="desc">
<title role="desc.title">Description</title>
<para>
Source groups define sections of the source list. A source group
consists of an internal name, a display name, and a category.
The internal name can be used to locate a registered source group.
The category is used to sort the source groups.</para>
<para>
</para>
</refsect1>
<refsect1 id="rhythmbox-RBSourceGroup.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBSourceGroupCategory" role="enum">
<title>enum RBSourceGroupCategory</title>
<indexterm zone="RBSourceGroupCategory"><primary>RBSourceGroupCategory</primary></indexterm><programlisting>typedef enum {
RB_SOURCE_GROUP_CATEGORY_FIXED = 0, /* library, iradio, podcast, queue */
RB_SOURCE_GROUP_CATEGORY_PERSISTENT, /* playlists */
RB_SOURCE_GROUP_CATEGORY_REMOVABLE, /* ipod, generic audio player, audio CD */
RB_SOURCE_GROUP_CATEGORY_TRANSIENT, /* DAAP shares */
RB_SOURCE_GROUP_CATEGORY_LAST
} RBSourceGroupCategory;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBSourceGroup" role="typedef">
<title>RBSourceGroup</title>
<indexterm zone="RBSourceGroup"><primary>RBSourceGroup</primary></indexterm><programlisting>typedef struct RBSourceGroup RBSourceGroup;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="RB-SOURCE-GROUP-LIBRARY:CAPS" role="macro">
<title>RB_SOURCE_GROUP_LIBRARY</title>
<indexterm zone="RB-SOURCE-GROUP-LIBRARY:CAPS"><primary>RB_SOURCE_GROUP_LIBRARY</primary></indexterm><programlisting>#define RB_SOURCE_GROUP_LIBRARY (rb_source_group_library_get_type ())
</programlisting>
<para>
</para></refsect2>
<refsect2 id="RB-SOURCE-GROUP-PLAYLISTS:CAPS" role="macro">
<title>RB_SOURCE_GROUP_PLAYLISTS</title>
<indexterm zone="RB-SOURCE-GROUP-PLAYLISTS:CAPS"><primary>RB_SOURCE_GROUP_PLAYLISTS</primary></indexterm><programlisting>#define RB_SOURCE_GROUP_PLAYLISTS (rb_source_group_playlists_get_type ())
</programlisting>
<para>
</para></refsect2>
<refsect2 id="RB-SOURCE-GROUP-DEVICES:CAPS" role="macro">
<title>RB_SOURCE_GROUP_DEVICES</title>
<indexterm zone="RB-SOURCE-GROUP-DEVICES:CAPS"><primary>RB_SOURCE_GROUP_DEVICES</primary></indexterm><programlisting>#define RB_SOURCE_GROUP_DEVICES (rb_source_group_devices_get_type ())
</programlisting>
<para>
</para></refsect2>
<refsect2 id="RB-SOURCE-GROUP-SHARED:CAPS" role="macro">
<title>RB_SOURCE_GROUP_SHARED</title>
<indexterm zone="RB-SOURCE-GROUP-SHARED:CAPS"><primary>RB_SOURCE_GROUP_SHARED</primary></indexterm><programlisting>#define RB_SOURCE_GROUP_SHARED (rb_source_group_shared_get_type ())
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-source-group-init" role="function">
<title>rb_source_group_init ()</title>
<indexterm zone="rb-source-group-init"><primary>rb_source_group_init</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_group_init (void);</programlisting>
<para>
Initializes source groups.</para>
<para>
</para></refsect2>
<refsect2 id="rb-source-group-get-by-name" role="function">
<title>rb_source_group_get_by_name ()</title>
<indexterm zone="rb-source-group-get-by-name"><primary>rb_source_group_get_by_name</primary></indexterm><programlisting><link linkend="RBSourceGroup">RBSourceGroup</link>* rb_source_group_get_by_name (const <link linkend="char">char</link> *name);</programlisting>
<para>
Locates a source group by name. If the source group has not been registered yet,
returns NULL instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of source group to find
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> existing source group, or NULL.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-group-register" role="function">
<title>rb_source_group_register ()</title>
<indexterm zone="rb-source-group-register"><primary>rb_source_group_register</primary></indexterm><programlisting><link linkend="RBSourceGroup">RBSourceGroup</link>* rb_source_group_register (const <link linkend="char">char</link> *name,
const <link linkend="char">char</link> *display_name,
<link linkend="RBSourceGroupCategory">RBSourceGroupCategory</link> category);</programlisting>
<para>
Registers and returns a new source group. Registering a source group
that already exists will probably do bad things.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of the source group (untranslated, used in code)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>display_name</parameter> :</term>
<listitem><simpara> display name of the source group (translated)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>category</parameter> :</term>
<listitem><simpara> category for the source group
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> new source group
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-group-library-get-type" role="function">
<title>rb_source_group_library_get_type ()</title>
<indexterm zone="rb-source-group-library-get-type"><primary>rb_source_group_library_get_type</primary></indexterm><programlisting><link linkend="RBSourceGroup">RBSourceGroup</link>* rb_source_group_library_get_type (void);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the predefined library source group
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-group-playlists-get-type" role="function">
<title>rb_source_group_playlists_get_type ()</title>
<indexterm zone="rb-source-group-playlists-get-type"><primary>rb_source_group_playlists_get_type</primary></indexterm><programlisting><link linkend="RBSourceGroup">RBSourceGroup</link>* rb_source_group_playlists_get_type (void);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the predefined playlists source group
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-group-devices-get-type" role="function">
<title>rb_source_group_devices_get_type ()</title>
<indexterm zone="rb-source-group-devices-get-type"><primary>rb_source_group_devices_get_type</primary></indexterm><programlisting><link linkend="RBSourceGroup">RBSourceGroup</link>* rb_source_group_devices_get_type (void);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the predefined devices source group
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-group-shared-get-type" role="function">
<title>rb_source_group_shared_get_type ()</title>
<indexterm zone="rb-source-group-shared-get-type"><primary>rb_source_group_shared_get_type</primary></indexterm><programlisting><link linkend="RBSourceGroup">RBSourceGroup</link>* rb_source_group_shared_get_type (void);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the predefined shared source group
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
