← Back to branch summary

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

« back to all changes in this revision

Viewing changes to devel-docs/libgimpconfig/html/libgimpconfig-gimpconfig-path.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/libgimpconfig/html/libgimpconfig-gimpconfig-path.html
42
42
<a name="libgimpconfig-gimpconfig-path.synopsis"></a><h2>Synopsis</h2>
43
43
<pre class="synopsis">
44
44
enum                <a class="link" href="libgimpconfig-gimpconfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType">GimpConfigPathType</a>;
45
 
<a
46
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
47
 
>GParamSpec</a>*         <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-param-spec-config-path" title="gimp_param_spec_config_path ()">gimp_param_spec_config_path</a>         (const <a
48
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
49
 
>gchar</a> *name,
50
 
                                                         const <a
51
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
52
 
>gchar</a> *nick,
53
 
                                                         const <a
54
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
55
 
>gchar</a> *blurb,
 
45
GParamSpec*         <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-param-spec-config-path" title="gimp_param_spec_config_path ()">gimp_param_spec_config_path</a>         (const gchar *name,
 
46
                                                         const gchar *nick,
 
47
                                                         const gchar *blurb,
56
48
                                                         <a class="link" href="libgimpconfig-gimpconfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType">GimpConfigPathType</a> type,
57
 
                                                         const <a
58
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
59
 
>gchar</a> *default_value,
60
 
                                                         <a
61
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamFlags"
62
 
>GParamFlags</a> flags);
63
 
<a class="link" href="libgimpconfig-gimpconfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType">GimpConfigPathType</a>  <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-param-spec-config-path-type" title="gimp_param_spec_config_path_type ()">gimp_param_spec_config_path_type</a>    (<a
64
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
65
 
>GParamSpec</a> *pspec);
66
 
<a
67
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
68
 
>gchar</a>*              <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-path-expand" title="gimp_config_path_expand ()">gimp_config_path_expand</a>             (const <a
69
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
70
 
>gchar</a> *path,
71
 
                                                         <a
72
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
73
 
>gboolean</a> recode,
74
 
                                                         <a
75
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
76
 
>GError</a> **error);
77
 
<a
78
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
79
 
>gchar</a>*              <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-build-data-path" title="gimp_config_build_data_path ()">gimp_config_build_data_path</a>         (const <a
80
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
81
 
>gchar</a> *name);
82
 
<a
83
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
84
 
>gchar</a>*              <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-build-writable-path" title="gimp_config_build_writable_path ()">gimp_config_build_writable_path</a>     (const <a
85
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
86
 
>gchar</a> *name);
87
 
<a
88
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
89
 
>gchar</a>*              <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-build-plug-in-path" title="gimp_config_build_plug_in_path ()">gimp_config_build_plug_in_path</a>      (const <a
90
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
91
 
>gchar</a> *name);
 
49
                                                         const gchar *default_value,
 
50
                                                         GParamFlags flags);
 
51
<a class="link" href="libgimpconfig-gimpconfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType">GimpConfigPathType</a>  <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-param-spec-config-path-type" title="gimp_param_spec_config_path_type ()">gimp_param_spec_config_path_type</a>    (GParamSpec *pspec);
 
52
gchar*              <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-path-expand" title="gimp_config_path_expand ()">gimp_config_path_expand</a>             (const gchar *path,
 
53
                                                         gboolean recode,
 
54
                                                         GError **error);
 
55
gchar*              <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-build-data-path" title="gimp_config_build_data_path ()">gimp_config_build_data_path</a>         (const gchar *name);
 
56
gchar*              <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-build-writable-path" title="gimp_config_build_writable_path ()">gimp_config_build_writable_path</a>     (const gchar *name);
 
57
gchar*              <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-build-plug-in-path" title="gimp_config_build_plug_in_path ()">gimp_config_build_plug_in_path</a>      (const gchar *name);
92
58
#define             <a class="link" href="libgimpconfig-gimpconfig-path.html#GIMP-VALUE-HOLDS-CONFIG-PATH:CAPS" title="GIMP_VALUE_HOLDS_CONFIG_PATH()">GIMP_VALUE_HOLDS_CONFIG_PATH</a>        (value)
93
59
</pre>
94
60
</div>
117
83
<hr>
118
84
<div class="refsect2" lang="en">
119
85
<a name="gimp-param-spec-config-path"></a><h3>gimp_param_spec_config_path ()</h3>
120
 
<pre class="programlisting"><a
121
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
122
 
>GParamSpec</a>*         gimp_param_spec_config_path         (const <a
123
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
124
 
>gchar</a> *name,
125
 
                                                         const <a
126
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
127
 
>gchar</a> *nick,
128
 
                                                         const <a
129
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
130
 
>gchar</a> *blurb,
 
86
<pre class="programlisting">GParamSpec*         gimp_param_spec_config_path         (const gchar *name,
 
87
                                                         const gchar *nick,
 
88
                                                         const gchar *blurb,
131
89
                                                         <a class="link" href="libgimpconfig-gimpconfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType">GimpConfigPathType</a> type,
132
 
                                                         const <a
133
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
134
 
>gchar</a> *default_value,
135
 
                                                         <a
136
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamFlags"
137
 
>GParamFlags</a> flags);</pre>
 
90
                                                         const gchar *default_value,
 
91
                                                         GParamFlags flags);</pre>
138
92
<p>
139
93
Creates a param spec to hold a filename, dir name,
140
94
or list of file or dir names.
141
 
See <a
142
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#g-param-spec-internal"
143
 
><code class="function">g_param_spec_internal()</code></a> for more information.</p>
 
95
See <code class="function">g_param_spec_internal()</code> for more information.</p>
144
96
<p>
145
97
 
146
98
</p>
174
126
</tr>
175
127
<tr>
176
128
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
177
 
<td>         a combination of <a
178
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamFlags"
179
 
><span class="type">GParamFlags</span></a>
 
129
<td>         a combination of <span class="type">GParamFlags</span>
180
130
</td>
181
131
</tr>
182
132
<tr>
183
133
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
184
 
<td> a newly allocated <a
185
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
186
 
><span class="type">GParamSpec</span></a> instance
 
134
<td> a newly allocated <span class="type">GParamSpec</span> instance
187
135
 
188
136
</td>
189
137
</tr>
195
143
<hr>
196
144
<div class="refsect2" lang="en">
197
145
<a name="gimp-param-spec-config-path-type"></a><h3>gimp_param_spec_config_path_type ()</h3>
198
 
<pre class="programlisting"><a class="link" href="libgimpconfig-gimpconfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType">GimpConfigPathType</a>  gimp_param_spec_config_path_type    (<a
199
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
200
 
>GParamSpec</a> *pspec);</pre>
 
146
<pre class="programlisting"><a class="link" href="libgimpconfig-gimpconfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType">GimpConfigPathType</a>  gimp_param_spec_config_path_type    (GParamSpec *pspec);</pre>
201
147
<p>
202
148
Tells whether the path param encodes a filename,
203
149
dir name, or list of file or dir names.</p>
209
155
<tbody>
210
156
<tr>
211
157
<td><p><span class="term"><em class="parameter"><code>pspec</code></em> :</span></p></td>
212
 
<td>         A <a
213
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
214
 
><span class="type">GParamSpec</span></a> for a path param
 
158
<td>         A <span class="type">GParamSpec</span> for a path param
215
159
</td>
216
160
</tr>
217
161
<tr>
228
172
<hr>
229
173
<div class="refsect2" lang="en">
230
174
<a name="gimp-config-path-expand"></a><h3>gimp_config_path_expand ()</h3>
231
 
<pre class="programlisting"><a
232
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
233
 
>gchar</a>*              gimp_config_path_expand             (const <a
234
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
235
 
>gchar</a> *path,
236
 
                                                         <a
237
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
238
 
>gboolean</a> recode,
239
 
                                                         <a
240
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
241
 
>GError</a> **error);</pre>
 
175
<pre class="programlisting">gchar*              gimp_config_path_expand             (const gchar *path,
 
176
                                                         gboolean recode,
 
177
                                                         GError **error);</pre>
242
178
<p>
243
179
Paths as stored in the gimprc have to be treated special.  The
244
180
string may contain special identifiers such as for example
282
218
<hr>
283
219
<div class="refsect2" lang="en">
284
220
<a name="gimp-config-build-data-path"></a><h3>gimp_config_build_data_path ()</h3>
285
 
<pre class="programlisting"><a
286
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
287
 
>gchar</a>*              gimp_config_build_data_path         (const <a
288
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
289
 
>gchar</a> *name);</pre>
 
221
<pre class="programlisting">gchar*              gimp_config_build_data_path         (const gchar *name);</pre>
290
222
<p>
291
223
Creates a search path as it is used in the gimprc file.  The path
292
224
returned by <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-build-data-path" title="gimp_config_build_data_path ()"><code class="function">gimp_config_build_data_path()</code></a> includes a directory
295
227
</p>
296
228
<p>
297
229
Note that you cannot use this path directly with <a
298
 
href="/usr/share/gtk-doc/html/libgimpbase/libgimpbase-gimpenv.html#gimp-path-parse"
 
230
href="../libgimpbase/libgimpbase-gimpenv.html#gimp-path-parse"
299
231
><code class="function">gimp_path_parse()</code></a>.
300
232
As it is in the gimprc notation, you first need to expand and
301
233
recode it using <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-path-expand" title="gimp_config_path_expand ()"><code class="function">gimp_config_path_expand()</code></a>.</p>
324
256
<hr>
325
257
<div class="refsect2" lang="en">
326
258
<a name="gimp-config-build-writable-path"></a><h3>gimp_config_build_writable_path ()</h3>
327
 
<pre class="programlisting"><a
328
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
329
 
>gchar</a>*              gimp_config_build_writable_path     (const <a
330
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
331
 
>gchar</a> *name);</pre>
 
259
<pre class="programlisting">gchar*              gimp_config_build_writable_path     (const gchar *name);</pre>
332
260
<p>
333
261
Creates a search path as it is used in the gimprc file.  The path
334
262
returned by <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-build-writable-path" title="gimp_config_build_writable_path ()"><code class="function">gimp_config_build_writable_path()</code></a> is just the writable
336
264
</p>
337
265
<p>
338
266
Note that you cannot use this path directly with <a
339
 
href="/usr/share/gtk-doc/html/libgimpbase/libgimpbase-gimpenv.html#gimp-path-parse"
 
267
href="../libgimpbase/libgimpbase-gimpenv.html#gimp-path-parse"
340
268
><code class="function">gimp_path_parse()</code></a>.
341
269
As it is in the gimprc notation, you first need to expand and
342
270
recode it using <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-path-expand" title="gimp_config_path_expand ()"><code class="function">gimp_config_path_expand()</code></a>.</p>
365
293
<hr>
366
294
<div class="refsect2" lang="en">
367
295
<a name="gimp-config-build-plug-in-path"></a><h3>gimp_config_build_plug_in_path ()</h3>
368
 
<pre class="programlisting"><a
369
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
370
 
>gchar</a>*              gimp_config_build_plug_in_path      (const <a
371
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
372
 
>gchar</a> *name);</pre>
 
296
<pre class="programlisting">gchar*              gimp_config_build_plug_in_path      (const gchar *name);</pre>
373
297
<p>
374
298
Creates a search path as it is used in the gimprc file.  The path
375
299
returned by <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-build-plug-in-path" title="gimp_config_build_plug_in_path ()"><code class="function">gimp_config_build_plug_in_path()</code></a> includes a directory
378
302
</p>
379
303
<p>
380
304
Note that you cannot use this path directly with <a
381
 
href="/usr/share/gtk-doc/html/libgimpbase/libgimpbase-gimpenv.html#gimp-path-parse"
 
305
href="../libgimpbase/libgimpbase-gimpenv.html#gimp-path-parse"
382
306
><code class="function">gimp_path_parse()</code></a>.
383
307
As it is in the gimprc notation, you first need to expand and
384
308
recode it using <a class="link" href="libgimpconfig-gimpconfig-path.html#gimp-config-path-expand" title="gimp_config_path_expand ()"><code class="function">gimp_config_path_expand()</code></a>.</p>