← Back to branch summary

~ubuntu-branches/ubuntu/precise/gtk+2.0/precise-updates

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkHSV.html

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2011-09-08 20:30:15 UTC
  • mfrom: (1.14.10 upstream)
  • Revision ID: package-import@ubuntu.com-20110908203015-hmdoq5jt1bl50nq3
Tags: 2.24.6-0ubuntu1
* debian/watch: Look for bz2 tarballs, and restrict to GTK 2 versions.
* New upstream bug fix release.
* Drop 094_git_fileselector_error.patch, include_m4_dir.patch: Included
  upstream.
* 003_gdk.pc_privates.patch, 009_gtk-export-filechooser.patch: Unfuzz.
* debian/libgail-doc.install, debian/libgtk2.0-doc.install.in: Install
  documentation from the source tree, as it's not being installed any more.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/html/GtkHSV.html
53
53
                                                         <em class="parameter"><code><span class="type">double</span> s</code></em>,
54
54
                                                         <em class="parameter"><code><span class="type">double</span> v</code></em>);
55
55
<span class="returnvalue">void</span>                <a class="link" href="GtkHSV.html#gtk-hsv-get-color" title="gtk_hsv_get_color ()">gtk_hsv_get_color</a>                   (<em class="parameter"><code><a class="link" href="GtkHSV.html" title="GtkHSV"><span class="type">GtkHSV</span></a> *hsv</code></em>,
56
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *h</code></em>,
57
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *s</code></em>,
58
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *v</code></em>);
 
56
                                                         <em class="parameter"><code><span class="type">gdouble</span> *h</code></em>,
 
57
                                                         <em class="parameter"><code><span class="type">gdouble</span> *s</code></em>,
 
58
                                                         <em class="parameter"><code><span class="type">gdouble</span> *v</code></em>);
59
59
<span class="returnvalue">void</span>                <a class="link" href="GtkHSV.html#gtk-hsv-set-metrics" title="gtk_hsv_set_metrics ()">gtk_hsv_set_metrics</a>                 (<em class="parameter"><code><a class="link" href="GtkHSV.html" title="GtkHSV"><span class="type">GtkHSV</span></a> *hsv</code></em>,
60
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>,
61
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> ring_width</code></em>);
 
60
                                                         <em class="parameter"><code><span class="type">gint</span> size</code></em>,
 
61
                                                         <em class="parameter"><code><span class="type">gint</span> ring_width</code></em>);
62
62
<span class="returnvalue">void</span>                <a class="link" href="GtkHSV.html#gtk-hsv-get-metrics" title="gtk_hsv_get_metrics ()">gtk_hsv_get_metrics</a>                 (<em class="parameter"><code><a class="link" href="GtkHSV.html" title="GtkHSV"><span class="type">GtkHSV</span></a> *hsv</code></em>,
63
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *size</code></em>,
64
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *ring_width</code></em>);
65
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GtkHSV.html#gtk-hsv-is-adjusting" title="gtk_hsv_is_adjusting ()">gtk_hsv_is_adjusting</a>                (<em class="parameter"><code><a class="link" href="GtkHSV.html" title="GtkHSV"><span class="type">GtkHSV</span></a> *hsv</code></em>);
66
 
<span class="returnvalue">void</span>                <a class="link" href="GtkHSV.html#gtk-hsv-to-rgb" title="gtk_hsv_to_rgb ()">gtk_hsv_to_rgb</a>                      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> h</code></em>,
67
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> s</code></em>,
68
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> v</code></em>,
69
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *r</code></em>,
70
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *g</code></em>,
71
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *b</code></em>);
72
 
<span class="returnvalue">void</span>                <a class="link" href="GtkHSV.html#gtk-rgb-to-hsv" title="gtk_rgb_to_hsv ()">gtk_rgb_to_hsv</a>                      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> r</code></em>,
73
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> g</code></em>,
74
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> b</code></em>,
75
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *h</code></em>,
76
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *s</code></em>,
77
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *v</code></em>);
 
63
                                                         <em class="parameter"><code><span class="type">gint</span> *size</code></em>,
 
64
                                                         <em class="parameter"><code><span class="type">gint</span> *ring_width</code></em>);
 
65
<span class="returnvalue">gboolean</span>            <a class="link" href="GtkHSV.html#gtk-hsv-is-adjusting" title="gtk_hsv_is_adjusting ()">gtk_hsv_is_adjusting</a>                (<em class="parameter"><code><a class="link" href="GtkHSV.html" title="GtkHSV"><span class="type">GtkHSV</span></a> *hsv</code></em>);
 
66
<span class="returnvalue">void</span>                <a class="link" href="GtkHSV.html#gtk-hsv-to-rgb" title="gtk_hsv_to_rgb ()">gtk_hsv_to_rgb</a>                      (<em class="parameter"><code><span class="type">gdouble</span> h</code></em>,
 
67
                                                         <em class="parameter"><code><span class="type">gdouble</span> s</code></em>,
 
68
                                                         <em class="parameter"><code><span class="type">gdouble</span> v</code></em>,
 
69
                                                         <em class="parameter"><code><span class="type">gdouble</span> *r</code></em>,
 
70
                                                         <em class="parameter"><code><span class="type">gdouble</span> *g</code></em>,
 
71
                                                         <em class="parameter"><code><span class="type">gdouble</span> *b</code></em>);
 
72
<span class="returnvalue">void</span>                <a class="link" href="GtkHSV.html#gtk-rgb-to-hsv" title="gtk_rgb_to_hsv ()">gtk_rgb_to_hsv</a>                      (<em class="parameter"><code><span class="type">gdouble</span> r</code></em>,
 
73
                                                         <em class="parameter"><code><span class="type">gdouble</span> g</code></em>,
 
74
                                                         <em class="parameter"><code><span class="type">gdouble</span> b</code></em>,
 
75
                                                         <em class="parameter"><code><span class="type">gdouble</span> *h</code></em>,
 
76
                                                         <em class="parameter"><code><span class="type">gdouble</span> *s</code></em>,
 
77
                                                         <em class="parameter"><code><span class="type">gdouble</span> *v</code></em>);
78
78
</pre>
79
79
</div>
80
80
<div class="refsect1">
81
81
<a name="GtkHSV.object-hierarchy"></a><h2>Object Hierarchy</h2>
82
82
<pre class="synopsis">
83
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
84
 
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
83
  GObject
 
84
   +----GInitiallyUnowned
85
85
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
86
86
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
87
87
                     +----GtkHSV
96
96
<div class="refsect1">
97
97
<a name="GtkHSV.signals"></a><h2>Signals</h2>
98
98
<pre class="synopsis">
99
 
  "<a class="link" href="GtkHSV.html#GtkHSV-changed" title='The "changed" signal'>changed</a>"                                        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
100
 
  "<a class="link" href="GtkHSV.html#GtkHSV-move" title='The "move" signal'>move</a>"                                           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
 
99
  "<a class="link" href="GtkHSV.html#GtkHSV-changed" title='The "changed" signal'>changed</a>"                                        : <code class="literal">Run First</code>
 
100
  "<a class="link" href="GtkHSV.html#GtkHSV-move" title='The "move" signal'>move</a>"                                           : <code class="literal">Action</code>
101
101
</pre>
102
102
</div>
103
103
<div class="refsect1">
172
172
<div class="refsect2">
173
173
<a name="gtk-hsv-get-color"></a><h3>gtk_hsv_get_color ()</h3>
174
174
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_hsv_get_color                   (<em class="parameter"><code><a class="link" href="GtkHSV.html" title="GtkHSV"><span class="type">GtkHSV</span></a> *hsv</code></em>,
175
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *h</code></em>,
176
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *s</code></em>,
177
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *v</code></em>);</pre>
 
175
                                                         <em class="parameter"><code><span class="type">gdouble</span> *h</code></em>,
 
176
                                                         <em class="parameter"><code><span class="type">gdouble</span> *s</code></em>,
 
177
                                                         <em class="parameter"><code><span class="type">gdouble</span> *v</code></em>);</pre>
178
178
<p>
179
179
Queries the current color in an HSV color selector.
180
180
Returned values will be in the [0.0, 1.0] range.
209
209
<div class="refsect2">
210
210
<a name="gtk-hsv-set-metrics"></a><h3>gtk_hsv_set_metrics ()</h3>
211
211
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_hsv_set_metrics                 (<em class="parameter"><code><a class="link" href="GtkHSV.html" title="GtkHSV"><span class="type">GtkHSV</span></a> *hsv</code></em>,
212
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>,
213
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> ring_width</code></em>);</pre>
 
212
                                                         <em class="parameter"><code><span class="type">gint</span> size</code></em>,
 
213
                                                         <em class="parameter"><code><span class="type">gint</span> ring_width</code></em>);</pre>
214
214
<p>
215
215
Sets the size and ring width of an HSV color selector.
216
216
</p>
237
237
<div class="refsect2">
238
238
<a name="gtk-hsv-get-metrics"></a><h3>gtk_hsv_get_metrics ()</h3>
239
239
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_hsv_get_metrics                 (<em class="parameter"><code><a class="link" href="GtkHSV.html" title="GtkHSV"><span class="type">GtkHSV</span></a> *hsv</code></em>,
240
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *size</code></em>,
241
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *ring_width</code></em>);</pre>
 
240
                                                         <em class="parameter"><code><span class="type">gint</span> *size</code></em>,
 
241
                                                         <em class="parameter"><code><span class="type">gint</span> *ring_width</code></em>);</pre>
242
242
<p>
243
243
Queries the size and ring width of an HSV color selector.
244
244
</p>
266
266
<hr>
267
267
<div class="refsect2">
268
268
<a name="gtk-hsv-is-adjusting"></a><h3>gtk_hsv_is_adjusting ()</h3>
269
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_hsv_is_adjusting                (<em class="parameter"><code><a class="link" href="GtkHSV.html" title="GtkHSV"><span class="type">GtkHSV</span></a> *hsv</code></em>);</pre>
 
269
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_hsv_is_adjusting                (<em class="parameter"><code><a class="link" href="GtkHSV.html" title="GtkHSV"><span class="type">GtkHSV</span></a> *hsv</code></em>);</pre>
270
270
<p>
271
271
An HSV color selector can be said to be adjusting if multiple rapid
272
272
changes are being made to its value, for example, when the user is 
284
284
<tr>
285
285
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
286
286
<td>
287
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if clients can ignore changes to the color value,
288
 
since they may be transitory, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if they should consider
 
287
<code class="literal">TRUE</code> if clients can ignore changes to the color value,
 
288
since they may be transitory, or <code class="literal">FALSE</code> if they should consider
289
289
the color value status to be final.</td>
290
290
</tr>
291
291
</tbody>
295
295
<hr>
296
296
<div class="refsect2">
297
297
<a name="gtk-hsv-to-rgb"></a><h3>gtk_hsv_to_rgb ()</h3>
298
 
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_hsv_to_rgb                      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> h</code></em>,
299
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> s</code></em>,
300
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> v</code></em>,
301
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *r</code></em>,
302
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *g</code></em>,
303
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *b</code></em>);</pre>
 
298
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_hsv_to_rgb                      (<em class="parameter"><code><span class="type">gdouble</span> h</code></em>,
 
299
                                                         <em class="parameter"><code><span class="type">gdouble</span> s</code></em>,
 
300
                                                         <em class="parameter"><code><span class="type">gdouble</span> v</code></em>,
 
301
                                                         <em class="parameter"><code><span class="type">gdouble</span> *r</code></em>,
 
302
                                                         <em class="parameter"><code><span class="type">gdouble</span> *g</code></em>,
 
303
                                                         <em class="parameter"><code><span class="type">gdouble</span> *b</code></em>);</pre>
304
304
<p>
305
305
Converts a color from HSV space to RGB.
306
306
Input values must be in the [0.0, 1.0] range; 
343
343
<hr>
344
344
<div class="refsect2">
345
345
<a name="gtk-rgb-to-hsv"></a><h3>gtk_rgb_to_hsv ()</h3>
346
 
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_rgb_to_hsv                      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> r</code></em>,
347
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> g</code></em>,
348
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> b</code></em>,
349
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *h</code></em>,
350
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *s</code></em>,
351
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *v</code></em>);</pre>
 
346
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_rgb_to_hsv                      (<em class="parameter"><code><span class="type">gdouble</span> r</code></em>,
 
347
                                                         <em class="parameter"><code><span class="type">gdouble</span> g</code></em>,
 
348
                                                         <em class="parameter"><code><span class="type">gdouble</span> b</code></em>,
 
349
                                                         <em class="parameter"><code><span class="type">gdouble</span> *h</code></em>,
 
350
                                                         <em class="parameter"><code><span class="type">gdouble</span> *s</code></em>,
 
351
                                                         <em class="parameter"><code><span class="type">gdouble</span> *v</code></em>);</pre>
352
352
<p>
353
353
Converts a color from RGB space to HSV.
354
354
Input values must be in the [0.0, 1.0] range;
394
394
<div class="refsect2">
395
395
<a name="GtkHSV-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
396
396
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkHSV.html" title="GtkHSV"><span class="type">GtkHSV</span></a>  *hsv,
397
 
                                                        <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-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
 
397
                                                        <span class="type">gpointer</span> user_data)      : <code class="literal">Run First</code></pre>
398
398
<p>
399
399
</p>
400
400
<div class="variablelist"><table border="0">
416
416
<a name="GtkHSV-move"></a><h3>The <code class="literal">"move"</code> signal</h3>
417
417
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkHSV.html" title="GtkHSV"><span class="type">GtkHSV</span></a>          *hsv,
418
418
                                                        <a class="link" href="gtk-Standard-Enumerations.html#GtkDirectionType" title="enum GtkDirectionType"><span class="type">GtkDirectionType</span></a> arg1,
419
 
                                                        <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>
 
419
                                                        <span class="type">gpointer</span>         user_data)      : <code class="literal">Action</code></pre>
420
420
<p>
421
421
</p>
422
422
<div class="variablelist"><table border="0">