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

Imported Upstream version 2.4.0

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:23:21 -04:00
parent f35d8506c6
commit 258b1471f0
781 changed files with 98804 additions and 57910 deletions
Download Patch File Download Diff File Expand all files Collapse all files

325
devel-docs/libgimpbase/html/libgimpbase-gimputils.html
View File

@ -8,7 +8,7 @@
<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.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.9 (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="#id2604865" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2611896" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2593227" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2573532" 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="id2604865"></a><span class="refentrytitle">gimputils</span>
<a name="id2611896"></a><span class="refentrytitle">gimputils</span>
</h2>
<p>gimputils &#8212; Utilities of general interest</p>
</td>
@ -47,152 +47,152 @@
<a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *str,
<a
href="../glib/glib-Basic-Types.html#gssize"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
>gssize</a> len,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *warning_format,
...);
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *filename);
<a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *str,
<a
href="../glib/glib-Basic-Types.html#gint"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> max_chars);
<a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *str);
<a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *str);
<a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
>GEnumClass</a> *enum_class,
<a
href="../glib/glib-Basic-Types.html#gint"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> value);
<a
href="../glib/glib-Basic-Types.html#gboolean"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> enum_type,
<a
href="../glib/glib-Basic-Types.html#gint"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> value,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_nick,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_desc,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_help);
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
>GEnumClass</a> *enum_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
>GEnumValue</a> *enum_value);
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
>GEnumClass</a> *enum_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
>GFlagsClass</a> *flags_class,
<a
href="../glib/glib-Basic-Types.html#guint"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> value);
<a
href="../glib/glib-Basic-Types.html#gboolean"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> flags_type,
<a
href="../glib/glib-Basic-Types.html#guint"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> value,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_nick,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_desc,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_help);
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
>GFlagsClass</a> *flags_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
>GFlagsValue</a> *flags_value);
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
>GFlagsClass</a> *flags_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
>GFlagsValue</a> *flags_value);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2593227"></a><h2>Description</h2>
<a name="id2573532"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2593242"></a><h2>Details</h2>
<a name="id2573548"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2593253"></a><h3>
<a name="id2573559"></a><h3>
<a name="gimp-any-to-utf8"></a>gimp_any_to_utf8 ()</h3>
<a class="indexterm" name="id2593266"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2573571"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_any_to_utf8 (const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *str,
<a
href="../glib/glib-Basic-Types.html#gssize"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
>gssize</a> len,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *warning_format,
...);</pre>
<p>
@ -204,7 +204,7 @@ If <em class="parameter"><code>str</code></em> is valid UTF-8, a copy of the str
</p>
<p>
If UTF-8 validation fails, <a
href="../glib/glib-Character-Set-Conversion.html#g-locale-to-utf8"
href="/usr/share/gtk-doc/html/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>
@ -251,12 +251,12 @@ of <em class="parameter"><code>str</code></em> is valid UTF-8, only "(invalid UT
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621912"></a><h3>
<a name="id2622245"></a><h3>
<a name="gimp-filename-to-utf8"></a>gimp_filename_to_utf8 ()</h3>
<a class="indexterm" name="id2621923"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2622256"></a><pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_filename_to_utf8 (const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *filename);</pre>
<p>
Convert a filename in the filesystem's encoding to UTF-8
@ -290,15 +290,15 @@ UTF-8 encoded filename.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2622010"></a><h3>
<a name="id2622343"></a><h3>
<a name="gimp-utf8-strtrim"></a>gimp_utf8_strtrim ()</h3>
<a class="indexterm" name="id2622023"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2622356"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_utf8_strtrim (const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *str,
<a
href="../glib/glib-Basic-Types.html#gint"
href="/usr/share/gtk-doc/html/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
@ -313,7 +313,7 @@ that the string was trimmed is indicated by appending an ellipsis.</p>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></p></td>
<td> an UTF-8 encoded string (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
@ -327,7 +327,7 @@ trimmed
<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 <a
href="../glib/glib-Memory-Allocation.html#g-free"
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a> when it is not needed any longer.
</td>
</tr>
@ -336,12 +336,12 @@ href="../glib/glib-Memory-Allocation.html#g-free"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2622142"></a><h3>
<a name="id2622475"></a><h3>
<a name="gimp-escape-uline"></a>gimp_escape_uline ()</h3>
<a class="indexterm" name="id2622156"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2622489"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_escape_uline (const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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
@ -357,7 +357,7 @@ them to mnemonics.</p>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></p></td>
<td> Underline infested string (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
@ -365,7 +365,7 @@ href="../glib/glib-Standard-Macros.html#NULL:CAPS"
<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 <a
href="../glib/glib-Memory-Allocation.html#g-free"
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a> when it is not needed any longer.
</td>
@ -377,12 +377,12 @@ href="../glib/glib-Memory-Allocation.html#g-free"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629516"></a><h3>
<a name="id2629872"></a><h3>
<a name="gimp-strip-uline"></a>gimp_strip_uline ()</h3>
<a class="indexterm" name="id2629526"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2629882"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_strip_uline (const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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
@ -403,7 +403,7 @@ rid of the mnemonic (see bug <span class="type">157561</span>).</p>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></p></td>
<td> underline infested string (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>)
</td>
</tr>
@ -411,7 +411,7 @@ href="../glib/glib-Standard-Macros.html#NULL:CAPS"
<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 <a
href="../glib/glib-Memory-Allocation.html#g-free"
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a> when it is not needed any longer.
</td>
</tr>
@ -420,12 +420,12 @@ href="../glib/glib-Memory-Allocation.html#g-free"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629627"></a><h3>
<a name="id2629985"></a><h3>
<a name="gimp-canonicalize-identifier"></a>gimp_canonicalize_identifier ()</h3>
<a class="indexterm" name="id2629643"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2630001"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_canonicalize_identifier (const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *identifier);</pre>
<p>
Turns any input string into a canonicalized string.
@ -449,7 +449,7 @@ not either '-', 'a-z', 'A-Z' or '0-9' will be replaced by a '-'.</p>
<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 <a
href="../glib/glib-Memory-Allocation.html#g-free"
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a>
when no longer needed.
@ -462,17 +462,17 @@ href="../glib/glib-Memory-Allocation.html#g-free"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629731"></a><h3>
<a name="id2630088"></a><h3>
<a name="gimp-enum-get-desc"></a>gimp_enum_get_desc ()</h3>
<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"
<a class="indexterm" name="id2630103"></a><pre class="programlisting"><a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* gimp_enum_get_desc (<a
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
>GEnumClass</a> *enum_class,
<a
href="../glib/glib-Basic-Types.html#gint"
href="/usr/share/gtk-doc/html/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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>.</p>
<p>
@ -483,7 +483,7 @@ href="../glib/glib-Standard-Macros.html#NULL:CAPS"
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_class</code></em>&#160;:</span></p></td>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
><span class="type">GEnumClass</span></a>
</td>
</tr>
@ -505,34 +505,34 @@ href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629872"></a><h3>
<a name="id2630230"></a><h3>
<a name="gimp-enum-get-value"></a>gimp_enum_get_value ()</h3>
<a class="indexterm" name="id2629886"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
<a class="indexterm" name="id2630244"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_enum_get_value (<a
href="../gobject/gobject-Type-Information.html#GType"
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> enum_type,
<a
href="../glib/glib-Basic-Types.html#gint"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> value,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_nick,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_desc,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>).</p>
<p>
@ -543,7 +543,7 @@ href="../glib/glib-Standard-Macros.html#NULL:CAPS"
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></p></td>
<td> the <a
href="../gobject/gobject-Type-Information.html#GType"
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
><span class="type">GType</span></a> of a registered enum
</td>
</tr>
@ -555,38 +555,38 @@ href="../gobject/gobject-Type-Information.html#GType"
<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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/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
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise
</td>
@ -598,15 +598,15 @@ href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630158"></a><h3>
<a name="id2630515"></a><h3>
<a name="gimp-enum-value-get-desc"></a>gimp_enum_value_get_desc ()</h3>
<a class="indexterm" name="id2630170"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2630528"></a><pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_enum_value_get_desc (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
>GEnumClass</a> *enum_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
href="/usr/share/gtk-doc/html/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>
@ -619,14 +619,14 @@ Retrieves the translated desc for a given <em class="parameter"><code>enum_value
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_class</code></em>&#160;:</span></p></td>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
href="/usr/share/gtk-doc/html/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 <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
href="/usr/share/gtk-doc/html/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>
@ -643,15 +643,15 @@ href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630274"></a><h3>
<a name="id2630632"></a><h3>
<a name="gimp-enum-value-get-help"></a>gimp_enum_value_get_help ()</h3>
<a class="indexterm" name="id2630287"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2630644"></a><pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_enum_value_get_help (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
>GEnumClass</a> *enum_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
href="/usr/share/gtk-doc/html/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>
@ -664,14 +664,14 @@ Retrieves the translated help for a given <em class="parameter"><code>enum_value
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_class</code></em>&#160;:</span></p></td>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
href="/usr/share/gtk-doc/html/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 <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
href="/usr/share/gtk-doc/html/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>
@ -688,17 +688,17 @@ href="../gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630391"></a><h3>
<a name="id2630749"></a><h3>
<a name="gimp-flags-get-first-desc"></a>gimp_flags_get_first_desc ()</h3>
<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"
<a class="indexterm" name="id2630762"></a><pre class="programlisting"><a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* gimp_flags_get_first_desc (<a
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
>GFlagsClass</a> *flags_class,
<a
href="../glib/glib-Basic-Types.html#guint"
href="/usr/share/gtk-doc/html/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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>.</p>
<p>
@ -709,7 +709,7 @@ href="../glib/glib-Standard-Macros.html#NULL:CAPS"
<tr>
<td><p><span class="term"><em class="parameter"><code>flags_class</code></em>&#160;:</span></p></td>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
><span class="type">GFlagsClass</span></a>
</td>
</tr>
@ -731,34 +731,34 @@ href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630516"></a><h3>
<a name="id2630874"></a><h3>
<a name="gimp-flags-get-first-value"></a>gimp_flags_get_first_value ()</h3>
<a class="indexterm" name="id2630529"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
<a class="indexterm" name="id2630887"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_flags_get_first_value (<a
href="../gobject/gobject-Type-Information.html#GType"
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> flags_type,
<a
href="../glib/glib-Basic-Types.html#guint"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> value,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_nick,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **value_desc,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>).</p>
<p>
@ -769,7 +769,7 @@ href="../glib/glib-Standard-Macros.html#NULL:CAPS"
<tr>
<td><p><span class="term"><em class="parameter"><code>flags_type</code></em>&#160;:</span></p></td>
<td> the <a
href="../gobject/gobject-Type-Information.html#GType"
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
><span class="type">GType</span></a> of registered flags
</td>
</tr>
@ -781,38 +781,38 @@ href="../gobject/gobject-Type-Information.html#GType"
<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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/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
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise
</td>
@ -824,15 +824,15 @@ href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630797"></a><h3>
<a name="id2631155"></a><h3>
<a name="gimp-flags-value-get-desc"></a>gimp_flags_value_get_desc ()</h3>
<a class="indexterm" name="id2630810"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2631168"></a><pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_flags_value_get_desc (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
>GFlagsClass</a> *flags_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
href="/usr/share/gtk-doc/html/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>
@ -845,14 +845,14 @@ Retrieves the translated desc for a given <em class="parameter"><code>flags_valu
<tr>
<td><p><span class="term"><em class="parameter"><code>flags_class</code></em>&#160;:</span></p></td>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
href="/usr/share/gtk-doc/html/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 <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
href="/usr/share/gtk-doc/html/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>
@ -869,15 +869,15 @@ href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630915"></a><h3>
<a name="id2631272"></a><h3>
<a name="gimp-flags-value-get-help"></a>gimp_flags_value_get_help ()</h3>
<a class="indexterm" name="id2630928"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2631285"></a><pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_flags_value_get_help (<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
>GFlagsClass</a> *flags_class,
<a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
href="/usr/share/gtk-doc/html/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>
@ -890,14 +890,14 @@ Retrieves the translated help for a given <em class="parameter"><code>flags_valu
<tr>
<td><p><span class="term"><em class="parameter"><code>flags_class</code></em>&#160;:</span></p></td>
<td> a <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
href="/usr/share/gtk-doc/html/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 <a
href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
href="/usr/share/gtk-doc/html/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>
@ -913,6 +913,11 @@ href="../gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2631391"></a><div class="refsect2" lang="en"><a name="id2631392"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2631393"></a></div>
</div>
</div>
</body>
</html>