41
41
<div class="refsynopsisdiv">
42
42
<a name="libgimpbase-gimputils.synopsis"></a><h2>Synopsis</h2>
43
43
<pre class="synopsis">
45
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
46
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-any-to-utf8" title="gimp_any_to_utf8 ()">gimp_any_to_utf8</a> (const <a
47
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
50
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
53
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
54
>gchar</a> *warning_format,
44
gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-any-to-utf8" title="gimp_any_to_utf8 ()">gimp_any_to_utf8</a> (const gchar *str,
46
const gchar *warning_format,
57
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
58
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-filename-to-utf8" title="gimp_filename_to_utf8 ()">gimp_filename_to_utf8</a> (const <a
59
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
60
>gchar</a> *filename);
62
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
63
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-utf8-strtrim" title="gimp_utf8_strtrim ()">gimp_utf8_strtrim</a> (const <a
64
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
67
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
70
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
71
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-escape-uline" title="gimp_escape_uline ()">gimp_escape_uline</a> (const <a
72
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
75
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
76
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-strip-uline" title="gimp_strip_uline ()">gimp_strip_uline</a> (const <a
77
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
80
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
81
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-canonicalize-identifier" title="gimp_canonicalize_identifier ()">gimp_canonicalize_identifier</a> (const <a
82
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
83
>gchar</a> *identifier);
84
<a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="GimpEnumDesc">GimpEnumDesc</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-enum-get-desc" title="gimp_enum_get_desc ()">gimp_enum_get_desc</a> (<a
85
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
86
>GEnumClass</a> *enum_class,
88
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
91
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
92
>gboolean</a> <a class="link" href="libgimpbase-gimputils.html#gimp-enum-get-value" title="gimp_enum_get_value ()">gimp_enum_get_value</a> (<a
93
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
96
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
99
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
100
>gchar</a> **value_name,
102
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
103
>gchar</a> **value_nick,
105
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
106
>gchar</a> **value_desc,
108
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
109
>gchar</a> **value_help);
111
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
112
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-enum-value-get-desc" title="gimp_enum_value_get_desc ()">gimp_enum_value_get_desc</a> (<a
113
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
114
>GEnumClass</a> *enum_class,
116
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
117
>GEnumValue</a> *enum_value);
119
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
120
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-enum-value-get-help" title="gimp_enum_value_get_help ()">gimp_enum_value_get_help</a> (<a
121
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
122
>GEnumClass</a> *enum_class,
124
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
125
>GEnumValue</a> *enum_value);
126
<a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="GimpFlagsDesc">GimpFlagsDesc</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-flags-get-first-desc" title="gimp_flags_get_first_desc ()">gimp_flags_get_first_desc</a> (<a
127
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
128
>GFlagsClass</a> *flags_class,
130
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
133
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
134
>gboolean</a> <a class="link" href="libgimpbase-gimputils.html#gimp-flags-get-first-value" title="gimp_flags_get_first_value ()">gimp_flags_get_first_value</a> (<a
135
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
136
>GType</a> flags_type,
138
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
141
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
142
>gchar</a> **value_name,
144
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
145
>gchar</a> **value_nick,
147
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
148
>gchar</a> **value_desc,
150
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
151
>gchar</a> **value_help);
153
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
154
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-flags-value-get-desc" title="gimp_flags_value_get_desc ()">gimp_flags_value_get_desc</a> (<a
155
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
156
>GFlagsClass</a> *flags_class,
158
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
159
>GFlagsValue</a> *flags_value);
161
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
162
>gchar</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-flags-value-get-help" title="gimp_flags_value_get_help ()">gimp_flags_value_get_help</a> (<a
163
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
164
>GFlagsClass</a> *flags_class,
166
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
167
>GFlagsValue</a> *flags_value);
48
const gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-filename-to-utf8" title="gimp_filename_to_utf8 ()">gimp_filename_to_utf8</a> (const gchar *filename);
49
gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-utf8-strtrim" title="gimp_utf8_strtrim ()">gimp_utf8_strtrim</a> (const gchar *str,
51
gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-escape-uline" title="gimp_escape_uline ()">gimp_escape_uline</a> (const gchar *str);
52
gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-strip-uline" title="gimp_strip_uline ()">gimp_strip_uline</a> (const gchar *str);
53
gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-canonicalize-identifier" title="gimp_canonicalize_identifier ()">gimp_canonicalize_identifier</a> (const gchar *identifier);
54
<a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="GimpEnumDesc">GimpEnumDesc</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-enum-get-desc" title="gimp_enum_get_desc ()">gimp_enum_get_desc</a> (GEnumClass *enum_class,
56
gboolean <a class="link" href="libgimpbase-gimputils.html#gimp-enum-get-value" title="gimp_enum_get_value ()">gimp_enum_get_value</a> (GType enum_type,
58
const gchar **value_name,
59
const gchar **value_nick,
60
const gchar **value_desc,
61
const gchar **value_help);
62
const gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-enum-value-get-desc" title="gimp_enum_value_get_desc ()">gimp_enum_value_get_desc</a> (GEnumClass *enum_class,
63
GEnumValue *enum_value);
64
const gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-enum-value-get-help" title="gimp_enum_value_get_help ()">gimp_enum_value_get_help</a> (GEnumClass *enum_class,
65
GEnumValue *enum_value);
66
<a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="GimpFlagsDesc">GimpFlagsDesc</a>* <a class="link" href="libgimpbase-gimputils.html#gimp-flags-get-first-desc" title="gimp_flags_get_first_desc ()">gimp_flags_get_first_desc</a> (GFlagsClass *flags_class,
68
gboolean <a class="link" href="libgimpbase-gimputils.html#gimp-flags-get-first-value" title="gimp_flags_get_first_value ()">gimp_flags_get_first_value</a> (GType flags_type,
70
const gchar **value_name,
71
const gchar **value_nick,
72
const gchar **value_desc,
73
const gchar **value_help);
74
const gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-flags-value-get-desc" title="gimp_flags_value_get_desc ()">gimp_flags_value_get_desc</a> (GFlagsClass *flags_class,
75
GFlagsValue *flags_value);
76
const gchar* <a class="link" href="libgimpbase-gimputils.html#gimp-flags-value-get-help" title="gimp_flags_value_get_help ()">gimp_flags_value_get_help</a> (GFlagsClass *flags_class,
77
GFlagsValue *flags_value);
170
80
<div class="refsect1" lang="en">
495
351
<div class="refsect2" lang="en">
496
352
<a name="gimp-enum-get-value"></a><h3>gimp_enum_get_value ()</h3>
497
<pre class="programlisting"><a
498
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
499
>gboolean</a> gimp_enum_get_value (<a
500
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
501
>GType</a> enum_type,
503
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
506
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
507
>gchar</a> **value_name,
509
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
510
>gchar</a> **value_nick,
512
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
513
>gchar</a> **value_desc,
515
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
516
>gchar</a> **value_help);</pre>
353
<pre class="programlisting">gboolean gimp_enum_get_value (GType enum_type,
355
const gchar **value_name,
356
const gchar **value_nick,
357
const gchar **value_desc,
358
const gchar **value_help);</pre>
518
360
Checks if <em class="parameter"><code>value</code></em> is valid for the enum registered as <em class="parameter"><code>enum_type</code></em>.
519
361
If the value exists in that enum, its name, nick and its translated
520
362
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>
521
and <em class="parameter"><code>value_help</code></em> are not <a
522
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
523
><code class="literal">NULL</code></a>).</p>
363
and <em class="parameter"><code>value_help</code></em> are not <code class="literal">NULL</code>).</p>
543
381
<td><p><span class="term"><em class="parameter"><code>value_name</code></em> :</span></p></td>
544
<td> return location for the value's name (or <a
545
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
546
><code class="literal">NULL</code></a>)
382
<td> return location for the value's name (or <code class="literal">NULL</code>)
550
386
<td><p><span class="term"><em class="parameter"><code>value_nick</code></em> :</span></p></td>
551
<td> return location for the value's nick (or <a
552
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
553
><code class="literal">NULL</code></a>)
387
<td> return location for the value's nick (or <code class="literal">NULL</code>)
557
391
<td><p><span class="term"><em class="parameter"><code>value_desc</code></em> :</span></p></td>
558
<td> return location for the value's translated desc (or <a
559
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
560
><code class="literal">NULL</code></a>)
392
<td> return location for the value's translated desc (or <code class="literal">NULL</code>)
564
396
<td><p><span class="term"><em class="parameter"><code>value_help</code></em> :</span></p></td>
565
<td> return location for the value's translated help (or <a
566
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
567
><code class="literal">NULL</code></a>)
397
<td> return location for the value's translated help (or <code class="literal">NULL</code>)
571
401
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
573
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
574
><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>,
576
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
577
><code class="literal">FALSE</code></a> otherwise
402
<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>,
403
<code class="literal">FALSE</code> otherwise
717
515
<div class="refsect2" lang="en">
718
516
<a name="gimp-flags-get-first-value"></a><h3>gimp_flags_get_first_value ()</h3>
719
<pre class="programlisting"><a
720
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
721
>gboolean</a> gimp_flags_get_first_value (<a
722
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
723
>GType</a> flags_type,
725
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
728
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
729
>gchar</a> **value_name,
731
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
732
>gchar</a> **value_nick,
734
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
735
>gchar</a> **value_desc,
737
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
738
>gchar</a> **value_help);</pre>
517
<pre class="programlisting">gboolean gimp_flags_get_first_value (GType flags_type,
519
const gchar **value_name,
520
const gchar **value_nick,
521
const gchar **value_desc,
522
const gchar **value_help);</pre>
740
524
Checks if <em class="parameter"><code>value</code></em> is valid for the flags registered as <em class="parameter"><code>flags_type</code></em>.
741
525
If the value exists in that flags, its name, nick and its translated
742
526
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>
743
and <em class="parameter"><code>value_help</code></em> are not <a
744
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
745
><code class="literal">NULL</code></a>).</p>
527
and <em class="parameter"><code>value_help</code></em> are not <code class="literal">NULL</code>).</p>
765
545
<td><p><span class="term"><em class="parameter"><code>value_name</code></em> :</span></p></td>
766
<td> return location for the value's name (or <a
767
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
768
><code class="literal">NULL</code></a>)
546
<td> return location for the value's name (or <code class="literal">NULL</code>)
772
550
<td><p><span class="term"><em class="parameter"><code>value_nick</code></em> :</span></p></td>
773
<td> return location for the value's nick (or <a
774
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
775
><code class="literal">NULL</code></a>)
551
<td> return location for the value's nick (or <code class="literal">NULL</code>)
779
555
<td><p><span class="term"><em class="parameter"><code>value_desc</code></em> :</span></p></td>
780
<td> return location for the value's translated desc (or <a
781
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
782
><code class="literal">NULL</code></a>)
556
<td> return location for the value's translated desc (or <code class="literal">NULL</code>)
786
560
<td><p><span class="term"><em class="parameter"><code>value_help</code></em> :</span></p></td>
787
<td> return location for the value's translated help (or <a
788
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
789
><code class="literal">NULL</code></a>)
561
<td> return location for the value's translated help (or <code class="literal">NULL</code>)
793
565
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
795
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
796
><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>,
798
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
799
><code class="literal">FALSE</code></a> otherwise
566
<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>,
567
<code class="literal">FALSE</code> otherwise