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
|
<?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="RBSourceList">
<refmeta>
<refentrytitle role="top_of_page" id="RBSourceList.top_of_page">rb-sourcelist</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rb-sourcelist</refname>
<refpurpose>source list widget</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="RBSourceList.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="RBSourceList-struct">RBSourceList</link>;
<link linkend="RBSourceListClass">RBSourceListClass</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="rb-sourcelist-new">rb_sourcelist_new</link> (<link linkend="RBShell">RBShell</link> *shell);
<link linkend="void">void</link> <link linkend="rb-sourcelist-append">rb_sourcelist_append</link> (<link linkend="RBSourceList">RBSourceList</link> *sourcelist,
<link linkend="RBSource">RBSource</link> *source,
<link linkend="RBSource">RBSource</link> *parent);
<link linkend="void">void</link> <link linkend="rb-sourcelist-set-playing-source">rb_sourcelist_set_playing_source</link> (<link linkend="RBSourceList">RBSourceList</link> *sourcelist,
<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-sourcelist-edit-source-name">rb_sourcelist_edit_source_name</link> (<link linkend="RBSourceList">RBSourceList</link> *sourcelist,
<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-sourcelist-remove">rb_sourcelist_remove</link> (<link linkend="RBSourceList">RBSourceList</link> *sourcelist,
<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-sourcelist-select">rb_sourcelist_select</link> (<link linkend="RBSourceList">RBSourceList</link> *sourcelist,
<link linkend="RBSource">RBSource</link> *source);
</synopsis>
</refsynopsisdiv>
<refsect1 id="RBSourceList.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="GtkBin">GtkBin</link>
+----<link linkend="GtkScrolledWindow">GtkScrolledWindow</link>
+----RBSourceList
</synopsis>
</refsect1>
<refsect1 id="RBSourceList.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
RBSourceList implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="RBSourceList.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="RBSourceList--model">model</link>" <link linkend="GtkTreeModel">GtkTreeModel</link>* : Read
"<link linkend="RBSourceList--shell">shell</link>" <link linkend="RBShell">RBShell</link>* : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="RBSourceList.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="RBSourceList-drop-received">drop-received</link>" : Run Last
"<link linkend="RBSourceList-selected">selected</link>" : Run Last
"<link linkend="RBSourceList-show-popup">show-popup</link>" : Run Last
"<link linkend="RBSourceList-source-activated">source-activated</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 id="RBSourceList.description" role="desc">
<title role="desc.title">Description</title>
<para>
The source list widget is a GtkTreeView backed by a GtkListStore
containing the sources and some extra data used to structure the
tree view.
</para>
<para>
The source list widget displays the available sources. Sources are divided into
groups - library, stores, playlists, devices, network shares. Groups are
displayed as headers, with expanders for hiding and showing the sources in
the group. Sources themselves may also have child sources, such as playlists
on portable audio players.
</para>
<para>
Sources are displayed with an icon and a name. If the source is currently
playing, the name is displayed in bold.</para>
<para>
</para>
</refsect1>
<refsect1 id="RBSourceList.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBSourceList-struct" role="struct">
<title>RBSourceList</title>
<indexterm zone="RBSourceList-struct"><primary>RBSourceList</primary></indexterm><programlisting>typedef struct _RBSourceList RBSourceList;</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBSourceListClass" role="struct">
<title>RBSourceListClass</title>
<indexterm zone="RBSourceListClass"><primary>RBSourceListClass</primary></indexterm><programlisting>typedef struct {
GtkScrolledWindowClass parent_class;
/* signals */
void (*selected) (RBSourceList *list, RBSource *source);
void (*drop_received) (RBSourceList *list, RBSource *target, GtkSelectionData *data);
void (*source_activated) (RBSourceList *list, RBSource *target);
gboolean (*show_popup) (RBSourceList *list, RBSource *target);
} RBSourceListClass;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-sourcelist-new" role="function">
<title>rb_sourcelist_new ()</title>
<indexterm zone="rb-sourcelist-new"><primary>rb_sourcelist_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* rb_sourcelist_new (<link linkend="RBShell">RBShell</link> *shell);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>shell</parameter> :</term>
<listitem><simpara> the <link linkend="RBShell"><type>RBShell</type></link> instance
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the source list widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-sourcelist-append" role="function">
<title>rb_sourcelist_append ()</title>
<indexterm zone="rb-sourcelist-append"><primary>rb_sourcelist_append</primary></indexterm><programlisting><link linkend="void">void</link> rb_sourcelist_append (<link linkend="RBSourceList">RBSourceList</link> *sourcelist,
<link linkend="RBSource">RBSource</link> *source,
<link linkend="RBSource">RBSource</link> *parent);</programlisting>
<para>
Adds a new source to the source list. If <parameter>parent</parameter> is not NULL, the new
source is added beneath it. Otherwise, it is added to the end of the
source group specified by the source's source-group property.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>sourcelist</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceList"><type>RBSourceList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the <link linkend="RBSource"><type>RBSource</type></link> to add
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent</parameter> :</term>
<listitem><simpara> the <link linkend="RBSource"><type>RBSource</type></link> below which to add the new source, or NULL
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-sourcelist-set-playing-source" role="function">
<title>rb_sourcelist_set_playing_source ()</title>
<indexterm zone="rb-sourcelist-set-playing-source"><primary>rb_sourcelist_set_playing_source</primary></indexterm><programlisting><link linkend="void">void</link> rb_sourcelist_set_playing_source (<link linkend="RBSourceList">RBSourceList</link> *sourcelist,
<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Updates the source list with the new playing source.
The source list tracks which source is playing in order to display
the name of the playing source in bold type.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>sourcelist</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceList"><type>RBSourceList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the new playing <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-sourcelist-edit-source-name" role="function">
<title>rb_sourcelist_edit_source_name ()</title>
<indexterm zone="rb-sourcelist-edit-source-name"><primary>rb_sourcelist_edit_source_name</primary></indexterm><programlisting><link linkend="void">void</link> rb_sourcelist_edit_source_name (<link linkend="RBSourceList">RBSourceList</link> *sourcelist,
<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Initiates editing of the name of the specified source. The row for the source
is selected and given input focus, allowing the user to edit the name.
source_name_edited_cb is called when the user finishes editing.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>sourcelist</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceList"><type>RBSourceList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the <link linkend="RBSource"><type>RBSource</type></link> to edit
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-sourcelist-remove" role="function">
<title>rb_sourcelist_remove ()</title>
<indexterm zone="rb-sourcelist-remove"><primary>rb_sourcelist_remove</primary></indexterm><programlisting><link linkend="void">void</link> rb_sourcelist_remove (<link linkend="RBSourceList">RBSourceList</link> *sourcelist,
<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Removes a source from the source list. Disconnects signal handlers,
removes the source from the underlying model, and updates the visibility
of the group containing the source.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>sourcelist</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceList"><type>RBSourceList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the <link linkend="RBSource"><type>RBSource</type></link> being removed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-sourcelist-select" role="function">
<title>rb_sourcelist_select ()</title>
<indexterm zone="rb-sourcelist-select"><primary>rb_sourcelist_select</primary></indexterm><programlisting><link linkend="void">void</link> rb_sourcelist_select (<link linkend="RBSourceList">RBSourceList</link> *sourcelist,
<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Selects the specified source in the source list. This will result in the 'selected'
signal being emitted.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>sourcelist</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceList"><type>RBSourceList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the <link linkend="RBSource"><type>RBSource</type></link> to select
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="RBSourceList.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="RBSourceList--model"><title>The <literal>"model"</literal> property</title>
<indexterm zone="RBSourceList--model"><primary>RBSourceList:model</primary></indexterm><programlisting> "model" <link linkend="GtkTreeModel">GtkTreeModel</link>* : Read</programlisting>
<para>
The <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link> for the source list</para>
<para>
</para></refsect2>
<refsect2 id="RBSourceList--shell"><title>The <literal>"shell"</literal> property</title>
<indexterm zone="RBSourceList--shell"><primary>RBSourceList:shell</primary></indexterm><programlisting> "shell" <link linkend="RBShell">RBShell</link>* : Read / Write / Construct Only</programlisting>
<para>
The <link linkend="RBShell"><type>RBShell</type></link> instance</para>
<para>
</para></refsect2>
</refsect1>
<refsect1 id="RBSourceList.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="RBSourceList-drop-received"><title>The <literal>"drop-received"</literal> signal</title>
<indexterm zone="RBSourceList-drop-received"><primary>RBSourceList::drop-received</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBSourceList">RBSourceList</link> *list,
<link linkend="gpointer">gpointer</link> target,
<link linkend="gpointer">gpointer</link> data,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when a drag and drop to the source list completes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceList"><type>RBSourceList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>target</parameter> :</term>
<listitem><simpara> the <link linkend="RBSource"><type>RBSource</type></link> receiving the drop
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> the drop data
</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="RBSourceList-selected"><title>The <literal>"selected"</literal> signal</title>
<indexterm zone="RBSourceList-selected"><primary>RBSourceList::selected</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBSourceList">RBSourceList</link> *list,
<link linkend="GObject">GObject</link> *source,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when a source is selected from the source list</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceList"><type>RBSourceList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the newly selected <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="RBSourceList-show-popup"><title>The <literal>"show-popup"</literal> signal</title>
<indexterm zone="RBSourceList-show-popup"><primary>RBSourceList::show-popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="RBSourceList">RBSourceList</link> *list,
<link linkend="RBSource">RBSource</link> *target,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when a source should display a popup menu in response to some
user action, such as right clicking or pressing shift-f10.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceList"><type>RBSourceList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>target</parameter> :</term>
<listitem><simpara> the <link linkend="RBSource"><type>RBSource</type></link> for which a popup menu should be shown
</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="RBSourceList-source-activated"><title>The <literal>"source-activated"</literal> signal</title>
<indexterm zone="RBSourceList-source-activated"><primary>RBSourceList::source-activated</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBSourceList">RBSourceList</link> *list,
<link linkend="GObject">GObject</link> *target,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when a source is activated (by double clicking or hitting
the enter key)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceList"><type>RBSourceList</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>target</parameter> :</term>
<listitem><simpara> the activated <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>
</refsect1>
</refentry>
|
