~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpbase/html/libgimpbase-gimputils.html

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2008-08-22 11:50:05 UTC
  • mfrom: (0.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 34.
  • Revision ID: james.westby@ubuntu.com-20080822115005-yxj5svf3v9x1mkr7
Tags: upstream-2.4.7
Import upstream version 2.4.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
41
41
<div class="refsynopsisdiv">
42
42
<a name="libgimpbase-gimputils.synopsis"></a><h2>Synopsis</h2>
43
43
<pre class="synopsis">
44
 
<a
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"
48
 
>gchar</a> *str,
49
 
                                                         <a
50
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
51
 
>gssize</a> len,
52
 
                                                         const <a
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,
 
45
                                                         gssize len,
 
46
                                                         const gchar *warning_format,
55
47
                                                         ...);
56
 
const <a
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);
61
 
<a
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"
65
 
>gchar</a> *str,
66
 
                                                         <a
67
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
68
 
>gint</a> max_chars);
69
 
<a
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"
73
 
>gchar</a> *str);
74
 
<a
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"
78
 
>gchar</a> *str);
79
 
<a
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,
87
 
                                                         <a
88
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
89
 
>gint</a> value);
90
 
<a
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"
94
 
>GType</a> enum_type,
95
 
                                                         <a
96
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
97
 
>gint</a> value,
98
 
                                                         const <a
99
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
100
 
>gchar</a> **value_name,
101
 
                                                         const <a
102
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
103
 
>gchar</a> **value_nick,
104
 
                                                         const <a
105
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
106
 
>gchar</a> **value_desc,
107
 
                                                         const <a
108
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
109
 
>gchar</a> **value_help);
110
 
const <a
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,
115
 
                                                         <a
116
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
117
 
>GEnumValue</a> *enum_value);
118
 
const <a
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,
123
 
                                                         <a
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,
129
 
                                                         <a
130
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
131
 
>guint</a> value);
132
 
<a
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,
137
 
                                                         <a
138
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
139
 
>guint</a> value,
140
 
                                                         const <a
141
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
142
 
>gchar</a> **value_name,
143
 
                                                         const <a
144
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
145
 
>gchar</a> **value_nick,
146
 
                                                         const <a
147
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
148
 
>gchar</a> **value_desc,
149
 
                                                         const <a
150
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
151
 
>gchar</a> **value_help);
152
 
const <a
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,
157
 
                                                         <a
158
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
159
 
>GFlagsValue</a> *flags_value);
160
 
const <a
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,
165
 
                                                         <a
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,
 
50
                                                         gint max_chars);
 
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,
 
55
                                                         gint value);
 
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,
 
57
                                                         gint value,
 
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,
 
67
                                                         guint value);
 
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,
 
69
                                                         guint value,
 
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);
168
78
</pre>
169
79
</div>
170
80
<div class="refsect1" lang="en">
177
87
<a name="libgimpbase-gimputils.details"></a><h2>Details</h2>
178
88
<div class="refsect2" lang="en">
179
89
<a name="gimp-any-to-utf8"></a><h3>gimp_any_to_utf8 ()</h3>
180
 
<pre class="programlisting"><a
181
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
182
 
>gchar</a>*              gimp_any_to_utf8                    (const <a
183
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
184
 
>gchar</a> *str,
185
 
                                                         <a
186
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"
187
 
>gssize</a> len,
188
 
                                                         const <a
189
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
190
 
>gchar</a> *warning_format,
 
90
<pre class="programlisting">gchar*              gimp_any_to_utf8                    (const gchar *str,
 
91
                                                         gssize len,
 
92
                                                         const gchar *warning_format,
191
93
                                                         ...);</pre>
192
94
<p>
193
95
This function takes any string (UTF-8 or not) and always returns a valid
197
99
If <em class="parameter"><code>str</code></em> is valid UTF-8, a copy of the string is returned.
198
100
</p>
199
101
<p>
200
 
If UTF-8 validation fails, <a
201
 
href="/usr/share/gtk-doc/html/glib/glib-Character-Set-Conversion.html#g-locale-to-utf8"
202
 
><code class="function">g_locale_to_utf8()</code></a> is tried and if it
 
102
If UTF-8 validation fails, <code class="function">g_locale_to_utf8()</code> is tried and if it
203
103
succeeds the resulting string is returned.
204
104
</p>
205
105
<p>
246
146
<hr>
247
147
<div class="refsect2" lang="en">
248
148
<a name="gimp-filename-to-utf8"></a><h3>gimp_filename_to_utf8 ()</h3>
249
 
<pre class="programlisting">const <a
250
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
251
 
>gchar</a>*        gimp_filename_to_utf8               (const <a
252
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
253
 
>gchar</a> *filename);</pre>
 
149
<pre class="programlisting">const gchar*        gimp_filename_to_utf8               (const gchar *filename);</pre>
254
150
<p>
255
151
Convert a filename in the filesystem's encoding to UTF-8
256
152
temporarily.  The return value is a pointer to a string that is
284
180
<hr>
285
181
<div class="refsect2" lang="en">
286
182
<a name="gimp-utf8-strtrim"></a><h3>gimp_utf8_strtrim ()</h3>
287
 
<pre class="programlisting"><a
288
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
289
 
>gchar</a>*              gimp_utf8_strtrim                   (const <a
290
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
291
 
>gchar</a> *str,
292
 
                                                         <a
293
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
294
 
>gint</a> max_chars);</pre>
 
183
<pre class="programlisting">gchar*              gimp_utf8_strtrim                   (const gchar *str,
 
184
                                                         gint max_chars);</pre>
295
185
<p>
296
186
Creates a (possibly trimmed) copy of <em class="parameter"><code>str</code></em>. The string is cut if it
297
187
exceeds <em class="parameter"><code>max_chars</code></em> characters or on the first newline. The fact
304
194
<tbody>
305
195
<tr>
306
196
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
307
 
<td> an UTF-8 encoded string (or <a
308
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
309
 
><code class="literal">NULL</code></a>)
 
197
<td> an UTF-8 encoded string (or <code class="literal">NULL</code>)
310
198
</td>
311
199
</tr>
312
200
<tr>
318
206
<tr>
319
207
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
320
208
<td> A (possibly trimmed) copy of <em class="parameter"><code>str</code></em> which should be freed
321
 
using <a
322
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
323
 
><code class="function">g_free()</code></a> when it is not needed any longer.
 
209
using <code class="function">g_free()</code> when it is not needed any longer.
324
210
</td>
325
211
</tr>
326
212
</tbody>
329
215
<hr>
330
216
<div class="refsect2" lang="en">
331
217
<a name="gimp-escape-uline"></a><h3>gimp_escape_uline ()</h3>
332
 
<pre class="programlisting"><a
333
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
334
 
>gchar</a>*              gimp_escape_uline                   (const <a
335
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
336
 
>gchar</a> *str);</pre>
 
218
<pre class="programlisting">gchar*              gimp_escape_uline                   (const gchar *str);</pre>
337
219
<p>
338
220
This function returns a copy of <em class="parameter"><code>str</code></em> with all underline converted
339
221
to two adjacent underlines. This comes in handy when needing to display
347
229
<tbody>
348
230
<tr>
349
231
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
350
 
<td> Underline infested string (or <a
351
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
352
 
><code class="literal">NULL</code></a>)
 
232
<td> Underline infested string (or <code class="literal">NULL</code>)
353
233
</td>
354
234
</tr>
355
235
<tr>
356
236
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
357
237
<td> A (possibly escaped) copy of <em class="parameter"><code>str</code></em> which should be
358
 
freed using <a
359
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
360
 
><code class="function">g_free()</code></a> when it is not needed any longer.
 
238
freed using <code class="function">g_free()</code> when it is not needed any longer.
361
239
 
362
240
</td>
363
241
</tr>
369
247
<hr>
370
248
<div class="refsect2" lang="en">
371
249
<a name="gimp-strip-uline"></a><h3>gimp_strip_uline ()</h3>
372
 
<pre class="programlisting"><a
373
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
374
 
>gchar</a>*              gimp_strip_uline                    (const <a
375
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
376
 
>gchar</a> *str);</pre>
 
250
<pre class="programlisting">gchar*              gimp_strip_uline                    (const gchar *str);</pre>
377
251
<p>
378
252
This function returns a copy of <em class="parameter"><code>str</code></em> stripped of underline
379
253
characters. This comes in handy when needing to strip mnemonics
392
266
<tbody>
393
267
<tr>
394
268
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
395
 
<td> underline infested string (or <a
396
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
397
 
><code class="literal">NULL</code></a>)
 
269
<td> underline infested string (or <code class="literal">NULL</code>)
398
270
</td>
399
271
</tr>
400
272
<tr>
401
273
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
402
274
<td> A (possibly stripped) copy of <em class="parameter"><code>str</code></em> which should be
403
 
              freed using <a
404
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
405
 
><code class="function">g_free()</code></a> when it is not needed any longer.
 
275
              freed using <code class="function">g_free()</code> when it is not needed any longer.
406
276
</td>
407
277
</tr>
408
278
</tbody>
411
281
<hr>
412
282
<div class="refsect2" lang="en">
413
283
<a name="gimp-canonicalize-identifier"></a><h3>gimp_canonicalize_identifier ()</h3>
414
 
<pre class="programlisting"><a
415
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
416
 
>gchar</a>*              gimp_canonicalize_identifier        (const <a
417
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
418
 
>gchar</a> *identifier);</pre>
 
284
<pre class="programlisting">gchar*              gimp_canonicalize_identifier        (const gchar *identifier);</pre>
419
285
<p>
420
286
Turns any input string into a canonicalized string.
421
287
</p>
437
303
<tr>
438
304
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
439
305
<td> The canonicalized identifier. This is a newly
440
 
              allocated string that should be freed with <a
441
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
442
 
><code class="function">g_free()</code></a>
 
306
              allocated string that should be freed with <code class="function">g_free()</code>
443
307
              when no longer needed.
444
308
 
445
309
</td>
452
316
<hr>
453
317
<div class="refsect2" lang="en">
454
318
<a name="gimp-enum-get-desc"></a><h3>gimp_enum_get_desc ()</h3>
455
 
<pre class="programlisting"><a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="GimpEnumDesc">GimpEnumDesc</a>*       gimp_enum_get_desc                  (<a
456
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
457
 
>GEnumClass</a> *enum_class,
458
 
                                                         <a
459
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
460
 
>gint</a> value);</pre>
 
319
<pre class="programlisting"><a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="GimpEnumDesc">GimpEnumDesc</a>*       gimp_enum_get_desc                  (GEnumClass *enum_class,
 
320
                                                         gint value);</pre>
461
321
<p>
462
 
Retrieves <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> associated with the given value, or <a
463
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
464
 
><code class="literal">NULL</code></a>.</p>
 
322
Retrieves <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> associated with the given value, or <code class="literal">NULL</code>.</p>
465
323
<p>
466
324
 
467
325
</p>
470
328
<tbody>
471
329
<tr>
472
330
<td><p><span class="term"><em class="parameter"><code>enum_class</code></em> :</span></p></td>
473
 
<td> a <a
474
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
475
 
><span class="type">GEnumClass</span></a>
 
331
<td> a <span class="type">GEnumClass</span>
476
332
</td>
477
333
</tr>
478
334
<tr>
494
350
<hr>
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,
502
 
                                                         <a
503
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
504
 
>gint</a> value,
505
 
                                                         const <a
506
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
507
 
>gchar</a> **value_name,
508
 
                                                         const <a
509
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
510
 
>gchar</a> **value_nick,
511
 
                                                         const <a
512
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
513
 
>gchar</a> **value_desc,
514
 
                                                         const <a
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,
 
354
                                                         gint value,
 
355
                                                         const gchar **value_name,
 
356
                                                         const gchar **value_nick,
 
357
                                                         const gchar **value_desc,
 
358
                                                         const gchar **value_help);</pre>
517
359
<p>
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>
524
364
<p>
525
365
 
526
366
</p>
529
369
<tbody>
530
370
<tr>
531
371
<td><p><span class="term"><em class="parameter"><code>enum_type</code></em> :</span></p></td>
532
 
<td>  the <a
533
 
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
534
 
><span class="type">GType</span></a> of a registered enum
 
372
<td>  the <span class="type">GType</span> of a registered enum
535
373
</td>
536
374
</tr>
537
375
<tr>
541
379
</tr>
542
380
<tr>
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>)
547
383
</td>
548
384
</tr>
549
385
<tr>
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>)
554
388
</td>
555
389
</tr>
556
390
<tr>
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>)
561
393
</td>
562
394
</tr>
563
395
<tr>
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>)
568
398
</td>
569
399
</tr>
570
400
<tr>
571
401
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
572
 
<td> <a
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>,
575
 
              <a
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
578
404
 
579
405
</td>
580
406
</tr>
586
412
<hr>
587
413
<div class="refsect2" lang="en">
588
414
<a name="gimp-enum-value-get-desc"></a><h3>gimp_enum_value_get_desc ()</h3>
589
 
<pre class="programlisting">const <a
590
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
591
 
>gchar</a>*        gimp_enum_value_get_desc            (<a
592
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
593
 
>GEnumClass</a> *enum_class,
594
 
                                                         <a
595
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
596
 
>GEnumValue</a> *enum_value);</pre>
 
415
<pre class="programlisting">const gchar*        gimp_enum_value_get_desc            (GEnumClass *enum_class,
 
416
                                                         GEnumValue *enum_value);</pre>
597
417
<p>
598
418
Retrieves the translated desc for a given <em class="parameter"><code>enum_value</code></em>.</p>
599
419
<p>
604
424
<tbody>
605
425
<tr>
606
426
<td><p><span class="term"><em class="parameter"><code>enum_class</code></em> :</span></p></td>
607
 
<td> a <a
608
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
609
 
><span class="type">GEnumClass</span></a>
 
427
<td> a <span class="type">GEnumClass</span>
610
428
</td>
611
429
</tr>
612
430
<tr>
613
431
<td><p><span class="term"><em class="parameter"><code>enum_value</code></em> :</span></p></td>
614
 
<td> a <a
615
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
616
 
><span class="type">GEnumValue</span></a> from <em class="parameter"><code>enum_class</code></em>
 
432
<td> a <span class="type">GEnumValue</span> from <em class="parameter"><code>enum_class</code></em>
617
433
</td>
618
434
</tr>
619
435
<tr>
630
446
<hr>
631
447
<div class="refsect2" lang="en">
632
448
<a name="gimp-enum-value-get-help"></a><h3>gimp_enum_value_get_help ()</h3>
633
 
<pre class="programlisting">const <a
634
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
635
 
>gchar</a>*        gimp_enum_value_get_help            (<a
636
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
637
 
>GEnumClass</a> *enum_class,
638
 
                                                         <a
639
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
640
 
>GEnumValue</a> *enum_value);</pre>
 
449
<pre class="programlisting">const gchar*        gimp_enum_value_get_help            (GEnumClass *enum_class,
 
450
                                                         GEnumValue *enum_value);</pre>
641
451
<p>
642
452
Retrieves the translated help for a given <em class="parameter"><code>enum_value</code></em>.</p>
643
453
<p>
648
458
<tbody>
649
459
<tr>
650
460
<td><p><span class="term"><em class="parameter"><code>enum_class</code></em> :</span></p></td>
651
 
<td> a <a
652
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumClass"
653
 
><span class="type">GEnumClass</span></a>
 
461
<td> a <span class="type">GEnumClass</span>
654
462
</td>
655
463
</tr>
656
464
<tr>
657
465
<td><p><span class="term"><em class="parameter"><code>enum_value</code></em> :</span></p></td>
658
 
<td> a <a
659
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GEnumValue"
660
 
><span class="type">GEnumValue</span></a> from <em class="parameter"><code>enum_class</code></em>
 
466
<td> a <span class="type">GEnumValue</span> from <em class="parameter"><code>enum_class</code></em>
661
467
</td>
662
468
</tr>
663
469
<tr>
674
480
<hr>
675
481
<div class="refsect2" lang="en">
676
482
<a name="gimp-flags-get-first-desc"></a><h3>gimp_flags_get_first_desc ()</h3>
677
 
<pre class="programlisting"><a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="GimpFlagsDesc">GimpFlagsDesc</a>*      gimp_flags_get_first_desc           (<a
678
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
679
 
>GFlagsClass</a> *flags_class,
680
 
                                                         <a
681
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
682
 
>guint</a> value);</pre>
 
483
<pre class="programlisting"><a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="GimpFlagsDesc">GimpFlagsDesc</a>*      gimp_flags_get_first_desc           (GFlagsClass *flags_class,
 
484
                                                         guint value);</pre>
683
485
<p>
684
 
Retrieves the first <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> that matches the given value, or <a
685
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
686
 
><code class="literal">NULL</code></a>.</p>
 
486
Retrieves the first <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> that matches the given value, or <code class="literal">NULL</code>.</p>
687
487
<p>
688
488
 
689
489
</p>
692
492
<tbody>
693
493
<tr>
694
494
<td><p><span class="term"><em class="parameter"><code>flags_class</code></em> :</span></p></td>
695
 
<td> a <a
696
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
697
 
><span class="type">GFlagsClass</span></a>
 
495
<td> a <span class="type">GFlagsClass</span>
698
496
</td>
699
497
</tr>
700
498
<tr>
716
514
<hr>
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,
724
 
                                                         <a
725
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
726
 
>guint</a> value,
727
 
                                                         const <a
728
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
729
 
>gchar</a> **value_name,
730
 
                                                         const <a
731
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
732
 
>gchar</a> **value_nick,
733
 
                                                         const <a
734
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
735
 
>gchar</a> **value_desc,
736
 
                                                         const <a
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,
 
518
                                                         guint value,
 
519
                                                         const gchar **value_name,
 
520
                                                         const gchar **value_nick,
 
521
                                                         const gchar **value_desc,
 
522
                                                         const gchar **value_help);</pre>
739
523
<p>
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>
746
528
<p>
747
529
 
748
530
</p>
751
533
<tbody>
752
534
<tr>
753
535
<td><p><span class="term"><em class="parameter"><code>flags_type</code></em> :</span></p></td>
754
 
<td> the <a
755
 
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
756
 
><span class="type">GType</span></a> of registered flags
 
536
<td> the <span class="type">GType</span> of registered flags
757
537
</td>
758
538
</tr>
759
539
<tr>
763
543
</tr>
764
544
<tr>
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>)
769
547
</td>
770
548
</tr>
771
549
<tr>
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>)
776
552
</td>
777
553
</tr>
778
554
<tr>
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>)
783
557
</td>
784
558
</tr>
785
559
<tr>
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>)
790
562
</td>
791
563
</tr>
792
564
<tr>
793
565
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
794
 
<td> <a
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>,
797
 
              <a
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
800
568
 
801
569
</td>
802
570
</tr>
808
576
<hr>
809
577
<div class="refsect2" lang="en">
810
578
<a name="gimp-flags-value-get-desc"></a><h3>gimp_flags_value_get_desc ()</h3>
811
 
<pre class="programlisting">const <a
812
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
813
 
>gchar</a>*        gimp_flags_value_get_desc           (<a
814
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
815
 
>GFlagsClass</a> *flags_class,
816
 
                                                         <a
817
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
818
 
>GFlagsValue</a> *flags_value);</pre>
 
579
<pre class="programlisting">const gchar*        gimp_flags_value_get_desc           (GFlagsClass *flags_class,
 
580
                                                         GFlagsValue *flags_value);</pre>
819
581
<p>
820
582
Retrieves the translated desc for a given <em class="parameter"><code>flags_value</code></em>.</p>
821
583
<p>
826
588
<tbody>
827
589
<tr>
828
590
<td><p><span class="term"><em class="parameter"><code>flags_class</code></em> :</span></p></td>
829
 
<td> a <a
830
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
831
 
><span class="type">GFlagsClass</span></a>
 
591
<td> a <span class="type">GFlagsClass</span>
832
592
</td>
833
593
</tr>
834
594
<tr>
835
595
<td><p><span class="term"><em class="parameter"><code>flags_value</code></em> :</span></p></td>
836
 
<td> a <a
837
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
838
 
><span class="type">GFlagsValue</span></a> from <em class="parameter"><code>flags_class</code></em>
 
596
<td> a <span class="type">GFlagsValue</span> from <em class="parameter"><code>flags_class</code></em>
839
597
</td>
840
598
</tr>
841
599
<tr>
852
610
<hr>
853
611
<div class="refsect2" lang="en">
854
612
<a name="gimp-flags-value-get-help"></a><h3>gimp_flags_value_get_help ()</h3>
855
 
<pre class="programlisting">const <a
856
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
857
 
>gchar</a>*        gimp_flags_value_get_help           (<a
858
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
859
 
>GFlagsClass</a> *flags_class,
860
 
                                                         <a
861
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
862
 
>GFlagsValue</a> *flags_value);</pre>
 
613
<pre class="programlisting">const gchar*        gimp_flags_value_get_help           (GFlagsClass *flags_class,
 
614
                                                         GFlagsValue *flags_value);</pre>
863
615
<p>
864
616
Retrieves the translated help for a given <em class="parameter"><code>flags_value</code></em>.</p>
865
617
<p>
870
622
<tbody>
871
623
<tr>
872
624
<td><p><span class="term"><em class="parameter"><code>flags_class</code></em> :</span></p></td>
873
 
<td> a <a
874
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass"
875
 
><span class="type">GFlagsClass</span></a>
 
625
<td> a <span class="type">GFlagsClass</span>
876
626
</td>
877
627
</tr>
878
628
<tr>
879
629
<td><p><span class="term"><em class="parameter"><code>flags_value</code></em> :</span></p></td>
880
 
<td> a <a
881
 
href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsValue"
882
 
><span class="type">GFlagsValue</span></a> from <em class="parameter"><code>flags_class</code></em>
 
630
<td> a <span class="type">GFlagsValue</span> from <em class="parameter"><code>flags_class</code></em>
883
631
</td>
884
632
</tr>
885
633
<tr>