← Back to branch summary

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

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/html/GimpFileEntry.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:
devel-docs/libgimpwidgets/html/GimpFileEntry.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GimpFileEntry</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="GimpEnumLabel.html" title="GimpEnumLabel">
10
10
<link rel="next" href="GimpFrame.html" title="GimpFrame">
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="GimpFrame.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="#GimpFileEntry.synopsis" class="shortcut">Top</a>
38
 
                   | 
39
 
                  <a href="#GimpFileEntry.description" class="shortcut">Description</a>
40
 
                   | 
41
 
                  <a href="#GimpFileEntry.object-hierarchy" class="shortcut">Object Hierarchy</a>
42
 
                   | 
43
 
                  <a href="#GimpFileEntry.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
44
 
                   | 
45
 
                  <a href="#GimpFileEntry.signals" class="shortcut">Signals</a></nobr></td></tr>
 
37
<tr><td colspan="5" class="shortcuts">
 
38
<a href="#GimpFileEntry.synopsis" class="shortcut">Top</a>
 
39
                 | 
 
40
                <a href="#GimpFileEntry.description" class="shortcut">Description</a>
 
41
                 | 
 
42
                <a href="#GimpFileEntry.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
43
                 | 
 
44
                <a href="#GimpFileEntry.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
45
                 | 
 
46
                <a href="#GimpFileEntry.signals" class="shortcut">Signals</a>
 
47
</td></tr>
46
48
</table>
47
 
<div class="refentry" lang="en">
 
49
<div class="refentry" title="GimpFileEntry">
48
50
<a name="GimpFileEntry"></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-file-entry.png"></td>
55
57
</tr></table></div>
56
 
<div class="refsynopsisdiv">
 
58
<div class="refsynopsisdiv" title="Synopsis">
57
59
<a name="GimpFileEntry.synopsis"></a><h2>Synopsis</h2>
58
60
<pre class="synopsis">
59
61
                    <a class="link" href="GimpFileEntry.html#GimpFileEntry-struct" title="GimpFileEntry">GimpFileEntry</a>;
60
62
<a
61
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
62
 
>GtkWidget</a>*          <a class="link" href="GimpFileEntry.html#gimp-file-entry-new" title="gimp_file_entry_new ()">gimp_file_entry_new</a>                 (const <a
 
63
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
 
64
>GtkWidget</a> *         <a class="link" href="GimpFileEntry.html#gimp-file-entry-new" title="gimp_file_entry_new ()">gimp_file_entry_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
73
75
>gboolean</a> check_valid);
74
76
<a
75
77
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
76
 
>gchar</a>*              <a class="link" href="GimpFileEntry.html#gimp-file-entry-get-filename" title="gimp_file_entry_get_filename ()">gimp_file_entry_get_filename</a>        (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry);
 
78
>gchar</a> *             <a class="link" href="GimpFileEntry.html#gimp-file-entry-get-filename" title="gimp_file_entry_get_filename ()">gimp_file_entry_get_filename</a>        (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry);
77
79
void                <a class="link" href="GimpFileEntry.html#gimp-file-entry-set-filename" title="gimp_file_entry_set_filename ()">gimp_file_entry_set_filename</a>        (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry,
78
80
                                                         const <a
79
81
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
80
82
>gchar</a> *filename);
81
83
</pre>
82
84
</div>
83
 
<div class="refsect1" lang="en">
 
85
<div class="refsect1" title="Object Hierarchy">
84
86
<a name="GimpFileEntry.object-hierarchy"></a><h2>Object Hierarchy</h2>
85
87
<pre class="synopsis">
86
88
  <a
90
92
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
91
93
>GInitiallyUnowned</a>
92
94
         +----<a
93
 
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
 
95
href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html"
94
96
>GtkObject</a>
95
97
               +----<a
96
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
98
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
97
99
>GtkWidget</a>
98
100
                     +----<a
99
 
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
 
101
href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html"
100
102
>GtkContainer</a>
101
103
                           +----<a
102
 
href="/usr/share/gtk-doc/html/gtk/GtkBox.html"
 
104
href="http://library.gnome.org/devel/gtk/unstable/GtkBox.html"
103
105
>GtkBox</a>
104
106
                                 +----<a
105
 
href="/usr/share/gtk-doc/html/gtk/GtkHBox.html"
 
107
href="http://library.gnome.org/devel/gtk/unstable/GtkHBox.html"
106
108
>GtkHBox</a>
107
109
                                       +----GimpFileEntry
108
110
</pre>
109
111
</div>
110
 
<div class="refsect1" lang="en">
 
112
<div class="refsect1" title="Implemented Interfaces">
111
113
<a name="GimpFileEntry.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
112
114
<p>
113
115
GimpFileEntry implements
114
 
 AtkImplementorIface and  <a
115
 
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
116
 
>GtkBuildable</a>.</p>
 
116
 <a
 
117
href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable"
 
118
>GtkBuildable</a>,  AtkImplementorIface and  <a
 
119
href="http://library.gnome.org/devel/gtk/unstable/gtk-Orientable.html#GtkOrientable"
 
120
>GtkOrientable</a>.</p>
117
121
</div>
118
 
<div class="refsect1" lang="en">
 
122
<div class="refsect1" title="Signals">
119
123
<a name="GimpFileEntry.signals"></a><h2>Signals</h2>
120
124
<pre class="synopsis">
121
125
  "<a class="link" href="GimpFileEntry.html#GimpFileEntry-filename-changed" title='The "filename-changed" signal'>filename-changed</a>"                               : Run First
122
126
</pre>
123
127
</div>
124
 
<div class="refsect1" lang="en">
 
128
<div class="refsect1" title="Description">
125
129
<a name="GimpFileEntry.description"></a><h2>Description</h2>
126
130
<p>
127
131
This widget is used to enter filenames or directories.
128
132
</p>
129
133
<p>
130
134
There is a <a
131
 
href="/usr/share/gtk-doc/html/gtk/GtkEntry.html"
 
135
href="http://library.gnome.org/devel/gtk/unstable/GtkEntry.html"
132
136
><span class="type">GtkEntry</span></a> for entering the filename manually and a "..."
133
137
button which will pop up a <a
134
 
href="/usr/share/gtk-doc/html/gtk/GtkFileSelection.html"
 
138
href="http://library.gnome.org/devel/gtk/unstable/GtkFileSelection.html"
135
139
><span class="type">GtkFileSelection</span></a> dialog.
136
140
</p>
137
141
<p>
138
142
You can restrict the <span class="type">GimpFileSelection</span> to directories. In this case
139
143
the filename listbox of the <a
140
 
href="/usr/share/gtk-doc/html/gtk/GtkFileSelection.html"
 
144
href="http://library.gnome.org/devel/gtk/unstable/GtkFileSelection.html"
141
145
><span class="type">GtkFileSelection</span></a> dialog will be hidden.
142
146
</p>
143
147
<p>
144
148
If you specify <em class="parameter"><code>check_valid</code></em> as <a
145
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
149
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
146
150
><span class="type">TRUE</span></a> in <a class="link" href="GimpFileEntry.html#gimp-file-entry-new" title="gimp_file_entry_new ()"><code class="function">gimp_file_entry_new()</code></a>
147
151
the entered filename will be checked for validity and a pixmap will be
148
152
shown which indicates if the file exists or not.
152
156
will be emitted.
153
157
</p>
154
158
</div>
155
 
<div class="refsect1" lang="en">
 
159
<div class="refsect1" title="Details">
156
160
<a name="GimpFileEntry.details"></a><h2>Details</h2>
157
 
<div class="refsect2" lang="en">
 
161
<div class="refsect2" title="GimpFileEntry">
158
162
<a name="GimpFileEntry-struct"></a><h3>GimpFileEntry</h3>
159
163
<pre class="programlisting">typedef struct _GimpFileEntry GimpFileEntry;</pre>
160
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
164
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
161
165
<h3 class="title">Warning</h3>
162
166
<p><code class="literal">GimpFileEntry</code> is deprecated and should not be used in newly-written code.</p>
163
167
</div>
164
168
<p>
165
 
 
166
169
</p>
167
170
</div>
168
171
<hr>
169
 
<div class="refsect2" lang="en">
 
172
<div class="refsect2" title="gimp_file_entry_new ()">
170
173
<a name="gimp-file-entry-new"></a><h3>gimp_file_entry_new ()</h3>
171
174
<pre class="programlisting"><a
172
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
173
 
>GtkWidget</a>*          gimp_file_entry_new                 (const <a
 
175
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
 
176
>GtkWidget</a> *         gimp_file_entry_new                 (const <a
174
177
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
175
178
>gchar</a> *title,
176
179
                                                         const <a
182
185
                                                         <a
183
186
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
184
187
>gboolean</a> check_valid);</pre>
185
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
188
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
186
189
<h3 class="title">Warning</h3>
187
190
<p><code class="literal">gimp_file_entry_new</code> is deprecated and should not be used in newly-written code.</p>
188
191
</div>
189
192
<p>
190
193
You should use <a
191
 
href="/usr/share/gtk-doc/html/gtk/GtkFileChooserButton.html"
 
194
href="http://library.gnome.org/devel/gtk/unstable/GtkFileChooserButton.html"
192
195
><span class="type">GtkFileChooserButton</span></a> instead.</p>
193
196
<p>
194
 
 
195
197
</p>
196
198
<div class="variablelist"><table border="0">
197
199
<col align="left" valign="top">
209
211
<tr>
210
212
<td><p><span class="term"><em class="parameter"><code>dir_only</code></em> :</span></p></td>
211
213
<td>    <a
212
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
214
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
213
215
><code class="literal">TRUE</code></a> if the file entry should accept directories only.
214
216
</td>
215
217
</tr>
216
218
<tr>
217
219
<td><p><span class="term"><em class="parameter"><code>check_valid</code></em> :</span></p></td>
218
220
<td> <a
219
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
221
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
220
222
><code class="literal">TRUE</code></a> if the widget should check if the entered file
221
223
              really exists.
222
224
</td>
230
232
</table></div>
231
233
</div>
232
234
<hr>
233
 
<div class="refsect2" lang="en">
 
235
<div class="refsect2" title="gimp_file_entry_get_filename ()">
234
236
<a name="gimp-file-entry-get-filename"></a><h3>gimp_file_entry_get_filename ()</h3>
235
237
<pre class="programlisting"><a
236
238
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
237
 
>gchar</a>*              gimp_file_entry_get_filename        (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry);</pre>
238
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
239
>gchar</a> *             gimp_file_entry_get_filename        (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry);</pre>
 
240
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
239
241
<h3 class="title">Warning</h3>
240
242
<p><code class="literal">gimp_file_entry_get_filename</code> is deprecated and should not be used in newly-written code.</p>
241
243
</div>
244
246
href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"
245
247
><code class="function">g_free()</code></a> the returned string.</p>
246
248
<p>
247
 
 
248
249
</p>
249
250
<div class="variablelist"><table border="0">
250
251
<col align="left" valign="top">
263
264
</table></div>
264
265
</div>
265
266
<hr>
266
 
<div class="refsect2" lang="en">
 
267
<div class="refsect2" title="gimp_file_entry_set_filename ()">
267
268
<a name="gimp-file-entry-set-filename"></a><h3>gimp_file_entry_set_filename ()</h3>
268
269
<pre class="programlisting">void                gimp_file_entry_set_filename        (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry,
269
270
                                                         const <a
270
271
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
271
272
>gchar</a> *filename);</pre>
272
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
273
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
273
274
<h3 class="title">Warning</h3>
274
275
<p><code class="literal">gimp_file_entry_set_filename</code> is deprecated and should not be used in newly-written code.</p>
275
276
</div>
276
277
<p>
277
278
If you specified <em class="parameter"><code>check_valid</code></em> as <a
278
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
279
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
279
280
><code class="literal">TRUE</code></a> in <a class="link" href="GimpFileEntry.html#gimp-file-entry-new" title="gimp_file_entry_new ()"><code class="function">gimp_file_entry_new()</code></a>
280
281
the <a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a> will immediately check the validity of the file
281
282
name.</p>
282
283
<p>
283
 
 
284
284
</p>
285
285
<div class="variablelist"><table border="0">
286
286
<col align="left" valign="top">
299
299
</table></div>
300
300
</div>
301
301
</div>
302
 
<div class="refsect1" lang="en">
 
302
<div class="refsect1" title="Signal Details">
303
303
<a name="GimpFileEntry.signal-details"></a><h2>Signal Details</h2>
304
 
<div class="refsect2" lang="en">
 
304
<div class="refsect2" title='The "filename-changed" signal'>
305
305
<a name="GimpFileEntry-filename-changed"></a><h3>The <code class="literal">"filename-changed"</code> signal</h3>
306
306
<pre class="programlisting">void                user_function                      (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *arg0,
307
307
                                                        <a
310
310
<p>
311
311
This signal is emitted whenever the user changes the filename.</p>
312
312
<p>
313
 
 
314
313
</p>
315
314
<div class="variablelist"><table border="0">
316
315
<col align="left" valign="top">
321
320
</table></div>
322
321
</div>
323
322
</div>
324
 
<div class="refsect1" lang="en">
 
323
<div class="refsect1" title="See Also">
325
324
<a name="GimpFileEntry.see-also"></a><h2>See Also</h2>
326
325
<p>
327
326
<a class="link" href="GimpPathEditor.html" title="GimpPathEditor"><span class="type">GimpPathEditor</span></a>
330
329
</div>
331
330
<div class="footer">
332
331
<hr>
333
 
          Generated by GTK-Doc V1.10</div>
 
332
          Generated by GTK-Doc V1.11</div>
334
333
</body>
335
334
</html>