← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpbase/xml/gimputils.xml
22
22
 
23
23
 
24
24
 
25
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-any-to-utf8">gimp_any_to_utf8</link>                (const <link linkend="gchar">gchar</link> *str,
26
 
                                             <link linkend="gssize">gssize</link> len,
27
 
                                             const <link linkend="gchar">gchar</link> *warning_format,
28
 
                                             ...);
29
 
const <link linkend="gchar">gchar</link>* <link linkend="gimp-filename-to-utf8">gimp_filename_to_utf8</link>          (const <link linkend="gchar">gchar</link> *filename);
30
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-utf8-strtrim">gimp_utf8_strtrim</link>               (const <link linkend="gchar">gchar</link> *str,
31
 
                                             <link linkend="gint">gint</link> max_chars);
32
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-escape-uline">gimp_escape_uline</link>               (const <link linkend="gchar">gchar</link> *str);
33
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-strip-uline">gimp_strip_uline</link>                (const <link linkend="gchar">gchar</link> *str);
34
 
<link linkend="GimpEnumDesc">GimpEnumDesc</link>* <link linkend="gimp-enum-get-desc">gimp_enum_get_desc</link>            (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
35
 
                                             <link linkend="gint">gint</link> value);
36
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-enum-get-value">gimp_enum_get_value</link>             (<link linkend="GType">GType</link> enum_type,
37
 
                                             <link linkend="gint">gint</link> value,
38
 
                                             const <link linkend="gchar">gchar</link> **value_name,
39
 
                                             const <link linkend="gchar">gchar</link> **value_nick,
40
 
                                             const <link linkend="gchar">gchar</link> **value_desc,
41
 
                                             const <link linkend="gchar">gchar</link> **value_help);
42
 
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,
43
 
                                             <link linkend="GEnumValue">GEnumValue</link> *enum_value);
44
 
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,
45
 
                                             <link linkend="GEnumValue">GEnumValue</link> *enum_value);
46
 
<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,
47
 
                                             <link linkend="guint">guint</link> value);
48
 
<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,
49
 
                                             <link linkend="guint">guint</link> value,
50
 
                                             const <link linkend="gchar">gchar</link> **value_name,
51
 
                                             const <link linkend="gchar">gchar</link> **value_nick,
52
 
                                             const <link linkend="gchar">gchar</link> **value_desc,
53
 
                                             const <link linkend="gchar">gchar</link> **value_help);
54
 
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,
55
 
                                             <link linkend="GFlagsValue">GFlagsValue</link> *flags_value);
56
 
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,
57
 
                                             <link linkend="GFlagsValue">GFlagsValue</link> *flags_value);
 
25
<link linkend="gchar">gchar</link>*              <link linkend="gimp-any-to-utf8">gimp_any_to_utf8</link>                    (const <link linkend="gchar">gchar</link> *str,
 
26
                                                         <link linkend="gssize">gssize</link> len,
 
27
                                                         const <link linkend="gchar">gchar</link> *warning_format,
 
28
                                                         ...);
 
29
const <link linkend="gchar">gchar</link>*        <link linkend="gimp-filename-to-utf8">gimp_filename_to_utf8</link>               (const <link linkend="gchar">gchar</link> *filename);
 
30
<link linkend="gchar">gchar</link>*              <link linkend="gimp-utf8-strtrim">gimp_utf8_strtrim</link>                   (const <link linkend="gchar">gchar</link> *str,
 
31
                                                         <link linkend="gint">gint</link> max_chars);
 
32
<link linkend="gchar">gchar</link>*              <link linkend="gimp-escape-uline">gimp_escape_uline</link>                   (const <link linkend="gchar">gchar</link> *str);
 
33
<link linkend="gchar">gchar</link>*              <link linkend="gimp-strip-uline">gimp_strip_uline</link>                    (const <link linkend="gchar">gchar</link> *str);
 
34
<link linkend="gchar">gchar</link>*              <link linkend="gimp-canonicalize-identifier">gimp_canonicalize_identifier</link>        (const <link linkend="gchar">gchar</link> *identifier);
 
35
<link linkend="GimpEnumDesc">GimpEnumDesc</link>*       <link linkend="gimp-enum-get-desc">gimp_enum_get_desc</link>                  (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
 
36
                                                         <link linkend="gint">gint</link> value);
 
37
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-enum-get-value">gimp_enum_get_value</link>                 (<link linkend="GType">GType</link> enum_type,
 
38
                                                         <link linkend="gint">gint</link> value,
 
39
                                                         const <link linkend="gchar">gchar</link> **value_name,
 
40
                                                         const <link linkend="gchar">gchar</link> **value_nick,
 
41
                                                         const <link linkend="gchar">gchar</link> **value_desc,
 
42
                                                         const <link linkend="gchar">gchar</link> **value_help);
 
43
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,
 
44
                                                         <link linkend="GEnumValue">GEnumValue</link> *enum_value);
 
45
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,
 
46
                                                         <link linkend="GEnumValue">GEnumValue</link> *enum_value);
 
47
<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,
 
48
                                                         <link linkend="guint">guint</link> value);
 
49
<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,
 
50
                                                         <link linkend="guint">guint</link> value,
 
51
                                                         const <link linkend="gchar">gchar</link> **value_name,
 
52
                                                         const <link linkend="gchar">gchar</link> **value_nick,
 
53
                                                         const <link linkend="gchar">gchar</link> **value_desc,
 
54
                                                         const <link linkend="gchar">gchar</link> **value_help);
 
55
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,
 
56
                                                         <link linkend="GFlagsValue">GFlagsValue</link> *flags_value);
 
57
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,
 
58
                                                         <link linkend="GFlagsValue">GFlagsValue</link> *flags_value);
58
59
</synopsis>
59
60
</refsynopsisdiv>
60
61
 
77
78
<title role="details.title">Details</title>
78
79
<refsect2>
79
80
<title><anchor id="gimp-any-to-utf8" role="function"/>gimp_any_to_utf8 ()</title>
80
 
<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,
81
 
                                             <link linkend="gssize">gssize</link> len,
82
 
                                             const <link linkend="gchar">gchar</link> *warning_format,
83
 
                                             ...);</programlisting>
 
81
<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,
 
82
                                                         <link linkend="gssize">gssize</link> len,
 
83
                                                         const <link linkend="gchar">gchar</link> *warning_format,
 
84
                                                         ...);</programlisting>
84
85
<para>
85
86
This function takes any string (UTF-8 or not) and always returns a valid
86
87
UTF-8 string.
119
120
</variablelist></refsect2>
120
121
<refsect2>
121
122
<title><anchor id="gimp-filename-to-utf8" role="function"/>gimp_filename_to_utf8 ()</title>
122
 
<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>
 
123
<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>
123
124
<para>
124
125
Convert a filename in the filesystem's encoding to UTF-8
125
126
temporarily.  The return value is a pointer to a string that is
142
143
</variablelist></refsect2>
143
144
<refsect2>
144
145
<title><anchor id="gimp-utf8-strtrim" role="function"/>gimp_utf8_strtrim ()</title>
145
 
<indexterm><primary>gimp_utf8_strtrim</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_utf8_strtrim               (const <link linkend="gchar">gchar</link> *str,
146
 
                                             <link linkend="gint">gint</link> max_chars);</programlisting>
 
146
<indexterm><primary>gimp_utf8_strtrim</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_utf8_strtrim                   (const <link linkend="gchar">gchar</link> *str,
 
147
                                                         <link linkend="gint">gint</link> max_chars);</programlisting>
147
148
<para>
148
149
Creates a (possibly trimmed) copy of <parameter>str</parameter>. The string is cut if it
149
150
exceeds <parameter>max_chars</parameter> characters or on the first newline. The fact
164
165
</variablelist></refsect2>
165
166
<refsect2>
166
167
<title><anchor id="gimp-escape-uline" role="function" condition="since:GIMP 2.2"/>gimp_escape_uline ()</title>
167
 
<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>
 
168
<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>
168
169
<para>
169
170
This function returns a copy of <parameter>str</parameter> with all underline converted
170
171
to two adjacent underlines. This comes in handy when needing to display
180
181
freed using <link linkend="g-free"><function>g_free()</function></link> when it is not needed any longer.
181
182
 
182
183
</simpara></listitem></varlistentry>
183
 
</variablelist><para>Since  GIMP 2.2
 
184
</variablelist><para role="since">Since  GIMP 2.2
184
185
</para></refsect2>
185
186
<refsect2>
186
187
<title><anchor id="gimp-strip-uline" role="function"/>gimp_strip_uline ()</title>
187
 
<indexterm><primary>gimp_strip_uline</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_strip_uline                (const <link linkend="gchar">gchar</link> *str);</programlisting>
 
188
<indexterm><primary>gimp_strip_uline</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_strip_uline                    (const <link linkend="gchar">gchar</link> *str);</programlisting>
188
189
<para>
189
190
This function returns a copy of <parameter>str</parameter> stripped of underline
190
191
characters. This comes in handy when needing to strip mnemonics
206
207
</simpara></listitem></varlistentry>
207
208
</variablelist></refsect2>
208
209
<refsect2>
 
210
<title><anchor id="gimp-canonicalize-identifier" role="function" condition="since:GIMP 2.4"/>gimp_canonicalize_identifier ()</title>
 
211
<indexterm role="GIMP 2.4"><primary>gimp_canonicalize_identifier</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_canonicalize_identifier        (const <link linkend="gchar">gchar</link> *identifier);</programlisting>
 
212
<para>
 
213
Turns any input string into a canonicalized string.
 
214
</para>
 
215
<para>
 
216
Canonical identifiers are e.g. expected by the PDB for procedure
 
217
and parameter names. Every character of the input string that is
 
218
not either '-', 'a-z', 'A-Z' or '0-9' will be replaced by a '-'.</para>
 
219
<para>
 
220
 
 
221
</para><variablelist role="params">
 
222
<varlistentry><term><parameter>identifier</parameter>&nbsp;:</term>
 
223
<listitem><simpara> The identifier string to canonicalize.
 
224
</simpara></listitem></varlistentry>
 
225
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The canonicalized identifier. This is a newly
 
226
              allocated string that should be freed with <link linkend="g-free"><function>g_free()</function></link>
 
227
              when no longer needed.
 
228
 
 
229
</simpara></listitem></varlistentry>
 
230
</variablelist><para role="since">Since  GIMP 2.4
 
231
</para></refsect2>
 
232
<refsect2>
209
233
<title><anchor id="gimp-enum-get-desc" role="function" condition="since:GIMP 2.2"/>gimp_enum_get_desc ()</title>
210
 
<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,
211
 
                                             <link linkend="gint">gint</link> value);</programlisting>
 
234
<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,
 
235
                                                         <link linkend="gint">gint</link> value);</programlisting>
212
236
<para>
213
237
Retrieves <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link> associated with the given value, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
214
238
<para>
223
247
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the value's <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>.
224
248
 
225
249
</simpara></listitem></varlistentry>
226
 
</variablelist><para>Since  GIMP 2.2
 
250
</variablelist><para role="since">Since  GIMP 2.2
227
251
</para></refsect2>
228
252
<refsect2>
229
253
<title><anchor id="gimp-enum-get-value" role="function" condition="since:GIMP 2.2"/>gimp_enum_get_value ()</title>
230
 
<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,
231
 
                                             <link linkend="gint">gint</link> value,
232
 
                                             const <link linkend="gchar">gchar</link> **value_name,
233
 
                                             const <link linkend="gchar">gchar</link> **value_nick,
234
 
                                             const <link linkend="gchar">gchar</link> **value_desc,
235
 
                                             const <link linkend="gchar">gchar</link> **value_help);</programlisting>
 
254
<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,
 
255
                                                         <link linkend="gint">gint</link> value,
 
256
                                                         const <link linkend="gchar">gchar</link> **value_name,
 
257
                                                         const <link linkend="gchar">gchar</link> **value_nick,
 
258
                                                         const <link linkend="gchar">gchar</link> **value_desc,
 
259
                                                         const <link linkend="gchar">gchar</link> **value_help);</programlisting>
236
260
<para>
237
261
Checks if <parameter>value</parameter> is valid for the enum registered as <parameter>enum_type</parameter>.
238
262
If the value exists in that enum, its name, nick and its translated
263
287
              <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
264
288
 
265
289
</simpara></listitem></varlistentry>
266
 
</variablelist><para>Since  GIMP 2.2
 
290
</variablelist><para role="since">Since  GIMP 2.2
267
291
</para></refsect2>
268
292
<refsect2>
269
293
<title><anchor id="gimp-enum-value-get-desc" role="function" condition="since:GIMP 2.2"/>gimp_enum_value_get_desc ()</title>
270
 
<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,
271
 
                                             <link linkend="GEnumValue">GEnumValue</link> *enum_value);</programlisting>
 
294
<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,
 
295
                                                         <link linkend="GEnumValue">GEnumValue</link> *enum_value);</programlisting>
272
296
<para>
273
297
Retrieves the translated desc for a given <parameter>enum_value</parameter>.</para>
274
298
<para>
283
307
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translated desc of the enum value
284
308
 
285
309
</simpara></listitem></varlistentry>
286
 
</variablelist><para>Since  GIMP 2.2
 
310
</variablelist><para role="since">Since  GIMP 2.2
287
311
</para></refsect2>
288
312
<refsect2>
289
313
<title><anchor id="gimp-enum-value-get-help" role="function" condition="since:GIMP 2.2"/>gimp_enum_value_get_help ()</title>
290
 
<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,
291
 
                                             <link linkend="GEnumValue">GEnumValue</link> *enum_value);</programlisting>
 
314
<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,
 
315
                                                         <link linkend="GEnumValue">GEnumValue</link> *enum_value);</programlisting>
292
316
<para>
293
317
Retrieves the translated help for a given <parameter>enum_value</parameter>.</para>
294
318
<para>
303
327
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translated help of the enum value
304
328
 
305
329
</simpara></listitem></varlistentry>
306
 
</variablelist><para>Since  GIMP 2.2
 
330
</variablelist><para role="since">Since  GIMP 2.2
307
331
</para></refsect2>
308
332
<refsect2>
309
333
<title><anchor id="gimp-flags-get-first-desc" role="function" condition="since:GIMP 2.2"/>gimp_flags_get_first_desc ()</title>
310
 
<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,
311
 
                                             <link linkend="guint">guint</link> value);</programlisting>
 
334
<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,
 
335
                                                         <link linkend="guint">guint</link> value);</programlisting>
312
336
<para>
313
337
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>
314
338
<para>
323
347
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the value's <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>.
324
348
 
325
349
</simpara></listitem></varlistentry>
326
 
</variablelist><para>Since  GIMP 2.2
 
350
</variablelist><para role="since">Since  GIMP 2.2
327
351
</para></refsect2>
328
352
<refsect2>
329
353
<title><anchor id="gimp-flags-get-first-value" role="function" condition="since:GIMP 2.2"/>gimp_flags_get_first_value ()</title>
330
 
<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,
331
 
                                             <link linkend="guint">guint</link> value,
332
 
                                             const <link linkend="gchar">gchar</link> **value_name,
333
 
                                             const <link linkend="gchar">gchar</link> **value_nick,
334
 
                                             const <link linkend="gchar">gchar</link> **value_desc,
335
 
                                             const <link linkend="gchar">gchar</link> **value_help);</programlisting>
 
354
<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,
 
355
                                                         <link linkend="guint">guint</link> value,
 
356
                                                         const <link linkend="gchar">gchar</link> **value_name,
 
357
                                                         const <link linkend="gchar">gchar</link> **value_nick,
 
358
                                                         const <link linkend="gchar">gchar</link> **value_desc,
 
359
                                                         const <link linkend="gchar">gchar</link> **value_help);</programlisting>
336
360
<para>
337
361
Checks if <parameter>value</parameter> is valid for the flags registered as <parameter>flags_type</parameter>.
338
362
If the value exists in that flags, its name, nick and its translated
363
387
              <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
364
388
 
365
389
</simpara></listitem></varlistentry>
366
 
</variablelist><para>Since  GIMP 2.2
 
390
</variablelist><para role="since">Since  GIMP 2.2
367
391
</para></refsect2>
368
392
<refsect2>
369
393
<title><anchor id="gimp-flags-value-get-desc" role="function" condition="since:GIMP 2.2"/>gimp_flags_value_get_desc ()</title>
370
 
<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,
371
 
                                             <link linkend="GFlagsValue">GFlagsValue</link> *flags_value);</programlisting>
 
394
<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,
 
395
                                                         <link linkend="GFlagsValue">GFlagsValue</link> *flags_value);</programlisting>
372
396
<para>
373
397
Retrieves the translated desc for a given <parameter>flags_value</parameter>.</para>
374
398
<para>
383
407
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translated desc of the flags value
384
408
 
385
409
</simpara></listitem></varlistentry>
386
 
</variablelist><para>Since  GIMP 2.2
 
410
</variablelist><para role="since">Since  GIMP 2.2
387
411
</para></refsect2>
388
412
<refsect2>
389
413
<title><anchor id="gimp-flags-value-get-help" role="function" condition="since:GIMP 2.2"/>gimp_flags_value_get_help ()</title>
390
 
<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,
391
 
                                             <link linkend="GFlagsValue">GFlagsValue</link> *flags_value);</programlisting>
 
414
<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,
 
415
                                                         <link linkend="GFlagsValue">GFlagsValue</link> *flags_value);</programlisting>
392
416
<para>
393
417
Retrieves the translated help for a given <parameter>flags_value</parameter>.</para>
394
418
<para>
403
427
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translated help of the flags value
404
428
 
405
429
</simpara></listitem></varlistentry>
406
 
</variablelist><para>Since  GIMP 2.2
 
430
</variablelist><para role="since">Since  GIMP 2.2
407
431
</para></refsect2>
408
432
 
409
433
</refsect1>