1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XfceFilenameInput: libxfce4ui Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="libxfce4ui Reference Manual">
<link rel="up" href="ch01.html" title="[Insert title here]">
<link rel="prev" href="XfceScreensaver.html" title="XfceScreensaver">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#XfceFilenameInput.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#XfceFilenameInput.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#XfceFilenameInput.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#XfceFilenameInput.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#XfceFilenameInput.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="XfceScreensaver.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="XfceFilenameInput"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="XfceFilenameInput.top_of_page"></a>XfceFilenameInput</span></h2>
<p>XfceFilenameInput — widget for filename input</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="XfceFilenameInput.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="XfceFilenameInput.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="XfceFilenameInput.html#xfce-filename-input-get-text" title="xfce_filename_input_get_text ()">xfce_filename_input_get_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="XfceFilenameInput.html#xfce-filename-input-check" title="xfce_filename_input_check ()">xfce_filename_input_check</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkEntry.html#GtkEntry-struct"><span class="returnvalue">GtkEntry</span></a> *
</td>
<td class="function_name">
<a class="link" href="XfceFilenameInput.html#xfce-filename-input-get-entry" title="xfce_filename_input_get_entry ()">xfce_filename_input_get_entry</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="XfceFilenameInput.html#xfce-filename-input-sensitise-widget" title="xfce_filename_input_sensitise_widget ()">xfce_filename_input_sensitise_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="XfceFilenameInput.html#xfce-filename-input-desensitise-widget" title="xfce_filename_input_desensitise_widget ()">xfce_filename_input_desensitise_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XfceFilenameInput.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">int</span></td>
<td class="property_name"><a class="link" href="XfceFilenameInput.html#XfceFilenameInput--max-text-length" title="The “max-text-length” property">max-text-length</a></td>
<td class="property_flags">Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">char</span> *</td>
<td class="property_name"><a class="link" href="XfceFilenameInput.html#XfceFilenameInput--original-filename" title="The “original-filename” property">original-filename</a></td>
<td class="property_flags">Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XfceFilenameInput.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="XfceFilenameInput.html#XfceFilenameInput-text-invalid" title="The “text-invalid” signal">text-invalid</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="XfceFilenameInput.html#XfceFilenameInput-text-valid" title="The “text-valid” signal">text-valid</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XfceFilenameInput.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="XfceFilenameInput.html#XfceFilenameInput-struct" title="XfceFilenameInput">XfceFilenameInput</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XfceFilenameInput.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkBox.html#GtkBox-struct">GtkBox</a>
<span class="lineart">╰──</span> XfceFilenameInput
</pre>
</div>
<div class="refsect1">
<a name="XfceFilenameInput.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
XfceFilenameInput implements
AtkImplementorIface, <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a> and <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Orientable.html#GtkOrientable-struct">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="XfceFilenameInput.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libxfce4ui/libxfce4ui.h>
</pre>
</div>
<div class="refsect1">
<a name="XfceFilenameInput.description"></a><h2>Description</h2>
<p>A widget to allow filename input for creating or renaming files,
with as-you-type checking for invalid filenames.</p>
</div>
<div class="refsect1">
<a name="XfceFilenameInput.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="xfce-filename-input-get-text"></a><h3>xfce_filename_input_get_text ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
xfce_filename_input_get_text (<em class="parameter"><code><a class="link" href="XfceFilenameInput.html" title="XfceFilenameInput"><span class="type">XfceFilenameInput</span></a> *filename_input</code></em>);</pre>
<p>Gets the current text of the widget.</p>
<div class="refsect3">
<a name="xfce-filename-input-get-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filename_input</p></td>
<td class="parameter_description"><p>a <a class="link" href="XfceFilenameInput.html" title="XfceFilenameInput"><span class="type">XfceFilenameInput</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-filename-input-get-text.returns"></a><h4>Returns</h4>
<p>the string representing the current text. </p>
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-filename-input-check"></a><h3>xfce_filename_input_check ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_filename_input_check (<em class="parameter"><code><a class="link" href="XfceFilenameInput.html" title="XfceFilenameInput"><span class="type">XfceFilenameInput</span></a> *filename_input</code></em>);</pre>
<p>Forces a check of the current input text even when it has not changed.
This is useful to force the appropriate signal to be sent to indicate
whether the text is a valid filename or not, so that for example any
GtkWidgets whose sensitivity is controlled by this can be correctly updated
when they are first created.</p>
<div class="refsect3">
<a name="xfce-filename-input-check.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filename_input</p></td>
<td class="parameter_description"><p>a <a class="link" href="XfceFilenameInput.html" title="XfceFilenameInput"><span class="type">XfceFilenameInput</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-filename-input-get-entry"></a><h3>xfce_filename_input_get_entry ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkEntry.html#GtkEntry-struct"><span class="returnvalue">GtkEntry</span></a> *
xfce_filename_input_get_entry (<em class="parameter"><code><a class="link" href="XfceFilenameInput.html" title="XfceFilenameInput"><span class="type">XfceFilenameInput</span></a> *filename_input</code></em>);</pre>
<p>Gets the <a href="/usr/share/gtk-doc/html/gtk3/GtkEntry.html#GtkEntry-struct"><span class="type">GtkEntry</span></a> associated to filename_input</p>
<div class="refsect3">
<a name="xfce-filename-input-get-entry.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filename_input</p></td>
<td class="parameter_description"><p>a <a class="link" href="XfceFilenameInput.html" title="XfceFilenameInput"><span class="type">XfceFilenameInput</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-filename-input-get-entry.returns"></a><h4>Returns</h4>
<p>A <a href="/usr/share/gtk-doc/html/gtk3/GtkEntry.html#GtkEntry-struct"><span class="type">GtkEntry</span></a>. </p>
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-filename-input-sensitise-widget"></a><h3>xfce_filename_input_sensitise_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_filename_input_sensitise_widget (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
<p>A convenience function to be connected as a callback for the "text-valid" signal
(for example, using g_connect_swapped) for the simple case where the desired effect
of this signal is to set the sensitivity of a single GtkWidget (for example, a GtkButton).</p>
<div class="refsect3">
<a name="xfce-filename-input-sensitise-widget.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-filename-input-desensitise-widget"></a><h3>xfce_filename_input_desensitise_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_filename_input_desensitise_widget
(<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
<p>A convenience function to be connected as a callback for the "text-invalid" signal
(for example, using g_connect_swapped) for the simple case where the desired effect
of this signal is to set the sensitivity of a single GtkWidget (for example, a GtkButton).</p>
<div class="refsect3">
<a name="xfce-filename-input-desensitise-widget.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
</div>
<div class="refsect1">
<a name="XfceFilenameInput.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="XfceFilenameInput-struct"></a><h3>XfceFilenameInput</h3>
<pre class="programlisting">typedef struct _XfceFilenameInput XfceFilenameInput;</pre>
<p>An opaque structure with only private fields.</p>
</div>
</div>
<div class="refsect1">
<a name="XfceFilenameInput.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="XfceFilenameInput--max-text-length"></a><h3>The <code class="literal">“max-text-length”</code> property</h3>
<pre class="programlisting"> “max-text-length” <span class="type">int</span></pre>
<p>The maximum permitted length of a filename. A value of -1
indicates no maximum length.</p>
<p>Owner: XfceFilenameInput</p>
<p>Flags: Write / Construct Only</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="XfceFilenameInput--original-filename"></a><h3>The <code class="literal">“original-filename”</code> property</h3>
<pre class="programlisting"> “original-filename” <span class="type">char</span> *</pre>
<p>The original name of the file, to be used as the initial text
displayed in the GtkEntry. A NULL value indicates no original
filename.</p>
<p>Owner: XfceFilenameInput</p>
<p>Flags: Write / Construct Only</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
</div>
<div class="refsect1">
<a name="XfceFilenameInput.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="XfceFilenameInput-text-invalid"></a><h3>The <code class="literal">“text-invalid”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="XfceFilenameInput.html" title="XfceFilenameInput"><span class="type">XfceFilenameInput</span></a> *filename_input,
<span class="type">gpointer</span> user_data)</pre>
<p>Signals that the current text is not a valid filename. This signal is
emitted whenever the user changes the text and the result is not a valid
filename.</p>
<div class="refsect3">
<a name="XfceFilenameInput-text-invalid.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename_input</p></td>
<td class="parameter_description"><p>An <a class="link" href="XfceFilenameInput.html" title="XfceFilenameInput"><span class="type">XfceFilenameInput</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="XfceFilenameInput-text-valid"></a><h3>The <code class="literal">“text-valid”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="XfceFilenameInput.html" title="XfceFilenameInput"><span class="type">XfceFilenameInput</span></a> *filename_input,
<span class="type">gpointer</span> user_data)</pre>
<p>Signals that the current text is a valid filename. This signal is
emitted whenever the user changes the text and the result is a valid
filename.</p>
<div class="refsect3">
<a name="XfceFilenameInput-text-valid.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename_input</p></td>
<td class="parameter_description"><p>An <a class="link" href="XfceFilenameInput.html" title="XfceFilenameInput"><span class="type">XfceFilenameInput</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="api-index-4-16.html#api-index-4.16">4.16</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.34.0</div>
</body>
</html>
|
