~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/html/GimpPathEditor.html

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GimpPathEditor</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
8
8
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
9
9
<link rel="prev" href="GimpPageSelector.html" title="GimpPageSelector">
10
10
<link rel="next" href="GimpPickButton.html" title="GimpPickButton">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
14
14
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
34
34
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
35
35
<td><a accesskey="n" href="GimpPickButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
36
36
</tr>
37
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GimpPathEditor.synopsis" class="shortcut">Top</a>
38
 
                   | 
39
 
                  <a href="#GimpPathEditor.description" class="shortcut">Description</a>
40
 
                   | 
41
 
                  <a href="#GimpPathEditor.object-hierarchy" class="shortcut">Object Hierarchy</a>
42
 
                   | 
43
 
                  <a href="#GimpPathEditor.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
44
 
                   | 
45
 
                  <a href="#GimpPathEditor.signals" class="shortcut">Signals</a></nobr></td></tr>
 
37
<tr><td colspan="5" class="shortcuts">
 
38
<a href="#GimpPathEditor.synopsis" class="shortcut">Top</a>
 
39
                 | 
 
40
                <a href="#GimpPathEditor.description" class="shortcut">Description</a>
 
41
                 | 
 
42
                <a href="#GimpPathEditor.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
43
                 | 
 
44
                <a href="#GimpPathEditor.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
45
                 | 
 
46
                <a href="#GimpPathEditor.signals" class="shortcut">Signals</a>
 
47
</td></tr>
46
48
</table>
47
 
<div class="refentry" lang="en">
 
49
<div class="refentry" title="GimpPathEditor">
48
50
<a name="GimpPathEditor"></a><div class="titlepage"></div>
49
51
<div class="refnamediv"><table width="100%"><tr>
50
52
<td valign="top">
53
55
</td>
54
56
<td valign="top" align="right"><img src="gimp-path-editor.png"></td>
55
57
</tr></table></div>
56
 
<div class="refsynopsisdiv">
 
58
<div class="refsynopsisdiv" title="Synopsis">
57
59
<a name="GimpPathEditor.synopsis"></a><h2>Synopsis</h2>
58
60
<pre class="synopsis">
59
61
                    <a class="link" href="GimpPathEditor.html#GimpPathEditor-struct" title="GimpPathEditor">GimpPathEditor</a>;
60
62
<a
61
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
62
 
>GtkWidget</a>*          <a class="link" href="GimpPathEditor.html#gimp-path-editor-new" title="gimp_path_editor_new ()">gimp_path_editor_new</a>                (const <a
 
63
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
 
64
>GtkWidget</a> *         <a class="link" href="GimpPathEditor.html#gimp-path-editor-new" title="gimp_path_editor_new ()">gimp_path_editor_new</a>                (const <a
63
65
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
64
66
>gchar</a> *title,
65
67
                                                         const <a
67
69
>gchar</a> *path);
68
70
<a
69
71
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
70
 
>gchar</a>*              <a class="link" href="GimpPathEditor.html#gimp-path-editor-get-path" title="gimp_path_editor_get_path ()">gimp_path_editor_get_path</a>           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);
 
72
>gchar</a> *             <a class="link" href="GimpPathEditor.html#gimp-path-editor-get-path" title="gimp_path_editor_get_path ()">gimp_path_editor_get_path</a>           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);
71
73
void                <a class="link" href="GimpPathEditor.html#gimp-path-editor-set-path" title="gimp_path_editor_set_path ()">gimp_path_editor_set_path</a>           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
72
74
                                                         const <a
73
75
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
74
76
>gchar</a> *path);
75
77
<a
76
78
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
77
 
>gchar</a>*              <a class="link" href="GimpPathEditor.html#gimp-path-editor-get-writable-path" title="gimp_path_editor_get_writable_path ()">gimp_path_editor_get_writable_path</a>  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);
 
79
>gchar</a> *             <a class="link" href="GimpPathEditor.html#gimp-path-editor-get-writable-path" title="gimp_path_editor_get_writable_path ()">gimp_path_editor_get_writable_path</a>  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);
78
80
void                <a class="link" href="GimpPathEditor.html#gimp-path-editor-set-writable-path" title="gimp_path_editor_set_writable_path ()">gimp_path_editor_set_writable_path</a>  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
79
81
                                                         const <a
80
82
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
94
96
>gboolean</a> writable);
95
97
</pre>
96
98
</div>
97
 
<div class="refsect1" lang="en">
 
99
<div class="refsect1" title="Object Hierarchy">
98
100
<a name="GimpPathEditor.object-hierarchy"></a><h2>Object Hierarchy</h2>
99
101
<pre class="synopsis">
100
102
  <a
104
106
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
105
107
>GInitiallyUnowned</a>
106
108
         +----<a
107
 
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
 
109
href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html"
108
110
>GtkObject</a>
109
111
               +----<a
110
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
112
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
111
113
>GtkWidget</a>
112
114
                     +----<a
113
 
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
 
115
href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html"
114
116
>GtkContainer</a>
115
117
                           +----<a
116
 
href="/usr/share/gtk-doc/html/gtk/GtkBox.html"
 
118
href="http://library.gnome.org/devel/gtk/unstable/GtkBox.html"
117
119
>GtkBox</a>
118
120
                                 +----<a
119
 
href="/usr/share/gtk-doc/html/gtk/GtkVBox.html"
 
121
href="http://library.gnome.org/devel/gtk/unstable/GtkVBox.html"
120
122
>GtkVBox</a>
121
123
                                       +----GimpPathEditor
122
124
</pre>
123
125
</div>
124
 
<div class="refsect1" lang="en">
 
126
<div class="refsect1" title="Implemented Interfaces">
125
127
<a name="GimpPathEditor.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
126
128
<p>
127
129
GimpPathEditor implements
128
 
 AtkImplementorIface and  <a
129
 
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
130
 
>GtkBuildable</a>.</p>
 
130
 <a
 
131
href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable"
 
132
>GtkBuildable</a>,  AtkImplementorIface and  <a
 
133
href="http://library.gnome.org/devel/gtk/unstable/gtk-Orientable.html#GtkOrientable"
 
134
>GtkOrientable</a>.</p>
131
135
</div>
132
 
<div class="refsect1" lang="en">
 
136
<div class="refsect1" title="Signals">
133
137
<a name="GimpPathEditor.signals"></a><h2>Signals</h2>
134
138
<pre class="synopsis">
135
139
  "<a class="link" href="GimpPathEditor.html#GimpPathEditor-path-changed" title='The "path-changed" signal'>path-changed</a>"                                   : Run First
136
140
  "<a class="link" href="GimpPathEditor.html#GimpPathEditor-writable-changed" title='The "writable-changed" signal'>writable-changed</a>"                               : Run First
137
141
</pre>
138
142
</div>
139
 
<div class="refsect1" lang="en">
 
143
<div class="refsect1" title="Description">
140
144
<a name="GimpPathEditor.description"></a><h2>Description</h2>
141
145
<p>
142
146
This widget is used to edit file search paths.
155
159
the search path, the "path_changed" signal will be emitted.
156
160
</p>
157
161
</div>
158
 
<div class="refsect1" lang="en">
 
162
<div class="refsect1" title="Details">
159
163
<a name="GimpPathEditor.details"></a><h2>Details</h2>
160
 
<div class="refsect2" lang="en">
 
164
<div class="refsect2" title="GimpPathEditor">
161
165
<a name="GimpPathEditor-struct"></a><h3>GimpPathEditor</h3>
162
166
<pre class="programlisting">typedef struct _GimpPathEditor GimpPathEditor;</pre>
163
167
<p>
164
 
 
165
168
</p>
166
169
</div>
167
170
<hr>
168
 
<div class="refsect2" lang="en">
 
171
<div class="refsect2" title="gimp_path_editor_new ()">
169
172
<a name="gimp-path-editor-new"></a><h3>gimp_path_editor_new ()</h3>
170
173
<pre class="programlisting"><a
171
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
172
 
>GtkWidget</a>*          gimp_path_editor_new                (const <a
 
174
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
 
175
>GtkWidget</a> *         gimp_path_editor_new                (const <a
173
176
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
174
177
>gchar</a> *title,
175
178
                                                         const <a
181
184
<p>
182
185
The elements of the initial search path must be separated with the
183
186
<a
184
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
 
187
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR--CAPS"
185
188
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> character.</p>
186
189
<p>
187
 
 
188
190
</p>
189
191
<div class="variablelist"><table border="0">
190
192
<col align="left" valign="top">
192
194
<tr>
193
195
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
194
196
<td> The title of the <a
195
 
href="/usr/share/gtk-doc/html/gtk/GtkFileChooser.html"
 
197
href="http://library.gnome.org/devel/gtk/unstable/GtkFileChooser.html"
196
198
><span class="type">GtkFileChooser</span></a> dialog which can be popped up.
197
199
</td>
198
200
</tr>
210
212
</table></div>
211
213
</div>
212
214
<hr>
213
 
<div class="refsect2" lang="en">
 
215
<div class="refsect2" title="gimp_path_editor_get_path ()">
214
216
<a name="gimp-path-editor-get-path"></a><h3>gimp_path_editor_get_path ()</h3>
215
217
<pre class="programlisting"><a
216
218
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
217
 
>gchar</a>*              gimp_path_editor_get_path           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);</pre>
 
219
>gchar</a> *             gimp_path_editor_get_path           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);</pre>
218
220
<p>
219
221
The elements of the returned search path string are separated with the
220
222
<a
221
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
 
223
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR--CAPS"
222
224
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> character.
223
225
</p>
224
226
<p>
226
228
href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"
227
229
><code class="function">g_free()</code></a> the returned string.</p>
228
230
<p>
229
 
 
230
231
</p>
231
232
<div class="variablelist"><table border="0">
232
233
<col align="left" valign="top">
245
246
</table></div>
246
247
</div>
247
248
<hr>
248
 
<div class="refsect2" lang="en">
 
249
<div class="refsect2" title="gimp_path_editor_set_path ()">
249
250
<a name="gimp-path-editor-set-path"></a><h3>gimp_path_editor_set_path ()</h3>
250
251
<pre class="programlisting">void                gimp_path_editor_set_path           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
251
252
                                                         const <a
254
255
<p>
255
256
The elements of the initial search path must be separated with the
256
257
<a
257
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
 
258
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR--CAPS"
258
259
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> character.</p>
259
260
<p>
260
 
 
261
261
</p>
262
262
<div class="variablelist"><table border="0">
263
263
<col align="left" valign="top">
276
276
</table></div>
277
277
</div>
278
278
<hr>
279
 
<div class="refsect2" lang="en">
 
279
<div class="refsect2" title="gimp_path_editor_get_writable_path ()">
280
280
<a name="gimp-path-editor-get-writable-path"></a><h3>gimp_path_editor_get_writable_path ()</h3>
281
281
<pre class="programlisting"><a
282
282
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
283
 
>gchar</a>*              gimp_path_editor_get_writable_path  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);</pre>
 
283
>gchar</a> *             gimp_path_editor_get_writable_path  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);</pre>
284
284
<p>
285
 
 
286
285
</p>
287
286
<div class="variablelist"><table border="0">
288
287
<col align="left" valign="top">
295
294
<tr>
296
295
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
297
296
<td>
298
 
 
299
 
 
300
297
</td>
301
298
</tr>
302
299
</tbody>
303
300
</table></div>
304
301
</div>
305
302
<hr>
306
 
<div class="refsect2" lang="en">
 
303
<div class="refsect2" title="gimp_path_editor_set_writable_path ()">
307
304
<a name="gimp-path-editor-set-writable-path"></a><h3>gimp_path_editor_set_writable_path ()</h3>
308
305
<pre class="programlisting">void                gimp_path_editor_set_writable_path  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
309
306
                                                         const <a
310
307
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
311
308
>gchar</a> *path);</pre>
312
309
<p>
313
 
 
314
310
</p>
315
311
<div class="variablelist"><table border="0">
316
312
<col align="left" valign="top">
323
319
<tr>
324
320
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
325
321
<td>
326
 
 
327
 
 
328
322
</td>
329
323
</tr>
330
324
</tbody>
331
325
</table></div>
332
326
</div>
333
327
<hr>
334
 
<div class="refsect2" lang="en">
 
328
<div class="refsect2" title="gimp_path_editor_get_dir_writable ()">
335
329
<a name="gimp-path-editor-get-dir-writable"></a><h3>gimp_path_editor_get_dir_writable ()</h3>
336
330
<pre class="programlisting"><a
337
331
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
340
334
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
341
335
>gchar</a> *directory);</pre>
342
336
<p>
343
 
 
344
337
</p>
345
338
<div class="variablelist"><table border="0">
346
339
<col align="left" valign="top">
358
351
<tr>
359
352
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
360
353
<td>
361
 
 
362
 
 
363
354
</td>
364
355
</tr>
365
356
</tbody>
366
357
</table></div>
367
358
</div>
368
359
<hr>
369
 
<div class="refsect2" lang="en">
 
360
<div class="refsect2" title="gimp_path_editor_set_dir_writable ()">
370
361
<a name="gimp-path-editor-set-dir-writable"></a><h3>gimp_path_editor_set_dir_writable ()</h3>
371
362
<pre class="programlisting">void                gimp_path_editor_set_dir_writable   (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
372
363
                                                         const <a
376
367
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
377
368
>gboolean</a> writable);</pre>
378
369
<p>
379
 
 
380
370
</p>
381
371
<div class="variablelist"><table border="0">
382
372
<col align="left" valign="top">
394
384
<tr>
395
385
<td><p><span class="term"><em class="parameter"><code>writable</code></em> :</span></p></td>
396
386
<td>
397
 
 
398
 
 
399
387
</td>
400
388
</tr>
401
389
</tbody>
402
390
</table></div>
403
391
</div>
404
392
</div>
405
 
<div class="refsect1" lang="en">
 
393
<div class="refsect1" title="Signal Details">
406
394
<a name="GimpPathEditor.signal-details"></a><h2>Signal Details</h2>
407
 
<div class="refsect2" lang="en">
 
395
<div class="refsect2" title='The "path-changed" signal'>
408
396
<a name="GimpPathEditor-path-changed"></a><h3>The <code class="literal">"path-changed"</code> signal</h3>
409
397
<pre class="programlisting">void                user_function                      (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *arg0,
410
398
                                                        <a
414
402
This signal is emitted whenever the user adds, deletes, modifies
415
403
or reorders an element of the search path.</p>
416
404
<p>
417
 
 
418
405
</p>
419
406
<div class="variablelist"><table border="0">
420
407
<col align="left" valign="top">
425
412
</table></div>
426
413
</div>
427
414
<hr>
428
 
<div class="refsect2" lang="en">
 
415
<div class="refsect2" title='The "writable-changed" signal'>
429
416
<a name="GimpPathEditor-writable-changed"></a><h3>The <code class="literal">"writable-changed"</code> signal</h3>
430
417
<pre class="programlisting">void                user_function                      (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *arg0,
431
418
                                                        <a
436
423
is changed, either by the user clicking on it or by calling
437
424
<a class="link" href="GimpPathEditor.html#gimp-path-editor-set-dir-writable" title="gimp_path_editor_set_dir_writable ()"><code class="function">gimp_path_editor_set_dir_writable()</code></a>.</p>
438
425
<p>
439
 
 
440
426
</p>
441
427
<div class="variablelist"><table border="0">
442
428
<col align="left" valign="top">
447
433
</table></div>
448
434
</div>
449
435
</div>
450
 
<div class="refsect1" lang="en">
 
436
<div class="refsect1" title="See Also">
451
437
<a name="GimpPathEditor.see-also"></a><h2>See Also</h2>
452
438
<p>
453
439
<a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a>
454
440
</p>
455
441
<p>
456
442
<a
457
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
 
443
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR--CAPS"
458
444
><span class="type">G_SEARCHPATH_SEPARATOR</span></a>
459
445
</p>
460
446
</div>
461
447
</div>
462
448
<div class="footer">
463
449
<hr>
464
 
          Generated by GTK-Doc V1.10</div>
 
450
          Generated by GTK-Doc V1.11</div>
465
451
</body>
466
452
</html>