Imported Upstream version 2.4.0~rc2

This commit is contained in:
Ari Pollak
2010-08-11 01:22:44 -04:00
parent d884b2912c
commit 4be5597e32
576 changed files with 70261 additions and 80724 deletions

View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpunit</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpsignal.html" title="gimpsignal">
@ -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="#id2575341" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2607792" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2604758" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2622539" 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="id2575341"></a><span class="refentrytitle">gimpunit</span>
<a name="id2607792"></a><span class="refentrytitle">gimpunit</span>
</h2>
<p>gimpunit &#8212; Provides a collection of predefined units and functions for creating
user-defined units.</p>
@ -47,93 +47,43 @@ user-defined units.</p>
enum <a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a>;
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="libgimpbase-gimpunit.html#gimp-unit-get-number-of-units">gimp_unit_get_number_of_units</a> (void);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="libgimpbase-gimpunit.html#gimp-unit-get-number-of-built-in-units">gimp_unit_get_number_of_built_in_units</a>
enum <a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a>;
gint <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-get-number-of-units">gimp_unit_get_number_of_units</a> (void);
gint <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-get-number-of-built-in-units">gimp_unit_get_number_of_built_in_units</a>
(void);
<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> <a href="libgimpbase-gimpunit.html#gimp-unit-new">gimp_unit_new</a> (<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *identifier,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> factor,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> digits,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *symbol,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *abbreviation,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *singular,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *plural);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimpbase-gimpunit.html#gimp-unit-get-deletion-flag">gimp_unit_get_deletion_flag</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
void <a href="libgimpbase-gimpunit.html#gimp-unit-set-deletion-flag">gimp_unit_set_deletion_flag</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> deletion_flag);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <a href="libgimpbase-gimpunit.html#gimp-unit-get-factor">gimp_unit_get_factor</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="libgimpbase-gimpunit.html#gimp-unit-get-digits">gimp_unit_get_digits</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libgimpbase-gimpunit.html#gimp-unit-get-identifier">gimp_unit_get_identifier</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libgimpbase-gimpunit.html#gimp-unit-get-symbol">gimp_unit_get_symbol</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libgimpbase-gimpunit.html#gimp-unit-get-abbreviation">gimp_unit_get_abbreviation</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libgimpbase-gimpunit.html#gimp-unit-get-singular">gimp_unit_get_singular</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libgimpbase-gimpunit.html#gimp-unit-get-plural">gimp_unit_get_plural</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
#define <a href="libgimpbase-gimpunit.html#GIMP-TYPE-UNIT:CAPS">GIMP_TYPE_UNIT</a>
#define <a href="libgimpbase-gimpunit.html#GIMP-TYPE-PARAM-UNIT:CAPS">GIMP_TYPE_PARAM_UNIT</a>
#define <a href="libgimpbase-gimpunit.html#GIMP-IS-PARAM-SPEC-UNIT:CAPS">GIMP_IS_PARAM_SPEC_UNIT</a> (pspec)
<a
href="../gobject/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a>* <a href="libgimpbase-gimpunit.html#gimp-param-spec-unit">gimp_param_spec_unit</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *nick,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *blurb,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> allow_pixels,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> allow_percent,
<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> default_value,
<a
href="../gobject/gobject-GParamSpec.html#GParamFlags"
>GParamFlags</a> flags);
#define <a href="libgimpbase-gimpunit.html#GIMP-VALUE-HOLDS-UNIT:CAPS">GIMP_VALUE_HOLDS_UNIT</a> (value)
<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-new">gimp_unit_new</a> (gchar *identifier,
gdouble factor,
gint digits,
gchar *symbol,
gchar *abbreviation,
gchar *singular,
gchar *plural);
gboolean <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-get-deletion-flag">gimp_unit_get_deletion_flag</a> (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
void <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-set-deletion-flag">gimp_unit_set_deletion_flag</a> (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit,
gboolean deletion_flag);
gdouble <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-get-factor">gimp_unit_get_factor</a> (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
gint <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-get-digits">gimp_unit_get_digits</a> (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-get-identifier">gimp_unit_get_identifier</a> (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-get-symbol">gimp_unit_get_symbol</a> (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-get-abbreviation">gimp_unit_get_abbreviation</a> (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-get-singular">gimp_unit_get_singular</a> (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-get-plural">gimp_unit_get_plural</a> (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
#define <a class="link" href="libgimpbase-gimpunit.html#GIMP-TYPE-UNIT:CAPS">GIMP_TYPE_UNIT</a>
#define <a class="link" href="libgimpbase-gimpunit.html#GIMP-TYPE-PARAM-UNIT:CAPS">GIMP_TYPE_PARAM_UNIT</a>
#define <a class="link" href="libgimpbase-gimpunit.html#GIMP-IS-PARAM-SPEC-UNIT:CAPS">GIMP_IS_PARAM_SPEC_UNIT</a> (pspec)
GParamSpec* <a class="link" href="libgimpbase-gimpunit.html#gimp-param-spec-unit">gimp_param_spec_unit</a> (const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean allow_pixels,
gboolean allow_percent,
<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> default_value,
GParamFlags flags);
#define <a class="link" href="libgimpbase-gimpunit.html#GIMP-VALUE-HOLDS-UNIT:CAPS">GIMP_VALUE_HOLDS_UNIT</a> (value)
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2604758"></a><h2>Description</h2>
<a name="id2622539"></a><h2>Description</h2>
<p>
Provides a collection of predefined units and functions for creating
user-defined units.
@ -141,11 +91,11 @@ user-defined units.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2604775"></a><h2>Details</h2>
<a name="id2622556"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2604785"></a><h3>
<a name="id2622567"></a><h3>
<a name="GimpUnit"></a>enum GimpUnit</h3>
<a class="indexterm" name="id2604798"></a><pre class="programlisting">typedef enum /*&lt; skip &gt;*/
<a class="indexterm" name="id2622579"></a><pre class="programlisting">typedef enum /*&lt; skip &gt;*/
{
GIMP_UNIT_PIXEL = 0,
@ -165,20 +115,18 @@ user-defined units.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604817"></a><h3>
<a name="id2622598"></a><h3>
<a name="gimp-unit-get-number-of-units"></a>gimp_unit_get_number_of_units ()</h3>
<a class="indexterm" name="id2604828"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gimp_unit_get_number_of_units (void);</pre>
<a class="indexterm" name="id2622610"></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>
Returns the number of units which are known to the <a class="link" href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a> system.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The number of defined units.
</td>
</tr></tbody>
@ -186,14 +134,12 @@ Returns the number of units which are known to the <a href="libgimpbase-gimpunit
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604876"></a><h3>
<a name="id2622657"></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="id2604887"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gimp_unit_get_number_of_built_in_units
<a class="indexterm" name="id2622669"></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
Returns the number of <a class="link" href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a>'s which are hardcoded in the unit system
(UNIT_INCH, UNIT_MM, UNIT_POINT, UNIT_PICA and the two "pseudo unit"
UNIT_PIXEL).</p>
<p>
@ -202,7 +148,7 @@ Returns the number of <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The number of built-in units.
</td>
</tr></tbody>
@ -210,40 +156,22 @@ Returns the number of <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604937"></a><h3>
<a name="id2622719"></a><h3>
<a name="gimp-unit-new"></a>gimp_unit_new ()</h3>
<a class="indexterm" name="id2604950"></a><pre class="programlisting"><a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> gimp_unit_new (<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *identifier,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> factor,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> digits,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *symbol,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *abbreviation,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *singular,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *plural);</pre>
<a class="indexterm" name="id2622732"></a><pre class="programlisting"><a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> gimp_unit_new (gchar *identifier,
gdouble factor,
gint digits,
gchar *symbol,
gchar *abbreviation,
gchar *singular,
gchar *plural);</pre>
<p>
Returns the integer ID of the new <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a>.
Returns the integer ID of the new <a class="link" href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a>.
</p>
<p>
Note that a new unit is always created with it's deletion flag
set to <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>. You will have to set it to <a
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> with
<a href="libgimpbase-gimpunit.html#gimp-unit-set-deletion-flag"><code class="function">gimp_unit_set_deletion_flag()</code></a> to make the unit definition persistent.</p>
set to <code class="literal">TRUE</code>. You will have to set it to <code class="literal">FALSE</code> with
<a class="link" href="libgimpbase-gimpunit.html#gimp-unit-set-deletion-flag"><code class="function">gimp_unit_set_deletion_flag()</code></a> to make the unit definition persistent.</p>
<p>
</p>
@ -251,42 +179,42 @@ href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>identifier</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>identifier</code></em>&#160;:</span></p></td>
<td> The unit's identifier string.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>factor</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>factor</code></em>&#160;:</span></p></td>
<td> The unit's factor (how many units are in one inch).
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>digits</code></em>&#160;:</span></td>
<td> The unit's suggested number of digits (see <a href="libgimpbase-gimpunit.html#gimp-unit-get-digits"><code class="function">gimp_unit_get_digits()</code></a>).
<td><p><span class="term"><em class="parameter"><code>digits</code></em>&#160;:</span></p></td>
<td> The unit's suggested number of digits (see <a class="link" href="libgimpbase-gimpunit.html#gimp-unit-get-digits"><code class="function">gimp_unit_get_digits()</code></a>).
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>symbol</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>symbol</code></em>&#160;:</span></p></td>
<td> The symbol of the unit (e.g. "''" for inch).
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>abbreviation</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>abbreviation</code></em>&#160;:</span></p></td>
<td> The abbreviation of the unit.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>singular</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>singular</code></em>&#160;:</span></p></td>
<td> The singular form of the unit.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>plural</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>plural</code></em>&#160;:</span></p></td>
<td> The plural form of the unit.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The ID of the new unit.
</td>
</tr>
@ -295,11 +223,9 @@ href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2576374"></a><h3>
<a name="id2619042"></a><h3>
<a name="gimp-unit-get-deletion-flag"></a>gimp_unit_get_deletion_flag ()</h3>
<a class="indexterm" name="id2576386"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_unit_get_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2619054"></a><pre class="programlisting">gboolean gimp_unit_get_deletion_flag (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
</p>
<p>
@ -309,12 +235,12 @@ href="../glib/glib-Basic-Types.html#gboolean"
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></p></td>
<td> The unit you want to know the <em class="parameter"><code>deletion_flag</code></em> of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The unit's <em class="parameter"><code>deletion_flag</code></em>.
</td>
</tr>
@ -323,17 +249,13 @@ href="../glib/glib-Basic-Types.html#gboolean"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2576458"></a><h3>
<a name="id2619126"></a><h3>
<a name="gimp-unit-set-deletion-flag"></a>gimp_unit_set_deletion_flag ()</h3>
<a class="indexterm" name="id2609531"></a><pre class="programlisting">void gimp_unit_set_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> deletion_flag);</pre>
<a class="indexterm" name="id2626702"></a><pre class="programlisting">void gimp_unit_set_deletion_flag (<a class="link" 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
<a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> when GIMP exits, this unit will not be saved in the users's
Sets a <a class="link" 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
<code class="literal">TRUE</code> when GIMP exits, this unit will not be saved in the users's
"unitrc" file.
</p>
<p>
@ -346,12 +268,12 @@ ignored.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></p></td>
<td> The unit you want to set the <em class="parameter"><code>deletion_flag</code></em> for.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>deletion_flag</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>deletion_flag</code></em>&#160;:</span></p></td>
<td> The new deletion_flag.
</td>
</tr>
@ -360,13 +282,11 @@ ignored.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609636"></a><h3>
<a name="id2626806"></a><h3>
<a name="gimp-unit-get-factor"></a>gimp_unit_get_factor ()</h3>
<a class="indexterm" name="id2609646"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> gimp_unit_get_factor (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2626817"></a><pre class="programlisting">gdouble gimp_unit_get_factor (<a class="link" 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:
A <a class="link" href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a>'s <em class="parameter"><code>factor</code></em> is defined to be:
</p>
<p>
distance_in_units == (<em class="parameter"><code>factor</code></em> * distance_in_inches)
@ -380,12 +300,12 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></p></td>
<td> The unit you want to know the factor of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The unit's factor.
</td>
</tr>
@ -394,11 +314,9 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609738"></a><h3>
<a name="id2626908"></a><h3>
<a name="gimp-unit-get-digits"></a>gimp_unit_get_digits ()</h3>
<a class="indexterm" name="id2609750"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gimp_unit_get_digits (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2626920"></a><pre class="programlisting">gint gimp_unit_get_digits (<a class="link" 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.
@ -412,12 +330,12 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></p></td>
<td> The unit you want to know the digits.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The suggested number of digits.
</td>
</tr>
@ -426,11 +344,9 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609797"></a><h3>
<a name="id2626992"></a><h3>
<a name="gimp-unit-get-identifier"></a>gimp_unit_get_identifier ()</h3>
<a class="indexterm" name="id2609807"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_unit_get_identifier (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2627004"></a><pre class="programlisting">const gchar* gimp_unit_get_identifier (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
This is an unstranslated string and must not be changed or freed.</p>
<p>
@ -440,12 +356,12 @@ This is an unstranslated string and must not be changed or freed.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></p></td>
<td> The unit you want to know the identifier of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The unit's identifier.
</td>
</tr>
@ -454,11 +370,9 @@ This is an unstranslated string and must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609864"></a><h3>
<a name="id2627066"></a><h3>
<a name="gimp-unit-get-symbol"></a>gimp_unit_get_symbol ()</h3>
<a class="indexterm" name="id2609874"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_unit_get_symbol (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2627077"></a><pre class="programlisting">const gchar* gimp_unit_get_symbol (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
This is e.g. "''" for UNIT_INCH.
</p>
@ -471,12 +385,12 @@ NOTE: This string must not be changed or freed.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></p></td>
<td> The unit you want to know the symbol of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The unit's symbol.
</td>
</tr>
@ -485,11 +399,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609934"></a><h3>
<a name="id2627144"></a><h3>
<a name="gimp-unit-get-abbreviation"></a>gimp_unit_get_abbreviation ()</h3>
<a class="indexterm" name="id2609945"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_unit_get_abbreviation (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2627156"></a><pre class="programlisting">const gchar* gimp_unit_get_abbreviation (<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
For built-in units, this function returns the translated abbreviation
of the unit.
@ -503,12 +415,12 @@ NOTE: This string must not be changed or freed.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></p></td>
<td> The unit you want to know the abbreviation of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The unit's abbreviation.
</td>
</tr>
@ -517,11 +429,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610007"></a><h3>
<a name="id2627223"></a><h3>
<a name="gimp-unit-get-singular"></a>gimp_unit_get_singular ()</h3>
<a class="indexterm" name="id2610017"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_unit_get_singular (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2627234"></a><pre class="programlisting">const gchar* gimp_unit_get_singular (<a class="link" 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.
@ -535,12 +445,12 @@ NOTE: This string must not be changed or freed.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></p></td>
<td> The unit you want to know the singular form of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The unit's singular form.
</td>
</tr>
@ -549,11 +459,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610078"></a><h3>
<a name="id2627302"></a><h3>
<a name="gimp-unit-get-plural"></a>gimp_unit_get_plural ()</h3>
<a class="indexterm" name="id2610089"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_unit_get_plural (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2627313"></a><pre class="programlisting">const gchar* gimp_unit_get_plural (<a class="link" 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.
@ -567,12 +475,12 @@ NOTE: This string must not be changed or freed.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></p></td>
<td> The unit you want to know the plural form of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The unit's plural form.
</td>
</tr>
@ -581,23 +489,19 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610150"></a><h3>
<a name="id2627381"></a><h3>
<a name="GIMP-TYPE-UNIT:CAPS"></a>GIMP_TYPE_UNIT</h3>
<a class="indexterm" name="id2610160"></a><pre class="programlisting">#define GIMP_TYPE_UNIT (gimp_unit_get_type ())
<a class="indexterm" name="id2627393"></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 <a
href="../gobject/gobject-Type-Information.html#GType"
><span class="type">GType</span></a> derived from <a
href="../gobject/gobject-Type-Information.html#G-TYPE-INT:CAPS"
><span class="type">G_TYPE_INT</span></a>.
<a class="link" 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>.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610194"></a><h3>
<a name="id2627431"></a><h3>
<a name="GIMP-TYPE-PARAM-UNIT:CAPS"></a>GIMP_TYPE_PARAM_UNIT</h3>
<a class="indexterm" name="id2610204"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_UNIT (gimp_param_unit_get_type ())
<a class="indexterm" name="id2627443"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_UNIT (gimp_param_unit_get_type ())
</pre>
<p>
@ -605,9 +509,9 @@ href="../gobject/gobject-Type-Information.html#G-TYPE-INT:CAPS"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610219"></a><h3>
<a name="id2627459"></a><h3>
<a name="GIMP-IS-PARAM-SPEC-UNIT:CAPS"></a>GIMP_IS_PARAM_SPEC_UNIT()</h3>
<a class="indexterm" name="id2610232"></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="id2627472"></a><pre class="programlisting">#define GIMP_IS_PARAM_SPEC_UNIT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_UNIT))
</pre>
<p>
@ -615,7 +519,7 @@ href="../gobject/gobject-Type-Information.html#G-TYPE-INT:CAPS"
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>pspec</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>pspec</code></em>&#160;:</span></p></td>
<td>
@ -625,34 +529,18 @@ href="../gobject/gobject-Type-Information.html#G-TYPE-INT:CAPS"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610264"></a><h3>
<a name="id2627508"></a><h3>
<a name="gimp-param-spec-unit"></a>gimp_param_spec_unit ()</h3>
<a class="indexterm" name="id2610276"></a><pre class="programlisting"><a
href="../gobject/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a>* gimp_param_spec_unit (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *nick,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *blurb,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> allow_pixels,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> allow_percent,
<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> default_value,
<a
href="../gobject/gobject-GParamSpec.html#GParamFlags"
>GParamFlags</a> flags);</pre>
<a class="indexterm" name="id2627522"></a><pre class="programlisting">GParamSpec* gimp_param_spec_unit (const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean allow_pixels,
gboolean allow_percent,
<a class="link" href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> default_value,
GParamFlags flags);</pre>
<p>
Creates a param spec to hold a units param.
See <a
href="../gobject/gobject-GParamSpec.html#g-param-spec-internal"
><code class="function">g_param_spec_internal()</code></a> for more information.</p>
See <code class="function">g_param_spec_internal()</code> for more information.</p>
<p>
</p>
@ -660,47 +548,43 @@ href="../gobject/gobject-GParamSpec.html#g-param-spec-internal"
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> Canonical name of the param
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>nick</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>nick</code></em>&#160;:</span></p></td>
<td> Nickname of the param
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>blurb</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>blurb</code></em>&#160;:</span></p></td>
<td> Brief desciption of param.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>allow_pixels</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>allow_pixels</code></em>&#160;:</span></p></td>
<td> Whether "pixels" is an allowed unit.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>allow_percent</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>allow_percent</code></em>&#160;:</span></p></td>
<td> Whether "perecent" is an allowed unit.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>default_value</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>default_value</code></em>&#160;:</span></p></td>
<td> Unit to use if none is assigned.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td> a combination of <a
href="../gobject/gobject-GParamSpec.html#GParamFlags"
><span class="type">GParamFlags</span></a>
<td><p><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></p></td>
<td> a combination of <span class="type">GParamFlags</span>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a newly allocated <a
href="../gobject/gobject-GParamSpec.html#GParamSpec"
><span class="type">GParamSpec</span></a> instance
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> a newly allocated <span class="type">GParamSpec</span> instance
</td>
</tr>
@ -711,9 +595,9 @@ href="../gobject/gobject-GParamSpec.html#GParamSpec"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610477"></a><h3>
<a name="id2627743"></a><h3>
<a name="GIMP-VALUE-HOLDS-UNIT:CAPS"></a>GIMP_VALUE_HOLDS_UNIT()</h3>
<a class="indexterm" name="id2610487"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
<a class="indexterm" name="id2627754"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
</pre>
<p>
@ -721,7 +605,7 @@ href="../gobject/gobject-GParamSpec.html#GParamSpec"
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></p></td>
<td>
@ -731,15 +615,15 @@ href="../gobject/gobject-GParamSpec.html#GParamSpec"
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2610520"></a><h2>See Also</h2>
<a name="id2627791"></a><h2>See Also</h2>
<p>
<a
href="../libgimpwidgets/GimpUnitMenu.html"
href="/local/head/share/gtk-doc/html/libgimpwidgets/GimpUnitMenu.html"
><span class="type">GimpUnitMenu</span></a>
</p>
<p>
<a
href="../libgimpwidgets/GimpSizeEntry.html"
href="/local/head/share/gtk-doc/html/libgimpwidgets/GimpSizeEntry.html"
><span class="type">GimpSizeEntry</span></a>
</p>
</div>