← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/rhythmbox/oneiric

« back to all changes in this revision

Viewing changes to doc/reference/html/RBRating.html

  • Committer: Bazaar Package Importer
  • Author(s): Rico Tzschichholz
  • Date: 2011-07-29 16:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 191.
  • Revision ID: james.westby@ubuntu.com-20110729164138-wwicy8nqalm18ck7
Tags: upstream-2.90.1~20110802
Import upstream version 2.90.1~20110802

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/RBRating.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>RBRating</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
 
8
<link rel="up" href="ch07.html" title="Widgets">
 
9
<link rel="prev" href="rhythmbox-rb-rating-helper.html" title="rb-rating-helper">
 
10
<link rel="next" href="RBSearchEntry.html" title="RBSearchEntry">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="rhythmbox-rb-rating-helper.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch07.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
 
21
<td><a accesskey="n" href="RBSearchEntry.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#RBRating.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#RBRating.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#RBRating.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#RBRating.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#RBRating.properties" class="shortcut">Properties</a>
 
33
                   | 
 
34
                  <a href="#RBRating.signals" class="shortcut">Signals</a>
 
35
</td></tr>
 
36
</table>
 
37
<div class="refentry">
 
38
<a name="RBRating"></a><div class="titlepage"></div>
 
39
<div class="refnamediv"><table width="100%"><tr>
 
40
<td valign="top">
 
41
<h2><span class="refentrytitle"><a name="RBRating.top_of_page"></a>RBRating</span></h2>
 
42
<p>RBRating — widget for displaying song ratings</p>
 
43
</td>
 
44
<td valign="top" align="right"></td>
 
45
</tr></table></div>
 
46
<div class="refsynopsisdiv">
 
47
<a name="RBRating.synopsis"></a><h2>Synopsis</h2>
 
48
<pre class="synopsis">struct              <a class="link" href="RBRating.html#RBRating-struct" title="struct RBRating">RBRating</a>;
 
49
struct              <a class="link" href="RBRating.html#RBRatingClass" title="struct RBRatingClass">RBRatingClass</a>;
 
50
<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>);
 
51
</pre>
 
52
</div>
 
53
<div class="refsect1">
 
54
<a name="RBRating.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
55
<pre class="synopsis">
 
56
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
57
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
58
         +----<a href="http://library.gnome.org/devel/gtk/GtkWidget.html">GtkWidget</a>
 
59
               +----RBRating
 
60
</pre>
 
61
</div>
 
62
<div class="refsect1">
 
63
<a name="RBRating.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
64
<p>
 
65
RBRating implements
 
66
 AtkImplementorIface and  <a href="http://library.gnome.org/devel/gtk/GtkBuildable.html">GtkBuildable</a>.</p>
 
67
</div>
 
68
<div class="refsect1">
 
69
<a name="RBRating.properties"></a><h2>Properties</h2>
 
70
<pre class="synopsis">
 
71
  "<a class="link" href="RBRating.html#RBRating--rating" title='The "rating" property'>rating</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
 
72
</pre>
 
73
</div>
 
74
<div class="refsect1">
 
75
<a name="RBRating.signals"></a><h2>Signals</h2>
 
76
<pre class="synopsis">
 
77
  "<a class="link" href="RBRating.html#RBRating-adjust-rating" title='The "adjust-rating" signal'>adjust-rating</a>"                                  : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
 
78
  "<a class="link" href="RBRating.html#RBRating-rated" title='The "rated" signal'>rated</a>"                                          : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
79
  "<a class="link" href="RBRating.html#RBRating-set-rating" title='The "set-rating" signal'>set-rating</a>"                                     : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
 
80
</pre>
 
81
</div>
 
82
<div class="refsect1">
 
83
<a name="RBRating.description"></a><h2>Description</h2>
 
84
<p>
 
85
This widget displays a rating (0-5 stars) and allows the user to
 
86
alter the rating by clicking.
 
87
</p>
 
88
</div>
 
89
<div class="refsect1">
 
90
<a name="RBRating.details"></a><h2>Details</h2>
 
91
<div class="refsect2">
 
92
<a name="RBRating-struct"></a><h3>struct RBRating</h3>
 
93
<pre class="programlisting">struct RBRating;</pre>
 
94
<p>
 
95
</p>
 
96
</div>
 
97
<hr>
 
98
<div class="refsect2">
 
99
<a name="RBRatingClass"></a><h3>struct RBRatingClass</h3>
 
100
<pre class="programlisting">struct RBRatingClass {
 
101
        GtkWidgetClass parent;
 
102
 
 
103
        void (*rated) (RBRating *rating, double score);
 
104
        gboolean (*set_rating) (RBRating *rating, double score);
 
105
        gboolean (*adjust_rating) (RBRating *rating, double adjust);
 
106
};
 
107
</pre>
 
108
<p>
 
109
</p>
 
110
</div>
 
111
<hr>
 
112
<div class="refsect2">
 
113
<a name="rb-rating-new"></a><h3>rb_rating_new ()</h3>
 
114
<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>
 
115
<p>
 
116
Creates a new rating widget
 
117
</p>
 
118
<div class="variablelist"><table border="0">
 
119
<col align="left" valign="top">
 
120
<tbody><tr>
 
121
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
122
<td>a new <a class="link" href="RBRating.html" title="RBRating"><span class="type">RBRating</span></a> widget.</td>
 
123
</tr></tbody>
 
124
</table></div>
 
125
</div>
 
126
</div>
 
127
<div class="refsect1">
 
128
<a name="RBRating.property-details"></a><h2>Property Details</h2>
 
129
<div class="refsect2">
 
130
<a name="RBRating--rating"></a><h3>The <code class="literal">"rating"</code> property</h3>
 
131
<pre class="programlisting">  "rating"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 
132
<p>
 
133
The rating displayed in the widget, as a floating point value
 
134
between 0.0 and 5.0.
 
135
</p>
 
136
<p>Allowed values: [0,5]</p>
 
137
<p>Default value: 2.5</p>
 
138
</div>
 
139
</div>
 
140
<div class="refsect1">
 
141
<a name="RBRating.signal-details"></a><h2>Signal Details</h2>
 
142
<div class="refsect2">
 
143
<a name="RBRating-adjust-rating"></a><h3>The <code class="literal">"adjust-rating"</code> signal</h3>
 
144
<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,
 
145
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>   adjust,
 
146
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>  user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
 
147
<p>
 
148
Action signal used to make a relative adjustment to the
 
149
rating.
 
150
</p>
 
151
<div class="variablelist"><table border="0">
 
152
<col align="left" valign="top">
 
153
<tbody>
 
154
<tr>
 
155
<td><p><span class="term"><em class="parameter"><code>rating</code></em> :</span></p></td>
 
156
<td>the <a class="link" href="RBRating.html" title="RBRating"><span class="type">RBRating</span></a>
 
157
</td>
 
158
</tr>
 
159
<tr>
 
160
<td><p><span class="term"><em class="parameter"><code>adjust</code></em> :</span></p></td>
 
161
<td>value to add to the rating</td>
 
162
</tr>
 
163
<tr>
 
164
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
165
<td>user data set when the signal handler was connected.</td>
 
166
</tr>
 
167
</tbody>
 
168
</table></div>
 
169
</div>
 
170
<hr>
 
171
<div class="refsect2">
 
172
<a name="RBRating-rated"></a><h3>The <code class="literal">"rated"</code> signal</h3>
 
173
<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,
 
174
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>   score,
 
175
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>  user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
176
<p>
 
177
Emitted when the user changes the rating.
 
178
</p>
 
179
<div class="variablelist"><table border="0">
 
180
<col align="left" valign="top">
 
181
<tbody>
 
182
<tr>
 
183
<td><p><span class="term"><em class="parameter"><code>rating</code></em> :</span></p></td>
 
184
<td>the <a class="link" href="RBRating.html" title="RBRating"><span class="type">RBRating</span></a>
 
185
</td>
 
186
</tr>
 
187
<tr>
 
188
<td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
 
189
<td>the new rating</td>
 
190
</tr>
 
191
<tr>
 
192
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
193
<td>user data set when the signal handler was connected.</td>
 
194
</tr>
 
195
</tbody>
 
196
</table></div>
 
197
</div>
 
198
<hr>
 
199
<div class="refsect2">
 
200
<a name="RBRating-set-rating"></a><h3>The <code class="literal">"set-rating"</code> signal</h3>
 
201
<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,
 
202
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>   score,
 
203
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>  user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
 
204
<p>
 
205
Action signal used to change the rating.
 
206
</p>
 
207
<div class="variablelist"><table border="0">
 
208
<col align="left" valign="top">
 
209
<tbody>
 
210
<tr>
 
211
<td><p><span class="term"><em class="parameter"><code>rating</code></em> :</span></p></td>
 
212
<td>the <a class="link" href="RBRating.html" title="RBRating"><span class="type">RBRating</span></a>
 
213
</td>
 
214
</tr>
 
215
<tr>
 
216
<td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
 
217
<td>the new rating</td>
 
218
</tr>
 
219
<tr>
 
220
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
221
<td>user data set when the signal handler was connected.</td>
 
222
</tr>
 
223
</tbody>
 
224
</table></div>
 
225
</div>
 
226
</div>
 
227
</div>
 
228
<div class="footer">
 
229
<hr>
 
230
          Generated by GTK-Doc V1.17</div>
 
231
</body>
 
232
</html>
 
 
b'\\ No newline at end of file'