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
|
<?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-rating-helper">
<refmeta>
<refentrytitle role="top_of_page" id="rhythmbox-rb-rating-helper.top_of_page">rb-rating-helper</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rb-rating-helper</refname>
<refpurpose>helper functions for displaying song ratings</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="rhythmbox-rb-rating-helper.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="RBRatingPixbufs">RBRatingPixbufs</link>;
#define <link linkend="RB-RATING-MAX-SCORE:CAPS">RB_RATING_MAX_SCORE</link>
<link linkend="gboolean">gboolean</link> <link linkend="rb-rating-render-stars">rb_rating_render_stars</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="GdkWindow">GdkWindow</link> *window,
<link linkend="RBRatingPixbufs">RBRatingPixbufs</link> *pixbufs,
<link linkend="gulong">gulong</link> x,
<link linkend="gulong">gulong</link> y,
<link linkend="gulong">gulong</link> x_offset,
<link linkend="gulong">gulong</link> y_offset,
<link linkend="gdouble">gdouble</link> rating,
<link linkend="gboolean">gboolean</link> selected);
<link linkend="double">double</link> <link linkend="rb-rating-get-rating-from-widget">rb_rating_get_rating_from_widget</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="gint">gint</link> widget_x,
<link linkend="gint">gint</link> widget_width,
<link linkend="double">double</link> current_rating);
<link linkend="RBRatingPixbufs">RBRatingPixbufs</link>* <link linkend="rb-rating-pixbufs-new">rb_rating_pixbufs_new</link> (void);
<link linkend="void">void</link> <link linkend="rb-rating-pixbufs-free">rb_rating_pixbufs_free</link> (<link linkend="RBRatingPixbufs">RBRatingPixbufs</link> *pixbufs);
<link linkend="void">void</link> <link linkend="rb-rating-install-rating-property">rb_rating_install_rating_property</link> (<link linkend="GObjectClass">GObjectClass</link> *klass,
<link linkend="gulong">gulong</link> prop);
</synopsis>
</refsynopsisdiv>
<refsect1 id="rhythmbox-rb-rating-helper.description" role="desc">
<title role="desc.title">Description</title>
<para>
A few helper functions for dealing with ratings. These are shared
between <link linkend="RBRating"><type>RBRating</type></link> and <link linkend="RBCellRendererRating"><type>RBCellRendererRating</type></link>.</para>
<para>
</para>
</refsect1>
<refsect1 id="rhythmbox-rb-rating-helper.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBRatingPixbufs" role="struct">
<title>RBRatingPixbufs</title>
<indexterm zone="RBRatingPixbufs"><primary>RBRatingPixbufs</primary></indexterm><programlisting>typedef struct _RBRatingPixbufs RBRatingPixbufs;</programlisting>
<para>
</para></refsect2>
<refsect2 id="RB-RATING-MAX-SCORE:CAPS" role="macro">
<title>RB_RATING_MAX_SCORE</title>
<indexterm zone="RB-RATING-MAX-SCORE:CAPS"><primary>RB_RATING_MAX_SCORE</primary></indexterm><programlisting>#define RB_RATING_MAX_SCORE 5
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-rating-render-stars" role="function">
<title>rb_rating_render_stars ()</title>
<indexterm zone="rb-rating-render-stars"><primary>rb_rating_render_stars</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_rating_render_stars (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="GdkWindow">GdkWindow</link> *window,
<link linkend="RBRatingPixbufs">RBRatingPixbufs</link> *pixbufs,
<link linkend="gulong">gulong</link> x,
<link linkend="gulong">gulong</link> y,
<link linkend="gulong">gulong</link> x_offset,
<link linkend="gulong">gulong</link> y_offset,
<link linkend="gdouble">gdouble</link> rating,
<link linkend="gboolean">gboolean</link> selected);</programlisting>
<para>
Renders a rating as a row of stars. floor(<parameter>rating</parameter>) large stars
are drawn, followed by 5-floor(<parameter>rating</parameter>) small stars.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link> to render on behalf of
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> the <link linkend="GdkWindow"><type>GdkWindow</type></link> being rendered to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixbufs</parameter> :</term>
<listitem><simpara> a <link linkend="RBRatingPixbufs"><type>RBRatingPixbufs</type></link> structure
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> source X coordinate within the rating pixbufs (usually 0)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> source Y coordinate within the rating pixbufs (usually 0)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x_offset</parameter> :</term>
<listitem><simpara> destination X coordinate within the window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y_offset</parameter> :</term>
<listitem><simpara> destination Y coordinate within the window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rating</parameter> :</term>
<listitem><simpara> the rating to display (between 0.0 and 5.0)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>selected</parameter> :</term>
<listitem><simpara> TRUE if the widget is currently selected for input
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the stars were drawn successfully
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-rating-get-rating-from-widget" role="function">
<title>rb_rating_get_rating_from_widget ()</title>
<indexterm zone="rb-rating-get-rating-from-widget"><primary>rb_rating_get_rating_from_widget</primary></indexterm><programlisting><link linkend="double">double</link> rb_rating_get_rating_from_widget (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="gint">gint</link> widget_x,
<link linkend="gint">gint</link> widget_width,
<link linkend="double">double</link> current_rating);</programlisting>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> the <link linkend="GtkWidget"><type>GtkWidget</type></link> displaying the rating
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>widget_x</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>widget_width</parameter> :</term>
<listitem><simpara> width of the widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>current_rating</parameter> :</term>
<listitem><simpara> the current rating displayed in the widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the updated rating
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-rating-pixbufs-new" role="function">
<title>rb_rating_pixbufs_new ()</title>
<indexterm zone="rb-rating-pixbufs-new"><primary>rb_rating_pixbufs_new</primary></indexterm><programlisting><link linkend="RBRatingPixbufs">RBRatingPixbufs</link>* rb_rating_pixbufs_new (void);</programlisting>
<para>
Creates and returns a structure holding a set of pixbufs
to use to display ratings.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="RBRatingPixbufs"><type>RBRatingPixbufs</type></link> structure, or NULL if not all of
the pixbufs could be loaded.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-rating-pixbufs-free" role="function">
<title>rb_rating_pixbufs_free ()</title>
<indexterm zone="rb-rating-pixbufs-free"><primary>rb_rating_pixbufs_free</primary></indexterm><programlisting><link linkend="void">void</link> rb_rating_pixbufs_free (<link linkend="RBRatingPixbufs">RBRatingPixbufs</link> *pixbufs);</programlisting>
<para>
Frees a set of rating pixbufs.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pixbufs</parameter> :</term>
<listitem><simpara> <link linkend="RBRatingPixbufs"><type>RBRatingPixbufs</type></link> instance
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-rating-install-rating-property" role="function">
<title>rb_rating_install_rating_property ()</title>
<indexterm zone="rb-rating-install-rating-property"><primary>rb_rating_install_rating_property</primary></indexterm><programlisting><link linkend="void">void</link> rb_rating_install_rating_property (<link linkend="GObjectClass">GObjectClass</link> *klass,
<link linkend="gulong">gulong</link> prop);</programlisting>
<para>
Installs a 'rating' property in the specified class.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>klass</parameter> :</term>
<listitem><simpara> a <link linkend="GObjectClass"><type>GObjectClass</type></link> to add the property to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prop</parameter> :</term>
<listitem><simpara> property index to use
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
