626 lines
25 KiB
HTML
626 lines
25 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>gimputils</title>
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
|
|
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
|
|
<link rel="up" href="libgimpbase.html" title="Part I. GIMP Base Library">
|
|
<link rel="prev" href="libgimpbase-gimpunit.html" title="gimpunit">
|
|
<link rel="next" href="libgimpbase-gimpprotocol.html" title="gimpprotocol">
|
|
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="libgimpbase.html" title="Part I. GIMP Base Library">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
|
|
<tr valign="middle">
|
|
<td><a accesskey="p" href="libgimpbase-gimpunit.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
|
|
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
|
|
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
|
|
<td><a accesskey="n" href="libgimpbase-gimpprotocol.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="#id2567164" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2600348" 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="id2567164"></a><span class="refentrytitle">gimputils</span>
|
|
</h2>
|
|
<p>gimputils — Utilities of general interest</p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
gchar* <a href="libgimpbase-gimputils.html#gimp-any-to-utf8">gimp_any_to_utf8</a> (const gchar *str,
|
|
gssize len,
|
|
const gchar *warning_format,
|
|
...);
|
|
const gchar* <a href="libgimpbase-gimputils.html#gimp-filename-to-utf8">gimp_filename_to_utf8</a> (const gchar *filename);
|
|
gchar* <a href="libgimpbase-gimputils.html#gimp-utf8-strtrim">gimp_utf8_strtrim</a> (const gchar *str,
|
|
gint max_chars);
|
|
gchar* <a href="libgimpbase-gimputils.html#gimp-escape-uline">gimp_escape_uline</a> (const gchar *str);
|
|
gchar* <a href="libgimpbase-gimputils.html#gimp-strip-uline">gimp_strip_uline</a> (const gchar *str);
|
|
<a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* <a href="libgimpbase-gimputils.html#gimp-enum-get-desc">gimp_enum_get_desc</a> (GEnumClass *enum_class,
|
|
gint value);
|
|
gboolean <a href="libgimpbase-gimputils.html#gimp-enum-get-value">gimp_enum_get_value</a> (GType enum_type,
|
|
gint value,
|
|
const gchar **value_name,
|
|
const gchar **value_nick,
|
|
const gchar **value_desc,
|
|
const gchar **value_help);
|
|
const gchar* <a href="libgimpbase-gimputils.html#gimp-enum-value-get-desc">gimp_enum_value_get_desc</a> (GEnumClass *enum_class,
|
|
GEnumValue *enum_value);
|
|
const gchar* <a href="libgimpbase-gimputils.html#gimp-enum-value-get-help">gimp_enum_value_get_help</a> (GEnumClass *enum_class,
|
|
GEnumValue *enum_value);
|
|
<a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* <a href="libgimpbase-gimputils.html#gimp-flags-get-first-desc">gimp_flags_get_first_desc</a> (GFlagsClass *flags_class,
|
|
guint value);
|
|
gboolean <a href="libgimpbase-gimputils.html#gimp-flags-get-first-value">gimp_flags_get_first_value</a> (GType flags_type,
|
|
guint value,
|
|
const gchar **value_name,
|
|
const gchar **value_nick,
|
|
const gchar **value_desc,
|
|
const gchar **value_help);
|
|
const gchar* <a href="libgimpbase-gimputils.html#gimp-flags-value-get-desc">gimp_flags_value_get_desc</a> (GFlagsClass *flags_class,
|
|
GFlagsValue *flags_value);
|
|
const gchar* <a href="libgimpbase-gimputils.html#gimp-flags-value-get-help">gimp_flags_value_get_help</a> (GFlagsClass *flags_class,
|
|
GFlagsValue *flags_value);
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2600348"></a><h2>Description</h2>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2600363"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2600374"></a><h3>
|
|
<a name="gimp-any-to-utf8"></a>gimp_any_to_utf8 ()</h3>
|
|
<a class="indexterm" name="id2600386"></a><pre class="programlisting">gchar* gimp_any_to_utf8 (const gchar *str,
|
|
gssize len,
|
|
const gchar *warning_format,
|
|
...);</pre>
|
|
<p>
|
|
This function takes any string (UTF-8 or not) and always returns a valid
|
|
UTF-8 string.
|
|
</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
|
|
succeeds the resulting string is returned.
|
|
</p>
|
|
<p>
|
|
Otherwise, the portion of <em class="parameter"><code>str</code></em> that is UTF-8, concatenated
|
|
with "(invalid UTF-8 string)" is returned. If not even the start
|
|
of <em class="parameter"><code>str</code></em> is valid UTF-8, only "(invalid UTF-8 string)" is returned.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>str</code></em> :</span></td>
|
|
<td> The string to be converted to UTF-8.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>len</code></em> :</span></td>
|
|
<td> The length of the string, or -1 if the string
|
|
is nul-terminated.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>warning_format</code></em> :</span></td>
|
|
<td> The message format for the warning message if conversion
|
|
to UTF-8 fails. See the <code class="function"><code class="function">printf()</code></code>
|
|
documentation.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>...</code></em> :</span></td>
|
|
<td> The parameters to insert into the format string.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The UTF-8 string as described above.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2600564"></a><h3>
|
|
<a name="gimp-filename-to-utf8"></a>gimp_filename_to_utf8 ()</h3>
|
|
<a class="indexterm" name="id2559978"></a><pre class="programlisting">const gchar* gimp_filename_to_utf8 (const gchar *filename);</pre>
|
|
<p>
|
|
Convert a filename in the filesystem's encoding to UTF-8
|
|
temporarily. The return value is a pointer to a string that is
|
|
guaranteed to be valid only during the current iteration of the
|
|
main loop or until the next call to <a href="libgimpbase-gimputils.html#gimp-filename-to-utf8"><code class="function">gimp_filename_to_utf8()</code></a>.
|
|
</p>
|
|
<p>
|
|
The only purpose of this function is to provide an easy way to pass
|
|
a filename in the filesystem encoding to a function that expects an
|
|
UTF-8 encoded filename.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>filename</code></em> :</span></td>
|
|
<td> The filename to be converted to UTF-8.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> A temporarily valid UTF-8 representation of <em class="parameter"><code>filename</code></em>.
|
|
This string must not be changed or freed.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2560064"></a><h3>
|
|
<a name="gimp-utf8-strtrim"></a>gimp_utf8_strtrim ()</h3>
|
|
<a class="indexterm" name="id2560077"></a><pre class="programlisting">gchar* gimp_utf8_strtrim (const gchar *str,
|
|
gint max_chars);</pre>
|
|
<p>
|
|
Creates a (possibly trimmed) copy of <em class="parameter"><code>str</code></em>. The string is cut if it
|
|
exceeds <em class="parameter"><code>max_chars</code></em> characters or on the first newline. The fact
|
|
that the string was trimmed is indicated by appending an ellipsis.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>str</code></em> :</span></td>
|
|
<td> an UTF-8 encoded string (or <code class="literal">NULL</code>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>max_chars</code></em> :</span></td>
|
|
<td> the maximum number of characters before the string get
|
|
trimmed
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></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.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2560196"></a><h3>
|
|
<a name="gimp-escape-uline"></a>gimp_escape_uline ()</h3>
|
|
<a class="indexterm" name="id2560210"></a><pre class="programlisting">gchar* gimp_escape_uline (const gchar *str);</pre>
|
|
<p>
|
|
This function returns a copy of <em class="parameter"><code>str</code></em> with all underline converted
|
|
to two adjacent underlines. This comes in handy when needing to display
|
|
strings with underlines (like filenames) in a place that would convert
|
|
them to mnemonics.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>str</code></em> :</span></td>
|
|
<td> Underline infested string (or <code class="literal">NULL</code>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></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.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2608398"></a><h3>
|
|
<a name="gimp-strip-uline"></a>gimp_strip_uline ()</h3>
|
|
<a class="indexterm" name="id2608409"></a><pre class="programlisting">gchar* gimp_strip_uline (const gchar *str);</pre>
|
|
<p>
|
|
This function returns a copy of <em class="parameter"><code>str</code></em> stripped of underline
|
|
characters. This comes in handy when needing to strip mnemonics
|
|
from menu paths etc.
|
|
</p>
|
|
<p>
|
|
In some languages, mnemonics are handled by adding the mnemonic
|
|
character in brackets (like "File (_F)"). This function recognizes
|
|
this construct and removes the whole bracket construction to get
|
|
rid of the mnemonic (see bug <span class="type">157561</span>).</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>str</code></em> :</span></td>
|
|
<td> underline infested string (or <code class="literal">NULL</code>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></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.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2608508"></a><h3>
|
|
<a name="gimp-enum-get-desc"></a>gimp_enum_get_desc ()</h3>
|
|
<a class="indexterm" name="id2608522"></a><pre class="programlisting"><a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* gimp_enum_get_desc (GEnumClass *enum_class,
|
|
gint value);</pre>
|
|
<p>
|
|
Retrieves <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> associated with the given value, or <code class="literal">NULL</code>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>enum_class</code></em> :</span></td>
|
|
<td> a <span class="type">GEnumClass</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value</code></em> :</span></td>
|
|
<td> a value from <em class="parameter"><code>enum_class</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> the value's <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2608646"></a><h3>
|
|
<a name="gimp-enum-get-value"></a>gimp_enum_get_value ()</h3>
|
|
<a class="indexterm" name="id2608661"></a><pre class="programlisting">gboolean gimp_enum_get_value (GType enum_type,
|
|
gint value,
|
|
const gchar **value_name,
|
|
const gchar **value_nick,
|
|
const gchar **value_desc,
|
|
const gchar **value_help);</pre>
|
|
<p>
|
|
Checks if <em class="parameter"><code>value</code></em> is valid for the enum registered as <em class="parameter"><code>enum_type</code></em>.
|
|
If the value exists in that enum, its name, nick and its translated
|
|
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>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>enum_type</code></em> :</span></td>
|
|
<td> the <span class="type">GType</span> of a registered enum
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value</code></em> :</span></td>
|
|
<td> an integer value
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value_name</code></em> :</span></td>
|
|
<td> return location for the value's name (or <code class="literal">NULL</code>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value_nick</code></em> :</span></td>
|
|
<td> return location for the value's nick (or <code class="literal">NULL</code>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value_desc</code></em> :</span></td>
|
|
<td> return location for the value's translated desc (or <code class="literal">NULL</code>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value_help</code></em> :</span></td>
|
|
<td> return location for the value's translated help (or <code class="literal">NULL</code>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></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>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2608957"></a><h3>
|
|
<a name="gimp-enum-value-get-desc"></a>gimp_enum_value_get_desc ()</h3>
|
|
<a class="indexterm" name="id2608970"></a><pre class="programlisting">const gchar* gimp_enum_value_get_desc (GEnumClass *enum_class,
|
|
GEnumValue *enum_value);</pre>
|
|
<p>
|
|
Retrieves the translated desc for a given <em class="parameter"><code>enum_value</code></em>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>enum_class</code></em> :</span></td>
|
|
<td> a <span class="type">GEnumClass</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>enum_value</code></em> :</span></td>
|
|
<td> a <span class="type">GEnumValue</span> from <em class="parameter"><code>enum_class</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> the translated desc of the enum value
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2609085"></a><h3>
|
|
<a name="gimp-enum-value-get-help"></a>gimp_enum_value_get_help ()</h3>
|
|
<a class="indexterm" name="id2609098"></a><pre class="programlisting">const gchar* gimp_enum_value_get_help (GEnumClass *enum_class,
|
|
GEnumValue *enum_value);</pre>
|
|
<p>
|
|
Retrieves the translated help for a given <em class="parameter"><code>enum_value</code></em>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>enum_class</code></em> :</span></td>
|
|
<td> a <span class="type">GEnumClass</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>enum_value</code></em> :</span></td>
|
|
<td> a <span class="type">GEnumValue</span> from <em class="parameter"><code>enum_class</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> the translated help of the enum value
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2609212"></a><h3>
|
|
<a name="gimp-flags-get-first-desc"></a>gimp_flags_get_first_desc ()</h3>
|
|
<a class="indexterm" name="id2609227"></a><pre class="programlisting"><a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* gimp_flags_get_first_desc (GFlagsClass *flags_class,
|
|
guint value);</pre>
|
|
<p>
|
|
Retrieves the first <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> that matches the given value, or <code class="literal">NULL</code>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>flags_class</code></em> :</span></td>
|
|
<td> a <span class="type">GFlagsClass</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value</code></em> :</span></td>
|
|
<td> a value from <em class="parameter"><code>flags_class</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> the value's <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2609326"></a><h3>
|
|
<a name="gimp-flags-get-first-value"></a>gimp_flags_get_first_value ()</h3>
|
|
<a class="indexterm" name="id2609339"></a><pre class="programlisting">gboolean gimp_flags_get_first_value (GType flags_type,
|
|
guint value,
|
|
const gchar **value_name,
|
|
const gchar **value_nick,
|
|
const gchar **value_desc,
|
|
const gchar **value_help);</pre>
|
|
<p>
|
|
Checks if <em class="parameter"><code>value</code></em> is valid for the flags registered as <em class="parameter"><code>flags_type</code></em>.
|
|
If the value exists in that flags, its name, nick and its translated
|
|
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>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>flags_type</code></em> :</span></td>
|
|
<td> the <span class="type">GType</span> of registered flags
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value</code></em> :</span></td>
|
|
<td> an integer value
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value_name</code></em> :</span></td>
|
|
<td> return location for the value's name (or <code class="literal">NULL</code>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value_nick</code></em> :</span></td>
|
|
<td> return location for the value's nick (or <code class="literal">NULL</code>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value_desc</code></em> :</span></td>
|
|
<td> return location for the value's translated desc (or <code class="literal">NULL</code>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value_help</code></em> :</span></td>
|
|
<td> return location for the value's translated help (or <code class="literal">NULL</code>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></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>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2609603"></a><h3>
|
|
<a name="gimp-flags-value-get-desc"></a>gimp_flags_value_get_desc ()</h3>
|
|
<a class="indexterm" name="id2609616"></a><pre class="programlisting">const gchar* gimp_flags_value_get_desc (GFlagsClass *flags_class,
|
|
GFlagsValue *flags_value);</pre>
|
|
<p>
|
|
Retrieves the translated desc for a given <em class="parameter"><code>flags_value</code></em>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>flags_class</code></em> :</span></td>
|
|
<td> a <span class="type">GFlagsClass</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>flags_value</code></em> :</span></td>
|
|
<td> a <span class="type">GFlagsValue</span> from <em class="parameter"><code>flags_class</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> the translated desc of the flags value
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2609718"></a><h3>
|
|
<a name="gimp-flags-value-get-help"></a>gimp_flags_value_get_help ()</h3>
|
|
<a class="indexterm" name="id2609731"></a><pre class="programlisting">const gchar* gimp_flags_value_get_help (GFlagsClass *flags_class,
|
|
GFlagsValue *flags_value);</pre>
|
|
<p>
|
|
Retrieves the translated help for a given <em class="parameter"><code>flags_value</code></em>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>flags_class</code></em> :</span></td>
|
|
<td> a <span class="type">GFlagsClass</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>flags_value</code></em> :</span></td>
|
|
<td> a <span class="type">GFlagsValue</span> from <em class="parameter"><code>flags_class</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> the translated help of the flags value
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|