← Back to branch summary

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

« back to all changes in this revision

Viewing changes to devel-docs/libgimpbase/html/libgimpbase-gimpenv.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:
devel-docs/libgimpbase/html/libgimpbase-gimpenv.html
41
41
<div class="refsynopsisdiv">
42
42
<a name="libgimpbase-gimpenv.synopsis"></a><h2>Synopsis</h2>
43
43
<pre class="synopsis">
44
 
void                <a class="link" href="libgimpbase-gimpenv.html#gimp-env-init" title="gimp_env_init ()">gimp_env_init</a>                       (<a
45
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
46
 
>gboolean</a> plug_in);
47
 
const <a
48
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
49
 
>gchar</a>*        <a class="link" href="libgimpbase-gimpenv.html#gimp-directory" title="gimp_directory ()">gimp_directory</a>                      (void);
50
 
const <a
51
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
52
 
>gchar</a>*        <a class="link" href="libgimpbase-gimpenv.html#gimp-data-directory" title="gimp_data_directory ()">gimp_data_directory</a>                 (void);
53
 
const <a
54
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
55
 
>gchar</a>*        <a class="link" href="libgimpbase-gimpenv.html#gimp-locale-directory" title="gimp_locale_directory ()">gimp_locale_directory</a>               (void);
56
 
const <a
57
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
58
 
>gchar</a>*        <a class="link" href="libgimpbase-gimpenv.html#gimp-plug-in-directory" title="gimp_plug_in_directory ()">gimp_plug_in_directory</a>              (void);
59
 
const <a
60
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
61
 
>gchar</a>*        <a class="link" href="libgimpbase-gimpenv.html#gimp-sysconf-directory" title="gimp_sysconf_directory ()">gimp_sysconf_directory</a>              (void);
62
 
const <a
63
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
64
 
>gchar</a>*        <a class="link" href="libgimpbase-gimpenv.html#gimp-user-directory" title="gimp_user_directory ()">gimp_user_directory</a>                 (<a class="link" href="libgimpbase-gimpbaseenums.html#GimpUserDirectory" title="enum GimpUserDirectory">GimpUserDirectory</a> type);
65
 
<a
66
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
67
 
>gchar</a>*              <a class="link" href="libgimpbase-gimpenv.html#gimp-personal-rc-file" title="gimp_personal_rc_file ()">gimp_personal_rc_file</a>               (const <a
68
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
69
 
>gchar</a> *basename);
70
 
const <a
71
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
72
 
>gchar</a>*        <a class="link" href="libgimpbase-gimpenv.html#gimp-gtkrc" title="gimp_gtkrc ()">gimp_gtkrc</a>                          (void);
73
 
<a
74
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
75
 
>GList</a>*              <a class="link" href="libgimpbase-gimpenv.html#gimp-path-parse" title="gimp_path_parse ()">gimp_path_parse</a>                     (const <a
76
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
77
 
>gchar</a> *path,
78
 
                                                         <a
79
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
80
 
>gint</a> max_paths,
81
 
                                                         <a
82
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
83
 
>gboolean</a> check,
84
 
                                                         <a
85
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
86
 
>GList</a> **check_failed);
87
 
<a
88
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
89
 
>gchar</a>*              <a class="link" href="libgimpbase-gimpenv.html#gimp-path-to-str" title="gimp_path_to_str ()">gimp_path_to_str</a>                    (<a
90
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
91
 
>GList</a> *path);
92
 
void                <a class="link" href="libgimpbase-gimpenv.html#gimp-path-free" title="gimp_path_free ()">gimp_path_free</a>                      (<a
93
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
94
 
>GList</a> *path);
95
 
<a
96
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
97
 
>gchar</a>*              <a class="link" href="libgimpbase-gimpenv.html#gimp-path-get-user-writable-dir" title="gimp_path_get_user_writable_dir ()">gimp_path_get_user_writable_dir</a>     (<a
98
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
99
 
>GList</a> *path);
 
44
void                <a class="link" href="libgimpbase-gimpenv.html#gimp-env-init" title="gimp_env_init ()">gimp_env_init</a>                       (gboolean plug_in);
 
45
const gchar*        <a class="link" href="libgimpbase-gimpenv.html#gimp-directory" title="gimp_directory ()">gimp_directory</a>                      (void);
 
46
const gchar*        <a class="link" href="libgimpbase-gimpenv.html#gimp-data-directory" title="gimp_data_directory ()">gimp_data_directory</a>                 (void);
 
47
const gchar*        <a class="link" href="libgimpbase-gimpenv.html#gimp-locale-directory" title="gimp_locale_directory ()">gimp_locale_directory</a>               (void);
 
48
const gchar*        <a class="link" href="libgimpbase-gimpenv.html#gimp-plug-in-directory" title="gimp_plug_in_directory ()">gimp_plug_in_directory</a>              (void);
 
49
const gchar*        <a class="link" href="libgimpbase-gimpenv.html#gimp-sysconf-directory" title="gimp_sysconf_directory ()">gimp_sysconf_directory</a>              (void);
 
50
const gchar*        <a class="link" href="libgimpbase-gimpenv.html#gimp-user-directory" title="gimp_user_directory ()">gimp_user_directory</a>                 (<a class="link" href="libgimpbase-gimpbaseenums.html#GimpUserDirectory" title="enum GimpUserDirectory">GimpUserDirectory</a> type);
 
51
gchar*              <a class="link" href="libgimpbase-gimpenv.html#gimp-personal-rc-file" title="gimp_personal_rc_file ()">gimp_personal_rc_file</a>               (const gchar *basename);
 
52
const gchar*        <a class="link" href="libgimpbase-gimpenv.html#gimp-gtkrc" title="gimp_gtkrc ()">gimp_gtkrc</a>                          (void);
 
53
GList*              <a class="link" href="libgimpbase-gimpenv.html#gimp-path-parse" title="gimp_path_parse ()">gimp_path_parse</a>                     (const gchar *path,
 
54
                                                         gint max_paths,
 
55
                                                         gboolean check,
 
56
                                                         GList **check_failed);
 
57
gchar*              <a class="link" href="libgimpbase-gimpenv.html#gimp-path-to-str" title="gimp_path_to_str ()">gimp_path_to_str</a>                    (GList *path);
 
58
void                <a class="link" href="libgimpbase-gimpenv.html#gimp-path-free" title="gimp_path_free ()">gimp_path_free</a>                      (GList *path);
 
59
gchar*              <a class="link" href="libgimpbase-gimpenv.html#gimp-path-get-user-writable-dir" title="gimp_path_get_user_writable_dir ()">gimp_path_get_user_writable_dir</a>     (GList *path);
100
60
</pre>
101
61
</div>
102
62
<div class="refsect1" lang="en">
110
70
<a name="libgimpbase-gimpenv.details"></a><h2>Details</h2>
111
71
<div class="refsect2" lang="en">
112
72
<a name="gimp-env-init"></a><h3>gimp_env_init ()</h3>
113
 
<pre class="programlisting">void                gimp_env_init                       (<a
114
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
115
 
>gboolean</a> plug_in);</pre>
 
73
<pre class="programlisting">void                gimp_env_init                       (gboolean plug_in);</pre>
116
74
<p>
117
75
You don't need to care about this function. It is being called for
118
 
you automatically (by means of the <a
119
 
href="/usr/share/gtk-doc/html/libgimp/libgimp-gimp.html#MAIN:CAPS"
120
 
><code class="function">MAIN()</code></a> macro that every plug-in
 
76
you automatically (by means of the <code class="function">MAIN()</code> macro that every plug-in
121
77
runs). Calling it again will cause a fatal error.</p>
122
78
<p>
123
79
 
126
82
<col align="left" valign="top">
127
83
<tbody><tr>
128
84
<td><p><span class="term"><em class="parameter"><code>plug_in</code></em> :</span></p></td>
129
 
<td> must be <a
130
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
131
 
><code class="literal">TRUE</code></a> if this function is called from a plug-in
 
85
<td> must be <code class="literal">TRUE</code> if this function is called from a plug-in
132
86
</td>
133
87
</tr></tbody>
134
88
</table></div>
138
92
<hr>
139
93
<div class="refsect2" lang="en">
140
94
<a name="gimp-directory"></a><h3>gimp_directory ()</h3>
141
 
<pre class="programlisting">const <a
142
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
143
 
>gchar</a>*        gimp_directory                      (void);</pre>
 
95
<pre class="programlisting">const gchar*        gimp_directory                      (void);</pre>
144
96
<p>
145
97
Returns the user-specific GIMP settings directory. If the
146
98
environment variable GIMP2_DIRECTORY exists, it is used. If it is
177
129
<hr>
178
130
<div class="refsect2" lang="en">
179
131
<a name="gimp-data-directory"></a><h3>gimp_data_directory ()</h3>
180
 
<pre class="programlisting">const <a
181
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
182
 
>gchar</a>*        gimp_data_directory                 (void);</pre>
 
132
<pre class="programlisting">const gchar*        gimp_data_directory                 (void);</pre>
183
133
<p>
184
134
Returns the top directory for GIMP data. If the environment
185
135
variable GIMP2_DATADIR exists, that is used.  It should be an
207
157
<hr>
208
158
<div class="refsect2" lang="en">
209
159
<a name="gimp-locale-directory"></a><h3>gimp_locale_directory ()</h3>
210
 
<pre class="programlisting">const <a
211
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
212
 
>gchar</a>*        gimp_locale_directory               (void);</pre>
 
160
<pre class="programlisting">const gchar*        gimp_locale_directory               (void);</pre>
213
161
<p>
214
162
Returns the top directory for GIMP locale files. If the environment
215
163
variable GIMP2_LOCALEDIR exists, that is used.  It should be an
240
188
<hr>
241
189
<div class="refsect2" lang="en">
242
190
<a name="gimp-plug-in-directory"></a><h3>gimp_plug_in_directory ()</h3>
243
 
<pre class="programlisting">const <a
244
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
245
 
>gchar</a>*        gimp_plug_in_directory              (void);</pre>
 
191
<pre class="programlisting">const gchar*        gimp_plug_in_directory              (void);</pre>
246
192
<p>
247
193
Returns the top directory for GIMP plug_ins and modules. If the
248
194
environment variable GIMP2_PLUGINDIR exists, that is used.  It
270
216
<hr>
271
217
<div class="refsect2" lang="en">
272
218
<a name="gimp-sysconf-directory"></a><h3>gimp_sysconf_directory ()</h3>
273
 
<pre class="programlisting">const <a
274
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
275
 
>gchar</a>*        gimp_sysconf_directory              (void);</pre>
 
219
<pre class="programlisting">const gchar*        gimp_sysconf_directory              (void);</pre>
276
220
<p>
277
221
Returns the top directory for GIMP config files. If the environment
278
222
variable GIMP2_SYSCONFDIR exists, that is used.  It should be an
300
244
<hr>
301
245
<div class="refsect2" lang="en">
302
246
<a name="gimp-user-directory"></a><h3>gimp_user_directory ()</h3>
303
 
<pre class="programlisting">const <a
304
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
305
 
>gchar</a>*        gimp_user_directory                 (<a class="link" href="libgimpbase-gimpbaseenums.html#GimpUserDirectory" title="enum GimpUserDirectory">GimpUserDirectory</a> type);</pre>
 
247
<pre class="programlisting">const gchar*        gimp_user_directory                 (<a class="link" href="libgimpbase-gimpbaseenums.html#GimpUserDirectory" title="enum GimpUserDirectory">GimpUserDirectory</a> type);</pre>
306
248
<p>
307
249
Identifies special folders used frequently by applications, but
308
250
which may not have the same name or location on any given system.
323
265
</tr>
324
266
<tr>
325
267
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
326
 
<td> The path to the specified user directory, or <a
327
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
328
 
><code class="literal">NULL</code></a> if the
 
268
<td> The path to the specified user directory, or <code class="literal">NULL</code> if the
329
269
         logical ID was not found.
330
270
 
331
271
</td>
338
278
<hr>
339
279
<div class="refsect2" lang="en">
340
280
<a name="gimp-personal-rc-file"></a><h3>gimp_personal_rc_file ()</h3>
341
 
<pre class="programlisting"><a
342
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
343
 
>gchar</a>*              gimp_personal_rc_file               (const <a
344
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
345
 
>gchar</a> *basename);</pre>
 
281
<pre class="programlisting">gchar*              gimp_personal_rc_file               (const gchar *basename);</pre>
346
282
<p>
347
283
Returns the name of a file in the user-specific GIMP settings directory.
348
284
</p>
349
285
<p>
350
286
The returned string is allocated dynamically and *SHOULD* be freed
351
 
with <a
352
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
353
 
><code class="function">g_free()</code></a> after use. The returned string is in the encoding
 
287
with <code class="function">g_free()</code> after use. The returned string is in the encoding
354
288
used for filenames by GLib, which isn't necessarily
355
289
UTF-8. (On Windows it always is UTF-8.)</p>
356
290
<p>
375
309
<hr>
376
310
<div class="refsect2" lang="en">
377
311
<a name="gimp-gtkrc"></a><h3>gimp_gtkrc ()</h3>
378
 
<pre class="programlisting">const <a
379
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
380
 
>gchar</a>*        gimp_gtkrc                          (void);</pre>
 
312
<pre class="programlisting">const gchar*        gimp_gtkrc                          (void);</pre>
381
313
<p>
382
314
Returns the name of GIMP's application-specific gtkrc file.
383
315
</p>
401
333
<hr>
402
334
<div class="refsect2" lang="en">
403
335
<a name="gimp-path-parse"></a><h3>gimp_path_parse ()</h3>
404
 
<pre class="programlisting"><a
405
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
406
 
>GList</a>*              gimp_path_parse                     (const <a
407
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
408
 
>gchar</a> *path,
409
 
                                                         <a
410
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
411
 
>gint</a> max_paths,
412
 
                                                         <a
413
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
414
 
>gboolean</a> check,
415
 
                                                         <a
416
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
417
 
>GList</a> **check_failed);</pre>
 
336
<pre class="programlisting">GList*              gimp_path_parse                     (const gchar *path,
 
337
                                                         gint max_paths,
 
338
                                                         gboolean check,
 
339
                                                         GList **check_failed);</pre>
418
340
<p>
419
341
</p>
420
342
<p>
425
347
<tbody>
426
348
<tr>
427
349
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
428
 
<td>         A list of directories separated by <a
429
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
430
 
><span class="type">G_SEARCHPATH_SEPARATOR</span></a>.
 
350
<td>         A list of directories separated by <span class="type">G_SEARCHPATH_SEPARATOR</span>.
431
351
</td>
432
352
</tr>
433
353
<tr>
437
357
</tr>
438
358
<tr>
439
359
<td><p><span class="term"><em class="parameter"><code>check</code></em> :</span></p></td>
440
 
<td>        <a
441
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
442
 
><code class="literal">TRUE</code></a> if you want the directories to be checked.
 
360
<td>        <code class="literal">TRUE</code> if you want the directories to be checked.
443
361
</td>
444
362
</tr>
445
363
<tr>
446
364
<td><p><span class="term"><em class="parameter"><code>check_failed</code></em> :</span></p></td>
447
 
<td> Returns a <a
448
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
449
 
><span class="type">GList</span></a> of path elements for which the
 
365
<td> Returns a <span class="type">GList</span> of path elements for which the
450
366
               check failed.
451
367
</td>
452
368
</tr>
453
369
<tr>
454
370
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
455
 
<td> A <a
456
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
457
 
><span class="type">GList</span></a> of all directories in <em class="parameter"><code>path</code></em>.
 
371
<td> A <span class="type">GList</span> of all directories in <em class="parameter"><code>path</code></em>.
458
372
</td>
459
373
</tr>
460
374
</tbody>
463
377
<hr>
464
378
<div class="refsect2" lang="en">
465
379
<a name="gimp-path-to-str"></a><h3>gimp_path_to_str ()</h3>
466
 
<pre class="programlisting"><a
467
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
468
 
>gchar</a>*              gimp_path_to_str                    (<a
469
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
470
 
>GList</a> *path);</pre>
 
380
<pre class="programlisting">gchar*              gimp_path_to_str                    (GList *path);</pre>
471
381
<p>
472
382
</p>
473
383
<p>
483
393
</tr>
484
394
<tr>
485
395
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
486
 
<td> A searchpath string separated by <a
487
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
488
 
><span class="type">G_SEARCHPATH_SEPARATOR</span></a>.
 
396
<td> A searchpath string separated by <span class="type">G_SEARCHPATH_SEPARATOR</span>.
489
397
</td>
490
398
</tr>
491
399
</tbody>
494
402
<hr>
495
403
<div class="refsect2" lang="en">
496
404
<a name="gimp-path-free"></a><h3>gimp_path_free ()</h3>
497
 
<pre class="programlisting">void                gimp_path_free                      (<a
498
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
499
 
>GList</a> *path);</pre>
 
405
<pre class="programlisting">void                gimp_path_free                      (GList *path);</pre>
500
406
<p>
501
407
This function frees the memory allocated for the list and the strings
502
408
it contains.</p>
515
421
<hr>
516
422
<div class="refsect2" lang="en">
517
423
<a name="gimp-path-get-user-writable-dir"></a><h3>gimp_path_get_user_writable_dir ()</h3>
518
 
<pre class="programlisting"><a
519
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
520
 
>gchar</a>*              gimp_path_get_user_writable_dir     (<a
521
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
522
 
>GList</a> *path);</pre>
 
424
<pre class="programlisting">gchar*              gimp_path_get_user_writable_dir     (GList *path);</pre>
523
425
<p>
524
 
Note that you have to <a
525
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
526
 
><code class="function">g_free()</code></a> the returned string.</p>
 
426
Note that you have to <code class="function">g_free()</code> the returned string.</p>
527
427
<p>
528
428
 
529
429
</p>