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
|
<?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="rhythmbox-rb-header">
<refmeta>
<refentrytitle role="top_of_page" id="rhythmbox-rb-header.top_of_page">rb-header</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rb-header</refname>
<refpurpose>playback area widgetry</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="rhythmbox-rb-header.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="RBHeader"/>
<synopsis>
<link linkend="RBHeader-struct">RBHeader</link>;
<link linkend="RBHeaderClass">RBHeaderClass</link>;
<link linkend="RBHeader">RBHeader</link>* <link linkend="rb-header-new">rb_header_new</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *shell_player,
<link linkend="RhythmDB">RhythmDB</link> *db);
<link linkend="void">void</link> <link linkend="rb-header-set-playing-entry">rb_header_set_playing_entry</link> (<link linkend="RBHeader">RBHeader</link> *header,
<link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
<link linkend="gboolean">gboolean</link> seekable);
<link linkend="void">void</link> <link linkend="rb-header-sync">rb_header_sync</link> (<link linkend="RBHeader">RBHeader</link> *header);
<link linkend="void">void</link> <link linkend="rb-header-sync-time">rb_header_sync_time</link> (<link linkend="RBHeader">RBHeader</link> *header);
<link linkend="char">char</link>* <link linkend="rb-header-get-elapsed-string">rb_header_get_elapsed_string</link> (<link linkend="RBHeader">RBHeader</link> *header);
</synopsis>
</refsynopsisdiv>
<refsect1 id="rhythmbox-rb-header.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>
+----RBHeader
</synopsis>
</refsect1>
<refsect1 id="rhythmbox-rb-header.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
RBHeader implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="rhythmbox-rb-header.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="RBHeader--db">db</link>" <link linkend="RhythmDB">RhythmDB</link>* : Read / Write
"<link linkend="RBHeader--entry">entry</link>" <link linkend="RhythmDBEntry">RhythmDBEntry</link>* : Read / Write
"<link linkend="RBHeader--seekable">seekable</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="RBHeader--shell-player">shell-player</link>" <link linkend="RBShellPlayer">RBShellPlayer</link>* : Read / Write / Construct Only
"<link linkend="RBHeader--slider-dragging">slider-dragging</link>" <link linkend="gboolean">gboolean</link> : Read
</synopsis>
</refsect1>
<refsect1 id="rhythmbox-rb-header.description" role="desc">
<title role="desc.title">Description</title>
<para>
The RBHeader widget displays information about the current playing track
(title, album, artist), the elapsed or remaining playback time, and a
position slider indicating the playback position. It translates slider
move and drag events into seek requests for the player backend.
</para>
<para>
For shoutcast-style streams, the title/artist/album display is supplemented
by metadata extracted from the stream. See <link linkend="RBStreamingSource"><type>RBStreamingSource</type></link> for more information
on how the metadata is reported.</para>
<para>
</para>
</refsect1>
<refsect1 id="rhythmbox-rb-header.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBHeader-struct" role="struct">
<title>RBHeader</title>
<indexterm zone="RBHeader-struct"><primary>RBHeader</primary></indexterm><programlisting>typedef struct _RBHeader RBHeader;</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBHeaderClass" role="struct">
<title>RBHeaderClass</title>
<indexterm zone="RBHeaderClass"><primary>RBHeaderClass</primary></indexterm><programlisting>typedef struct {
GtkHBoxClass parent;
} RBHeaderClass;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-header-new" role="function">
<title>rb_header_new ()</title>
<indexterm zone="rb-header-new"><primary>rb_header_new</primary></indexterm><programlisting><link linkend="RBHeader">RBHeader</link>* rb_header_new (<link linkend="RBShellPlayer">RBShellPlayer</link> *shell_player,
<link linkend="RhythmDB">RhythmDB</link> *db);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>shell_player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link> instance
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>db</parameter> :</term>
<listitem><simpara> the <link linkend="RhythmDB"><type>RhythmDB</type></link> instance
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the header widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-header-set-playing-entry" role="function">
<title>rb_header_set_playing_entry ()</title>
<indexterm zone="rb-header-set-playing-entry"><primary>rb_header_set_playing_entry</primary></indexterm><programlisting><link linkend="void">void</link> rb_header_set_playing_entry (<link linkend="RBHeader">RBHeader</link> *header,
<link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
<link linkend="gboolean">gboolean</link> seekable);</programlisting>
<para>
Sets a new playing entry to be displayed in the header.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>header</parameter> :</term>
<listitem><simpara> the <link linkend="RBHeader"><type>RBHeader</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry</parameter> :</term>
<listitem><simpara> the new playing <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>seekable</parameter> :</term>
<listitem><simpara> whether the new playing entry is seekable
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-header-sync" role="function">
<title>rb_header_sync ()</title>
<indexterm zone="rb-header-sync"><primary>rb_header_sync</primary></indexterm><programlisting><link linkend="void">void</link> rb_header_sync (<link linkend="RBHeader">RBHeader</link> *header);</programlisting>
<para>
Updates the header widget to be consistent with the current playing entry
including all streaming metadata.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>header</parameter> :</term>
<listitem><simpara> the <link linkend="RBHeader"><type>RBHeader</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-header-sync-time" role="function">
<title>rb_header_sync_time ()</title>
<indexterm zone="rb-header-sync-time"><primary>rb_header_sync_time</primary></indexterm><programlisting><link linkend="void">void</link> rb_header_sync_time (<link linkend="RBHeader">RBHeader</link> *header);</programlisting>
<para>
Updates the time display components of the header.
If the position slider is being dragged, the display is not updated.
If the duration of the playing entry is known, the position slider is
updated along with the elapsed/remaining time display. Otherwise,
the slider is made insensitive.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>header</parameter> :</term>
<listitem><simpara> the <link linkend="RBHeader"><type>RBHeader</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-header-get-elapsed-string" role="function">
<title>rb_header_get_elapsed_string ()</title>
<indexterm zone="rb-header-get-elapsed-string"><primary>rb_header_get_elapsed_string</primary></indexterm><programlisting><link linkend="char">char</link>* rb_header_get_elapsed_string (<link linkend="RBHeader">RBHeader</link> *header);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>header</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="rhythmbox-rb-header.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="RBHeader--db"><title>The <literal>"db"</literal> property</title>
<indexterm zone="RBHeader--db"><primary>RBHeader:db</primary></indexterm><programlisting> "db" <link linkend="RhythmDB">RhythmDB</link>* : Read / Write</programlisting>
<para>
<link linkend="RhythmDB"><type>RhythmDB</type></link> instance</para>
<para>
</para></refsect2>
<refsect2 id="RBHeader--entry"><title>The <literal>"entry"</literal> property</title>
<indexterm zone="RBHeader--entry"><primary>RBHeader:entry</primary></indexterm><programlisting> "entry" <link linkend="RhythmDBEntry">RhythmDBEntry</link>* : Read / Write</programlisting>
<para>
The <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> to display</para>
<para>
</para></refsect2>
<refsect2 id="RBHeader--seekable"><title>The <literal>"seekable"</literal> property</title>
<indexterm zone="RBHeader--seekable"><primary>RBHeader:seekable</primary></indexterm><programlisting> "seekable" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>
If TRUE, the header should allow seeking by dragging the playback position slider</para>
<para>
</para><para>Default value: TRUE</para>
</refsect2>
<refsect2 id="RBHeader--shell-player"><title>The <literal>"shell-player"</literal> property</title>
<indexterm zone="RBHeader--shell-player"><primary>RBHeader:shell-player</primary></indexterm><programlisting> "shell-player" <link linkend="RBShellPlayer">RBShellPlayer</link>* : Read / Write / Construct Only</programlisting>
<para>
The <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link> instance</para>
<para>
</para></refsect2>
<refsect2 id="RBHeader--slider-dragging"><title>The <literal>"slider-dragging"</literal> property</title>
<indexterm zone="RBHeader--slider-dragging"><primary>RBHeader:slider-dragging</primary></indexterm><programlisting> "slider-dragging" <link linkend="gboolean">gboolean</link> : Read</programlisting>
<para>
Whether the song position slider is currently being dragged.</para>
<para>
</para><para>Default value: FALSE</para>
</refsect2>
</refsect1>
</refentry>
|
