Imported Upstream version 2.3.18

This commit is contained in:
Ari Pollak
2010-08-11 01:21:39 -04:00
parent 2e1d89b96f
commit 50ca37e277
1279 changed files with 155433 additions and 58921 deletions

View File

@ -25,16 +25,16 @@
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimputils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2590987" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2593333" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2604938" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2557203" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpunit"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2590987"></a><span class="refentrytitle">gimpunit</span>
<a name="id2593333"></a><span class="refentrytitle">gimpunit</span>
</h2>
<p>gimpunit &#8212; Provides a collection of predefined units and functions for creating
user-defined units.</p>
@ -83,7 +83,7 @@ GParamSpec* <a href="libgimpbase-gimpunit.html#gimp-param-spec-unit">gim
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2604938"></a><h2>Description</h2>
<a name="id2557203"></a><h2>Description</h2>
<p>
Provides a collection of predefined units and functions for creating
user-defined units.
@ -91,11 +91,11 @@ user-defined units.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2604955"></a><h2>Details</h2>
<a name="id2557220"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2604966"></a><h3>
<a name="id2557230"></a><h3>
<a name="GimpUnit"></a>enum GimpUnit</h3>
<a class="indexterm" name="id2604978"></a><pre class="programlisting">typedef enum /*&lt; skip &gt;*/
<a class="indexterm" name="id2557242"></a><pre class="programlisting">typedef enum /*&lt; skip &gt;*/
{
GIMP_UNIT_PIXEL = 0,
@ -115,9 +115,9 @@ user-defined units.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604997"></a><h3>
<a name="id2557262"></a><h3>
<a name="gimp-unit-get-number-of-units"></a>gimp_unit_get_number_of_units ()</h3>
<a class="indexterm" name="id2605008"></a><pre class="programlisting">gint gimp_unit_get_number_of_units (void);</pre>
<a class="indexterm" name="id2557273"></a><pre class="programlisting">gint gimp_unit_get_number_of_units (void);</pre>
<p>
Returns the number of units which are known to the <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a> system.</p>
<p>
@ -134,9 +134,9 @@ Returns the number of units which are known to the <a href="libgimpbase-gimpunit
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605056"></a><h3>
<a name="id2557320"></a><h3>
<a name="gimp-unit-get-number-of-built-in-units"></a>gimp_unit_get_number_of_built_in_units ()</h3>
<a class="indexterm" name="id2605067"></a><pre class="programlisting">gint gimp_unit_get_number_of_built_in_units
<a class="indexterm" name="id2557332"></a><pre class="programlisting">gint gimp_unit_get_number_of_built_in_units
(void);</pre>
<p>
Returns the number of <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a>'s which are hardcoded in the unit system
@ -156,9 +156,9 @@ Returns the number of <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605117"></a><h3>
<a name="id2557382"></a><h3>
<a name="gimp-unit-new"></a>gimp_unit_new ()</h3>
<a class="indexterm" name="id2605130"></a><pre class="programlisting"><a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> gimp_unit_new (gchar *identifier,
<a class="indexterm" name="id2557394"></a><pre class="programlisting"><a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> gimp_unit_new (gchar *identifier,
gdouble factor,
gint digits,
gchar *symbol,
@ -223,9 +223,9 @@ set to <code class="literal">TRUE</code>. You will have to set it to <code class
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606014"></a><h3>
<a name="id2604825"></a><h3>
<a name="gimp-unit-get-deletion-flag"></a>gimp_unit_get_deletion_flag ()</h3>
<a class="indexterm" name="id2606026"></a><pre class="programlisting">gboolean gimp_unit_get_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2604837"></a><pre class="programlisting">gboolean gimp_unit_get_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
</p>
<p>
@ -249,9 +249,9 @@ set to <code class="literal">TRUE</code>. You will have to set it to <code class
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606099"></a><h3>
<a name="id2604909"></a><h3>
<a name="gimp-unit-set-deletion-flag"></a>gimp_unit_set_deletion_flag ()</h3>
<a class="indexterm" name="id2609211"></a><pre class="programlisting">void gimp_unit_set_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit,
<a class="indexterm" name="id2609370"></a><pre class="programlisting">void gimp_unit_set_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit,
gboolean deletion_flag);</pre>
<p>
Sets a <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a>'s <em class="parameter"><code>deletion_flag</code></em>. If the <em class="parameter"><code>deletion_flag</code></em> of a unit is
@ -282,9 +282,9 @@ ignored.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609317"></a><h3>
<a name="id2609475"></a><h3>
<a name="gimp-unit-get-factor"></a>gimp_unit_get_factor ()</h3>
<a class="indexterm" name="id2609328"></a><pre class="programlisting">gdouble gimp_unit_get_factor (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2609486"></a><pre class="programlisting">gdouble gimp_unit_get_factor (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
A <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a>'s <em class="parameter"><code>factor</code></em> is defined to be:
</p>
@ -314,9 +314,9 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609397"></a><h3>
<a name="id2609577"></a><h3>
<a name="gimp-unit-get-digits"></a>gimp_unit_get_digits ()</h3>
<a class="indexterm" name="id2609408"></a><pre class="programlisting">gint gimp_unit_get_digits (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2609588"></a><pre class="programlisting">gint gimp_unit_get_digits (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
Returns the number of digits an entry field should provide to get
approximately the same accuracy as an inch input field with two digits.
@ -344,9 +344,9 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609473"></a><h3>
<a name="id2609661"></a><h3>
<a name="gimp-unit-get-identifier"></a>gimp_unit_get_identifier ()</h3>
<a class="indexterm" name="id2609484"></a><pre class="programlisting">const gchar* gimp_unit_get_identifier (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2609672"></a><pre class="programlisting">const gchar* gimp_unit_get_identifier (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
This is an unstranslated string and must not be changed or freed.</p>
<p>
@ -370,9 +370,9 @@ This is an unstranslated string and must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609540"></a><h3>
<a name="id2609735"></a><h3>
<a name="gimp-unit-get-symbol"></a>gimp_unit_get_symbol ()</h3>
<a class="indexterm" name="id2609551"></a><pre class="programlisting">const gchar* gimp_unit_get_symbol (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2609746"></a><pre class="programlisting">const gchar* gimp_unit_get_symbol (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
This is e.g. "''" for UNIT_INCH.
</p>
@ -399,9 +399,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609611"></a><h3>
<a name="id2609813"></a><h3>
<a name="gimp-unit-get-abbreviation"></a>gimp_unit_get_abbreviation ()</h3>
<a class="indexterm" name="id2609622"></a><pre class="programlisting">const gchar* gimp_unit_get_abbreviation (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2609825"></a><pre class="programlisting">const gchar* gimp_unit_get_abbreviation (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
For built-in units, this function returns the translated abbreviation
of the unit.
@ -429,9 +429,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609683"></a><h3>
<a name="id2609892"></a><h3>
<a name="gimp-unit-get-singular"></a>gimp_unit_get_singular ()</h3>
<a class="indexterm" name="id2609694"></a><pre class="programlisting">const gchar* gimp_unit_get_singular (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2609903"></a><pre class="programlisting">const gchar* gimp_unit_get_singular (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
For built-in units, this function returns the translated singular form
of the unit's name.
@ -459,9 +459,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609755"></a><h3>
<a name="id2609971"></a><h3>
<a name="gimp-unit-get-plural"></a>gimp_unit_get_plural ()</h3>
<a class="indexterm" name="id2609765"></a><pre class="programlisting">const gchar* gimp_unit_get_plural (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2609982"></a><pre class="programlisting">const gchar* gimp_unit_get_plural (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
For built-in units, this function returns the translated plural form
of the unit's name.
@ -489,9 +489,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609827"></a><h3>
<a name="id2610050"></a><h3>
<a name="GIMP-TYPE-UNIT:CAPS"></a>GIMP_TYPE_UNIT</h3>
<a class="indexterm" name="id2609837"></a><pre class="programlisting">#define GIMP_TYPE_UNIT (gimp_unit_get_type ())
<a class="indexterm" name="id2610062"></a><pre class="programlisting">#define GIMP_TYPE_UNIT (gimp_unit_get_type ())
</pre>
<p>
<a href="libgimpbase-gimpunit.html#GIMP-TYPE-UNIT:CAPS"><span class="type">GIMP_TYPE_UNIT</span></a> is a <span class="type">GType</span> derived from <span class="type">G_TYPE_INT</span>.
@ -499,9 +499,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609871"></a><h3>
<a name="id2610100"></a><h3>
<a name="GIMP-TYPE-PARAM-UNIT:CAPS"></a>GIMP_TYPE_PARAM_UNIT</h3>
<a class="indexterm" name="id2609881"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_UNIT (gimp_param_unit_get_type ())
<a class="indexterm" name="id2610112"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_UNIT (gimp_param_unit_get_type ())
</pre>
<p>
@ -509,9 +509,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609896"></a><h3>
<a name="id2610128"></a><h3>
<a name="GIMP-IS-PARAM-SPEC-UNIT:CAPS"></a>GIMP_IS_PARAM_SPEC_UNIT()</h3>
<a class="indexterm" name="id2609908"></a><pre class="programlisting">#define GIMP_IS_PARAM_SPEC_UNIT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_UNIT))
<a class="indexterm" name="id2610141"></a><pre class="programlisting">#define GIMP_IS_PARAM_SPEC_UNIT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_UNIT))
</pre>
<p>
@ -529,9 +529,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609941"></a><h3>
<a name="id2610177"></a><h3>
<a name="gimp-param-spec-unit"></a>gimp_param_spec_unit ()</h3>
<a class="indexterm" name="id2609953"></a><pre class="programlisting">GParamSpec* gimp_param_spec_unit (const gchar *name,
<a class="indexterm" name="id2610191"></a><pre class="programlisting">GParamSpec* gimp_param_spec_unit (const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean allow_pixels,
@ -595,9 +595,9 @@ See <code class="function">g_param_spec_internal()</code> for more information.<
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610153"></a><h3>
<a name="id2610412"></a><h3>
<a name="GIMP-VALUE-HOLDS-UNIT:CAPS"></a>GIMP_VALUE_HOLDS_UNIT()</h3>
<a class="indexterm" name="id2610164"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
<a class="indexterm" name="id2610423"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
</pre>
<p>
@ -615,7 +615,7 @@ See <code class="function">g_param_spec_internal()</code> for more information.<
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2610197"></a><h2>See Also</h2>
<a name="id2610460"></a><h2>See Also</h2>
<p>
<a
href="../libgimpwidgets/GimpUnitMenu.html"