Imported Upstream version 2.4.0~rc3

This commit is contained in:
Ari Pollak
2010-08-11 01:23:08 -04:00
parent 4be5597e32
commit f35d8506c6
668 changed files with 59324 additions and 37769 deletions

View File

@ -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="#id2581976" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2604865" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2626244" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2593227" 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="id2581976"></a><span class="refentrytitle">gimputils</span>
<a name="id2604865"></a><span class="refentrytitle">gimputils</span>
</h2>
<p>gimputils &#8212; Utilities of general interest</p>
</td>
@ -46,56 +46,154 @@
gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-any-to-utf8">gimp_any_to_utf8</a> (const gchar *str,
gssize len,
const gchar *warning_format,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-any-to-utf8">gimp_any_to_utf8</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *str,
<a
href="../glib/glib-Basic-Types.html#gssize"
>gssize</a> len,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *warning_format,
...);
const gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-filename-to-utf8">gimp_filename_to_utf8</a> (const gchar *filename);
gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-utf8-strtrim">gimp_utf8_strtrim</a> (const gchar *str,
gint max_chars);
gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-escape-uline">gimp_escape_uline</a> (const gchar *str);
gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-strip-uline">gimp_strip_uline</a> (const gchar *str);
gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-canonicalize-identifier">gimp_canonicalize_identifier</a> (const gchar *identifier);
<a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-enum-get-desc">gimp_enum_get_desc</a> (GEnumClass *enum_class,
gint value);
gboolean <a class="link" 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 class="link" href="libgimpbase-gimputils.html#gimp-enum-value-get-desc">gimp_enum_value_get_desc</a> (GEnumClass *enum_class,
GEnumValue *enum_value);
const gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-enum-value-get-help">gimp_enum_value_get_help</a> (GEnumClass *enum_class,
GEnumValue *enum_value);
<a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-flags-get-first-desc">gimp_flags_get_first_desc</a> (GFlagsClass *flags_class,
guint value);
gboolean <a class="link" 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 class="link" href="libgimpbase-gimputils.html#gimp-flags-value-get-desc">gimp_flags_value_get_desc</a> (GFlagsClass *flags_class,
GFlagsValue *flags_value);
const gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-flags-value-get-help">gimp_flags_value_get_help</a> (GFlagsClass *flags_class,
GFlagsValue *flags_value);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-filename-to-utf8">gimp_filename_to_utf8</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filename);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-utf8-strtrim">gimp_utf8_strtrim</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *str,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> max_chars);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-escape-uline">gimp_escape_uline</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *str);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-strip-uline">gimp_strip_uline</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *str);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-canonicalize-identifier">gimp_canonicalize_identifier</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *identifier);
<a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-enum-get-desc">gimp_enum_get_desc</a> (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
>GEnumClass</a> *enum_class,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> value);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimpbase-gimputils.html#gimp-enum-get-value">gimp_enum_get_value</a> (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> enum_type,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> value,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_nick,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_desc,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_help);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-enum-value-get-desc">gimp_enum_value_get_desc</a> (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
>GEnumClass</a> *enum_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
>GEnumValue</a> *enum_value);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-enum-value-get-help">gimp_enum_value_get_help</a> (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
>GEnumClass</a> *enum_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
>GEnumValue</a> *enum_value);
<a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-flags-get-first-desc">gimp_flags_get_first_desc</a> (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
>GFlagsClass</a> *flags_class,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> value);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimpbase-gimputils.html#gimp-flags-get-first-value">gimp_flags_get_first_value</a> (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> flags_type,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> value,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_nick,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_desc,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_help);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-flags-value-get-desc">gimp_flags_value_get_desc</a> (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
>GFlagsClass</a> *flags_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
>GFlagsValue</a> *flags_value);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-flags-value-get-help">gimp_flags_value_get_help</a> (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
>GFlagsClass</a> *flags_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
>GFlagsValue</a> *flags_value);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2626244"></a><h2>Description</h2>
<a name="id2593227"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2626260"></a><h2>Details</h2>
<a name="id2593242"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2626271"></a><h3>
<a name="id2593253"></a><h3>
<a name="gimp-any-to-utf8"></a>gimp_any_to_utf8 ()</h3>
<a class="indexterm" name="id2626283"></a><pre class="programlisting">gchar* gimp_any_to_utf8 (const gchar *str,
gssize len,
const gchar *warning_format,
<a class="indexterm" name="id2593266"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_any_to_utf8 (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *str,
<a
href="../glib/glib-Basic-Types.html#gssize"
>gssize</a> len,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *warning_format,
...);</pre>
<p>
This function takes any string (UTF-8 or not) and always returns a valid
@ -105,7 +203,9 @@ UTF-8 string.
If <em class="parameter"><code>str</code></em> is valid UTF-8, a copy of the string is returned.
</p>
<p>
If UTF-8 validation fails, <code class="function">g_locale_to_utf8()</code> is tried and if it
If UTF-8 validation fails, <a
href="../glib/glib-Character-Set-Conversion.html#g-locale-to-utf8"
><code class="function">g_locale_to_utf8()</code></a> is tried and if it
succeeds the resulting string is returned.
</p>
<p>
@ -151,9 +251,13 @@ of <em class="parameter"><code>str</code></em> is valid UTF-8, only "(invalid UT
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623336"></a><h3>
<a name="id2621912"></a><h3>
<a name="gimp-filename-to-utf8"></a>gimp_filename_to_utf8 ()</h3>
<a class="indexterm" name="id2623346"></a><pre class="programlisting">const gchar* gimp_filename_to_utf8 (const gchar *filename);</pre>
<a class="indexterm" name="id2621923"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_filename_to_utf8 (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *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 +290,16 @@ UTF-8 encoded filename.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623434"></a><h3>
<a name="id2622010"></a><h3>
<a name="gimp-utf8-strtrim"></a>gimp_utf8_strtrim ()</h3>
<a class="indexterm" name="id2623446"></a><pre class="programlisting">gchar* gimp_utf8_strtrim (const gchar *str,
gint max_chars);</pre>
<a class="indexterm" name="id2622023"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_utf8_strtrim (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *str,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> 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
@ -202,7 +312,9 @@ that the string was trimmed is indicated by appending an ellipsis.</p>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></p></td>
<td> an UTF-8 encoded string (or <code class="literal">NULL</code>)
<td> an UTF-8 encoded string (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
<tr>
@ -214,7 +326,9 @@ trimmed
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> A (possibly trimmed) copy of <em class="parameter"><code>str</code></em> which should be freed
using <code class="function">g_free()</code> when it is not needed any longer.
using <a
href="../glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a> when it is not needed any longer.
</td>
</tr>
</tbody>
@ -222,9 +336,13 @@ using <code class="function">g_free()</code> when it is not needed any longer.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623565"></a><h3>
<a name="id2622142"></a><h3>
<a name="gimp-escape-uline"></a>gimp_escape_uline ()</h3>
<a class="indexterm" name="id2623580"></a><pre class="programlisting">gchar* gimp_escape_uline (const gchar *str);</pre>
<a class="indexterm" name="id2622156"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_escape_uline (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *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
@ -238,13 +356,17 @@ them to mnemonics.</p>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></p></td>
<td> Underline infested string (or <code class="literal">NULL</code>)
<td> Underline infested string (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> A (possibly escaped) copy of <em class="parameter"><code>str</code></em> which should be
freed using <code class="function">g_free()</code> when it is not needed any longer.
freed using <a
href="../glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a> when it is not needed any longer.
</td>
</tr>
@ -255,9 +377,13 @@ freed using <code class="function">g_free()</code> when it is not needed any lon
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629534"></a><h3>
<a name="id2629516"></a><h3>
<a name="gimp-strip-uline"></a>gimp_strip_uline ()</h3>
<a class="indexterm" name="id2629544"></a><pre class="programlisting">gchar* gimp_strip_uline (const gchar *str);</pre>
<a class="indexterm" name="id2629526"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_strip_uline (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *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
@ -276,13 +402,17 @@ rid of the mnemonic (see bug <span class="type">157561</span>).</p>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></p></td>
<td> underline infested string (or <code class="literal">NULL</code>)
<td> underline infested string (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> A (possibly stripped) copy of <em class="parameter"><code>str</code></em> which should be
freed using <code class="function">g_free()</code> when it is not needed any longer.
freed using <a
href="../glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a> when it is not needed any longer.
</td>
</tr>
</tbody>
@ -290,9 +420,13 @@ rid of the mnemonic (see bug <span class="type">157561</span>).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629650"></a><h3>
<a name="id2629627"></a><h3>
<a name="gimp-canonicalize-identifier"></a>gimp_canonicalize_identifier ()</h3>
<a class="indexterm" name="id2629665"></a><pre class="programlisting">gchar* gimp_canonicalize_identifier (const gchar *identifier);</pre>
<a class="indexterm" name="id2629643"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_canonicalize_identifier (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *identifier);</pre>
<p>
Turns any input string into a canonicalized string.
</p>
@ -314,7 +448,9 @@ not either '-', 'a-z', 'A-Z' or '0-9' will be replaced by a '-'.</p>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The canonicalized identifier. This is a newly
allocated string that should be freed with <code class="function">g_free()</code>
allocated string that should be freed with <a
href="../glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a>
when no longer needed.
</td>
@ -326,12 +462,18 @@ not either '-', 'a-z', 'A-Z' or '0-9' will be replaced by a '-'.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629753"></a><h3>
<a name="id2629731"></a><h3>
<a name="gimp-enum-get-desc"></a>gimp_enum_get_desc ()</h3>
<a class="indexterm" name="id2629767"></a><pre class="programlisting"><a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* gimp_enum_get_desc (GEnumClass *enum_class,
gint value);</pre>
<a class="indexterm" name="id2629745"></a><pre class="programlisting"><a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* gimp_enum_get_desc (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
>GEnumClass</a> *enum_class,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> value);</pre>
<p>
Retrieves <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> associated with the given value, or <code class="literal">NULL</code>.</p>
Retrieves <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> associated with the given value, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>.</p>
<p>
</p>
@ -340,7 +482,9 @@ Retrieves <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><sp
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_class</code></em>&#160;:</span></p></td>
<td> a <span class="type">GEnumClass</span>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
><span class="type">GEnumClass</span></a>
</td>
</tr>
<tr>
@ -361,19 +505,35 @@ Retrieves <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><sp
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629894"></a><h3>
<a name="id2629872"></a><h3>
<a name="gimp-enum-get-value"></a>gimp_enum_get_value ()</h3>
<a class="indexterm" name="id2629908"></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="id2629886"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_enum_get_value (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> enum_type,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> value,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_nick,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_desc,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **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
desc and help are returned (if <em class="parameter"><code>value_name</code></em>, <em class="parameter"><code>value_nick</code></em>, <em class="parameter"><code>value_desc</code></em>
and <em class="parameter"><code>value_help</code></em> are not <code class="literal">NULL</code>).</p>
and <em class="parameter"><code>value_help</code></em> are not <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>).</p>
<p>
</p>
@ -382,7 +542,9 @@ and <em class="parameter"><code>value_help</code></em> are not <code class="lite
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></p></td>
<td> the <span class="type">GType</span> of a registered enum
<td> the <a
href="../gobject/gobject-Type-Information.html#GType"
><span class="type">GType</span></a> of a registered enum
</td>
</tr>
<tr>
@ -392,28 +554,40 @@ and <em class="parameter"><code>value_help</code></em> are not <code class="lite
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value_name</code></em>&#160;:</span></p></td>
<td> return location for the value's name (or <code class="literal">NULL</code>)
<td> return location for the value's name (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value_nick</code></em>&#160;:</span></p></td>
<td> return location for the value's nick (or <code class="literal">NULL</code>)
<td> return location for the value's nick (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value_desc</code></em>&#160;:</span></p></td>
<td> return location for the value's translated desc (or <code class="literal">NULL</code>)
<td> return location for the value's translated desc (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value_help</code></em>&#160;:</span></p></td>
<td> return location for the value's translated help (or <code class="literal">NULL</code>)
<td> return location for the value's translated help (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>value</code></em> is valid for the <em class="parameter"><code>enum_type</code></em>,
<code class="literal">FALSE</code> otherwise
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if <em class="parameter"><code>value</code></em> is valid for the <em class="parameter"><code>enum_type</code></em>,
<a
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise
</td>
</tr>
@ -424,10 +598,16 @@ and <em class="parameter"><code>value_help</code></em> are not <code class="lite
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630208"></a><h3>
<a name="id2630158"></a><h3>
<a name="gimp-enum-value-get-desc"></a>gimp_enum_value_get_desc ()</h3>
<a class="indexterm" name="id2630222"></a><pre class="programlisting">const gchar* gimp_enum_value_get_desc (GEnumClass *enum_class,
GEnumValue *enum_value);</pre>
<a class="indexterm" name="id2630170"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_enum_value_get_desc (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
>GEnumClass</a> *enum_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
>GEnumValue</a> *enum_value);</pre>
<p>
Retrieves the translated desc for a given <em class="parameter"><code>enum_value</code></em>.</p>
<p>
@ -438,12 +618,16 @@ Retrieves the translated desc for a given <em class="parameter"><code>enum_value
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_class</code></em>&#160;:</span></p></td>
<td> a <span class="type">GEnumClass</span>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
><span class="type">GEnumClass</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_value</code></em>&#160;:</span></p></td>
<td> a <span class="type">GEnumValue</span> from <em class="parameter"><code>enum_class</code></em>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
><span class="type">GEnumValue</span></a> from <em class="parameter"><code>enum_class</code></em>
</td>
</tr>
<tr>
@ -459,10 +643,16 @@ Retrieves the translated desc for a given <em class="parameter"><code>enum_value
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630339"></a><h3>
<a name="id2630274"></a><h3>
<a name="gimp-enum-value-get-help"></a>gimp_enum_value_get_help ()</h3>
<a class="indexterm" name="id2630352"></a><pre class="programlisting">const gchar* gimp_enum_value_get_help (GEnumClass *enum_class,
GEnumValue *enum_value);</pre>
<a class="indexterm" name="id2630287"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_enum_value_get_help (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
>GEnumClass</a> *enum_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
>GEnumValue</a> *enum_value);</pre>
<p>
Retrieves the translated help for a given <em class="parameter"><code>enum_value</code></em>.</p>
<p>
@ -473,12 +663,16 @@ Retrieves the translated help for a given <em class="parameter"><code>enum_value
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_class</code></em>&#160;:</span></p></td>
<td> a <span class="type">GEnumClass</span>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
><span class="type">GEnumClass</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_value</code></em>&#160;:</span></p></td>
<td> a <span class="type">GEnumValue</span> from <em class="parameter"><code>enum_class</code></em>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
><span class="type">GEnumValue</span></a> from <em class="parameter"><code>enum_class</code></em>
</td>
</tr>
<tr>
@ -494,12 +688,18 @@ Retrieves the translated help for a given <em class="parameter"><code>enum_value
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630470"></a><h3>
<a name="id2630391"></a><h3>
<a name="gimp-flags-get-first-desc"></a>gimp_flags_get_first_desc ()</h3>
<a class="indexterm" name="id2630484"></a><pre class="programlisting"><a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* gimp_flags_get_first_desc (GFlagsClass *flags_class,
guint value);</pre>
<a class="indexterm" name="id2630404"></a><pre class="programlisting"><a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* gimp_flags_get_first_desc (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
>GFlagsClass</a> *flags_class,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> value);</pre>
<p>
Retrieves the first <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> that matches the given value, or <code class="literal">NULL</code>.</p>
Retrieves the first <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> that matches the given value, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>.</p>
<p>
</p>
@ -508,7 +708,9 @@ Retrieves the first <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFla
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags_class</code></em>&#160;:</span></p></td>
<td> a <span class="type">GFlagsClass</span>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
><span class="type">GFlagsClass</span></a>
</td>
</tr>
<tr>
@ -529,19 +731,35 @@ Retrieves the first <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFla
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630610"></a><h3>
<a name="id2630516"></a><h3>
<a name="gimp-flags-get-first-value"></a>gimp_flags_get_first_value ()</h3>
<a class="indexterm" name="id2630624"></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="id2630529"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_flags_get_first_value (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> flags_type,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> value,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_nick,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_desc,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **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
desc and help are returned (if <em class="parameter"><code>value_name</code></em>, <em class="parameter"><code>value_nick</code></em>, <em class="parameter"><code>value_desc</code></em>
and <em class="parameter"><code>value_help</code></em> are not <code class="literal">NULL</code>).</p>
and <em class="parameter"><code>value_help</code></em> are not <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>).</p>
<p>
</p>
@ -550,7 +768,9 @@ and <em class="parameter"><code>value_help</code></em> are not <code class="lite
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags_type</code></em>&#160;:</span></p></td>
<td> the <span class="type">GType</span> of registered flags
<td> the <a
href="../gobject/gobject-Type-Information.html#GType"
><span class="type">GType</span></a> of registered flags
</td>
</tr>
<tr>
@ -560,28 +780,40 @@ and <em class="parameter"><code>value_help</code></em> are not <code class="lite
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value_name</code></em>&#160;:</span></p></td>
<td> return location for the value's name (or <code class="literal">NULL</code>)
<td> return location for the value's name (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value_nick</code></em>&#160;:</span></p></td>
<td> return location for the value's nick (or <code class="literal">NULL</code>)
<td> return location for the value's nick (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value_desc</code></em>&#160;:</span></p></td>
<td> return location for the value's translated desc (or <code class="literal">NULL</code>)
<td> return location for the value's translated desc (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value_help</code></em>&#160;:</span></p></td>
<td> return location for the value's translated help (or <code class="literal">NULL</code>)
<td> return location for the value's translated help (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>value</code></em> is valid for the <em class="parameter"><code>flags_type</code></em>,
<code class="literal">FALSE</code> otherwise
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if <em class="parameter"><code>value</code></em> is valid for the <em class="parameter"><code>flags_type</code></em>,
<a
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise
</td>
</tr>
@ -592,10 +824,16 @@ and <em class="parameter"><code>value_help</code></em> are not <code class="lite
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630896"></a><h3>
<a name="id2630797"></a><h3>
<a name="gimp-flags-value-get-desc"></a>gimp_flags_value_get_desc ()</h3>
<a class="indexterm" name="id2630910"></a><pre class="programlisting">const gchar* gimp_flags_value_get_desc (GFlagsClass *flags_class,
GFlagsValue *flags_value);</pre>
<a class="indexterm" name="id2630810"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_flags_value_get_desc (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
>GFlagsClass</a> *flags_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
>GFlagsValue</a> *flags_value);</pre>
<p>
Retrieves the translated desc for a given <em class="parameter"><code>flags_value</code></em>.</p>
<p>
@ -606,12 +844,16 @@ Retrieves the translated desc for a given <em class="parameter"><code>flags_valu
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags_class</code></em>&#160;:</span></p></td>
<td> a <span class="type">GFlagsClass</span>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
><span class="type">GFlagsClass</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags_value</code></em>&#160;:</span></p></td>
<td> a <span class="type">GFlagsValue</span> from <em class="parameter"><code>flags_class</code></em>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
><span class="type">GFlagsValue</span></a> from <em class="parameter"><code>flags_class</code></em>
</td>
</tr>
<tr>
@ -627,10 +869,16 @@ Retrieves the translated desc for a given <em class="parameter"><code>flags_valu
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631014"></a><h3>
<a name="id2630915"></a><h3>
<a name="gimp-flags-value-get-help"></a>gimp_flags_value_get_help ()</h3>
<a class="indexterm" name="id2631027"></a><pre class="programlisting">const gchar* gimp_flags_value_get_help (GFlagsClass *flags_class,
GFlagsValue *flags_value);</pre>
<a class="indexterm" name="id2630928"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_flags_value_get_help (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
>GFlagsClass</a> *flags_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
>GFlagsValue</a> *flags_value);</pre>
<p>
Retrieves the translated help for a given <em class="parameter"><code>flags_value</code></em>.</p>
<p>
@ -641,12 +889,16 @@ Retrieves the translated help for a given <em class="parameter"><code>flags_valu
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags_class</code></em>&#160;:</span></p></td>
<td> a <span class="type">GFlagsClass</span>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
><span class="type">GFlagsClass</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags_value</code></em>&#160;:</span></p></td>
<td> a <span class="type">GFlagsValue</span> from <em class="parameter"><code>flags_class</code></em>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
><span class="type">GFlagsValue</span></a> from <em class="parameter"><code>flags_class</code></em>
</td>
</tr>
<tr>