callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.3.11

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:20:03 -04:00
parent efbc58ed09
commit 79785b4adf
1382 changed files with 88625 additions and 63323 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
devel-docs/libgimpbase/html/libgimpbase-gimpunit.html
View File

@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpunit</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
<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">
<link rel="next" href="libgimpbase-gimputils.html" title="gimputils">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<meta name="generator" content="GTK-Doc V1.7 (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">
@ -25,22 +25,24 @@
<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="#top_of_page" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2565666" class="shortcut">Top</a>
&#160;|&#160;
<a href="#desc" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2558450" 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"><a name="top_of_page"></a>gimpunit</span></h2>
<h2>
<a name="id2565666"></a><span class="refentrytitle">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">
<a name="synopsis"></a><h2>Synopsis</h2>
<h2>Synopsis</h2>
<pre class="synopsis">
@ -81,7 +83,7 @@ GParamSpec* <a href="libgimpbase-gimpunit.html#gimp-param-spec-unit">gimp_param_
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<a name="id2558450"></a><h2>Description</h2>
<p>
Provides a collection of predefined units and functions for creating
user-defined units.
@ -89,11 +91,11 @@ user-defined units.
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<a name="id2558467"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2536444"></a><h3>
<a name="id2558478"></a><h3>
<a name="GimpUnit"></a>enum GimpUnit</h3>
<a class="indexterm" name="id2536456"></a><pre class="programlisting">typedef enum /*&lt; skip &gt;*/
<a class="indexterm" name="id2558490"></a><pre class="programlisting">typedef enum /*&lt; skip &gt;*/
{
GIMP_UNIT_PIXEL = 0,
@ -113,9 +115,9 @@ user-defined units.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2536475"></a><h3>
<a name="id2558509"></a><h3>
<a name="gimp-unit-get-number-of-units"></a>gimp_unit_get_number_of_units ()</h3>
<a class="indexterm" name="id2536486"></a><pre class="programlisting">gint gimp_unit_get_number_of_units (void);</pre>
<a class="indexterm" name="id2558520"></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>
@ -133,9 +135,9 @@ Returns the number of units which are known to the <a href="libgimpbase-gimpunit
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2536533"></a><h3>
<a name="id2558568"></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="id2536545"></a><pre class="programlisting">gint gimp_unit_get_number_of_built_in_units
<a class="indexterm" name="id2558580"></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 +158,9 @@ Returns the number of <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2536595"></a><h3>
<a name="id2558630"></a><h3>
<a name="gimp-unit-new"></a>gimp_unit_new ()</h3>
<a class="indexterm" name="id2536608"></a><pre class="programlisting"><a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> gimp_unit_new (gchar *identifier,
<a class="indexterm" name="id2558642"></a><pre class="programlisting"><a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> gimp_unit_new (gchar *identifier,
gdouble factor,
gint digits,
gchar *symbol,
@ -231,9 +233,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="id2524077"></a><h3>
<a name="id2605476"></a><h3>
<a name="gimp-unit-get-deletion-flag"></a>gimp_unit_get_deletion_flag ()</h3>
<a class="indexterm" name="id2524089"></a><pre class="programlisting">gboolean gimp_unit_get_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2605487"></a><pre class="programlisting">gboolean gimp_unit_get_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
</p>
<p>
@ -259,9 +261,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="id2524161"></a><h3>
<a name="id2605559"></a><h3>
<a name="gimp-unit-set-deletion-flag"></a>gimp_unit_set_deletion_flag ()</h3>
<a class="indexterm" name="id2575100"></a><pre class="programlisting">void gimp_unit_set_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit,
<a class="indexterm" name="id2608693"></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
@ -294,9 +296,9 @@ ignored.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575204"></a><h3>
<a name="id2608797"></a><h3>
<a name="gimp-unit-get-factor"></a>gimp_unit_get_factor ()</h3>
<a class="indexterm" name="id2575215"></a><pre class="programlisting">gdouble gimp_unit_get_factor (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2608808"></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>
@ -328,9 +330,9 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575306"></a><h3>
<a name="id2608900"></a><h3>
<a name="gimp-unit-get-digits"></a>gimp_unit_get_digits ()</h3>
<a class="indexterm" name="id2575318"></a><pre class="programlisting">gint gimp_unit_get_digits (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2608911"></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.
@ -360,9 +362,9 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575390"></a><h3>
<a name="id2608960"></a><h3>
<a name="gimp-unit-get-identifier"></a>gimp_unit_get_identifier ()</h3>
<a class="indexterm" name="id2575401"></a><pre class="programlisting">const gchar* gimp_unit_get_identifier (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2608970"></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>
@ -388,9 +390,9 @@ This is an unstranslated string and must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575464"></a><h3>
<a name="id2609027"></a><h3>
<a name="gimp-unit-get-symbol"></a>gimp_unit_get_symbol ()</h3>
<a class="indexterm" name="id2575475"></a><pre class="programlisting">const gchar* gimp_unit_get_symbol (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2609037"></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>
@ -419,9 +421,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575541"></a><h3>
<a name="id2609097"></a><h3>
<a name="gimp-unit-get-abbreviation"></a>gimp_unit_get_abbreviation ()</h3>
<a class="indexterm" name="id2575553"></a><pre class="programlisting">const gchar* gimp_unit_get_abbreviation (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2609108"></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.
@ -451,9 +453,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575620"></a><h3>
<a name="id2609169"></a><h3>
<a name="gimp-unit-get-singular"></a>gimp_unit_get_singular ()</h3>
<a class="indexterm" name="id2575631"></a><pre class="programlisting">const gchar* gimp_unit_get_singular (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2609179"></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.
@ -483,9 +485,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575699"></a><h3>
<a name="id2609240"></a><h3>
<a name="gimp-unit-get-plural"></a>gimp_unit_get_plural ()</h3>
<a class="indexterm" name="id2575710"></a><pre class="programlisting">const gchar* gimp_unit_get_plural (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2609251"></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.
@ -515,9 +517,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575777"></a><h3>
<a name="id2609312"></a><h3>
<a name="GIMP-TYPE-UNIT:CAPS"></a>GIMP_TYPE_UNIT</h3>
<a class="indexterm" name="id2575789"></a><pre class="programlisting">#define GIMP_TYPE_UNIT (gimp_unit_get_type ())
<a class="indexterm" name="id2609322"></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>.
@ -525,9 +527,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575828"></a><h3>
<a name="id2609356"></a><h3>
<a name="GIMP-TYPE-PARAM-UNIT:CAPS"></a>GIMP_TYPE_PARAM_UNIT</h3>
<a class="indexterm" name="id2575839"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_UNIT (gimp_param_unit_get_type ())
<a class="indexterm" name="id2609366"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_UNIT (gimp_param_unit_get_type ())
</pre>
<p>
@ -535,9 +537,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575855"></a><h3>
<a name="id2609381"></a><h3>
<a name="GIMP-IS-PARAM-SPEC-UNIT:CAPS"></a>GIMP_IS_PARAM_SPEC_UNIT()</h3>
<a class="indexterm" name="id2575869"></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="id2609394"></a><pre class="programlisting">#define GIMP_IS_PARAM_SPEC_UNIT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_UNIT))
</pre>
<p>
@ -556,9 +558,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575904"></a><h3>
<a name="id2609426"></a><h3>
<a name="gimp-param-spec-unit"></a>gimp_param_spec_unit ()</h3>
<a class="indexterm" name="id2575918"></a><pre class="programlisting">GParamSpec* gimp_param_spec_unit (const gchar *name,
<a class="indexterm" name="id2609438"></a><pre class="programlisting">GParamSpec* gimp_param_spec_unit (const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean allow_pixels,
@ -630,9 +632,9 @@ See <code class="function">g_param_spec_internal()</code> for more information.<
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2576135"></a><h3>
<a name="id2609635"></a><h3>
<a name="GIMP-VALUE-HOLDS-UNIT:CAPS"></a>GIMP_VALUE_HOLDS_UNIT()</h3>
<a class="indexterm" name="id2576147"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
<a class="indexterm" name="id2609646"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
</pre>
<p>
@ -651,7 +653,7 @@ See <code class="function">g_param_spec_internal()</code> for more information.<
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2576184"></a><h2>See Also</h2>
<a name="id2609679"></a><h2>See Also</h2>
<p>
<a
href="../libgimpwidgets/GimpUnitMenu.html"