/usr/share/gtk-doc/html/rhythmbox/rhythmbox-rb-rating-helper.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>rb-rating-helper</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="RBQueryCreator.html" title="RBQueryCreator">
<link rel="next" href="RBRating.html" title="RBRating">
<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="RBQueryCreator.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="RBRating.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#rhythmbox-rb-rating-helper.synopsis" class="shortcut">Top</a>
|
<a href="#rhythmbox-rb-rating-helper.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="rhythmbox-rb-rating-helper"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="rhythmbox-rb-rating-helper.top_of_page"></a>rb-rating-helper</span></h2>
<p>rb-rating-helper — helper functions for displaying song ratings</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="rhythmbox-rb-rating-helper.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="rhythmbox-rb-rating-helper.html#RBRatingPixbufs" title="RBRatingPixbufs">RBRatingPixbufs</a>;
#define <a class="link" href="rhythmbox-rb-rating-helper.html#RB-RATING-MAX-SCORE:CAPS" title="RB_RATING_MAX_SCORE">RB_RATING_MAX_SCORE</a>
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="rhythmbox-rb-rating-helper.html#rb-rating-render-stars" title="rb_rating_render_stars ()">rb_rating_render_stars</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code><span class="type">cairo_t</span> *cr</code></em>,
<em class="parameter"><code><a class="link" href="rhythmbox-rb-rating-helper.html#RBRatingPixbufs" title="RBRatingPixbufs"><span class="type">RBRatingPixbufs</span></a> *pixbufs</code></em>,
<em class="parameter"><code><span class="type">int</span> x</code></em>,
<em class="parameter"><code><span class="type">int</span> y</code></em>,
<em class="parameter"><code><span class="type">int</span> x_offset</code></em>,
<em class="parameter"><code><span class="type">int</span> y_offset</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> rating</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> selected</code></em>);
<span class="returnvalue">double</span> <a class="link" href="rhythmbox-rb-rating-helper.html#rb-rating-get-rating-from-widget" title="rb_rating_get_rating_from_widget ()">rb_rating_get_rating_from_widget</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> widget_x</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> widget_width</code></em>,
<em class="parameter"><code><span class="type">double</span> current_rating</code></em>);
<a class="link" href="rhythmbox-rb-rating-helper.html#RBRatingPixbufs" title="RBRatingPixbufs"><span class="returnvalue">RBRatingPixbufs</span></a> * <a class="link" href="rhythmbox-rb-rating-helper.html#rb-rating-pixbufs-new" title="rb_rating_pixbufs_new ()">rb_rating_pixbufs_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="rhythmbox-rb-rating-helper.html#rb-rating-pixbufs-free" title="rb_rating_pixbufs_free ()">rb_rating_pixbufs_free</a> (<em class="parameter"><code><a class="link" href="rhythmbox-rb-rating-helper.html#RBRatingPixbufs" title="RBRatingPixbufs"><span class="type">RBRatingPixbufs</span></a> *pixbufs</code></em>);
<span class="returnvalue">void</span> <a class="link" href="rhythmbox-rb-rating-helper.html#rb-rating-install-rating-property" title="rb_rating_install_rating_property ()">rb_rating_install_rating_property</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> *klass</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> prop</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="rhythmbox-rb-rating-helper.description"></a><h2>Description</h2>
<p>
A few helper functions for dealing with ratings. These are shared
between <a class="link" href="RBRating.html" title="RBRating"><span class="type">RBRating</span></a> and <a class="link" href="RBCellRendererRating.html" title="RBCellRendererRating"><span class="type">RBCellRendererRating</span></a>.
</p>
</div>
<div class="refsect1">
<a name="rhythmbox-rb-rating-helper.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="RBRatingPixbufs"></a><h3>RBRatingPixbufs</h3>
<pre class="programlisting">typedef struct _RBRatingPixbufs RBRatingPixbufs;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RB-RATING-MAX-SCORE:CAPS"></a><h3>RB_RATING_MAX_SCORE</h3>
<pre class="programlisting">#define RB_RATING_MAX_SCORE 5
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="rb-rating-render-stars"></a><h3>rb_rating_render_stars ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_rating_render_stars (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code><span class="type">cairo_t</span> *cr</code></em>,
<em class="parameter"><code><a class="link" href="rhythmbox-rb-rating-helper.html#RBRatingPixbufs" title="RBRatingPixbufs"><span class="type">RBRatingPixbufs</span></a> *pixbufs</code></em>,
<em class="parameter"><code><span class="type">int</span> x</code></em>,
<em class="parameter"><code><span class="type">int</span> y</code></em>,
<em class="parameter"><code><span class="type">int</span> x_offset</code></em>,
<em class="parameter"><code><span class="type">int</span> y_offset</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> rating</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> selected</code></em>);</pre>
<p>
Renders a rating as a row of stars. floor(<em class="parameter"><code>rating</code></em>) large stars
are drawn, followed by 5-floor(<em class="parameter"><code>rating</code></em>) small stars.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> to render on behalf of</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cr</code></em> :</span></p></td>
<td>cairo context to render into</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixbufs</code></em> :</span></p></td>
<td>a <a class="link" href="rhythmbox-rb-rating-helper.html#RBRatingPixbufs" title="RBRatingPixbufs"><span class="type">RBRatingPixbufs</span></a> structure</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>source X coordinate within the rating pixbufs (usually 0)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>source Y coordinate within the rating pixbufs (usually 0)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x_offset</code></em> :</span></p></td>
<td>destination X coordinate within the window</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y_offset</code></em> :</span></p></td>
<td>destination Y coordinate within the window</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rating</code></em> :</span></p></td>
<td>the rating to display (between 0.0 and 5.0)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>selected</code></em> :</span></p></td>
<td>TRUE if the widget is currently selected for input</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the stars were drawn successfully</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-rating-get-rating-from-widget"></a><h3>rb_rating_get_rating_from_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> rb_rating_get_rating_from_widget (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> widget_x</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> widget_width</code></em>,
<em class="parameter"><code><span class="type">double</span> current_rating</code></em>);</pre>
<p>
Updates the rating for a widget after the user clicks on the
rating. If the user clicks on the Nth star, the rating is set
to N, unless the rating is already N, in which case the rating is
set to N-1. This allows the user to set the rating to 0.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
<td>the <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> displaying the rating</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget_x</code></em> :</span></p></td>
<td>x component of the position to query</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget_width</code></em> :</span></p></td>
<td>width of the widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>current_rating</code></em> :</span></p></td>
<td>the current rating displayed in the widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the updated rating</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-rating-pixbufs-new"></a><h3>rb_rating_pixbufs_new ()</h3>
<pre class="programlisting"><a class="link" href="rhythmbox-rb-rating-helper.html#RBRatingPixbufs" title="RBRatingPixbufs"><span class="returnvalue">RBRatingPixbufs</span></a> * rb_rating_pixbufs_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates and returns a structure holding a set of pixbufs
to use to display ratings.
</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 class="link" href="rhythmbox-rb-rating-helper.html#RBRatingPixbufs" title="RBRatingPixbufs"><span class="type">RBRatingPixbufs</span></a> structure, or NULL if not all of
the pixbufs could be loaded.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-rating-pixbufs-free"></a><h3>rb_rating_pixbufs_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_rating_pixbufs_free (<em class="parameter"><code><a class="link" href="rhythmbox-rb-rating-helper.html#RBRatingPixbufs" title="RBRatingPixbufs"><span class="type">RBRatingPixbufs</span></a> *pixbufs</code></em>);</pre>
<p>
Frees a set of rating pixbufs.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>pixbufs</code></em> :</span></p></td>
<td>
<a class="link" href="rhythmbox-rb-rating-helper.html#RBRatingPixbufs" title="RBRatingPixbufs"><span class="type">RBRatingPixbufs</span></a> instance</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-rating-install-rating-property"></a><h3>rb_rating_install_rating_property ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_rating_install_rating_property (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> *klass</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> prop</code></em>);</pre>
<p>
Installs a 'rating' property in the specified class.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> to add the property to</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prop</code></em> :</span></p></td>
<td>property index to use</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|