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
|
<?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="RBPlayQueueSource">
<refmeta>
<refentrytitle role="top_of_page" id="RBPlayQueueSource.top_of_page">RBPlayQueueSource</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>RBPlayQueueSource</refname>
<refpurpose>source object for the play queue</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="RBPlayQueueSource.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="RBPlayQueueSource-struct">RBPlayQueueSource</link>;
<link linkend="RBPlayQueueSourceClass">RBPlayQueueSourceClass</link>;
<link linkend="RBSource">RBSource</link>* <link linkend="rb-play-queue-source-new">rb_play_queue_source_new</link> (<link linkend="RBShell">RBShell</link> *shell);
<link linkend="void">void</link> <link linkend="rb-play-queue-source-sidebar-song-info">rb_play_queue_source_sidebar_song_info</link>
(<link linkend="RBPlayQueueSource">RBPlayQueueSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-play-queue-source-sidebar-delete">rb_play_queue_source_sidebar_delete</link> (<link linkend="RBPlayQueueSource">RBPlayQueueSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-play-queue-source-clear-queue">rb_play_queue_source_clear_queue</link> (<link linkend="RBPlayQueueSource">RBPlayQueueSource</link> *source);
</synopsis>
</refsynopsisdiv>
<refsect1 id="RBPlayQueueSource.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="GtkBox">GtkBox</link>
+----<link linkend="GtkHBox">GtkHBox</link>
+----<link linkend="RBSource">RBSource</link>
+----<link linkend="RBPlaylistSource">RBPlaylistSource</link>
+----<link linkend="RBStaticPlaylistSource">RBStaticPlaylistSource</link>
+----RBPlayQueueSource
</synopsis>
</refsect1>
<refsect1 id="RBPlayQueueSource.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
RBPlayQueueSource implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="RBPlayQueueSource.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="RBPlayQueueSource--sidebar">sidebar</link>" <link linkend="RBEntryView">RBEntryView</link>* : Read
</synopsis>
</refsect1>
<refsect1 id="RBPlayQueueSource.description" role="desc">
<title role="desc.title">Description</title>
<para>
The main interesting thing about this source is that is
contains a second <link linkend="RBEntryView"><type>RBEntryView</type></link> to be displayed in the side
pane (beneath the source list). This entry view displays
the track title, artist, and album in a single column,
split across three lines so the information mostly fits in
the usual horizontal space allowed for the side bar.</para>
<para>
</para>
</refsect1>
<refsect1 id="RBPlayQueueSource.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBPlayQueueSource-struct" role="struct">
<title>RBPlayQueueSource</title>
<indexterm zone="RBPlayQueueSource-struct"><primary>RBPlayQueueSource</primary></indexterm><programlisting>typedef struct _RBPlayQueueSource RBPlayQueueSource;</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBPlayQueueSourceClass" role="struct">
<title>RBPlayQueueSourceClass</title>
<indexterm zone="RBPlayQueueSourceClass"><primary>RBPlayQueueSourceClass</primary></indexterm><programlisting>typedef struct {
RBStaticPlaylistSourceClass parent;
} RBPlayQueueSourceClass;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-play-queue-source-new" role="function">
<title>rb_play_queue_source_new ()</title>
<indexterm zone="rb-play-queue-source-new"><primary>rb_play_queue_source_new</primary></indexterm><programlisting><link linkend="RBSource">RBSource</link>* rb_play_queue_source_new (<link linkend="RBShell">RBShell</link> *shell);</programlisting>
<para>
Creates the play queue source object.</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 play queue source
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-play-queue-source-sidebar-song-info" role="function">
<title>rb_play_queue_source_sidebar_song_info ()</title>
<indexterm zone="rb-play-queue-source-sidebar-song-info"><primary>rb_play_queue_source_sidebar_song_info</primary></indexterm><programlisting><link linkend="void">void</link> rb_play_queue_source_sidebar_song_info
(<link linkend="RBPlayQueueSource">RBPlayQueueSource</link> *source);</programlisting>
<para>
Creates and displays a <link linkend="RBSongInfo"><type>RBSongInfo</type></link> for the currently selected
entry in the side pane play queue view</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the <link linkend="RBPlayQueueSource"><type>RBPlayQueueSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-play-queue-source-sidebar-delete" role="function">
<title>rb_play_queue_source_sidebar_delete ()</title>
<indexterm zone="rb-play-queue-source-sidebar-delete"><primary>rb_play_queue_source_sidebar_delete</primary></indexterm><programlisting><link linkend="void">void</link> rb_play_queue_source_sidebar_delete (<link linkend="RBPlayQueueSource">RBPlayQueueSource</link> *source);</programlisting>
<para>
Deletes the selected entries from the play queue side pane.
This is called by the <link linkend="RBShellClipboard"><type>RBShellClipboard</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the <link linkend="RBPlayQueueSource"><type>RBPlayQueueSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-play-queue-source-clear-queue" role="function">
<title>rb_play_queue_source_clear_queue ()</title>
<indexterm zone="rb-play-queue-source-clear-queue"><primary>rb_play_queue_source_clear_queue</primary></indexterm><programlisting><link linkend="void">void</link> rb_play_queue_source_clear_queue (<link linkend="RBPlayQueueSource">RBPlayQueueSource</link> *source);</programlisting>
<para>
Clears the play queue.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the <link linkend="RBPlayQueueSource"><type>RBPlayQueueSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="RBPlayQueueSource.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="RBPlayQueueSource--sidebar"><title>The <literal>"sidebar"</literal> property</title>
<indexterm zone="RBPlayQueueSource--sidebar"><primary>RBPlayQueueSource:sidebar</primary></indexterm><programlisting> "sidebar" <link linkend="RBEntryView">RBEntryView</link>* : Read</programlisting>
<para>
The <link linkend="RBEntryView"><type>RBEntryView</type></link> for the play queue side pane.</para>
<para>
</para></refsect2>
</refsect1>
</refentry>
|
