← 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.5
Import upstream version 0.9.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/rb-play-order.xml
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="rhythmbox-rb-play-order">
5
5
<refmeta>
6
 
<refentrytitle>rb-play-order</refentrytitle>
 
6
<refentrytitle id="top_of_page">rb-play-order</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
9
9
</refmeta>
10
10
 
11
11
<refnamediv>
12
 
<refname>rb-play-order</refname><refpurpose></refpurpose>
 
12
<refname>rb-play-order</refname>
 
13
<refpurpose></refpurpose>
 
14
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
13
15
</refnamediv>
14
16
 
15
 
<refsynopsisdiv><title>Synopsis</title>
 
17
<refsynopsisdiv id="synopsis">
 
18
<title id="synopsis.title">Synopsis</title>
16
19
 
17
20
<synopsis>
18
21
 
56
59
 
57
60
 
58
61
 
59
 
<refsect1>
60
 
<title>Description</title>
 
62
<refsect1 id="desc">
 
63
<title id="desc.title">Description</title>
61
64
<para>
62
65
 
63
66
</para>
64
67
</refsect1>
65
68
 
66
 
<refsect1>
67
 
<title>Details</title>
 
69
<refsect1 id="details">
 
70
<title id="details.title">Details</title>
68
71
<refsect2>
69
 
<title><anchor id="RBPlayOrderPrivate"/>RBPlayOrderPrivate</title>
 
72
<title><anchor id="RBPlayOrderPrivate" role="typedef"/>RBPlayOrderPrivate</title>
70
73
<indexterm><primary>RBPlayOrderPrivate</primary></indexterm><programlisting>typedef struct RBPlayOrderPrivate RBPlayOrderPrivate;
71
74
</programlisting>
72
75
<para>
73
76
 
74
77
</para></refsect2>
75
78
<refsect2>
76
 
<title><anchor id="rb-play-order-new"/>rb_play_order_new ()</title>
 
79
<title><anchor id="rb-play-order-new" role="function"/>rb_play_order_new ()</title>
77
80
<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
81
                                             <link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
79
82
<para>
91
94
</simpara></listitem></varlistentry>
92
95
</variablelist></refsect2>
93
96
<refsect2>
94
 
<title><anchor id="RBPlayOrderDescription"/>RBPlayOrderDescription</title>
 
97
<title><anchor id="RBPlayOrderDescription" role="struct"/>RBPlayOrderDescription</title>
95
98
<indexterm><primary>RBPlayOrderDescription</primary></indexterm><programlisting>typedef struct {
96
99
        /** Value of the state/play-order gconf key */
97
100
        char *name;
110
113
 
111
114
</para></refsect2>
112
115
<refsect2>
113
 
<title><anchor id="rb-play-order-get-orders"/>rb_play_order_get_orders ()</title>
 
116
<title><anchor id="rb-play-order-get-orders" role="function"/>rb_play_order_get_orders ()</title>
114
117
<indexterm><primary>rb_play_order_get_orders</primary></indexterm><programlisting>const <link linkend="RBPlayOrderDescription">RBPlayOrderDescription</link>* rb_play_order_get_orders
115
118
                                            (void);</programlisting>
116
119
<para>
130
133
</simpara></listitem></varlistentry>
131
134
</variablelist></refsect2>
132
135
<refsect2>
133
 
<title><anchor id="rb-play-order-playing-source-changed"/>rb_play_order_playing_source_changed ()</title>
 
136
<title><anchor id="rb-play-order-playing-source-changed" role="function"/>rb_play_order_playing_source_changed ()</title>
134
137
<indexterm><primary>rb_play_order_playing_source_changed</primary></indexterm><programlisting><link linkend="void">void</link>        rb_play_order_playing_source_changed
135
138
                                            (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder,
136
139
                                             <link linkend="RBSource">RBSource</link> *source);</programlisting>
150
153
</simpara></listitem></varlistentry>
151
154
</variablelist></refsect2>
152
155
<refsect2>
153
 
<title><anchor id="rb-play-order-has-next"/>rb_play_order_has_next ()</title>
 
156
<title><anchor id="rb-play-order-has-next" role="function"/>rb_play_order_has_next ()</title>
154
157
<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>
155
158
<para>
156
159
If there is no current playing entry, returns true if the play order is non-empty.</para>
164
167
</simpara></listitem></varlistentry>
165
168
</variablelist></refsect2>
166
169
<refsect2>
167
 
<title><anchor id="rb-play-order-get-next"/>rb_play_order_get_next ()</title>
 
170
<title><anchor id="rb-play-order-get-next" role="function"/>rb_play_order_get_next ()</title>
168
171
<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>
169
172
<para>
170
173
</para>
178
181
</simpara></listitem></varlistentry>
179
182
</variablelist></refsect2>
180
183
<refsect2>
181
 
<title><anchor id="rb-play-order-go-next"/>rb_play_order_go_next ()</title>
 
184
<title><anchor id="rb-play-order-go-next" role="function"/>rb_play_order_go_next ()</title>
182
185
<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>
183
186
<para>
184
187
Moves to the next entry in the play order.  If not currently playing, sets the
191
194
</simpara></listitem></varlistentry>
192
195
</variablelist></refsect2>
193
196
<refsect2>
194
 
<title><anchor id="rb-play-order-has-previous"/>rb_play_order_has_previous ()</title>
 
197
<title><anchor id="rb-play-order-has-previous" role="function"/>rb_play_order_has_previous ()</title>
195
198
<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>
196
199
<para>
197
200
</para>
206
209
</simpara></listitem></varlistentry>
207
210
</variablelist></refsect2>
208
211
<refsect2>
209
 
<title><anchor id="rb-play-order-get-previous"/>rb_play_order_get_previous ()</title>
 
212
<title><anchor id="rb-play-order-get-previous" role="function"/>rb_play_order_get_previous ()</title>
210
213
<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>
211
214
<para>
212
215
</para>
220
223
</simpara></listitem></varlistentry>
221
224
</variablelist></refsect2>
222
225
<refsect2>
223
 
<title><anchor id="rb-play-order-go-previous"/>rb_play_order_go_previous ()</title>
 
226
<title><anchor id="rb-play-order-go-previous" role="function"/>rb_play_order_go_previous ()</title>
224
227
<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>
225
228
<para>
226
229
Moves to the previous entry in the play order.  If not currently playing, does nothing.</para>
232
235
</simpara></listitem></varlistentry>
233
236
</variablelist></refsect2>
234
237
<refsect2>
235
 
<title><anchor id="rb-play-order-get-player"/>rb_play_order_get_player ()</title>
 
238
<title><anchor id="rb-play-order-get-player" role="function"/>rb_play_order_get_player ()</title>
236
239
<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>
237
240
<para>
238
241
Only for use by <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> subclasses.</para>
246
249
</simpara></listitem></varlistentry>
247
250
</variablelist></refsect2>
248
251
<refsect2>
249
 
<title><anchor id="rb-play-order-get-source"/>rb_play_order_get_source ()</title>
 
252
<title><anchor id="rb-play-order-get-source" role="function"/>rb_play_order_get_source ()</title>
250
253
<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>
251
254
<para>
252
255
Only for use by <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> subclasses.</para>
260
263
</simpara></listitem></varlistentry>
261
264
</variablelist></refsect2>
262
265
<refsect2>
263
 
<title><anchor id="rb-play-order-get-db"/>rb_play_order_get_db ()</title>
 
266
<title><anchor id="rb-play-order-get-db" role="function"/>rb_play_order_get_db ()</title>
264
267
<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>
265
268
<para>
266
269
Only for use by <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> subclasses.</para>
274
277
</simpara></listitem></varlistentry>
275
278
</variablelist></refsect2>
276
279
<refsect2>
277
 
<title><anchor id="rb-play-order-get-playing-entry"/>rb_play_order_get_playing_entry ()</title>
 
280
<title><anchor id="rb-play-order-get-playing-entry" role="function"/>rb_play_order_get_playing_entry ()</title>
278
281
<indexterm><primary>rb_play_order_get_playing_entry</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_play_order_get_playing_entry
279
282
                                            (<link linkend="RBPlayOrder">RBPlayOrder</link> *porder);</programlisting>
280
283
<para>
289
292
</simpara></listitem></varlistentry>
290
293
</variablelist></refsect2>
291
294
<refsect2>
292
 
<title><anchor id="rb-play-order-player-is-playing"/>rb_play_order_player_is_playing ()</title>
 
295
<title><anchor id="rb-play-order-player-is-playing" role="function"/>rb_play_order_player_is_playing ()</title>
293
296
<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>
294
297
<para>
295
298
</para>
303
306
</simpara></listitem></varlistentry>
304
307
</variablelist></refsect2>
305
308
<refsect2>
306
 
<title><anchor id="rb-play-order-ref-entry-swapped"/>rb_play_order_ref_entry_swapped ()</title>
 
309
<title><anchor id="rb-play-order-ref-entry-swapped" role="function"/>rb_play_order_ref_entry_swapped ()</title>
307
310
<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,
308
311
                                             <link linkend="RhythmDB">RhythmDB</link> *db);</programlisting>
309
312
<para>
320
323
</simpara></listitem></varlistentry>
321
324
</variablelist></refsect2>
322
325
<refsect2>
323
 
<title><anchor id="rb-play-order-unref-entry-swapped"/>rb_play_order_unref_entry_swapped ()</title>
 
326
<title><anchor id="rb-play-order-unref-entry-swapped" role="function"/>rb_play_order_unref_entry_swapped ()</title>
324
327
<indexterm><primary>rb_play_order_unref_entry_swapped</primary></indexterm><programlisting><link linkend="void">void</link>        rb_play_order_unref_entry_swapped
325
328
                                            (<link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
326
329
                                             <link linkend="RhythmDB">RhythmDB</link> *db);</programlisting>