Imported Upstream version 2.3.13

This commit is contained in:
Ari Pollak
2010-08-11 01:20:31 -04:00
parent a028e0b309
commit bbd6d9844c
1225 changed files with 162390 additions and 93699 deletions

View File

@ -11,10 +11,10 @@
<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">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
<link rel="index" href="libgimpbase-index.html" title="Index">
<link rel="index" href="libgimpbase-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimpbase-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimpbase-index-deprecated.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
@ -25,16 +25,16 @@
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimprectangle.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="#id2502148" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2563750" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2553803" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2553876" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpmemsize"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2502148"></a><span class="refentrytitle">gimpmemsize</span>
<a name="id2563750"></a><span class="refentrytitle">gimpmemsize</span>
</h2>
<p>gimpmemsize &#8212; Functions to (de)serialize a given memory size.</p>
</td>
@ -65,17 +65,17 @@ GParamSpec* <a href="libgimpbase-gimpmemsize.html#gimp-param-spec-memsize">gimp_
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2553803"></a><h2>Description</h2>
<a name="id2553876"></a><h2>Description</h2>
<p>
Functions to (de)serialize a given memory size.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2553819"></a><h2>Details</h2>
<a name="id2553892"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2553830"></a><h3>
<a name="id2553903"></a><h3>
<a name="gimp-memsize-serialize"></a>gimp_memsize_serialize ()</h3>
<a class="indexterm" name="id2568308"></a><pre class="programlisting">gchar* gimp_memsize_serialize (guint64 memsize);</pre>
<a class="indexterm" name="id2550271"></a><pre class="programlisting">gchar* gimp_memsize_serialize (guint64 memsize);</pre>
<p>
Creates a string representation of a given memory size. This string
can be parsed by <a href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize"><code class="function">gimp_memsize_deserialize()</code></a> and can thus be used in
@ -88,14 +88,12 @@ nice human-readable string please use <a href="libgimpbase-gimpmemsize.html#gimp
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
<td> memory size in bytes
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A newly allocated string representation of <em class="parameter"><code>memsize</code></em>.
</td>
@ -107,9 +105,9 @@ nice human-readable string please use <a href="libgimpbase-gimpmemsize.html#gimp
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568399"></a><h3>
<a name="id2550362"></a><h3>
<a name="gimp-memsize-deserialize"></a>gimp_memsize_deserialize ()</h3>
<a class="indexterm" name="id2568413"></a><pre class="programlisting">gboolean gimp_memsize_deserialize (const gchar *string,
<a class="indexterm" name="id2550375"></a><pre class="programlisting">gboolean gimp_memsize_deserialize (const gchar *string,
guint64 *memsize);</pre>
<p>
Parses a string representation of a memory size as returned by
@ -121,20 +119,17 @@ Parses a string representation of a memory size as returned by
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>string</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>string</code></em>&#160;:</span></td>
<td> a string as returned by <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"><code class="function">gimp_memsize_serialize()</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
<td> return location for memory size in bytes
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>string</code></em> was successfully parsed and
<em class="parameter"><code>memsize</code></em> has been set, <code class="literal">FALSE</code> otherwise.
@ -147,9 +142,9 @@ Parses a string representation of a memory size as returned by
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2577510"></a><h3>
<a name="id2550680"></a><h3>
<a name="gimp-memsize-to-string"></a>gimp_memsize_to_string ()</h3>
<a class="indexterm" name="id2577521"></a><pre class="programlisting">gchar* gimp_memsize_to_string (guint64 memsize);</pre>
<a class="indexterm" name="id2550691"></a><pre class="programlisting">gchar* gimp_memsize_to_string (guint64 memsize);</pre>
<p>
This function returns a human readable, translated representation
of the passed <em class="parameter"><code>memsize</code></em>. Large values are displayed using a
@ -162,14 +157,12 @@ becomes "4.4 KB" and so on.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
<td> A memory size in bytes.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A newly allocated human-readable, translated string.
</td>
</tr>
@ -178,9 +171,9 @@ becomes "4.4 KB" and so on.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2577590"></a><h3>
<a name="id2550761"></a><h3>
<a name="GIMP-TYPE-MEMSIZE:CAPS"></a>GIMP_TYPE_MEMSIZE</h3>
<a class="indexterm" name="id2577602"></a><pre class="programlisting">#define GIMP_TYPE_MEMSIZE (gimp_memsize_get_type ())
<a class="indexterm" name="id2550772"></a><pre class="programlisting">#define GIMP_TYPE_MEMSIZE (gimp_memsize_get_type ())
</pre>
<p>
<a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS"><span class="type">GIMP_TYPE_MEMSIZE</span></a> is a <span class="type">GType</span> derived from <span class="type">G_TYPE_UINT64</span>.
@ -188,9 +181,9 @@ becomes "4.4 KB" and so on.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2577640"></a><h3>
<a name="id2550810"></a><h3>
<a name="GIMP-TYPE-PARAM-MEMSIZE:CAPS"></a>GIMP_TYPE_PARAM_MEMSIZE</h3>
<a class="indexterm" name="id2577651"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_MEMSIZE (gimp_param_memsize_get_type ())
<a class="indexterm" name="id2550822"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_MEMSIZE (gimp_param_memsize_get_type ())
</pre>
<p>
@ -198,9 +191,9 @@ becomes "4.4 KB" and so on.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2577668"></a><h3>
<a name="id2550838"></a><h3>
<a name="GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS"></a>GIMP_IS_PARAM_SPEC_MEMSIZE()</h3>
<a class="indexterm" name="id2558705"></a><pre class="programlisting">#define GIMP_IS_PARAM_SPEC_MEMSIZE(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_MEMSIZE))
<a class="indexterm" name="id2570631"></a><pre class="programlisting">#define GIMP_IS_PARAM_SPEC_MEMSIZE(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_MEMSIZE))
</pre>
<p>
@ -208,8 +201,7 @@ becomes "4.4 KB" and so on.</p>
<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><span class="term"><em class="parameter"><code>pspec</code></em>&#160;:</span></td>
<td>
@ -219,9 +211,9 @@ becomes "4.4 KB" and so on.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558741"></a><h3>
<a name="id2570667"></a><h3>
<a name="gimp-param-spec-memsize"></a>gimp_param_spec_memsize ()</h3>
<a class="indexterm" name="id2558755"></a><pre class="programlisting">GParamSpec* gimp_param_spec_memsize (const gchar *name,
<a class="indexterm" name="id2570680"></a><pre class="programlisting">GParamSpec* gimp_param_spec_memsize (const gchar *name,
const gchar *nick,
const gchar *blurb,
guint64 minimum,
@ -238,50 +230,42 @@ See <code class="function">g_param_spec_internal()</code> for more information.<
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></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><span class="term"><em class="parameter"><code>nick</code></em>&#160;:</span></td>
<td> Nickname of the param
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>blurb</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>blurb</code></em>&#160;:</span></td>
<td> Brief desciption of param.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>minimum</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>minimum</code></em>&#160;:</span></td>
<td> Smallest allowed value of the parameter.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>maximum</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>maximum</code></em>&#160;:</span></td>
<td> Largest allowed value of the parameter.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>default_value</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>default_value</code></em>&#160;:</span></td>
<td> Value to use if none is assigned.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></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><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a newly allocated <span class="type">GParamSpec</span> instance
</td>
@ -293,9 +277,9 @@ See <code class="function">g_param_spec_internal()</code> for more information.<
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558971"></a><h3>
<a name="id2570897"></a><h3>
<a name="GIMP-VALUE-HOLDS-MEMSIZE:CAPS"></a>GIMP_VALUE_HOLDS_MEMSIZE()</h3>
<a class="indexterm" name="id2595568"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))
<a class="indexterm" name="id2594990"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))
</pre>
<p>
@ -303,8 +287,7 @@ See <code class="function">g_param_spec_internal()</code> for more information.<
<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><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td>