Imported Upstream version 2.3.16

This commit is contained in:
Ari Pollak
2010-08-11 01:21:23 -04:00
parent d694295a3e
commit 2e1d89b96f
944 changed files with 103935 additions and 69090 deletions

View File

@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimputils</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<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-gimpunit.html" title="gimpunit">
<link rel="next" href="libgimpbase-index.html" title="Index">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<meta name="generator" content="GTK-Doc V1.8 (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="libgimpbase-index.html" title="Index">
@ -25,16 +25,16 @@
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-index.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="#id2564641" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2586401" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2569408" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2608749" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimputils"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2564641"></a><span class="refentrytitle">gimputils</span>
<a name="id2586401"></a><span class="refentrytitle">gimputils</span>
</h2>
<p>gimputils &#8212; Utilities of general interest</p>
</td>
@ -46,57 +46,57 @@
gchar* <a href="libgimpbase-gimputils.html#gimp-any-to-utf8">gimp_any_to_utf8</a> (const gchar *str,
gssize len,
const gchar *warning_format,
...);
const gchar* <a href="libgimpbase-gimputils.html#gimp-filename-to-utf8">gimp_filename_to_utf8</a> (const gchar *filename);
gchar* <a href="libgimpbase-gimputils.html#gimp-utf8-strtrim">gimp_utf8_strtrim</a> (const gchar *str,
gint max_chars);
gchar* <a href="libgimpbase-gimputils.html#gimp-escape-uline">gimp_escape_uline</a> (const gchar *str);
gchar* <a href="libgimpbase-gimputils.html#gimp-strip-uline">gimp_strip_uline</a> (const gchar *str);
gchar* <a href="libgimpbase-gimputils.html#gimp-canonicalize-identifier">gimp_canonicalize_identifier</a> (const gchar *identifier);
<a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* <a href="libgimpbase-gimputils.html#gimp-enum-get-desc">gimp_enum_get_desc</a> (GEnumClass *enum_class,
gint value);
gboolean <a href="libgimpbase-gimputils.html#gimp-enum-get-value">gimp_enum_get_value</a> (GType enum_type,
gint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);
const gchar* <a href="libgimpbase-gimputils.html#gimp-enum-value-get-desc">gimp_enum_value_get_desc</a> (GEnumClass *enum_class,
GEnumValue *enum_value);
const gchar* <a href="libgimpbase-gimputils.html#gimp-enum-value-get-help">gimp_enum_value_get_help</a> (GEnumClass *enum_class,
GEnumValue *enum_value);
<a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* <a href="libgimpbase-gimputils.html#gimp-flags-get-first-desc">gimp_flags_get_first_desc</a> (GFlagsClass *flags_class,
guint value);
gboolean <a href="libgimpbase-gimputils.html#gimp-flags-get-first-value">gimp_flags_get_first_value</a> (GType flags_type,
guint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);
const gchar* <a href="libgimpbase-gimputils.html#gimp-flags-value-get-desc">gimp_flags_value_get_desc</a> (GFlagsClass *flags_class,
GFlagsValue *flags_value);
const gchar* <a href="libgimpbase-gimputils.html#gimp-flags-value-get-help">gimp_flags_value_get_help</a> (GFlagsClass *flags_class,
GFlagsValue *flags_value);
gchar* <a href="libgimpbase-gimputils.html#gimp-any-to-utf8">gimp_any_to_utf8</a> (const gchar *str,
gssize len,
const gchar *warning_format,
...);
const gchar* <a href="libgimpbase-gimputils.html#gimp-filename-to-utf8">gimp_filename_to_utf8</a> (const gchar *filename);
gchar* <a href="libgimpbase-gimputils.html#gimp-utf8-strtrim">gimp_utf8_strtrim</a> (const gchar *str,
gint max_chars);
gchar* <a href="libgimpbase-gimputils.html#gimp-escape-uline">gimp_escape_uline</a> (const gchar *str);
gchar* <a href="libgimpbase-gimputils.html#gimp-strip-uline">gimp_strip_uline</a> (const gchar *str);
gchar* <a href="libgimpbase-gimputils.html#gimp-canonicalize-identifier">gimp_canonicalize_identifier</a> (const gchar *identifier);
<a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* <a href="libgimpbase-gimputils.html#gimp-enum-get-desc">gimp_enum_get_desc</a> (GEnumClass *enum_class,
gint value);
gboolean <a href="libgimpbase-gimputils.html#gimp-enum-get-value">gimp_enum_get_value</a> (GType enum_type,
gint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);
const gchar* <a href="libgimpbase-gimputils.html#gimp-enum-value-get-desc">gimp_enum_value_get_desc</a> (GEnumClass *enum_class,
GEnumValue *enum_value);
const gchar* <a href="libgimpbase-gimputils.html#gimp-enum-value-get-help">gimp_enum_value_get_help</a> (GEnumClass *enum_class,
GEnumValue *enum_value);
<a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* <a href="libgimpbase-gimputils.html#gimp-flags-get-first-desc">gimp_flags_get_first_desc</a> (GFlagsClass *flags_class,
guint value);
gboolean <a href="libgimpbase-gimputils.html#gimp-flags-get-first-value">gimp_flags_get_first_value</a> (GType flags_type,
guint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);
const gchar* <a href="libgimpbase-gimputils.html#gimp-flags-value-get-desc">gimp_flags_value_get_desc</a> (GFlagsClass *flags_class,
GFlagsValue *flags_value);
const gchar* <a href="libgimpbase-gimputils.html#gimp-flags-value-get-help">gimp_flags_value_get_help</a> (GFlagsClass *flags_class,
GFlagsValue *flags_value);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2569408"></a><h2>Description</h2>
<a name="id2608749"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2569424"></a><h2>Details</h2>
<a name="id2608764"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2569434"></a><h3>
<a name="id2608775"></a><h3>
<a name="gimp-any-to-utf8"></a>gimp_any_to_utf8 ()</h3>
<a class="indexterm" name="id2569447"></a><pre class="programlisting">gchar* gimp_any_to_utf8 (const gchar *str,
gssize len,
const gchar *warning_format,
...);</pre>
<a class="indexterm" name="id2608788"></a><pre class="programlisting">gchar* gimp_any_to_utf8 (const gchar *str,
gssize len,
const gchar *warning_format,
...);</pre>
<p>
This function takes any string (UTF-8 or not) and always returns a valid
UTF-8 string.
@ -151,9 +151,9 @@ of <em class="parameter"><code>str</code></em> is valid UTF-8, only "(invalid UT
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2596081"></a><h3>
<a name="id2607404"></a><h3>
<a name="gimp-filename-to-utf8"></a>gimp_filename_to_utf8 ()</h3>
<a class="indexterm" name="id2596092"></a><pre class="programlisting">const gchar* gimp_filename_to_utf8 (const gchar *filename);</pre>
<a class="indexterm" name="id2607416"></a><pre class="programlisting">const gchar* gimp_filename_to_utf8 (const gchar *filename);</pre>
<p>
Convert a filename in the filesystem's encoding to UTF-8
temporarily. The return value is a pointer to a string that is
@ -186,10 +186,10 @@ UTF-8 encoded filename.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2596179"></a><h3>
<a name="id2607503"></a><h3>
<a name="gimp-utf8-strtrim"></a>gimp_utf8_strtrim ()</h3>
<a class="indexterm" name="id2596191"></a><pre class="programlisting">gchar* gimp_utf8_strtrim (const gchar *str,
gint max_chars);</pre>
<a class="indexterm" name="id2607516"></a><pre class="programlisting">gchar* gimp_utf8_strtrim (const gchar *str,
gint max_chars);</pre>
<p>
Creates a (possibly trimmed) copy of <em class="parameter"><code>str</code></em>. The string is cut if it
exceeds <em class="parameter"><code>max_chars</code></em> characters or on the first newline. The fact
@ -222,9 +222,9 @@ using <code class="function">g_free()</code> when it is not needed any longer.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2596311"></a><h3>
<a name="id2607635"></a><h3>
<a name="gimp-escape-uline"></a>gimp_escape_uline ()</h3>
<a class="indexterm" name="id2596325"></a><pre class="programlisting">gchar* gimp_escape_uline (const gchar *str);</pre>
<a class="indexterm" name="id2607649"></a><pre class="programlisting">gchar* gimp_escape_uline (const gchar *str);</pre>
<p>
This function returns a copy of <em class="parameter"><code>str</code></em> with all underline converted
to two adjacent underlines. This comes in handy when needing to display
@ -250,14 +250,14 @@ freed using <code class="function">g_free()</code> when it is not needed any lon
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603625"></a><h3>
<a name="id2612054"></a><h3>
<a name="gimp-strip-uline"></a>gimp_strip_uline ()</h3>
<a class="indexterm" name="id2603635"></a><pre class="programlisting">gchar* gimp_strip_uline (const gchar *str);</pre>
<a class="indexterm" name="id2612064"></a><pre class="programlisting">gchar* gimp_strip_uline (const gchar *str);</pre>
<p>
This function returns a copy of <em class="parameter"><code>str</code></em> stripped of underline
characters. This comes in handy when needing to strip mnemonics
@ -290,9 +290,9 @@ rid of the mnemonic (see bug <span class="type">157561</span>).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603739"></a><h3>
<a name="id2612168"></a><h3>
<a name="gimp-canonicalize-identifier"></a>gimp_canonicalize_identifier ()</h3>
<a class="indexterm" name="id2603754"></a><pre class="programlisting">gchar* gimp_canonicalize_identifier (const gchar *identifier);</pre>
<a class="indexterm" name="id2612184"></a><pre class="programlisting">gchar* gimp_canonicalize_identifier (const gchar *identifier);</pre>
<p>
Turns any input string into a canonicalized string.
</p>
@ -321,15 +321,15 @@ not either '-', 'a-z', 'A-Z' or '0-9' will be replaced by a '-'.</p>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.4
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603840"></a><h3>
<a name="id2612271"></a><h3>
<a name="gimp-enum-get-desc"></a>gimp_enum_get_desc ()</h3>
<a class="indexterm" name="id2603854"></a><pre class="programlisting"><a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* gimp_enum_get_desc (GEnumClass *enum_class,
gint value);</pre>
<a class="indexterm" name="id2612286"></a><pre class="programlisting"><a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* gimp_enum_get_desc (GEnumClass *enum_class,
gint value);</pre>
<p>
Retrieves <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> associated with the given value, or <code class="literal">NULL</code>.</p>
<p>
@ -356,19 +356,19 @@ Retrieves <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="typ
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603978"></a><h3>
<a name="id2612412"></a><h3>
<a name="gimp-enum-get-value"></a>gimp_enum_get_value ()</h3>
<a class="indexterm" name="id2603992"></a><pre class="programlisting">gboolean gimp_enum_get_value (GType enum_type,
gint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);</pre>
<a class="indexterm" name="id2612427"></a><pre class="programlisting">gboolean gimp_enum_get_value (GType enum_type,
gint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);</pre>
<p>
Checks if <em class="parameter"><code>value</code></em> is valid for the enum registered as <em class="parameter"><code>enum_type</code></em>.
If the value exists in that enum, its name, nick and its translated
@ -419,15 +419,15 @@ and <em class="parameter"><code>value_help</code></em> are not <code class="lite
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604288"></a><h3>
<a name="id2612727"></a><h3>
<a name="gimp-enum-value-get-desc"></a>gimp_enum_value_get_desc ()</h3>
<a class="indexterm" name="id2604302"></a><pre class="programlisting">const gchar* gimp_enum_value_get_desc (GEnumClass *enum_class,
GEnumValue *enum_value);</pre>
<a class="indexterm" name="id2612740"></a><pre class="programlisting">const gchar* gimp_enum_value_get_desc (GEnumClass *enum_class,
GEnumValue *enum_value);</pre>
<p>
Retrieves the translated desc for a given <em class="parameter"><code>enum_value</code></em>.</p>
<p>
@ -454,15 +454,15 @@ Retrieves the translated desc for a given <em class="parameter"><code>enum_value
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604387"></a><h3>
<a name="id2612857"></a><h3>
<a name="gimp-enum-value-get-help"></a>gimp_enum_value_get_help ()</h3>
<a class="indexterm" name="id2604399"></a><pre class="programlisting">const gchar* gimp_enum_value_get_help (GEnumClass *enum_class,
GEnumValue *enum_value);</pre>
<a class="indexterm" name="id2612871"></a><pre class="programlisting">const gchar* gimp_enum_value_get_help (GEnumClass *enum_class,
GEnumValue *enum_value);</pre>
<p>
Retrieves the translated help for a given <em class="parameter"><code>enum_value</code></em>.</p>
<p>
@ -489,15 +489,15 @@ Retrieves the translated help for a given <em class="parameter"><code>enum_value
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604501"></a><h3>
<a name="id2612988"></a><h3>
<a name="gimp-flags-get-first-desc"></a>gimp_flags_get_first_desc ()</h3>
<a class="indexterm" name="id2604514"></a><pre class="programlisting"><a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* gimp_flags_get_first_desc (GFlagsClass *flags_class,
guint value);</pre>
<a class="indexterm" name="id2613002"></a><pre class="programlisting"><a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* gimp_flags_get_first_desc (GFlagsClass *flags_class,
guint value);</pre>
<p>
Retrieves the first <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> that matches the given value, or <code class="literal">NULL</code>.</p>
<p>
@ -524,19 +524,19 @@ Retrieves the first <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604623"></a><h3>
<a name="id2613128"></a><h3>
<a name="gimp-flags-get-first-value"></a>gimp_flags_get_first_value ()</h3>
<a class="indexterm" name="id2604636"></a><pre class="programlisting">gboolean gimp_flags_get_first_value (GType flags_type,
guint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);</pre>
<a class="indexterm" name="id2613142"></a><pre class="programlisting">gboolean gimp_flags_get_first_value (GType flags_type,
guint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);</pre>
<p>
Checks if <em class="parameter"><code>value</code></em> is valid for the flags registered as <em class="parameter"><code>flags_type</code></em>.
If the value exists in that flags, its name, nick and its translated
@ -587,15 +587,15 @@ and <em class="parameter"><code>value_help</code></em> are not <code class="lite
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604901"></a><h3>
<a name="id2613442"></a><h3>
<a name="gimp-flags-value-get-desc"></a>gimp_flags_value_get_desc ()</h3>
<a class="indexterm" name="id2604914"></a><pre class="programlisting">const gchar* gimp_flags_value_get_desc (GFlagsClass *flags_class,
GFlagsValue *flags_value);</pre>
<a class="indexterm" name="id2613456"></a><pre class="programlisting">const gchar* gimp_flags_value_get_desc (GFlagsClass *flags_class,
GFlagsValue *flags_value);</pre>
<p>
Retrieves the translated desc for a given <em class="parameter"><code>flags_value</code></em>.</p>
<p>
@ -622,15 +622,15 @@ Retrieves the translated desc for a given <em class="parameter"><code>flags_valu
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605016"></a><h3>
<a name="id2613573"></a><h3>
<a name="gimp-flags-value-get-help"></a>gimp_flags_value_get_help ()</h3>
<a class="indexterm" name="id2605029"></a><pre class="programlisting">const gchar* gimp_flags_value_get_help (GFlagsClass *flags_class,
GFlagsValue *flags_value);</pre>
<a class="indexterm" name="id2613587"></a><pre class="programlisting">const gchar* gimp_flags_value_get_help (GFlagsClass *flags_class,
GFlagsValue *flags_value);</pre>
<p>
Retrieves the translated help for a given <em class="parameter"><code>flags_value</code></em>.</p>
<p>
@ -657,7 +657,7 @@ Retrieves the translated help for a given <em class="parameter"><code>flags_valu
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
</div>