~ubuntu-branches/ubuntu/gutsy/gimp/gutsy

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-09-30 18:06:49 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20070930180649-f647f0cxj32tgyn3
Tags: 2.4.0~rc3-1ubuntu1
* Resynchronized with Debian.
* Remaining Ubuntu changes:
  - 02_help-message.patch, 03_gimp.desktop.in.in.patch: Distro changes.
  - Weave i18n magic in the rules file.
  - Munge Maintainer field as per spec.
* Ubuntu changes dropped:
  - 10_dont_show_wizard.patch: Unused, upstream doesn't call it anymore.
  - Use dh_icons.
* Disabled the print plugin, and removed the Conflicts/Replaces on
  gimp-print.

Show diffs side-by-side

added added

removed removed

Lines of Context:
33
33
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
34
34
<td><a accesskey="n" href="GimpPickButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
35
35
</tr>
36
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2575741" class="shortcut">Top</a>
37
 
                  &#160;|&#160;
38
 
                  <a href="#id2641787" class="shortcut">Description</a>
39
 
                  &#160;|&#160;
40
 
                  <a href="#id2641650" class="shortcut">Object Hierarchy</a>
41
 
                  &#160;|&#160;
42
 
                  <a href="#id2641710" class="shortcut">Implemented Interfaces</a>
43
 
                  &#160;|&#160;
44
 
                  <a href="#id2641755" class="shortcut">Signals</a></nobr></td></tr>
 
36
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2612205" class="shortcut">Top</a>
 
37
                  &#160;|&#160;
 
38
                  <a href="#id2637283" class="shortcut">Description</a>
 
39
                  &#160;|&#160;
 
40
                  <a href="#id2637164" class="shortcut">Object Hierarchy</a>
 
41
                  &#160;|&#160;
 
42
                  <a href="#id2637224" class="shortcut">Implemented Interfaces</a>
 
43
                  &#160;|&#160;
 
44
                  <a href="#id2637251" class="shortcut">Signals</a></nobr></td></tr>
45
45
</table>
46
46
<div class="refentry" lang="en">
47
47
<a name="GimpPathEditor"></a><div class="titlepage"></div>
48
48
<div class="refnamediv"><table width="100%"><tr>
49
49
<td valign="top">
50
50
<h2>
51
 
<a name="id2575741"></a><span class="refentrytitle">GimpPathEditor</span>
 
51
<a name="id2612205"></a><span class="refentrytitle">GimpPathEditor</span>
52
52
</h2>
53
53
<p>GimpPathEditor &#8212; Widget for editing a file search path.</p>
54
54
</td>
61
61
 
62
62
 
63
63
                    <a class="link" href="GimpPathEditor.html#GimpPathEditor-struct">GimpPathEditor</a>;
64
 
GtkWidget*          <a class="link" href="GimpPathEditor.html#gimp-path-editor-new">gimp_path_editor_new</a>                (const gchar *title,
65
 
                                                         const gchar *path);
66
 
gchar*              <a class="link" href="GimpPathEditor.html#gimp-path-editor-get-path">gimp_path_editor_get_path</a>           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);
 
64
<a
 
65
href="../gtk/GtkWidget.html"
 
66
>GtkWidget</a>*          <a class="link" href="GimpPathEditor.html#gimp-path-editor-new">gimp_path_editor_new</a>                (const <a
 
67
href="../glib/glib-Basic-Types.html#gchar"
 
68
>gchar</a> *title,
 
69
                                                         const <a
 
70
href="../glib/glib-Basic-Types.html#gchar"
 
71
>gchar</a> *path);
 
72
<a
 
73
href="../glib/glib-Basic-Types.html#gchar"
 
74
>gchar</a>*              <a class="link" href="GimpPathEditor.html#gimp-path-editor-get-path">gimp_path_editor_get_path</a>           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);
67
75
void                <a class="link" href="GimpPathEditor.html#gimp-path-editor-set-path">gimp_path_editor_set_path</a>           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
68
 
                                                         const gchar *path);
69
 
gchar*              <a class="link" href="GimpPathEditor.html#gimp-path-editor-get-writable-path">gimp_path_editor_get_writable_path</a>  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);
 
76
                                                         const <a
 
77
href="../glib/glib-Basic-Types.html#gchar"
 
78
>gchar</a> *path);
 
79
<a
 
80
href="../glib/glib-Basic-Types.html#gchar"
 
81
>gchar</a>*              <a class="link" href="GimpPathEditor.html#gimp-path-editor-get-writable-path">gimp_path_editor_get_writable_path</a>  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);
70
82
void                <a class="link" href="GimpPathEditor.html#gimp-path-editor-set-writable-path">gimp_path_editor_set_writable_path</a>  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
71
 
                                                         const gchar *path);
72
 
gboolean            <a class="link" href="GimpPathEditor.html#gimp-path-editor-get-dir-writable">gimp_path_editor_get_dir_writable</a>   (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
73
 
                                                         const gchar *directory);
 
83
                                                         const <a
 
84
href="../glib/glib-Basic-Types.html#gchar"
 
85
>gchar</a> *path);
 
86
<a
 
87
href="../glib/glib-Basic-Types.html#gboolean"
 
88
>gboolean</a>            <a class="link" href="GimpPathEditor.html#gimp-path-editor-get-dir-writable">gimp_path_editor_get_dir_writable</a>   (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
 
89
                                                         const <a
 
90
href="../glib/glib-Basic-Types.html#gchar"
 
91
>gchar</a> *directory);
74
92
void                <a class="link" href="GimpPathEditor.html#gimp-path-editor-set-dir-writable">gimp_path_editor_set_dir_writable</a>   (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
75
 
                                                         const gchar *directory,
76
 
                                                         gboolean writable);
 
93
                                                         const <a
 
94
href="../glib/glib-Basic-Types.html#gchar"
 
95
>gchar</a> *directory,
 
96
                                                         <a
 
97
href="../glib/glib-Basic-Types.html#gboolean"
 
98
>gboolean</a> writable);
77
99
 
78
100
</pre>
79
101
</div>
80
102
<div class="refsect1" lang="en">
81
 
<a name="id2641650"></a><h2>Object Hierarchy</h2>
 
103
<a name="id2637164"></a><h2>Object Hierarchy</h2>
82
104
<pre class="synopsis">
83
105
 
84
 
  GObject
85
 
   +----GInitiallyUnowned
86
 
         +----GtkObject
87
 
               +----GtkWidget
88
 
                     +----GtkContainer
89
 
                           +----GtkBox
90
 
                                 +----GtkVBox
 
106
  <a
 
107
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
 
108
>GObject</a>
 
109
   +----<a
 
110
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
 
111
>GInitiallyUnowned</a>
 
112
         +----<a
 
113
href="../gtk/GtkObject.html"
 
114
>GtkObject</a>
 
115
               +----<a
 
116
href="../gtk/GtkWidget.html"
 
117
>GtkWidget</a>
 
118
                     +----<a
 
119
href="../gtk/GtkContainer.html"
 
120
>GtkContainer</a>
 
121
                           +----<a
 
122
href="../gtk/GtkBox.html"
 
123
>GtkBox</a>
 
124
                                 +----<a
 
125
href="../gtk/GtkVBox.html"
 
126
>GtkVBox</a>
91
127
                                       +----GimpPathEditor
92
128
</pre>
93
129
</div>
94
130
<div class="refsect1" lang="en">
95
 
<a name="id2641710"></a><h2>Implemented Interfaces</h2>
 
131
<a name="id2637224"></a><h2>Implemented Interfaces</h2>
96
132
<p>
97
133
GimpPathEditor implements
98
134
 AtkImplementorIface and  GtkBuildable.</p>
99
135
</div>
100
136
<div class="refsect1" lang="en">
101
 
<a name="id2641755"></a><h2>Signals</h2>
 
137
<a name="id2637251"></a><h2>Signals</h2>
102
138
<pre class="synopsis">
103
139
 
104
140
  "<a class="link" href="GimpPathEditor.html#GimpPathEditor-path-changed">path-changed</a>"                                   : Run First
106
142
</pre>
107
143
</div>
108
144
<div class="refsect1" lang="en">
109
 
<a name="id2641787"></a><h2>Description</h2>
 
145
<a name="id2637283"></a><h2>Description</h2>
110
146
<p>
111
147
This widget is used to edit file search paths.
112
148
</p>
125
161
</p>
126
162
</div>
127
163
<div class="refsect1" lang="en">
128
 
<a name="id2641829"></a><h2>Details</h2>
 
164
<a name="id2637325"></a><h2>Details</h2>
129
165
<div class="refsect2" lang="en">
130
 
<a name="id2641840"></a><h3>
 
166
<a name="id2637335"></a><h3>
131
167
<a name="GimpPathEditor-struct"></a>GimpPathEditor</h3>
132
 
<a class="indexterm" name="id2641852"></a><pre class="programlisting">typedef struct _GimpPathEditor GimpPathEditor;</pre>
 
168
<a class="indexterm" name="id2637347"></a><pre class="programlisting">typedef struct _GimpPathEditor GimpPathEditor;</pre>
133
169
<p>
134
170
 
135
171
</p>
136
172
</div>
137
173
<hr>
138
174
<div class="refsect2" lang="en">
139
 
<a name="id2641868"></a><h3>
 
175
<a name="id2637363"></a><h3>
140
176
<a name="gimp-path-editor-new"></a>gimp_path_editor_new ()</h3>
141
 
<a class="indexterm" name="id2641879"></a><pre class="programlisting">GtkWidget*          gimp_path_editor_new                (const gchar *title,
142
 
                                                         const gchar *path);</pre>
 
177
<a class="indexterm" name="id2637375"></a><pre class="programlisting"><a
 
178
href="../gtk/GtkWidget.html"
 
179
>GtkWidget</a>*          gimp_path_editor_new                (const <a
 
180
href="../glib/glib-Basic-Types.html#gchar"
 
181
>gchar</a> *title,
 
182
                                                         const <a
 
183
href="../glib/glib-Basic-Types.html#gchar"
 
184
>gchar</a> *path);</pre>
143
185
<p>
144
186
Creates a new <a class="link" href="GimpPathEditor.html" title="GimpPathEditor"><span class="type">GimpPathEditor</span></a> widget.
145
187
</p>
146
188
<p>
147
189
The elements of the initial search path must be separated with the
148
 
<span class="type">G_SEARCHPATH_SEPARATOR</span> character.</p>
 
190
<a
 
191
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
 
192
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> character.</p>
149
193
<p>
150
194
 
151
195
</p>
154
198
<tbody>
155
199
<tr>
156
200
<td><p><span class="term"><em class="parameter"><code>title</code></em>&#160;:</span></p></td>
157
 
<td> The title of the <span class="type">GtkFileChooser</span> dialog which can be popped up.
 
201
<td> The title of the <a
 
202
href="../gtk/GtkFileChooser.html"
 
203
><span class="type">GtkFileChooser</span></a> dialog which can be popped up.
158
204
</td>
159
205
</tr>
160
206
<tr>
172
218
</div>
173
219
<hr>
174
220
<div class="refsect2" lang="en">
175
 
<a name="id2635996"></a><h3>
 
221
<a name="id2637489"></a><h3>
176
222
<a name="gimp-path-editor-get-path"></a>gimp_path_editor_get_path ()</h3>
177
 
<a class="indexterm" name="id2636008"></a><pre class="programlisting">gchar*              gimp_path_editor_get_path           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);</pre>
 
223
<a class="indexterm" name="id2637500"></a><pre class="programlisting"><a
 
224
href="../glib/glib-Basic-Types.html#gchar"
 
225
>gchar</a>*              gimp_path_editor_get_path           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);</pre>
178
226
<p>
179
227
The elements of the returned search path string are separated with the
180
 
<span class="type">G_SEARCHPATH_SEPARATOR</span> character.
 
228
<a
 
229
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
 
230
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> character.
181
231
</p>
182
232
<p>
183
 
Note that you have to <code class="function">g_free()</code> the returned string.</p>
 
233
Note that you have to <a
 
234
href="../glib/glib-Memory-Allocation.html#g-free"
 
235
><code class="function">g_free()</code></a> the returned string.</p>
184
236
<p>
185
237
 
186
238
</p>
202
254
</div>
203
255
<hr>
204
256
<div class="refsect2" lang="en">
205
 
<a name="id2636090"></a><h3>
 
257
<a name="id2637582"></a><h3>
206
258
<a name="gimp-path-editor-set-path"></a>gimp_path_editor_set_path ()</h3>
207
 
<a class="indexterm" name="id2636102"></a><pre class="programlisting">void                gimp_path_editor_set_path           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
208
 
                                                         const gchar *path);</pre>
 
259
<a class="indexterm" name="id2636673"></a><pre class="programlisting">void                gimp_path_editor_set_path           (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
 
260
                                                         const <a
 
261
href="../glib/glib-Basic-Types.html#gchar"
 
262
>gchar</a> *path);</pre>
209
263
<p>
210
264
The elements of the initial search path must be separated with the
211
 
<span class="type">G_SEARCHPATH_SEPARATOR</span> character.</p>
 
265
<a
 
266
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
 
267
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> character.</p>
212
268
<p>
213
269
 
214
270
</p>
230
286
</div>
231
287
<hr>
232
288
<div class="refsect2" lang="en">
233
 
<a name="id2637226"></a><h3>
 
289
<a name="id2636751"></a><h3>
234
290
<a name="gimp-path-editor-get-writable-path"></a>gimp_path_editor_get_writable_path ()</h3>
235
 
<a class="indexterm" name="id2637239"></a><pre class="programlisting">gchar*              gimp_path_editor_get_writable_path  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);</pre>
 
291
<a class="indexterm" name="id2636763"></a><pre class="programlisting"><a
 
292
href="../glib/glib-Basic-Types.html#gchar"
 
293
>gchar</a>*              gimp_path_editor_get_writable_path  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);</pre>
236
294
<p>
237
295
 
238
296
</p>
256
314
</div>
257
315
<hr>
258
316
<div class="refsect2" lang="en">
259
 
<a name="id2637296"></a><h3>
 
317
<a name="id2636819"></a><h3>
260
318
<a name="gimp-path-editor-set-writable-path"></a>gimp_path_editor_set_writable_path ()</h3>
261
 
<a class="indexterm" name="id2637309"></a><pre class="programlisting">void                gimp_path_editor_set_writable_path  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
262
 
                                                         const gchar *path);</pre>
 
319
<a class="indexterm" name="id2636830"></a><pre class="programlisting">void                gimp_path_editor_set_writable_path  (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
 
320
                                                         const <a
 
321
href="../glib/glib-Basic-Types.html#gchar"
 
322
>gchar</a> *path);</pre>
263
323
<p>
264
324
 
265
325
</p>
283
343
</div>
284
344
<hr>
285
345
<div class="refsect2" lang="en">
286
 
<a name="id2637376"></a><h3>
 
346
<a name="id2636898"></a><h3>
287
347
<a name="gimp-path-editor-get-dir-writable"></a>gimp_path_editor_get_dir_writable ()</h3>
288
 
<a class="indexterm" name="id2637389"></a><pre class="programlisting">gboolean            gimp_path_editor_get_dir_writable   (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
289
 
                                                         const gchar *directory);</pre>
 
348
<a class="indexterm" name="id2636909"></a><pre class="programlisting"><a
 
349
href="../glib/glib-Basic-Types.html#gboolean"
 
350
>gboolean</a>            gimp_path_editor_get_dir_writable   (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
 
351
                                                         const <a
 
352
href="../glib/glib-Basic-Types.html#gchar"
 
353
>gchar</a> *directory);</pre>
290
354
<p>
291
355
 
292
356
</p>
315
379
</div>
316
380
<hr>
317
381
<div class="refsect2" lang="en">
318
 
<a name="id2637467"></a><h3>
 
382
<a name="id2636987"></a><h3>
319
383
<a name="gimp-path-editor-set-dir-writable"></a>gimp_path_editor_set_dir_writable ()</h3>
320
 
<a class="indexterm" name="id2637480"></a><pre class="programlisting">void                gimp_path_editor_set_dir_writable   (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
321
 
                                                         const gchar *directory,
322
 
                                                         gboolean writable);</pre>
 
384
<a class="indexterm" name="id2637000"></a><pre class="programlisting">void                gimp_path_editor_set_dir_writable   (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
 
385
                                                         const <a
 
386
href="../glib/glib-Basic-Types.html#gchar"
 
387
>gchar</a> *directory,
 
388
                                                         <a
 
389
href="../glib/glib-Basic-Types.html#gboolean"
 
390
>gboolean</a> writable);</pre>
323
391
<p>
324
392
 
325
393
</p>
348
416
</div>
349
417
</div>
350
418
<div class="refsect1" lang="en">
351
 
<a name="id2640148"></a><h2>Signal Details</h2>
 
419
<a name="id2637090"></a><h2>Signal Details</h2>
352
420
<div class="refsect2" lang="en">
353
 
<a name="id2640159"></a><h3>
 
421
<a name="id2635220"></a><h3>
354
422
<a name="GimpPathEditor-path-changed"></a>The "path-changed" signal</h3>
355
 
<a class="indexterm" name="id2640167"></a><pre class="programlisting">void                user_function                      (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *arg0,
356
 
                                                        gpointer        user_data)      : Run First</pre>
 
423
<a class="indexterm" name="id2635227"></a><pre class="programlisting">void                user_function                      (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *arg0,
 
424
                                                        <a
 
425
href="../glib/glib-Basic-Types.html#gpointer"
 
426
>gpointer</a>        user_data)      : Run First</pre>
357
427
<p>
358
428
This signal is emitted whenever the user adds, deletes, modifies
359
429
or reorders an element of the search path.</p>
370
440
</div>
371
441
<hr>
372
442
<div class="refsect2" lang="en">
373
 
<a name="id2640226"></a><h3>
 
443
<a name="id2635286"></a><h3>
374
444
<a name="GimpPathEditor-writable-changed"></a>The "writable-changed" signal</h3>
375
 
<a class="indexterm" name="id2640235"></a><pre class="programlisting">void                user_function                      (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *arg0,
376
 
                                                        gpointer        user_data)      : Run First</pre>
 
445
<a class="indexterm" name="id2635296"></a><pre class="programlisting">void                user_function                      (<a class="link" href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *arg0,
 
446
                                                        <a
 
447
href="../glib/glib-Basic-Types.html#gpointer"
 
448
>gpointer</a>        user_data)      : Run First</pre>
377
449
<p>
378
450
This signal is emitted whenever the "writable" column of a directory
379
451
is changed, either by the user clicking on it or by calling
391
463
</div>
392
464
</div>
393
465
<div class="refsect1" lang="en">
394
 
<a name="id2640307"></a><h2>See Also</h2>
 
466
<a name="id2635368"></a><h2>See Also</h2>
395
467
<p>
396
468
<a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a>
397
469
</p>
398
470
<p>
399
 
<span class="type">G_SEARCHPATH_SEPARATOR</span>
 
471
<a
 
472
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR:CAPS"
 
473
><span class="type">G_SEARCHPATH_SEPARATOR</span></a>
400
474
</p>
401
475
</div>
402
476
</div>