/usr/share/gtk-doc/html/rhythmbox/RBHeader.html is in rhythmbox-doc 2.96-0ubuntu4.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RBHeader</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch07.html" title="Widgets">
<link rel="prev" href="RBEntryView.html" title="RBEntryView">
<link rel="next" href="RBLibraryBrowser.html" title="RBLibraryBrowser">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="RBEntryView.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch07.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
<td><a accesskey="n" href="RBLibraryBrowser.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#RBHeader.synopsis" class="shortcut">Top</a>
|
<a href="#RBHeader.description" class="shortcut">Description</a>
|
<a href="#RBHeader.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#RBHeader.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#RBHeader.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="RBHeader"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBHeader.top_of_page"></a>RBHeader</span></h2>
<p>RBHeader — playback area widgetry</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="RBHeader.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="RBHeader.html#RBHeader-struct" title="struct RBHeader">RBHeader</a>;
struct <a class="link" href="RBHeader.html#RBHeaderClass" title="struct RBHeaderClass">RBHeaderClass</a>;
<a class="link" href="RBHeader.html" title="RBHeader"><span class="returnvalue">RBHeader</span></a> * <a class="link" href="RBHeader.html#rb-header-new" title="rb_header_new ()">rb_header_new</a> (<em class="parameter"><code><a class="link" href="RBShellPlayer.html" title="RBShellPlayer"><span class="type">RBShellPlayer</span></a> *shell_player</code></em>,
<em class="parameter"><code><a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> *db</code></em>);
<span class="returnvalue">void</span> <a class="link" href="RBHeader.html#rb-header-set-show-position-slider" title="rb_header_set_show_position_slider ()">rb_header_set_show_position_slider</a> (<em class="parameter"><code><a class="link" href="RBHeader.html" title="RBHeader"><span class="type">RBHeader</span></a> *header</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show</code></em>);
<span class="returnvalue">void</span> <a class="link" href="RBHeader.html#rb-header-sync" title="rb_header_sync ()">rb_header_sync</a> (<em class="parameter"><code><a class="link" href="RBHeader.html" title="RBHeader"><span class="type">RBHeader</span></a> *header</code></em>);
<span class="returnvalue">void</span> <a class="link" href="RBHeader.html#rb-header-sync-time" title="rb_header_sync_time ()">rb_header_sync_time</a> (<em class="parameter"><code><a class="link" href="RBHeader.html" title="RBHeader"><span class="type">RBHeader</span></a> *header</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="RBHeader.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html">GtkWidget</a>
+----<a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html">GtkContainer</a>
+----<a href="/usr/share/gtk-doc/html/gtk3/GtkBox.html">GtkBox</a>
+----<a href="/usr/share/gtk-doc/html/gtk3/GtkHBox.html">GtkHBox</a>
+----RBHeader
</pre>
</div>
<div class="refsect1">
<a name="RBHeader.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
RBHeader implements
AtkImplementorIface, <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html">GtkBuildable</a> and <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="RBHeader.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="RBHeader.html#RBHeader--db" title='The "db" property'>db</a>" <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a>* : Read / Write
"<a class="link" href="RBHeader.html#RBHeader--seekable" title='The "seekable" property'>seekable</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a class="link" href="RBHeader.html#RBHeader--shell-player" title='The "shell-player" property'>shell-player</a>" <a class="link" href="RBShellPlayer.html" title="RBShellPlayer"><span class="type">RBShellPlayer</span></a>* : Read / Write / Construct Only
"<a class="link" href="RBHeader.html#RBHeader--show-position-slider" title='The "show-position-slider" property'>show-position-slider</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a class="link" href="RBHeader.html#RBHeader--show-remaining" title='The "show-remaining" property'>show-remaining</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a class="link" href="RBHeader.html#RBHeader--slider-dragging" title='The "slider-dragging" property'>slider-dragging</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
</pre>
</div>
<div class="refsect1">
<a name="RBHeader.description"></a><h2>Description</h2>
<p>
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.
</p>
<p>
For shoutcast-style streams, the title/artist/album display is supplemented
by metadata extracted from the stream. See <a class="link" href="RBStreamingSource.html" title="RBStreamingSource"><span class="type">RBStreamingSource</span></a> for more information
on how the metadata is reported.
</p>
</div>
<div class="refsect1">
<a name="RBHeader.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="RBHeader-struct"></a><h3>struct RBHeader</h3>
<pre class="programlisting">struct RBHeader;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RBHeaderClass"></a><h3>struct RBHeaderClass</h3>
<pre class="programlisting">struct RBHeaderClass {
GtkHBoxClass parent;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="rb-header-new"></a><h3>rb_header_new ()</h3>
<pre class="programlisting"><a class="link" href="RBHeader.html" title="RBHeader"><span class="returnvalue">RBHeader</span></a> * rb_header_new (<em class="parameter"><code><a class="link" href="RBShellPlayer.html" title="RBShellPlayer"><span class="type">RBShellPlayer</span></a> *shell_player</code></em>,
<em class="parameter"><code><a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> *db</code></em>);</pre>
<p>
Creates a new header widget.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_player</code></em> :</span></p></td>
<td>the <a class="link" href="RBShellPlayer.html" title="RBShellPlayer"><span class="type">RBShellPlayer</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>db</code></em> :</span></p></td>
<td>the <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the header widget</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-header-set-show-position-slider"></a><h3>rb_header_set_show_position_slider ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_header_set_show_position_slider (<em class="parameter"><code><a class="link" href="RBHeader.html" title="RBHeader"><span class="type">RBHeader</span></a> *header</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="rb-header-sync"></a><h3>rb_header_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_header_sync (<em class="parameter"><code><a class="link" href="RBHeader.html" title="RBHeader"><span class="type">RBHeader</span></a> *header</code></em>);</pre>
<p>
Updates the header widget to be consistent with the current playing entry
including all streaming metadata.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
<td>the <a class="link" href="RBHeader.html" title="RBHeader"><span class="type">RBHeader</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-header-sync-time"></a><h3>rb_header_sync_time ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_header_sync_time (<em class="parameter"><code><a class="link" href="RBHeader.html" title="RBHeader"><span class="type">RBHeader</span></a> *header</code></em>);</pre>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
<td>the <a class="link" href="RBHeader.html" title="RBHeader"><span class="type">RBHeader</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="RBHeader.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="RBHeader--db"></a><h3>The <code class="literal">"db"</code> property</h3>
<pre class="programlisting"> "db" <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a>* : Read / Write</pre>
<p>
<a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> instance
</p>
</div>
<hr>
<div class="refsect2">
<a name="RBHeader--seekable"></a><h3>The <code class="literal">"seekable"</code> property</h3>
<pre class="programlisting"> "seekable" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>
If TRUE, the header should allow seeking by dragging the playback position slider
</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="RBHeader--shell-player"></a><h3>The <code class="literal">"shell-player"</code> property</h3>
<pre class="programlisting"> "shell-player" <a class="link" href="RBShellPlayer.html" title="RBShellPlayer"><span class="type">RBShellPlayer</span></a>* : Read / Write / Construct Only</pre>
<p>
The <a class="link" href="RBShellPlayer.html" title="RBShellPlayer"><span class="type">RBShellPlayer</span></a> instance
</p>
</div>
<hr>
<div class="refsect2">
<a name="RBHeader--show-position-slider"></a><h3>The <code class="literal">"show-position-slider"</code> property</h3>
<pre class="programlisting"> "show-position-slider" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>
Whether to show the playback position slider.
</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="RBHeader--show-remaining"></a><h3>The <code class="literal">"show-remaining"</code> property</h3>
<pre class="programlisting"> "show-remaining" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>
Whether to show remaining time (as opposed to elapsed time) in the numeric
time display.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="RBHeader--slider-dragging"></a><h3>The <code class="literal">"slider-dragging"</code> property</h3>
<pre class="programlisting"> "slider-dragging" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
<p>
Whether the song position slider is currently being dragged.
</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|