Debian Codegraph @

docs/reference/html/XfceFilenameInput.html

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