Imported Upstream version 2.3.9

This commit is contained in:
Ari Pollak
2010-08-11 01:19:20 -04:00
parent 836308f327
commit 2a222e99d4
1588 changed files with 125210 additions and 92631 deletions

View File

@ -1,3 +1,4 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
@ -7,7 +8,7 @@
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpsignal.html" title="gimpsignal">
<link rel="next" href="libgimpbase-gimputils.html" title="gimputils">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
@ -16,25 +17,30 @@
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpsignal.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<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></table>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
&#160;|&#160;
<a href="#desc" 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><span class="refentrytitle">gimpunit</span></h2>
<h2><span class="refentrytitle"><a name="top_of_page"></a>gimpunit</span></h2>
<p>gimpunit &#8212; Provides a collection of predefined units and functions for creating
user-defined units.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
@ -75,7 +81,7 @@ GParamSpec* <a href="libgimpbase-gimpunit.html#gimp-param-spec-unit">gimp_param_
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2517214"></a><h2>Description</h2>
<a name="desc"></a><h2>Description</h2>
<p>
Provides a collection of predefined units and functions for creating
user-defined units.
@ -83,11 +89,11 @@ user-defined units.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2518095"></a><h2>Details</h2>
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2518102"></a><h3>
<a name="id2562859"></a><h3>
<a name="GimpUnit"></a>enum GimpUnit</h3>
<a class="indexterm" name="id2518111"></a><pre class="programlisting">typedef enum /*&lt; skip &gt;*/
<a class="indexterm" name="id2562871"></a><pre class="programlisting">typedef enum /*&lt; skip &gt;*/
{
GIMP_UNIT_PIXEL = 0,
@ -107,9 +113,9 @@ user-defined units.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2518131"></a><h3>
<a name="id2562890"></a><h3>
<a name="gimp-unit-get-number-of-units"></a>gimp_unit_get_number_of_units ()</h3>
<a class="indexterm" name="id2518140"></a><pre class="programlisting">gint gimp_unit_get_number_of_units (void);</pre>
<a class="indexterm" name="id2562901"></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>
@ -127,9 +133,9 @@ Returns the number of units which are known to the <a href="libgimpbase-gimpunit
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2518187"></a><h3>
<a name="id2562948"></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="id2518196"></a><pre class="programlisting">gint gimp_unit_get_number_of_built_in_units
<a class="indexterm" name="id2562960"></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
@ -150,9 +156,9 @@ Returns the number of <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2518246"></a><h3>
<a name="id2563010"></a><h3>
<a name="gimp-unit-new"></a>gimp_unit_new ()</h3>
<a class="indexterm" name="id2518256"></a><pre class="programlisting"><a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> gimp_unit_new (gchar *identifier,
<a class="indexterm" name="id2563022"></a><pre class="programlisting"><a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> gimp_unit_new (gchar *identifier,
gdouble factor,
gint digits,
gchar *symbol,
@ -225,9 +231,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="id2561734"></a><h3>
<a name="id2565320"></a><h3>
<a name="gimp-unit-get-deletion-flag"></a>gimp_unit_get_deletion_flag ()</h3>
<a class="indexterm" name="id2561744"></a><pre class="programlisting">gboolean gimp_unit_get_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2565332"></a><pre class="programlisting">gboolean gimp_unit_get_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
</p>
<p>
@ -253,9 +259,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="id2561817"></a><h3>
<a name="id2565404"></a><h3>
<a name="gimp-unit-set-deletion-flag"></a>gimp_unit_set_deletion_flag ()</h3>
<a class="indexterm" name="id2561826"></a><pre class="programlisting">void gimp_unit_set_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit,
<a class="indexterm" name="id2569907"></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
@ -288,9 +294,9 @@ ignored.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567137"></a><h3>
<a name="id2570011"></a><h3>
<a name="gimp-unit-get-factor"></a>gimp_unit_get_factor ()</h3>
<a class="indexterm" name="id2567145"></a><pre class="programlisting">gdouble gimp_unit_get_factor (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2570021"></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>
@ -322,9 +328,9 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567229"></a><h3>
<a name="id2570113"></a><h3>
<a name="gimp-unit-get-digits"></a>gimp_unit_get_digits ()</h3>
<a class="indexterm" name="id2567238"></a><pre class="programlisting">gint gimp_unit_get_digits (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2570124"></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.
@ -354,9 +360,9 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567311"></a><h3>
<a name="id2570196"></a><h3>
<a name="gimp-unit-get-identifier"></a>gimp_unit_get_identifier ()</h3>
<a class="indexterm" name="id2567320"></a><pre class="programlisting">const gchar* gimp_unit_get_identifier (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2570208"></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>
@ -382,9 +388,9 @@ This is an unstranslated string and must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567382"></a><h3>
<a name="id2570270"></a><h3>
<a name="gimp-unit-get-symbol"></a>gimp_unit_get_symbol ()</h3>
<a class="indexterm" name="id2567391"></a><pre class="programlisting">const gchar* gimp_unit_get_symbol (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2570281"></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>
@ -413,9 +419,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567457"></a><h3>
<a name="id2570347"></a><h3>
<a name="gimp-unit-get-abbreviation"></a>gimp_unit_get_abbreviation ()</h3>
<a class="indexterm" name="id2567467"></a><pre class="programlisting">const gchar* gimp_unit_get_abbreviation (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2570359"></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.
@ -445,9 +451,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567534"></a><h3>
<a name="id2570426"></a><h3>
<a name="gimp-unit-get-singular"></a>gimp_unit_get_singular ()</h3>
<a class="indexterm" name="id2567543"></a><pre class="programlisting">const gchar* gimp_unit_get_singular (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2570438"></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.
@ -477,9 +483,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567610"></a><h3>
<a name="id2570505"></a><h3>
<a name="gimp-unit-get-plural"></a>gimp_unit_get_plural ()</h3>
<a class="indexterm" name="id2567619"></a><pre class="programlisting">const gchar* gimp_unit_get_plural (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2570516"></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.
@ -509,9 +515,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567686"></a><h3>
<a name="id2570583"></a><h3>
<a name="GIMP-TYPE-UNIT:CAPS"></a>GIMP_TYPE_UNIT</h3>
<a class="indexterm" name="id2567696"></a><pre class="programlisting">#define GIMP_TYPE_UNIT (gimp_unit_get_type ())
<a class="indexterm" name="id2570596"></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>.
@ -519,9 +525,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567735"></a><h3>
<a name="id2570634"></a><h3>
<a name="GIMP-TYPE-PARAM-UNIT:CAPS"></a>GIMP_TYPE_PARAM_UNIT</h3>
<a class="indexterm" name="id2567744"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_UNIT (gimp_param_unit_get_type ())
<a class="indexterm" name="id2570645"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_UNIT (gimp_param_unit_get_type ())
</pre>
<p>
@ -529,9 +535,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567760"></a><h3>
<a name="id2570662"></a><h3>
<a name="GIMP-IS-PARAM-SPEC-UNIT:CAPS"></a>GIMP_IS_PARAM_SPEC_UNIT()</h3>
<a class="indexterm" name="id2567771"></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="id2570675"></a><pre class="programlisting">#define GIMP_IS_PARAM_SPEC_UNIT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_UNIT))
</pre>
<p>
@ -550,9 +556,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567807"></a><h3>
<a name="id2570711"></a><h3>
<a name="gimp-param-spec-unit"></a>gimp_param_spec_unit ()</h3>
<a class="indexterm" name="id2567816"></a><pre class="programlisting">GParamSpec* gimp_param_spec_unit (const gchar *name,
<a class="indexterm" name="id2570724"></a><pre class="programlisting">GParamSpec* gimp_param_spec_unit (const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean allow_pixels,
@ -624,9 +630,9 @@ See <code class="function">g_param_spec_internal()</code> for more information.<
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568033"></a><h3>
<a name="id2570942"></a><h3>
<a name="GIMP-VALUE-HOLDS-UNIT:CAPS"></a>GIMP_VALUE_HOLDS_UNIT()</h3>
<a class="indexterm" name="id2568042"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
<a class="indexterm" name="id2570953"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
</pre>
<p>
@ -645,7 +651,7 @@ See <code class="function">g_param_spec_internal()</code> for more information.<
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2568079"></a><h2>See Also</h2>
<a name="id2570990"></a><h2>See Also</h2>
<p>
<a
href="../libgimpwidgets/GimpUnitMenu.html"
@ -658,9 +664,5 @@ href="../libgimpwidgets/GimpSizeEntry.html"
</p>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimpsignal.html"><b>&lt;&lt;&#160;gimpsignal</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimputils.html"><b>gimputils&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>