← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/rhythmbox/oneiric

« back to all changes in this revision

Viewing changes to doc/reference/html/RBPlayQueueSource.html

  • Committer: Bazaar Package Importer
  • Author(s): Rico Tzschichholz
  • Date: 2011-07-29 16:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 191.
  • Revision ID: james.westby@ubuntu.com-20110729164138-wwicy8nqalm18ck7
Tags: upstream-2.90.1~20110802
Import upstream version 2.90.1~20110802

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/RBPlayQueueSource.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>RBPlayQueueSource</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
 
8
<link rel="up" href="ch06.html" title="Sources">
 
9
<link rel="prev" href="RBMediaPlayerSource.html" title="RBMediaPlayerSource">
 
10
<link rel="next" href="RBPlaylistSource.html" title="RBPlaylistSource">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="RBMediaPlayerSource.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
 
21
<td><a accesskey="n" href="RBPlaylistSource.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#RBPlayQueueSource.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#RBPlayQueueSource.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#RBPlayQueueSource.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#RBPlayQueueSource.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#RBPlayQueueSource.properties" class="shortcut">Properties</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry">
 
36
<a name="RBPlayQueueSource"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="RBPlayQueueSource.top_of_page"></a>RBPlayQueueSource</span></h2>
 
40
<p>RBPlayQueueSource — source object for the play queue</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv">
 
45
<a name="RBPlayQueueSource.synopsis"></a><h2>Synopsis</h2>
 
46
<pre class="synopsis">struct              <a class="link" href="RBPlayQueueSource.html#RBPlayQueueSource-struct" title="struct RBPlayQueueSource">RBPlayQueueSource</a>;
 
47
struct              <a class="link" href="RBPlayQueueSource.html#RBPlayQueueSourceClass" title="struct RBPlayQueueSourceClass">RBPlayQueueSourceClass</a>;
 
48
<a class="link" href="RBSource.html" title="RBSource"><span class="returnvalue">RBSource</span></a> *            <a class="link" href="RBPlayQueueSource.html#rb-play-queue-source-new" title="rb_play_queue_source_new ()">rb_play_queue_source_new</a>            (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>);
 
49
<span class="returnvalue">void</span>                <a class="link" href="RBPlayQueueSource.html#rb-play-queue-source-sidebar-song-info" title="rb_play_queue_source_sidebar_song_info ()">rb_play_queue_source_sidebar_song_info</a>
 
50
                                                        (<em class="parameter"><code><a class="link" href="RBPlayQueueSource.html" title="RBPlayQueueSource"><span class="type">RBPlayQueueSource</span></a> *source</code></em>);
 
51
<span class="returnvalue">void</span>                <a class="link" href="RBPlayQueueSource.html#rb-play-queue-source-sidebar-delete" title="rb_play_queue_source_sidebar_delete ()">rb_play_queue_source_sidebar_delete</a> (<em class="parameter"><code><a class="link" href="RBPlayQueueSource.html" title="RBPlayQueueSource"><span class="type">RBPlayQueueSource</span></a> *source</code></em>);
 
52
<span class="returnvalue">void</span>                <a class="link" href="RBPlayQueueSource.html#rb-play-queue-source-clear-queue" title="rb_play_queue_source_clear_queue ()">rb_play_queue_source_clear_queue</a>    (<em class="parameter"><code><a class="link" href="RBPlayQueueSource.html" title="RBPlayQueueSource"><span class="type">RBPlayQueueSource</span></a> *source</code></em>);
 
53
</pre>
 
54
</div>
 
55
<div class="refsect1">
 
56
<a name="RBPlayQueueSource.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
57
<pre class="synopsis">
 
58
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
59
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
60
         +----<a href="http://library.gnome.org/devel/gtk/GtkWidget.html">GtkWidget</a>
 
61
               +----<a href="http://library.gnome.org/devel/gtk/GtkContainer.html">GtkContainer</a>
 
62
                     +----<a href="http://library.gnome.org/devel/gtk/GtkBox.html">GtkBox</a>
 
63
                           +----<a href="http://library.gnome.org/devel/gtk/GtkHBox.html">GtkHBox</a>
 
64
                                 +----RBDisplayPage
 
65
                                       +----<a class="link" href="RBSource.html" title="RBSource">RBSource</a>
 
66
                                             +----<a class="link" href="RBPlaylistSource.html" title="RBPlaylistSource">RBPlaylistSource</a>
 
67
                                                   +----<a class="link" href="RBStaticPlaylistSource.html" title="RBStaticPlaylistSource">RBStaticPlaylistSource</a>
 
68
                                                         +----RBPlayQueueSource
 
69
</pre>
 
70
</div>
 
71
<div class="refsect1">
 
72
<a name="RBPlayQueueSource.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
73
<p>
 
74
RBPlayQueueSource implements
 
75
 AtkImplementorIface,  <a href="http://library.gnome.org/devel/gtk/GtkBuildable.html">GtkBuildable</a> and  <a href="http://library.gnome.org/devel/gtk/gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
 
76
</div>
 
77
<div class="refsect1">
 
78
<a name="RBPlayQueueSource.properties"></a><h2>Properties</h2>
 
79
<pre class="synopsis">
 
80
  "<a class="link" href="RBPlayQueueSource.html#RBPlayQueueSource--sidebar" title='The "sidebar" property'>sidebar</a>"                  <a class="link" href="RBEntryView.html" title="RBEntryView"><span class="type">RBEntryView</span></a>*          : Read
 
81
</pre>
 
82
</div>
 
83
<div class="refsect1">
 
84
<a name="RBPlayQueueSource.description"></a><h2>Description</h2>
 
85
<p>
 
86
The main interesting thing about this source is that is
 
87
contains a second <a class="link" href="RBEntryView.html" title="RBEntryView"><span class="type">RBEntryView</span></a> to be displayed in the side
 
88
pane (beneath the source list).  This entry view displays
 
89
the track title, artist, and album in a single column,
 
90
split across three lines so the information mostly fits in
 
91
the usual horizontal space allowed for the side bar.
 
92
</p>
 
93
</div>
 
94
<div class="refsect1">
 
95
<a name="RBPlayQueueSource.details"></a><h2>Details</h2>
 
96
<div class="refsect2">
 
97
<a name="RBPlayQueueSource-struct"></a><h3>struct RBPlayQueueSource</h3>
 
98
<pre class="programlisting">struct RBPlayQueueSource;</pre>
 
99
<p>
 
100
</p>
 
101
</div>
 
102
<hr>
 
103
<div class="refsect2">
 
104
<a name="RBPlayQueueSourceClass"></a><h3>struct RBPlayQueueSourceClass</h3>
 
105
<pre class="programlisting">struct RBPlayQueueSourceClass {
 
106
        RBStaticPlaylistSourceClass parent;
 
107
};
 
108
</pre>
 
109
<p>
 
110
</p>
 
111
</div>
 
112
<hr>
 
113
<div class="refsect2">
 
114
<a name="rb-play-queue-source-new"></a><h3>rb_play_queue_source_new ()</h3>
 
115
<pre class="programlisting"><a class="link" href="RBSource.html" title="RBSource"><span class="returnvalue">RBSource</span></a> *                rb_play_queue_source_new            (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>);</pre>
 
116
<p>
 
117
Creates the play queue source object.
 
118
</p>
 
119
<div class="variablelist"><table border="0">
 
120
<col align="left" valign="top">
 
121
<tbody>
 
122
<tr>
 
123
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
 
124
<td>the <a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> instance</td>
 
125
</tr>
 
126
<tr>
 
127
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
128
<td>the play queue source</td>
 
129
</tr>
 
130
</tbody>
 
131
</table></div>
 
132
</div>
 
133
<hr>
 
134
<div class="refsect2">
 
135
<a name="rb-play-queue-source-sidebar-song-info"></a><h3>rb_play_queue_source_sidebar_song_info ()</h3>
 
136
<pre class="programlisting"><span class="returnvalue">void</span>                rb_play_queue_source_sidebar_song_info
 
137
                                                        (<em class="parameter"><code><a class="link" href="RBPlayQueueSource.html" title="RBPlayQueueSource"><span class="type">RBPlayQueueSource</span></a> *source</code></em>);</pre>
 
138
<p>
 
139
Creates and displays a <a class="link" href="RBSongInfo.html" title="RBSongInfo"><span class="type">RBSongInfo</span></a> for the currently selected
 
140
entry in the side pane play queue view
 
141
</p>
 
142
<div class="variablelist"><table border="0">
 
143
<col align="left" valign="top">
 
144
<tbody><tr>
 
145
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
146
<td>the <a class="link" href="RBPlayQueueSource.html" title="RBPlayQueueSource"><span class="type">RBPlayQueueSource</span></a>
 
147
</td>
 
148
</tr></tbody>
 
149
</table></div>
 
150
</div>
 
151
<hr>
 
152
<div class="refsect2">
 
153
<a name="rb-play-queue-source-sidebar-delete"></a><h3>rb_play_queue_source_sidebar_delete ()</h3>
 
154
<pre class="programlisting"><span class="returnvalue">void</span>                rb_play_queue_source_sidebar_delete (<em class="parameter"><code><a class="link" href="RBPlayQueueSource.html" title="RBPlayQueueSource"><span class="type">RBPlayQueueSource</span></a> *source</code></em>);</pre>
 
155
<p>
 
156
Deletes the selected entries from the play queue side pane.
 
157
This is called by the <a class="link" href="RBShellClipboard.html" title="RBShellClipboard"><span class="type">RBShellClipboard</span></a>.
 
158
</p>
 
159
<div class="variablelist"><table border="0">
 
160
<col align="left" valign="top">
 
161
<tbody><tr>
 
162
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
163
<td>the <a class="link" href="RBPlayQueueSource.html" title="RBPlayQueueSource"><span class="type">RBPlayQueueSource</span></a>
 
164
</td>
 
165
</tr></tbody>
 
166
</table></div>
 
167
</div>
 
168
<hr>
 
169
<div class="refsect2">
 
170
<a name="rb-play-queue-source-clear-queue"></a><h3>rb_play_queue_source_clear_queue ()</h3>
 
171
<pre class="programlisting"><span class="returnvalue">void</span>                rb_play_queue_source_clear_queue    (<em class="parameter"><code><a class="link" href="RBPlayQueueSource.html" title="RBPlayQueueSource"><span class="type">RBPlayQueueSource</span></a> *source</code></em>);</pre>
 
172
<p>
 
173
Clears the play queue.
 
174
</p>
 
175
<div class="variablelist"><table border="0">
 
176
<col align="left" valign="top">
 
177
<tbody><tr>
 
178
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
179
<td>the <a class="link" href="RBPlayQueueSource.html" title="RBPlayQueueSource"><span class="type">RBPlayQueueSource</span></a>
 
180
</td>
 
181
</tr></tbody>
 
182
</table></div>
 
183
</div>
 
184
</div>
 
185
<div class="refsect1">
 
186
<a name="RBPlayQueueSource.property-details"></a><h2>Property Details</h2>
 
187
<div class="refsect2">
 
188
<a name="RBPlayQueueSource--sidebar"></a><h3>The <code class="literal">"sidebar"</code> property</h3>
 
189
<pre class="programlisting">  "sidebar"                  <a class="link" href="RBEntryView.html" title="RBEntryView"><span class="type">RBEntryView</span></a>*          : Read</pre>
 
190
<p>
 
191
The <a class="link" href="RBEntryView.html" title="RBEntryView"><span class="type">RBEntryView</span></a> for the play queue side pane.
 
192
</p>
 
193
</div>
 
194
</div>
 
195
</div>
 
196
<div class="footer">
 
197
<hr>
 
198
          Generated by GTK-Doc V1.17</div>
 
199
</body>
 
200
</html>
 
 
b'\\ No newline at end of file'