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

Imported Upstream version 2.8.16

Browse Source
This commit is contained in:
Ari Pollak
2015-11-24 14:17:30 -05:00
parent bf2f572083
commit 66d1b776a9
842 changed files with 251623 additions and 240362 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2,13 +2,13 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GIMP Base Library Reference Manual: gimputils</title>
<title>gimputils: GIMP Base Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part I. 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.21 (XML mode)">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -41,14 +41,14 @@
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimputils.html#gimp-any-to-utf8" title="gimp_any_to_utf8 ()">gimp_any_to_utf8</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimputils.html#gimp-filename-to-utf8" title="gimp_filename_to_utf8 ()">gimp_filename_to_utf8</a> <span class="c_punctuation">()</span>
@ -56,7 +56,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimputils.html#gimp-utf8-strtrim" title="gimp_utf8_strtrim ()">gimp_utf8_strtrim</a> <span class="c_punctuation">()</span>
@ -64,7 +64,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimputils.html#gimp-escape-uline" title="gimp_escape_uline ()">gimp_escape_uline</a> <span class="c_punctuation">()</span>
@ -72,7 +72,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimputils.html#gimp-strip-uline" title="gimp_strip_uline ()">gimp_strip_uline</a> <span class="c_punctuation">()</span>
@ -80,7 +80,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimputils.html#gimp-canonicalize-identifier" title="gimp_canonicalize_identifier ()">gimp_canonicalize_identifier</a> <span class="c_punctuation">()</span>
@ -96,21 +96,21 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimputils.html#gimp-enum-get-value" title="gimp_enum_get_value ()">gimp_enum_get_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimputils.html#gimp-enum-value-get-desc" title="gimp_enum_value_get_desc ()">gimp_enum_value_get_desc</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimputils.html#gimp-enum-value-get-help" title="gimp_enum_value_get_help ()">gimp_enum_value_get_help</a> <span class="c_punctuation">()</span>
@ -126,21 +126,21 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimputils.html#gimp-flags-get-first-value" title="gimp_flags_get_first_value ()">gimp_flags_get_first_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimputils.html#gimp-flags-value-get-desc" title="gimp_flags_value_get_desc ()">gimp_flags_value_get_desc</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimputils.html#gimp-flags-value-get-help" title="gimp_flags_value_get_help ()">gimp_flags_value_get_help</a> <span class="c_punctuation">()</span>
@ -157,16 +157,16 @@
<a name="libgimpbase-gimputils.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-any-to-utf8"></a><h3>gimp_any_to_utf8 ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_any_to_utf8 (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>,
<em class="parameter"><code><span class="type">gssize</span> len</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *warning_format</code></em>,
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_any_to_utf8 (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> len</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *warning_format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>This function takes any string (UTF-8 or not) and always returns a valid
UTF-8 string.</p>
<p>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
<p>If UTF-8 validation fails, <a href="https://developer.gnome.org/glib/unstable/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>Otherwise, the portion of <em class="parameter"><code>str</code></em>
that is UTF-8, concatenated
@ -211,14 +211,13 @@ documentation.</p></td>
<div class="refsect3">
<a name="id-1.2.17.5.2.9"></a><h4>Returns</h4>
<p> The UTF-8 string as described above.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-filename-to-utf8"></a><h3>gimp_filename_to_utf8 ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_filename_to_utf8 (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_filename_to_utf8 (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</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
guaranteed to be valid only during the current iteration of the
@ -246,15 +245,14 @@ UTF-8 encoded filename.</p>
<p> A temporarily valid UTF-8 representation of <em class="parameter"><code>filename</code></em>
.
This string must not be changed or freed.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-utf8-strtrim"></a><h3>gimp_utf8_strtrim ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_utf8_strtrim (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>,
<em class="parameter"><code><span class="type">gint</span> max_chars</code></em>);</pre>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_utf8_strtrim (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> max_chars</code></em>);</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>
@ -271,7 +269,7 @@ that the string was trimmed is indicated by appending an ellipsis.</p>
<tbody>
<tr>
<td class="parameter_name"><p>str</p></td>
<td class="parameter_description"><p>an UTF-8 encoded string (or <code class="literal">NULL</code>)</p></td>
<td class="parameter_description"><p>an UTF-8 encoded string (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
@ -287,15 +285,14 @@ trimmed</p></td>
<a name="id-1.2.17.5.4.6"></a><h4>Returns</h4>
<p> 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.</p>
<p></p>
using <a href="https://developer.gnome.org/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when it is not needed any longer.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-escape-uline"></a><h3>gimp_escape_uline ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_escape_uline (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);</pre>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_escape_uline (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>);</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
@ -311,7 +308,7 @@ them to mnemonics.</p>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>str</p></td>
<td class="parameter_description"><p>Underline infested string (or <code class="literal">NULL</code>)</p></td>
<td class="parameter_description"><p>Underline infested string (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
@ -320,16 +317,15 @@ them to mnemonics.</p>
<a name="id-1.2.17.5.5.6"></a><h4>Returns</h4>
<p> 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.</p>
<p></p>
freed using <a href="https://developer.gnome.org/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when it is not needed any longer.</p>
</div>
<p class="since">Since GIMP 2.2</p>
<p class="since">Since: GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-strip-uline"></a><h3>gimp_strip_uline ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_strip_uline (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);</pre>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_strip_uline (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>);</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
@ -348,7 +344,7 @@ rid of the mnemonic (see bug 157561).</p>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>str</p></td>
<td class="parameter_description"><p>underline infested string (or <code class="literal">NULL</code>)</p></td>
<td class="parameter_description"><p>underline infested string (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
@ -357,15 +353,14 @@ rid of the mnemonic (see bug 157561).</p>
<a name="id-1.2.17.5.6.7"></a><h4>Returns</h4>
<p> 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.</p>
<p></p>
freed using <a href="https://developer.gnome.org/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when it is not needed any longer.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-canonicalize-identifier"></a><h3>gimp_canonicalize_identifier ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_canonicalize_identifier (<em class="parameter"><code>const <span class="type">gchar</span> *identifier</code></em>);</pre>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_canonicalize_identifier (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *identifier</code></em>);</pre>
<p>Turns any input string into a canonicalized string.</p>
<p>Canonical identifiers are e.g. expected by the PDB for procedure
and parameter names. Every character of the input string that is
@ -388,19 +383,18 @@ not either '-', 'a-z', 'A-Z' or '0-9' will be replaced by a '-'.</p>
<div class="refsect3">
<a name="id-1.2.17.5.7.7"></a><h4>Returns</h4>
<p> 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="https://developer.gnome.org/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
when no longer needed.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-enum-get-desc"></a><h3>gimp_enum_get_desc ()</h3>
<pre class="programlisting"><a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="returnvalue">GimpEnumDesc</span></a> *
gimp_enum_get_desc (<em class="parameter"><code><span class="type">GEnumClass</span> *enum_class</code></em>,
<em class="parameter"><code><span class="type">gint</span> value</code></em>);</pre>
<p>Retrieves <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> associated with the given value, or <code class="literal">NULL</code>.</p>
gimp_enum_get_desc (<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GEnumClass"><span class="type">GEnumClass</span></a> *enum_class</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre>
<p>Retrieves <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> associated with the given value, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.17.5.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
@ -412,7 +406,7 @@ gimp_enum_get_desc (<em class="parameter"><code><span class="type">GEnumClass</s
<tbody>
<tr>
<td class="parameter_name"><p>enum_class</p></td>
<td class="parameter_description"><p>a <span class="type">GEnumClass</span></p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GEnumClass"><span class="type">GEnumClass</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
@ -427,20 +421,19 @@ gimp_enum_get_desc (<em class="parameter"><code><span class="type">GEnumClass</s
<div class="refsect3">
<a name="id-1.2.17.5.8.6"></a><h4>Returns</h4>
<p> the value's <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.2</p>
<p class="since">Since: GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-enum-get-value"></a><h3>gimp_enum_get_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_enum_get_value (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>,
<em class="parameter"><code><span class="type">gint</span> value</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **value_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **value_nick</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **value_desc</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **value_help</code></em>);</pre>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_enum_get_value (<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> enum_type</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value_name</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value_nick</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value_desc</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value_help</code></em>);</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>
.
@ -450,7 +443,7 @@ description and help are returned (if <em class="parameter"><code>value_name</co
,
<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>
are not <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).</p>
<div class="refsect3">
<a name="id-1.2.17.5.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
@ -462,7 +455,7 @@ description and help are returned (if <em class="parameter"><code>value_name</co
<tbody>
<tr>
<td class="parameter_name"><p>enum_type</p></td>
<td class="parameter_description"><p>the <span class="type">GType</span> of a registered enum</p></td>
<td class="parameter_description"><p>the <a href="https://developer.gnome.org/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of a registered enum</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
@ -472,22 +465,22 @@ description and help are returned (if <em class="parameter"><code>value_name</co
</tr>
<tr>
<td class="parameter_name"><p>value_name</p></td>
<td class="parameter_description"><p>return location for the value's name (or <code class="literal">NULL</code>)</p></td>
<td class="parameter_description"><p>return location for the value's name (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value_nick</p></td>
<td class="parameter_description"><p>return location for the value's nick (or <code class="literal">NULL</code>)</p></td>
<td class="parameter_description"><p>return location for the value's nick (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value_desc</p></td>
<td class="parameter_description"><p>return location for the value's translated description (or <code class="literal">NULL</code>)</p></td>
<td class="parameter_description"><p>return location for the value's translated description (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value_help</p></td>
<td class="parameter_description"><p>return location for the value's translated help (or <code class="literal">NULL</code>)</p></td>
<td class="parameter_description"><p>return location for the value's translated help (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
@ -495,20 +488,19 @@ description and help are returned (if <em class="parameter"><code>value_name</co
</div>
<div class="refsect3">
<a name="id-1.2.17.5.9.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>value</code></em>
<p> <a href="https://developer.gnome.org/glib/unstable/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>
,
<code class="literal">FALSE</code> otherwise</p>
<p></p>
<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
<p class="since">Since GIMP 2.2</p>
<p class="since">Since: GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-enum-value-get-desc"></a><h3>gimp_enum_value_get_desc ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_enum_value_get_desc (<em class="parameter"><code><span class="type">GEnumClass</span> *enum_class</code></em>,
<em class="parameter"><code><span class="type">GEnumValue</span> *enum_value</code></em>);</pre>
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_enum_value_get_desc (<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GEnumClass"><span class="type">GEnumClass</span></a> *enum_class</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GEnumValue"><span class="type">GEnumValue</span></a> *enum_value</code></em>);</pre>
<p>Retrieves the translated description for a given <em class="parameter"><code>enum_value</code></em>
.</p>
<div class="refsect3">
@ -522,12 +514,12 @@ gimp_enum_value_get_desc (<em class="parameter"><code><span class="type">GEnumCl
<tbody>
<tr>
<td class="parameter_name"><p>enum_class</p></td>
<td class="parameter_description"><p>a <span class="type">GEnumClass</span></p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GEnumClass"><span class="type">GEnumClass</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enum_value</p></td>
<td class="parameter_description"><p>a <span class="type">GEnumValue</span> from <em class="parameter"><code>enum_class</code></em>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GEnumValue"><span class="type">GEnumValue</span></a> from <em class="parameter"><code>enum_class</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
@ -537,16 +529,15 @@ gimp_enum_value_get_desc (<em class="parameter"><code><span class="type">GEnumCl
<div class="refsect3">
<a name="id-1.2.17.5.10.6"></a><h4>Returns</h4>
<p> the translated description of the enum value</p>
<p></p>
</div>
<p class="since">Since GIMP 2.2</p>
<p class="since">Since: GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-enum-value-get-help"></a><h3>gimp_enum_value_get_help ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_enum_value_get_help (<em class="parameter"><code><span class="type">GEnumClass</span> *enum_class</code></em>,
<em class="parameter"><code><span class="type">GEnumValue</span> *enum_value</code></em>);</pre>
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_enum_value_get_help (<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GEnumClass"><span class="type">GEnumClass</span></a> *enum_class</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GEnumValue"><span class="type">GEnumValue</span></a> *enum_value</code></em>);</pre>
<p>Retrieves the translated help for a given <em class="parameter"><code>enum_value</code></em>
.</p>
<div class="refsect3">
@ -560,12 +551,12 @@ gimp_enum_value_get_help (<em class="parameter"><code><span class="type">GEnumCl
<tbody>
<tr>
<td class="parameter_name"><p>enum_class</p></td>
<td class="parameter_description"><p>a <span class="type">GEnumClass</span></p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GEnumClass"><span class="type">GEnumClass</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enum_value</p></td>
<td class="parameter_description"><p>a <span class="type">GEnumValue</span> from <em class="parameter"><code>enum_class</code></em>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GEnumValue"><span class="type">GEnumValue</span></a> from <em class="parameter"><code>enum_class</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
@ -575,17 +566,16 @@ gimp_enum_value_get_help (<em class="parameter"><code><span class="type">GEnumCl
<div class="refsect3">
<a name="id-1.2.17.5.11.6"></a><h4>Returns</h4>
<p> the translated help of the enum value</p>
<p></p>
</div>
<p class="since">Since GIMP 2.2</p>
<p class="since">Since: GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-flags-get-first-desc"></a><h3>gimp_flags_get_first_desc ()</h3>
<pre class="programlisting"><a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="returnvalue">GimpFlagsDesc</span></a> *
gimp_flags_get_first_desc (<em class="parameter"><code><span class="type">GFlagsClass</span> *flags_class</code></em>,
<em class="parameter"><code><span class="type">guint</span> value</code></em>);</pre>
<p>Retrieves the first <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> that matches the given value, or <code class="literal">NULL</code>.</p>
gimp_flags_get_first_desc (<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"><span class="type">GFlagsClass</span></a> *flags_class</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> value</code></em>);</pre>
<p>Retrieves the first <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> that matches the given value, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.17.5.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
@ -597,7 +587,7 @@ gimp_flags_get_first_desc (<em class="parameter"><code><span class="type">GFlags
<tbody>
<tr>
<td class="parameter_name"><p>flags_class</p></td>
<td class="parameter_description"><p>a <span class="type">GFlagsClass</span></p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"><span class="type">GFlagsClass</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
@ -612,20 +602,19 @@ gimp_flags_get_first_desc (<em class="parameter"><code><span class="type">GFlags
<div class="refsect3">
<a name="id-1.2.17.5.12.6"></a><h4>Returns</h4>
<p> the value's <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.2</p>
<p class="since">Since: GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-flags-get-first-value"></a><h3>gimp_flags_get_first_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_flags_get_first_value (<em class="parameter"><code><span class="type">GType</span> flags_type</code></em>,
<em class="parameter"><code><span class="type">guint</span> value</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **value_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **value_nick</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **value_desc</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **value_help</code></em>);</pre>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_flags_get_first_value (<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> flags_type</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> value</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value_name</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value_nick</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value_desc</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value_help</code></em>);</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>
.
@ -635,7 +624,7 @@ translated description and help are returned (if <em class="parameter"><code>val
<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>
are not <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).</p>
<div class="refsect3">
<a name="id-1.2.17.5.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
@ -647,7 +636,7 @@ translated description and help are returned (if <em class="parameter"><code>val
<tbody>
<tr>
<td class="parameter_name"><p>flags_type</p></td>
<td class="parameter_description"><p>the <span class="type">GType</span> of registered flags</p></td>
<td class="parameter_description"><p>the <a href="https://developer.gnome.org/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of registered flags</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
@ -657,22 +646,22 @@ translated description and help are returned (if <em class="parameter"><code>val
</tr>
<tr>
<td class="parameter_name"><p>value_name</p></td>
<td class="parameter_description"><p>return location for the value's name (or <code class="literal">NULL</code>)</p></td>
<td class="parameter_description"><p>return location for the value's name (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value_nick</p></td>
<td class="parameter_description"><p>return location for the value's nick (or <code class="literal">NULL</code>)</p></td>
<td class="parameter_description"><p>return location for the value's nick (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value_desc</p></td>
<td class="parameter_description"><p>return location for the value's translated description (or <code class="literal">NULL</code>)</p></td>
<td class="parameter_description"><p>return location for the value's translated description (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value_help</p></td>
<td class="parameter_description"><p>return location for the value's translated help (or <code class="literal">NULL</code>)</p></td>
<td class="parameter_description"><p>return location for the value's translated help (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
@ -680,20 +669,19 @@ translated description and help are returned (if <em class="parameter"><code>val
</div>
<div class="refsect3">
<a name="id-1.2.17.5.13.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>value</code></em>
<p> <a href="https://developer.gnome.org/glib/unstable/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>
,
<code class="literal">FALSE</code> otherwise</p>
<p></p>
<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
<p class="since">Since GIMP 2.2</p>
<p class="since">Since: GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-flags-value-get-desc"></a><h3>gimp_flags_value_get_desc ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_flags_value_get_desc (<em class="parameter"><code><span class="type">GFlagsClass</span> *flags_class</code></em>,
<em class="parameter"><code><span class="type">GFlagsValue</span> *flags_value</code></em>);</pre>
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_flags_value_get_desc (<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"><span class="type">GFlagsClass</span></a> *flags_class</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"><span class="type">GFlagsValue</span></a> *flags_value</code></em>);</pre>
<p>Retrieves the translated description for a given <em class="parameter"><code>flags_value</code></em>
.</p>
<div class="refsect3">
@ -707,12 +695,12 @@ gimp_flags_value_get_desc (<em class="parameter"><code><span class="type">GFlags
<tbody>
<tr>
<td class="parameter_name"><p>flags_class</p></td>
<td class="parameter_description"><p>a <span class="type">GFlagsClass</span></p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"><span class="type">GFlagsClass</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags_value</p></td>
<td class="parameter_description"><p>a <span class="type">GFlagsValue</span> from <em class="parameter"><code>flags_class</code></em>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"><span class="type">GFlagsValue</span></a> from <em class="parameter"><code>flags_class</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
@ -722,16 +710,15 @@ gimp_flags_value_get_desc (<em class="parameter"><code><span class="type">GFlags
<div class="refsect3">
<a name="id-1.2.17.5.14.6"></a><h4>Returns</h4>
<p> the translated description of the flags value</p>
<p></p>
</div>
<p class="since">Since GIMP 2.2</p>
<p class="since">Since: GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-flags-value-get-help"></a><h3>gimp_flags_value_get_help ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_flags_value_get_help (<em class="parameter"><code><span class="type">GFlagsClass</span> *flags_class</code></em>,
<em class="parameter"><code><span class="type">GFlagsValue</span> *flags_value</code></em>);</pre>
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_flags_value_get_help (<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"><span class="type">GFlagsClass</span></a> *flags_class</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"><span class="type">GFlagsValue</span></a> *flags_value</code></em>);</pre>
<p>Retrieves the translated help for a given <em class="parameter"><code>flags_value</code></em>
.</p>
<div class="refsect3">
@ -745,12 +732,12 @@ gimp_flags_value_get_help (<em class="parameter"><code><span class="type">GFlags
<tbody>
<tr>
<td class="parameter_name"><p>flags_class</p></td>
<td class="parameter_description"><p>a <span class="type">GFlagsClass</span></p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"><span class="type">GFlagsClass</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags_value</p></td>
<td class="parameter_description"><p>a <span class="type">GFlagsValue</span> from <em class="parameter"><code>flags_class</code></em>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"><span class="type">GFlagsValue</span></a> from <em class="parameter"><code>flags_class</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
@ -760,9 +747,8 @@ gimp_flags_value_get_help (<em class="parameter"><code><span class="type">GFlags
<div class="refsect3">
<a name="id-1.2.17.5.15.6"></a><h4>Returns</h4>
<p> the translated help of the flags value</p>
<p></p>
</div>
<p class="since">Since GIMP 2.2</p>
<p class="since">Since: GIMP 2.2</p>
</div>
</div>
<div class="refsect1">
@ -770,7 +756,6 @@ gimp_flags_value_get_help (<em class="parameter"><code><span class="type">GFlags
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>