/usr/share/gtk-doc/html/rhythmbox/RBRating.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RBRating</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="rhythmbox-rb-rating-helper.html" title="rb-rating-helper">
<link rel="next" href="RBSearchEntry.html" title="RBSearchEntry">
<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="rhythmbox-rb-rating-helper.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="RBSearchEntry.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#RBRating.synopsis" class="shortcut">Top</a>
|
<a href="#RBRating.description" class="shortcut">Description</a>
|
<a href="#RBRating.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#RBRating.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#RBRating.properties" class="shortcut">Properties</a>
|
<a href="#RBRating.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="RBRating"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBRating.top_of_page"></a>RBRating</span></h2>
<p>RBRating — widget for displaying song ratings</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="RBRating.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="RBRating.html#RBRating-struct" title="struct RBRating">RBRating</a>;
struct <a class="link" href="RBRating.html#RBRatingClass" title="struct RBRatingClass">RBRatingClass</a>;
<a class="link" href="RBRating.html" title="RBRating"><span class="returnvalue">RBRating</span></a> * <a class="link" href="RBRating.html#rb-rating-new" title="rb_rating_new ()">rb_rating_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="RBRating.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>
+----RBRating
</pre>
</div>
<div class="refsect1">
<a name="RBRating.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
RBRating implements
AtkImplementorIface and <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="RBRating.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="RBRating.html#RBRating--rating" title='The "rating" property'>rating</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="RBRating.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="RBRating.html#RBRating-adjust-rating" title='The "adjust-rating" signal'>adjust-rating</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
"<a class="link" href="RBRating.html#RBRating-rated" title='The "rated" signal'>rated</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
"<a class="link" href="RBRating.html#RBRating-set-rating" title='The "set-rating" signal'>set-rating</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
</pre>
</div>
<div class="refsect1">
<a name="RBRating.description"></a><h2>Description</h2>
<p>
This widget displays a rating (0-5 stars) and allows the user to
alter the rating by clicking.
</p>
</div>
<div class="refsect1">
<a name="RBRating.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="RBRating-struct"></a><h3>struct RBRating</h3>
<pre class="programlisting">struct RBRating;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RBRatingClass"></a><h3>struct RBRatingClass</h3>
<pre class="programlisting">struct RBRatingClass {
GtkWidgetClass parent;
void (*rated) (RBRating *rating, double score);
gboolean (*set_rating) (RBRating *rating, double score);
gboolean (*adjust_rating) (RBRating *rating, double adjust);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="rb-rating-new"></a><h3>rb_rating_new ()</h3>
<pre class="programlisting"><a class="link" href="RBRating.html" title="RBRating"><span class="returnvalue">RBRating</span></a> * rb_rating_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new rating widget
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="RBRating.html" title="RBRating"><span class="type">RBRating</span></a> widget.</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="RBRating.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="RBRating--rating"></a><h3>The <code class="literal">"rating"</code> property</h3>
<pre class="programlisting"> "rating" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
<p>
The rating displayed in the widget, as a floating point value
between 0.0 and 5.0.
</p>
<p>Allowed values: [0,5]</p>
<p>Default value: 2.5</p>
</div>
</div>
<div class="refsect1">
<a name="RBRating.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="RBRating-adjust-rating"></a><h3>The <code class="literal">"adjust-rating"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="RBRating.html" title="RBRating"><span class="type">RBRating</span></a> *rating,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> adjust,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
<p>
Action signal used to make a relative adjustment to the
rating.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>rating</code></em> :</span></p></td>
<td>the <a class="link" href="RBRating.html" title="RBRating"><span class="type">RBRating</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>adjust</code></em> :</span></p></td>
<td>value to add to the rating</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="RBRating-rated"></a><h3>The <code class="literal">"rated"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="RBRating.html" title="RBRating"><span class="type">RBRating</span></a> *rating,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> score,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted when the user changes the rating.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>rating</code></em> :</span></p></td>
<td>the <a class="link" href="RBRating.html" title="RBRating"><span class="type">RBRating</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
<td>the new rating</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="RBRating-set-rating"></a><h3>The <code class="literal">"set-rating"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="RBRating.html" title="RBRating"><span class="type">RBRating</span></a> *rating,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> score,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
<p>
Action signal used to change the rating.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>rating</code></em> :</span></p></td>
<td>the <a class="link" href="RBRating.html" title="RBRating"><span class="type">RBRating</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
<td>the new rating</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|