← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-play-order.xml

Tags: upstream-0.9.2cvs20060102
Import upstream version 0.9.2cvs20060102

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/rb-play-order.xml
25
25
const <link linkend="RBPlayOrderDescription">RBPlayOrderDescription</link>* <link linkend="rb-play-order-get-orders">rb_play_order_get_orders</link>
26
26
                                            (void);
27
27
<link linkend="void">void</link>        <link linkend="rb-play-order-playing-source-changed">rb_play_order_playing_source_changed</link>
28
 
                                            (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);
 
28
                                            (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder,
 
29
                                             <link linkend="RBSource">RBSource</link> *source);
29
30
<link linkend="gboolean">gboolean</link>    <link linkend="rb-play-order-has-next">rb_play_order_has_next</link>          (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);
30
31
<link linkend="RhythmDBEntry">RhythmDBEntry</link>* <link linkend="rb-play-order-get-next">rb_play_order_get_next</link>       (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);
31
32
<link linkend="void">void</link>        <link linkend="rb-play-order-go-next">rb_play_order_go_next</link>           (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);
35
36
<link linkend="RBShellPlayer">RBShellPlayer</link>* <link linkend="rb-play-order-get-player">rb_play_order_get_player</link>     (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);
36
37
<link linkend="RBSource">RBSource</link>*   <link linkend="rb-play-order-get-source">rb_play_order_get_source</link>        (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);
37
38
<link linkend="RhythmDB">RhythmDB</link>*   <link linkend="rb-play-order-get-db">rb_play_order_get_db</link>            (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);
38
 
<link linkend="RBEntryView">RBEntryView</link>* <link linkend="rb-play-order-get-entry-view">rb_play_order_get_entry_view</link>   (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);
39
39
<link linkend="RhythmDBEntry">RhythmDBEntry</link>* <link linkend="rb-play-order-get-playing-entry">rb_play_order_get_playing_entry</link>
40
40
                                            (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);
41
41
<link linkend="gboolean">gboolean</link>    <link linkend="rb-play-order-player-is-playing">rb_play_order_player_is_playing</link> (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);
77
77
<indexterm><primary>rb_play_order_new</primary></indexterm><programlisting><link linkend="RBPlayOrder">RBPlayOrder</link>* rb_play_order_new              (const <link linkend="char">char</link> *play_order_name,
78
78
                                             <link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
79
79
<para>
 
80
Creates a new <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> of the specified type.</para>
 
81
<para>
80
82
 
81
83
</para><variablelist role="params">
82
84
<varlistentry><term><parameter>play_order_name</parameter>&nbsp;:</term>
83
85
<listitem><simpara>
84
86
</simpara></listitem></varlistentry>
85
87
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
86
 
<listitem><simpara>
 
88
<listitem><simpara> <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link> instance to attach to
87
89
</simpara></listitem></varlistentry>
88
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
89
 
 
90
 
 
 
90
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> instance
91
91
</simpara></listitem></varlistentry>
92
92
</variablelist></refsect2>
93
93
<refsect2>
114
114
<indexterm><primary>rb_play_order_get_orders</primary></indexterm><programlisting>const <link linkend="RBPlayOrderDescription">RBPlayOrderDescription</link>* rb_play_order_get_orders
115
115
                                            (void);</programlisting>
116
116
<para>
 
117
Defines the set of available play orders, their translatable descriptions, their
 
118
constructor functions, whether they should appear in a drop-down list of 
 
119
play orders, and which one is the default.
 
120
</para>
 
121
<para>
 
122
This should be the only function with full knowledge of what play orders are
 
123
available.</para>
 
124
<para>
117
125
 
118
126
</para><variablelist role="params">
119
127
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
124
132
<refsect2>
125
133
<title><anchor id="rb-play-order-playing-source-changed"/>rb_play_order_playing_source_changed ()</title>
126
134
<indexterm><primary>rb_play_order_playing_source_changed</primary></indexterm><programlisting><link linkend="void">void</link>        rb_play_order_playing_source_changed
127
 
                                            (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
 
135
                                            (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder,
 
136
                                             <link linkend="RBSource">RBSource</link> *source);</programlisting>
 
137
<para>
 
138
Sets the playing <link linkend="RBSource"><type>RBSource</type></link> for the play order.  Should be called
 
139
by <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link> when the active source changes.  Subclasses
 
140
should implement <link linkend="playing-source-changed"><function>playing_source_changed()</function></link> to make any necessary
 
141
changes.</para>
128
142
<para>
129
143
 
130
144
</para><variablelist role="params">
131
145
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
132
 
<listitem><simpara>
133
 
 
134
 
 
 
146
<listitem><simpara> <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> instance
 
147
</simpara></listitem></varlistentry>
 
148
<varlistentry><term><parameter>source</parameter>&nbsp;:</term>
 
149
<listitem><simpara> New playing <link linkend="RBSource"><type>RBSource</type></link>
135
150
</simpara></listitem></varlistentry>
136
151
</variablelist></refsect2>
137
152
<refsect2>
138
153
<title><anchor id="rb-play-order-has-next"/>rb_play_order_has_next ()</title>
139
154
<indexterm><primary>rb_play_order_has_next</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_play_order_has_next          (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
140
155
<para>
 
156
If there is no current playing entry, returns true if the play order is non-empty.</para>
 
157
<para>
141
158
 
142
159
</para><variablelist role="params">
143
160
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
144
 
<listitem><simpara>
 
161
<listitem><simpara> RBPlayOrder instance.
145
162
</simpara></listitem></varlistentry>
146
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
147
 
 
148
 
 
 
163
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> true if there is an entry after the current playing entry in the play order.
149
164
</simpara></listitem></varlistentry>
150
165
</variablelist></refsect2>
151
166
<refsect2>
152
167
<title><anchor id="rb-play-order-get-next"/>rb_play_order_get_next ()</title>
153
168
<indexterm><primary>rb_play_order_get_next</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_play_order_get_next       (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
154
169
<para>
 
170
</para>
 
171
<para>
155
172
 
156
173
</para><variablelist role="params">
157
174
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
158
 
<listitem><simpara>
 
175
<listitem><simpara> RBPlayOrder instance
159
176
</simpara></listitem></varlistentry>
160
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
161
 
 
162
 
 
 
177
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the next entry in the play order, or the first if not currently playing.
163
178
</simpara></listitem></varlistentry>
164
179
</variablelist></refsect2>
165
180
<refsect2>
166
181
<title><anchor id="rb-play-order-go-next"/>rb_play_order_go_next ()</title>
167
182
<indexterm><primary>rb_play_order_go_next</primary></indexterm><programlisting><link linkend="void">void</link>        rb_play_order_go_next           (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
168
183
<para>
 
184
Moves to the next entry in the play order.  If not currently playing, sets the
 
185
first entry in the play order as the playing entry.</para>
 
186
<para>
169
187
 
170
188
</para><variablelist role="params">
171
189
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
172
 
<listitem><simpara>
173
 
 
174
 
 
 
190
<listitem><simpara> RBPlayOrder instance
175
191
</simpara></listitem></varlistentry>
176
192
</variablelist></refsect2>
177
193
<refsect2>
178
194
<title><anchor id="rb-play-order-has-previous"/>rb_play_order_has_previous ()</title>
179
195
<indexterm><primary>rb_play_order_has_previous</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_play_order_has_previous      (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
180
196
<para>
 
197
</para>
 
198
<para>
181
199
 
182
200
</para><variablelist role="params">
183
201
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
184
 
<listitem><simpara>
 
202
<listitem><simpara> RBPlayOrder instance
185
203
</simpara></listitem></varlistentry>
186
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
187
 
 
188
 
 
 
204
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> true if there is an entry before the current entry in the play order.
 
205
If not currently playing, returns false.
189
206
</simpara></listitem></varlistentry>
190
207
</variablelist></refsect2>
191
208
<refsect2>
192
209
<title><anchor id="rb-play-order-get-previous"/>rb_play_order_get_previous ()</title>
193
210
<indexterm><primary>rb_play_order_get_previous</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_play_order_get_previous   (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
194
211
<para>
 
212
</para>
 
213
<para>
195
214
 
196
215
</para><variablelist role="params">
197
216
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
198
 
<listitem><simpara>
 
217
<listitem><simpara> RBPlayOrder instance
199
218
</simpara></listitem></varlistentry>
200
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
201
 
 
202
 
 
 
219
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the previous entry in the play order, or NULL if not currently playing.
203
220
</simpara></listitem></varlistentry>
204
221
</variablelist></refsect2>
205
222
<refsect2>
206
223
<title><anchor id="rb-play-order-go-previous"/>rb_play_order_go_previous ()</title>
207
224
<indexterm><primary>rb_play_order_go_previous</primary></indexterm><programlisting><link linkend="void">void</link>        rb_play_order_go_previous       (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
208
225
<para>
 
226
Moves to the previous entry in the play order.  If not currently playing, does nothing.</para>
 
227
<para>
209
228
 
210
229
</para><variablelist role="params">
211
230
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
212
 
<listitem><simpara>
213
 
 
214
 
 
 
231
<listitem><simpara> RBPlayOrder instance
215
232
</simpara></listitem></varlistentry>
216
233
</variablelist></refsect2>
217
234
<refsect2>
218
235
<title><anchor id="rb-play-order-get-player"/>rb_play_order_get_player ()</title>
219
236
<indexterm><primary>rb_play_order_get_player</primary></indexterm><programlisting><link linkend="RBShellPlayer">RBShellPlayer</link>* rb_play_order_get_player     (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
220
237
<para>
 
238
Only for use by <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> subclasses.</para>
 
239
<para>
221
240
 
222
241
</para><variablelist role="params">
223
242
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
224
 
<listitem><simpara>
 
243
<listitem><simpara> <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> instance
225
244
</simpara></listitem></varlistentry>
226
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
227
 
 
228
 
 
 
245
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link> instance
229
246
</simpara></listitem></varlistentry>
230
247
</variablelist></refsect2>
231
248
<refsect2>
232
249
<title><anchor id="rb-play-order-get-source"/>rb_play_order_get_source ()</title>
233
250
<indexterm><primary>rb_play_order_get_source</primary></indexterm><programlisting><link linkend="RBSource">RBSource</link>*   rb_play_order_get_source        (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
234
251
<para>
 
252
Only for use by <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> subclasses.</para>
 
253
<para>
235
254
 
236
255
</para><variablelist role="params">
237
256
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
238
 
<listitem><simpara>
 
257
<listitem><simpara> <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> instance
239
258
</simpara></listitem></varlistentry>
240
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
241
 
 
242
 
 
 
259
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the playing <link linkend="RBSource"><type>RBSource</type></link> instance.
243
260
</simpara></listitem></varlistentry>
244
261
</variablelist></refsect2>
245
262
<refsect2>
246
263
<title><anchor id="rb-play-order-get-db"/>rb_play_order_get_db ()</title>
247
264
<indexterm><primary>rb_play_order_get_db</primary></indexterm><programlisting><link linkend="RhythmDB">RhythmDB</link>*   rb_play_order_get_db            (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
248
265
<para>
249
 
 
250
 
</para><variablelist role="params">
251
 
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
252
 
<listitem><simpara>
253
 
</simpara></listitem></varlistentry>
254
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
255
 
 
256
 
 
257
 
</simpara></listitem></varlistentry>
258
 
</variablelist></refsect2>
259
 
<refsect2>
260
 
<title><anchor id="rb-play-order-get-entry-view"/>rb_play_order_get_entry_view ()</title>
261
 
<indexterm><primary>rb_play_order_get_entry_view</primary></indexterm><programlisting><link linkend="RBEntryView">RBEntryView</link>* rb_play_order_get_entry_view   (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
 
266
Only for use by <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> subclasses.</para>
262
267
<para>
263
268
 
264
269
</para><variablelist role="params">
265
270
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
266
 
<listitem><simpara>
 
271
<listitem><simpara> <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> instance
267
272
</simpara></listitem></varlistentry>
268
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
269
 
 
270
 
 
 
273
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="RhythmDB"><type>RhythmDB</type></link> instance.
271
274
</simpara></listitem></varlistentry>
272
275
</variablelist></refsect2>
273
276
<refsect2>
275
278
<indexterm><primary>rb_play_order_get_playing_entry</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_play_order_get_playing_entry
276
279
                                            (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
277
280
<para>
 
281
</para>
 
282
<para>
278
283
 
279
284
</para><variablelist role="params">
280
285
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
281
 
<listitem><simpara>
 
286
<listitem><simpara> <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> instance
282
287
</simpara></listitem></varlistentry>
283
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
284
 
 
285
 
 
 
288
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the current playing entry in the play order.
286
289
</simpara></listitem></varlistentry>
287
290
</variablelist></refsect2>
288
291
<refsect2>
289
292
<title><anchor id="rb-play-order-player-is-playing"/>rb_play_order_player_is_playing ()</title>
290
293
<indexterm><primary>rb_play_order_player_is_playing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_play_order_player_is_playing (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
291
294
<para>
 
295
</para>
 
296
<para>
292
297
 
293
298
</para><variablelist role="params">
294
299
<varlistentry><term><parameter>porder</parameter>&nbsp;:</term>
295
 
<listitem><simpara>
 
300
<listitem><simpara> <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> instance
296
301
</simpara></listitem></varlistentry>
297
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
298
 
 
299
 
 
 
302
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> true if there is a current playing entry in the play order.
300
303
</simpara></listitem></varlistentry>
301
304
</variablelist></refsect2>
302
305
<refsect2>
304
307
<indexterm><primary>rb_play_order_ref_entry_swapped</primary></indexterm><programlisting><link linkend="void">void</link>        rb_play_order_ref_entry_swapped (<link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
305
308
                                             <link linkend="RhythmDB">RhythmDB</link> *db);</programlisting>
306
309
<para>
 
310
Utility function that can be used with <link linkend="RBHistory"><type>RBHistory</type></link> to implement play orders
 
311
that maintain an internal list of entries.</para>
 
312
<para>
307
313
 
308
314
</para><variablelist role="params">
309
315
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
310
 
<listitem><simpara>
 
316
<listitem><simpara> <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> to reference
311
317
</simpara></listitem></varlistentry>
312
318
<varlistentry><term><parameter>db</parameter>&nbsp;:</term>
313
 
<listitem><simpara>
314
 
 
315
 
 
 
319
<listitem><simpara> <link linkend="RhythmDB"><type>RhythmDB</type></link> instance
316
320
</simpara></listitem></varlistentry>
317
321
</variablelist></refsect2>
318
322
<refsect2>
321
325
                                            (<link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
322
326
                                             <link linkend="RhythmDB">RhythmDB</link> *db);</programlisting>
323
327
<para>
 
328
Utility function that can be used with <link linkend="RBHistory"><type>RBHistory</type></link> to implement play orders
 
329
that maintain an internal list of entries.</para>
 
330
<para>
324
331
 
325
332
</para><variablelist role="params">
326
333
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
327
 
<listitem><simpara>
 
334
<listitem><simpara> <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> to unreference
328
335
</simpara></listitem></varlistentry>
329
336
<varlistentry><term><parameter>db</parameter>&nbsp;:</term>
330
 
<listitem><simpara>
331
 
 
332
 
 
 
337
<listitem><simpara> <link linkend="RhythmDB"><type>RhythmDB</type></link> instance
333
338
</simpara></listitem></varlistentry>
334
339
</variablelist></refsect2>
335
340