Imported Upstream version 2.8.6

This commit is contained in:
Ari Pollak
2013-07-01 20:23:15 -04:00
parent 08fdee2b19
commit a7debe0231
613 changed files with 76756 additions and 58854 deletions

View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpWidgets</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
<link rel="prev" href="libgimpwidgets-GimpPropWidgets.html" title="GimpPropWidgets">
@ -191,8 +191,11 @@ and helper functions.
Convenience function to create a group of radio buttons embedded into
a <span class="type">GtkFrame</span> or <span class="type">GtkVBox</span>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>in_frame</code></em> :</span></p></td>
@ -227,8 +230,11 @@ a <span class="type">GtkFrame</span> or <span class="type">GtkVBox</span>.
Convenience function to create a group of radio buttons embedded into
a <span class="type">GtkFrame</span> or <span class="type">GtkVBox</span>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>in_frame</code></em> :</span></p></td>
@ -275,8 +281,11 @@ the radio buttons.</td>
Calls <code class="function">gtk_toggle_button_set_active()</code> with the radio button that was
created with a matching <em class="parameter"><code>item_data</code></em>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>radio_button</code></em> :</span></p></td>
@ -305,8 +314,11 @@ a <span class="type">GtkFrame</span> or <span class="type">GtkVBox</span>. This
pointers, since that is a very common case (mapping an enum to a radio
group).
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>in_frame</code></em> :</span></p></td>
@ -355,8 +367,11 @@ with a matching <em class="parameter"><code>item_data</code></em>. This function
<a class="link" href="libgimpwidgets-GimpWidgets.html#gimp-radio-group-set-active" title="gimp_radio_group_set_active ()"><code class="function">gimp_radio_group_set_active()</code></a>, but takes integers as <em class="parameter"><code>item_data</code></em> instead
of pointers.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>radio_button</code></em> :</span></p></td>
@ -387,8 +402,11 @@ subsequent <code class="function">gtk_spin_button_new()</code>. It also calls
<code class="function">gtk_spin_button_set_numeric()</code> so that non-numeric text cannot be
entered.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adjustment</code></em> :</span></p></td>
@ -437,8 +455,11 @@ entered.
<div class="refsect2">
<a name="GIMP-SCALE-ENTRY-LABEL:CAPS"></a><h3>GIMP_SCALE_ENTRY_LABEL()</h3>
<pre class="programlisting">#define GIMP_SCALE_ENTRY_LABEL(adj)</pre>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adj</code></em> :</span></p></td>
@ -455,8 +476,11 @@ entered.
<div class="refsect2">
<a name="GIMP-SCALE-ENTRY-SCALE:CAPS"></a><h3>GIMP_SCALE_ENTRY_SCALE()</h3>
<pre class="programlisting">#define GIMP_SCALE_ENTRY_SCALE(adj)</pre>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adj</code></em> :</span></p></td>
@ -473,8 +497,11 @@ entered.
<div class="refsect2">
<a name="GIMP-SCALE-ENTRY-SCALE-ADJ:CAPS"></a><h3>GIMP_SCALE_ENTRY_SCALE_ADJ()</h3>
<pre class="programlisting">#define GIMP_SCALE_ENTRY_SCALE_ADJ(adj)</pre>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adj</code></em> :</span></p></td>
@ -491,8 +518,11 @@ entered.
<div class="refsect2">
<a name="GIMP-SCALE-ENTRY-SPINBUTTON:CAPS"></a><h3>GIMP_SCALE_ENTRY_SPINBUTTON()</h3>
<pre class="programlisting">#define GIMP_SCALE_ENTRY_SPINBUTTON(adj)</pre>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adj</code></em> :</span></p></td>
@ -509,8 +539,11 @@ entered.
<div class="refsect2">
<a name="GIMP-SCALE-ENTRY-SPINBUTTON-ADJ:CAPS"></a><h3>GIMP_SCALE_ENTRY_SPINBUTTON_ADJ()</h3>
<pre class="programlisting">#define GIMP_SCALE_ENTRY_SPINBUTTON_ADJ(adj)</pre>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adj</code></em> :</span></p></td>
@ -547,8 +580,11 @@ entered.
This function creates a <span class="type">GtkLabel</span>, a <span class="type">GtkHScale</span> and a <span class="type">GtkSpinButton</span> and
attaches them to a 3-column <span class="type">GtkTable</span>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
@ -639,8 +675,11 @@ if <em class="parameter"><code>constrain</code></em> == <code class="literal">FA
Sets the sensitivity of the scale_entry's <span class="type">GtkLabel</span>, <span class="type">GtkHScale</span> and
<span class="type">GtkSpinButton</span>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adjustment</code></em> :</span></p></td>
@ -667,8 +706,11 @@ or logharithmic fashion. Useful when an entry has to attend large
ranges, but smaller selections on that range require a finer
adjustment.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adjustment</code></em> :</span></p></td>
@ -688,8 +730,11 @@ of the scale widget</td>
<div class="refsect2">
<a name="gimp-scale-entry-get-logarithmic"></a><h3>gimp_scale_entry_get_logarithmic ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_scale_entry_get_logarithmic (<em class="parameter"><code><span class="type">GtkObject</span> *adjustment</code></em>);</pre>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adjustment</code></em> :</span></p></td>
@ -727,8 +772,11 @@ logharithmic fashion, <code class="literal">FALSE</code> for linear behaviour.</
This function creates a <span class="type">GtkLabel</span>, a <a class="link" href="GimpColorScale.html" title="GimpColorScale"><span class="type">GimpColorScale</span></a> and a
<span class="type">GtkSpinButton</span> and attaches them to a 3-column <span class="type">GtkTable</span>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
@ -798,8 +846,11 @@ left of the <span class="type">GtkHScale</span>.</td>
<div class="refsect2">
<a name="GIMP-RANDOM-SEED-SPINBUTTON:CAPS"></a><h3>GIMP_RANDOM_SEED_SPINBUTTON()</h3>
<pre class="programlisting">#define GIMP_RANDOM_SEED_SPINBUTTON(hbox)</pre>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hbox</code></em> :</span></p></td>
@ -816,8 +867,11 @@ left of the <span class="type">GtkHScale</span>.</td>
<div class="refsect2">
<a name="GIMP-RANDOM-SEED-SPINBUTTON-ADJ:CAPS"></a><h3>GIMP_RANDOM_SEED_SPINBUTTON_ADJ()</h3>
<pre class="programlisting">#define GIMP_RANDOM_SEED_SPINBUTTON_ADJ(hbox)</pre>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hbox</code></em> :</span></p></td>
@ -834,8 +888,11 @@ left of the <span class="type">GtkHScale</span>.</td>
<div class="refsect2">
<a name="GIMP-RANDOM-SEED-TOGGLE:CAPS"></a><h3>GIMP_RANDOM_SEED_TOGGLE()</h3>
<pre class="programlisting">#define GIMP_RANDOM_SEED_TOGGLE(hbox)</pre>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hbox</code></em> :</span></p></td>
@ -857,8 +914,11 @@ left of the <span class="type">GtkHScale</span>.</td>
Creates a widget that allows the user to control how the random number
generator is initialized.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>seed</code></em> :</span></p></td>
@ -881,8 +941,11 @@ a <span class="type">GtkButton</span> for setting a random seed.</td>
<div class="refsect2">
<a name="GIMP-COORDINATES-CHAINBUTTON:CAPS"></a><h3>GIMP_COORDINATES_CHAINBUTTON()</h3>
<pre class="programlisting">#define GIMP_COORDINATES_CHAINBUTTON(sizeentry)</pre>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sizeentry</code></em> :</span></p></td>
@ -926,8 +989,11 @@ Convenience function that creates a <a class="link" href="GimpSizeEntry.html" ti
coordinates/sizes with a <a class="link" href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a> attached to constrain either the
two fields' values or the ratio between them.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>unit</code></em> :</span></p></td>
@ -1045,8 +1111,11 @@ Note that this function calls <a class="link" href="libgimpwidgets-GimpOldWidget
which is a deprecated hack you shouldn't use. See that function's
documentation for a proper replacement of its functionality.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
@ -1070,8 +1139,11 @@ Note that this function calls <a class="link" href="libgimpwidgets-GimpOldWidget
which is a deprecated hack you shouldn't use. See that function's
documentation for a proper replacement of its functionality.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
@ -1094,8 +1166,11 @@ GPOINTER_TO_INT (g_object_get_data (<em class="parameter"><code>widget</code></e
Note that the <span class="type">GtkAdjustment</span>'s value (which is a <span class="type">gdouble</span>) will be
rounded with <a href="/local/head/share/gtk-doc/html/libgimpmath/libgimpmath-GimpMath.html#RINT:CAPS"><code class="function">RINT()</code></a>.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adjustment</code></em> :</span></p></td>
@ -1118,8 +1193,11 @@ rounded with <a href="/local/head/share/gtk-doc/html/libgimpmath/libgimpmath-Gim
Note that the <span class="type">GtkAdjustment</span>'s value (which is a <span class="type">gdouble</span>) will be rounded
with (<span class="type">guint</span>) (value + 0.5).
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adjustment</code></em> :</span></p></td>
@ -1138,8 +1216,11 @@ with (<span class="type">guint</span>) (value + 0.5).
<a name="gimp-float-adjustment-update"></a><h3>gimp_float_adjustment_update ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_float_adjustment_update (<em class="parameter"><code><span class="type">GtkAdjustment</span> *adjustment</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adjustment</code></em> :</span></p></td>
@ -1158,8 +1239,11 @@ with (<span class="type">guint</span>) (value + 0.5).
<a name="gimp-double-adjustment-update"></a><h3>gimp_double_adjustment_update ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_double_adjustment_update (<em class="parameter"><code><span class="type">GtkAdjustment</span> *adjustment</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>adjustment</code></em> :</span></p></td>
@ -1189,8 +1273,11 @@ with (<span class="type">guint</span>) (value + 0.5).
Note that the <em class="parameter"><code>label_text</code></em> can be <code class="literal">NULL</code> and that the widget will be
attached starting at (<em class="parameter"><code>column</code></em> + 1) in this case, too.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
@ -1256,8 +1343,11 @@ The attributes are set on the complete label, from start to end. If
you need to set attributes on part of the label, you will have to
use the PangoAttributes API directly.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
@ -1289,8 +1379,11 @@ The GIMP widgets error domain.
<p>
This function is never called directly. Use <a class="link" href="libgimpwidgets-GimpWidgets.html#GIMP-WIDGETS-ERROR:CAPS" title="GIMP_WIDGETS_ERROR"><code class="function">GIMP_WIDGETS_ERROR()</code></a> instead.
</p>
<div class="variablelist"><table border="0">
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <span class="type">GQuark</span> that defines the GIMP widgets error domain.</td>