File: gimputils.xml

package info (click to toggle)
gimp 2.2.13-1etch4
  • links: PTS
  • area: main
  • in suites: etch
  • size: 94,832 kB
  • ctags: 47,113
  • sloc: ansic: 524,858; xml: 36,798; lisp: 9,870; sh: 9,409; makefile: 7,923; python: 2,674; perl: 2,589; yacc: 520; lex: 334
file content (414 lines) | stat: -rw-r--r-- 26,261 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="libgimpbase-gimputils">
<refmeta>
<refentrytitle role="top_of_page">gimputils</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gimputils</refname>
<refpurpose>Utilities of general interest</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>



<link linkend="gchar">gchar</link>*      <link linkend="gimp-any-to-utf8">gimp_any_to_utf8</link>                (const <link linkend="gchar">gchar</link> *str,
                                             <link linkend="gssize">gssize</link> len,
                                             const <link linkend="gchar">gchar</link> *warning_format,
                                             ...);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-filename-to-utf8">gimp_filename_to_utf8</link>          (const <link linkend="gchar">gchar</link> *filename);
<link linkend="gchar">gchar</link>*      <link linkend="gimp-utf8-strtrim">gimp_utf8_strtrim</link>               (const <link linkend="gchar">gchar</link> *str,
                                             <link linkend="gint">gint</link> max_chars);
<link linkend="gchar">gchar</link>*      <link linkend="gimp-escape-uline">gimp_escape_uline</link>               (const <link linkend="gchar">gchar</link> *str);
<link linkend="gchar">gchar</link>*      <link linkend="gimp-strip-uline">gimp_strip_uline</link>                (const <link linkend="gchar">gchar</link> *str);
<link linkend="GimpEnumDesc">GimpEnumDesc</link>* <link linkend="gimp-enum-get-desc">gimp_enum_get_desc</link>            (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
                                             <link linkend="gint">gint</link> value);
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-enum-get-value">gimp_enum_get_value</link>             (<link linkend="GType">GType</link> enum_type,
                                             <link linkend="gint">gint</link> value,
                                             const <link linkend="gchar">gchar</link> **value_name,
                                             const <link linkend="gchar">gchar</link> **value_nick,
                                             const <link linkend="gchar">gchar</link> **value_desc,
                                             const <link linkend="gchar">gchar</link> **value_help);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-enum-value-get-desc">gimp_enum_value_get_desc</link>       (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
                                             <link linkend="GEnumValue">GEnumValue</link> *enum_value);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-enum-value-get-help">gimp_enum_value_get_help</link>       (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
                                             <link linkend="GEnumValue">GEnumValue</link> *enum_value);
<link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* <link linkend="gimp-flags-get-first-desc">gimp_flags_get_first_desc</link>    (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
                                             <link linkend="guint">guint</link> value);
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-flags-get-first-value">gimp_flags_get_first_value</link>      (<link linkend="GType">GType</link> flags_type,
                                             <link linkend="guint">guint</link> value,
                                             const <link linkend="gchar">gchar</link> **value_name,
                                             const <link linkend="gchar">gchar</link> **value_nick,
                                             const <link linkend="gchar">gchar</link> **value_desc,
                                             const <link linkend="gchar">gchar</link> **value_help);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-flags-value-get-desc">gimp_flags_value_get_desc</link>      (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
                                             <link linkend="GFlagsValue">GFlagsValue</link> *flags_value);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-flags-value-get-help">gimp_flags_value_get_help</link>      (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
                                             <link linkend="GFlagsValue">GFlagsValue</link> *flags_value);
</synopsis>
</refsynopsisdiv>









<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-any-to-utf8" role="function"/>gimp_any_to_utf8 ()</title>
<indexterm><primary>gimp_any_to_utf8</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_any_to_utf8                (const <link linkend="gchar">gchar</link> *str,
                                             <link linkend="gssize">gssize</link> len,
                                             const <link linkend="gchar">gchar</link> *warning_format,
                                             ...);</programlisting>
<para>
This function takes any string (UTF-8 or not) and always returns a valid
UTF-8 string.
</para>
<para>
If <parameter>str</parameter> is valid UTF-8, a copy of the string is returned.
</para>
<para>
If UTF-8 validation fails, <link linkend="g-locale-to-utf8"><function>g_locale_to_utf8()</function></link> is tried and if it
succeeds the resulting string is returned.
</para>
<para>
Otherwise, the portion of <parameter>str</parameter> that is UTF-8, concatenated
with "(invalid UTF-8 string)" is returned. If not even the start
of <parameter>str</parameter> is valid UTF-8, only "(invalid UTF-8 string)" is returned.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara>            The string to be converted to UTF-8.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
<listitem><simpara>            The length of the string, or -1 if the string
                 is nul-terminated.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>warning_format</parameter>&nbsp;:</term>
<listitem><simpara> The message format for the warning message if conversion
                 to UTF-8 fails. See the <function><link linkend="printf"><function>printf()</function></link></function>
                 documentation.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
<listitem><simpara>        The parameters to insert into the format string.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The UTF-8 string as described above.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-filename-to-utf8" role="function"/>gimp_filename_to_utf8 ()</title>
<indexterm><primary>gimp_filename_to_utf8</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_filename_to_utf8          (const <link linkend="gchar">gchar</link> *filename);</programlisting>
<para>
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 <link linkend="gimp-filename-to-utf8"><function>gimp_filename_to_utf8()</function></link>.
</para>
<para>
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.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara> The filename to be converted to UTF-8.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A temporarily valid UTF-8 representation of <parameter>filename</parameter>.
              This string must not be changed or freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-utf8-strtrim" role="function"/>gimp_utf8_strtrim ()</title>
<indexterm><primary>gimp_utf8_strtrim</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_utf8_strtrim               (const <link linkend="gchar">gchar</link> *str,
                                             <link linkend="gint">gint</link> max_chars);</programlisting>
<para>
Creates a (possibly trimmed) copy of <parameter>str</parameter>. The string is cut if it
exceeds <parameter>max_chars</parameter> characters or on the first newline. The fact
that the string was trimmed is indicated by appending an ellipsis.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara> an UTF-8 encoded string (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max_chars</parameter>&nbsp;:</term>
<listitem><simpara> the maximum number of characters before the string get
trimmed
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A (possibly trimmed) copy of <parameter>str</parameter> which should be freed
using <link linkend="g-free"><function>g_free()</function></link> when it is not needed any longer.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-escape-uline" role="function" condition="since:GIMP 2.2"/>gimp_escape_uline ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_escape_uline</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_escape_uline               (const <link linkend="gchar">gchar</link> *str);</programlisting>
<para>
This function returns a copy of <parameter>str</parameter> 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.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara> Underline infested string (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A (possibly escaped) copy of <parameter>str</parameter> which should be
freed using <link linkend="g-free"><function>g_free()</function></link> when it is not needed any longer.

</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-strip-uline" role="function"/>gimp_strip_uline ()</title>
<indexterm><primary>gimp_strip_uline</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_strip_uline                (const <link linkend="gchar">gchar</link> *str);</programlisting>
<para>
This function returns a copy of <parameter>str</parameter> stripped of underline
characters. This comes in handy when needing to strip mnemonics
from menu paths etc.
</para>
<para>
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 <link linkend="157561:CAPS"><type>157561</type></link>).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara> underline infested string (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A (possibly stripped) copy of <parameter>str</parameter> which should be
              freed using <link linkend="g-free"><function>g_free()</function></link> when it is not needed any longer.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-enum-get-desc" role="function" condition="since:GIMP 2.2"/>gimp_enum_get_desc ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_get_desc</primary></indexterm><programlisting><link linkend="GimpEnumDesc">GimpEnumDesc</link>* gimp_enum_get_desc            (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
                                             <link linkend="gint">gint</link> value);</programlisting>
<para>
Retrieves <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link> associated with the given value, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>enum_class</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GEnumClass"><type>GEnumClass</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara>      a value from <parameter>enum_class</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the value's <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>.

</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-enum-get-value" role="function" condition="since:GIMP 2.2"/>gimp_enum_get_value ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_get_value</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_enum_get_value             (<link linkend="GType">GType</link> enum_type,
                                             <link linkend="gint">gint</link> value,
                                             const <link linkend="gchar">gchar</link> **value_name,
                                             const <link linkend="gchar">gchar</link> **value_nick,
                                             const <link linkend="gchar">gchar</link> **value_desc,
                                             const <link linkend="gchar">gchar</link> **value_help);</programlisting>
<para>
Checks if <parameter>value</parameter> is valid for the enum registered as <parameter>enum_type</parameter>.
If the value exists in that enum, its name, nick and its translated
desc and help are returned (if <parameter>value_name</parameter>, <parameter>value_nick</parameter>, <parameter>value_desc</parameter>
and <parameter>value_help</parameter> are not <link linkend="NULL:CAPS"><literal>NULL</literal></link>).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>enum_type</parameter>&nbsp;:</term>
<listitem><simpara>  the <link linkend="GType"><type>GType</type></link> of a registered enum
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara>      an integer value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_name</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's name (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_nick</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's nick (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_desc</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's translated desc (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_help</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's translated help (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>value</parameter> is valid for the <parameter>enum_type</parameter>,
              <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise

</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-enum-value-get-desc" role="function" condition="since:GIMP 2.2"/>gimp_enum_value_get_desc ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_value_get_desc</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_enum_value_get_desc       (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
                                             <link linkend="GEnumValue">GEnumValue</link> *enum_value);</programlisting>
<para>
Retrieves the translated desc for a given <parameter>enum_value</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>enum_class</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GEnumClass"><type>GEnumClass</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>enum_value</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GEnumValue"><type>GEnumValue</type></link> from <parameter>enum_class</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translated desc of the enum value

</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-enum-value-get-help" role="function" condition="since:GIMP 2.2"/>gimp_enum_value_get_help ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_value_get_help</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_enum_value_get_help       (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
                                             <link linkend="GEnumValue">GEnumValue</link> *enum_value);</programlisting>
<para>
Retrieves the translated help for a given <parameter>enum_value</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>enum_class</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GEnumClass"><type>GEnumClass</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>enum_value</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GEnumValue"><type>GEnumValue</type></link> from <parameter>enum_class</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translated help of the enum value

</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-flags-get-first-desc" role="function" condition="since:GIMP 2.2"/>gimp_flags_get_first_desc ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_get_first_desc</primary></indexterm><programlisting><link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* gimp_flags_get_first_desc    (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
                                             <link linkend="guint">guint</link> value);</programlisting>
<para>
Retrieves the first <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link> that matches the given value, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>flags_class</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GFlagsClass"><type>GFlagsClass</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara>       a value from <parameter>flags_class</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the value's <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>.

</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-flags-get-first-value" role="function" condition="since:GIMP 2.2"/>gimp_flags_get_first_value ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_get_first_value</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_flags_get_first_value      (<link linkend="GType">GType</link> flags_type,
                                             <link linkend="guint">guint</link> value,
                                             const <link linkend="gchar">gchar</link> **value_name,
                                             const <link linkend="gchar">gchar</link> **value_nick,
                                             const <link linkend="gchar">gchar</link> **value_desc,
                                             const <link linkend="gchar">gchar</link> **value_help);</programlisting>
<para>
Checks if <parameter>value</parameter> is valid for the flags registered as <parameter>flags_type</parameter>.
If the value exists in that flags, its name, nick and its translated
desc and help are returned (if <parameter>value_name</parameter>, <parameter>value_nick</parameter>, <parameter>value_desc</parameter>
and <parameter>value_help</parameter> are not <link linkend="NULL:CAPS"><literal>NULL</literal></link>).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>flags_type</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of registered flags
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara>      an integer value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_name</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's name (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_nick</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's nick (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_desc</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's translated desc (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_help</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's translated help (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>value</parameter> is valid for the <parameter>flags_type</parameter>,
              <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise

</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-flags-value-get-desc" role="function" condition="since:GIMP 2.2"/>gimp_flags_value_get_desc ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_value_get_desc</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_flags_value_get_desc      (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
                                             <link linkend="GFlagsValue">GFlagsValue</link> *flags_value);</programlisting>
<para>
Retrieves the translated desc for a given <parameter>flags_value</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>flags_class</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GFlagsClass"><type>GFlagsClass</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags_value</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GFlagsValue"><type>GFlagsValue</type></link> from <parameter>flags_class</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translated desc of the flags value

</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-flags-value-get-help" role="function" condition="since:GIMP 2.2"/>gimp_flags_value_get_help ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_value_get_help</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_flags_value_get_help      (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
                                             <link linkend="GFlagsValue">GFlagsValue</link> *flags_value);</programlisting>
<para>
Retrieves the translated help for a given <parameter>flags_value</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>flags_class</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GFlagsClass"><type>GFlagsClass</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags_value</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GFlagsValue"><type>GFlagsValue</type></link> from <parameter>flags_class</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translated help of the flags value

</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>

</refsect1>




</refentry>