← Back to branch summary

~ubuntu-branches/debian/squeeze/glib2.0/squeeze

« back to all changes in this revision

Viewing changes to docs/reference/gio/html/GFilenameCompleter.html

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo Noronha Silva
  • Date: 2009-02-15 13:00:43 UTC
  • mfrom: (1.3.1 upstream) (69.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20090215130043-q47fbt3owmt42m2f
Tags: 2.18.4-2
* Release to unstable
* debian/rules:
- bump SHVER, since we are already forcing a 2.18.0 dependecy on the
  symbols introduced in the development versions
* debian/control.in:
- added Homepage and Vcs-* control fields

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/html/GFilenameCompleter.html
1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html>
3
3
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GFilenameCompleter</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="GIO Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
7
<link rel="home" href="index.html" title="GIO Reference Manual">
8
8
<link rel="up" href="utils.html" title="Utilities">
9
9
<link rel="prev" href="utils.html" title="Utilities">
10
10
<link rel="next" href="extending.html" title="Extending GIO">
11
 
<meta name="generator" content="GTK-Doc V1.9 (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
 
<link rel="part" href="pt01.html" title="Part&#160;I.&#160;GIO Overview">
 
13
<link rel="part" href="pt01.html" title="Part I. GIO Overview">
14
14
<link rel="chapter" href="ch01.html" title="Introduction">
15
15
<link rel="chapter" href="ch02.html" title="Compiling GIO applications">
16
16
<link rel="chapter" href="ch03.html" title="Running GIO applications">
17
 
<link rel="chapter" href="gio-extension-points.html" title="Extending GIO">
18
 
<link rel="part" href="pt02.html" title="Part&#160;II.&#160;API Reference">
 
17
<link rel="chapter" href="extending-gio.html" title="Extending GIO">
 
18
<link rel="part" href="pt02.html" title="Part II. API Reference">
19
19
<link rel="chapter" href="file_ops.html" title="File Operations">
20
20
<link rel="chapter" href="file_mon.html" title="File System Monitoring">
21
21
<link rel="chapter" href="async.html" title="Asynchronous I/O">
25
25
<link rel="chapter" href="icons.html" title="Icons">
26
26
<link rel="chapter" href="utils.html" title="Utilities">
27
27
<link rel="chapter" href="extending.html" title="Extending GIO">
28
 
<link rel="part" href="migrating.html" title="Part&#160;III.&#160;Migrating to GIO">
 
28
<link rel="part" href="migrating.html" title="Part III. Migrating to GIO">
29
29
<link rel="chapter" href="ch14.html" title="Migrating from POSIX to GIO">
30
30
<link rel="chapter" href="ch15.html" title="Migrating from GnomeVFS to GIO">
31
31
<link rel="chapter" href="gio-hierarchy.html" title="Object Hierarchy">
32
32
<link rel="index" href="ix01.html" title="Index">
 
33
<link rel="index" href="ix02.html" title="Index of new symbols in 2.18">
33
34
</head>
34
35
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
35
36
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
40
41
<th width="100%" align="center">GIO Reference Manual</th>
41
42
<td><a accesskey="n" href="extending.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
42
43
</tr>
43
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2746607" class="shortcut">Top</a>
44
 
                  &#160;|&#160;
45
 
                  <a href="#id2899059" class="shortcut">Description</a>
46
 
                  &#160;|&#160;
47
 
                  <a href="#id2899014" class="shortcut">Object Hierarchy</a>
48
 
                  &#160;|&#160;
49
 
                  <a href="#id2899036" class="shortcut">Signals</a></nobr></td></tr>
 
44
<tr><td colspan="5" class="shortcuts">
 
45
<a href="#GFilenameCompleter.synopsis" class="shortcut">Top</a>
 
46
                 | 
 
47
                <a href="#GFilenameCompleter.description" class="shortcut">Description</a>
 
48
                 | 
 
49
                <a href="#GFilenameCompleter.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
50
                 | 
 
51
                <a href="#GFilenameCompleter.signals" class="shortcut">Signals</a>
 
52
</td></tr>
50
53
</table>
51
54
<div class="refentry" lang="en">
52
55
<a name="GFilenameCompleter"></a><div class="titlepage"></div>
53
56
<div class="refnamediv"><table width="100%"><tr>
54
57
<td valign="top">
55
 
<h2>
56
 
<a name="id2746607"></a><span class="refentrytitle">GFilenameCompleter</span>
57
 
</h2>
58
 
<p>GFilenameCompleter &#8212; Filename Completer</p>
 
58
<h2><span class="refentrytitle"><a name="GFilenameCompleter.top_of_page"></a>GFilenameCompleter</span></h2>
 
59
<p>GFilenameCompleter — Filename Completer</p>
59
60
</td>
60
61
<td valign="top" align="right"></td>
61
62
</tr></table></div>
62
63
<div class="refsynopsisdiv">
63
 
<h2>Synopsis</h2>
 
64
<a name="GFilenameCompleter.synopsis"></a><h2>Synopsis</h2>
64
65
<pre class="synopsis">
65
66
 
66
67
#include &lt;gio/gio.h&gt;
67
68
 
68
 
 
69
 
                    <a class="link" href="GFilenameCompleter.html#GFilenameCompleter-struct">GFilenameCompleter</a>;
70
 
<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a>* <a class="link" href="GFilenameCompleter.html#g-filename-completer-new">g_filename_completer_new</a>            (void);
71
 
char*               <a class="link" href="GFilenameCompleter.html#g-filename-completer-get-completion-suffix">g_filename_completer_get_completion_suffix</a>
72
 
                                                        (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer,
73
 
                                                         const char *initial_text);
74
 
char**              <a class="link" href="GFilenameCompleter.html#g-filename-completer-get-completions">g_filename_completer_get_completions</a>
75
 
                                                        (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer,
76
 
                                                         const char *initial_text);
77
 
void                <a class="link" href="GFilenameCompleter.html#g-filename-completer-set-dirs-only">g_filename_completer_set_dirs_only</a>  (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer,
 
69
                    <a class="link" href="GFilenameCompleter.html#GFilenameCompleter-struct" title="GFilenameCompleter">GFilenameCompleter</a>;
 
70
<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> * <a class="link" href="GFilenameCompleter.html#g-filename-completer-new" title="g_filename_completer_new ()">g_filename_completer_new</a>           (void);
 
71
char *              <a class="link" href="GFilenameCompleter.html#g-filename-completer-get-completion-suffix" title="g_filename_completer_get_completion_suffix ()">g_filename_completer_get_completion_suffix</a>
 
72
                                                        (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer,
 
73
                                                         const char *initial_text);
 
74
char **             <a class="link" href="GFilenameCompleter.html#g-filename-completer-get-completions" title="g_filename_completer_get_completions ()">g_filename_completer_get_completions</a>
 
75
                                                        (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer,
 
76
                                                         const char *initial_text);
 
77
void                <a class="link" href="GFilenameCompleter.html#g-filename-completer-set-dirs-only" title="g_filename_completer_set_dirs_only ()">g_filename_completer_set_dirs_only</a>  (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer,
78
78
                                                         <a
79
79
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
80
80
>gboolean</a> dirs_only);
81
 
 
82
 
 
83
81
</pre>
84
82
</div>
85
83
<div class="refsect1" lang="en">
86
 
<a name="id2899014"></a><h2>Object Hierarchy</h2>
 
84
<a name="GFilenameCompleter.object-hierarchy"></a><h2>Object Hierarchy</h2>
87
85
<pre class="synopsis">
88
 
 
89
86
  <a
90
87
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
91
88
>GObject</a>
93
90
</pre>
94
91
</div>
95
92
<div class="refsect1" lang="en">
96
 
<a name="id2899036"></a><h2>Signals</h2>
 
93
<a name="GFilenameCompleter.signals"></a><h2>Signals</h2>
97
94
<pre class="synopsis">
98
 
 
99
 
  "<a class="link" href="GFilenameCompleter.html#GFilenameCompleter-got-completion-data">got-completion-data</a>"                            : Run Last
 
95
  "<a class="link" href="GFilenameCompleter.html#GFilenameCompleter-got-completion-data" title='The "got-completion-data" signal'>got-completion-data</a>"                            : Run Last
100
96
</pre>
101
97
</div>
102
98
<div class="refsect1" lang="en">
103
 
<a name="id2899059"></a><h2>Description</h2>
 
99
<a name="GFilenameCompleter.description"></a><h2>Description</h2>
104
100
<p>
105
101
Completes partial file and directory names given a partial string by
106
102
looking in the file system for clues. Can return a list of possible 
107
103
completion strings for widget implementations.</p>
108
104
<p>
109
 
 
110
105
</p>
111
106
</div>
112
107
<div class="refsect1" lang="en">
113
 
<a name="id2899081"></a><h2>Details</h2>
 
108
<a name="GFilenameCompleter.details"></a><h2>Details</h2>
114
109
<div class="refsect2" lang="en">
115
 
<a name="id2899091"></a><h3>
116
 
<a name="GFilenameCompleter-struct"></a>GFilenameCompleter</h3>
117
 
<a class="indexterm" name="id2899103"></a><pre class="programlisting">typedef struct _GFilenameCompleter GFilenameCompleter;</pre>
 
110
<a name="GFilenameCompleter-struct"></a><h3>GFilenameCompleter</h3>
 
111
<pre class="programlisting">typedef struct _GFilenameCompleter GFilenameCompleter;</pre>
118
112
<p>
119
113
Completes filenames based on files that exist within the file system.</p>
120
114
<p>
121
 
 
122
115
</p>
123
116
</div>
124
117
<hr>
125
118
<div class="refsect2" lang="en">
126
 
<a name="id2899123"></a><h3>
127
 
<a name="g-filename-completer-new"></a>g_filename_completer_new ()</h3>
128
 
<a class="indexterm" name="id2899134"></a><pre class="programlisting"><a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a>* g_filename_completer_new            (void);</pre>
 
119
<a name="g-filename-completer-new"></a><h3>g_filename_completer_new ()</h3>
 
120
<pre class="programlisting"><a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> * g_filename_completer_new           (void);</pre>
129
121
<p>
130
122
Creates a new filename completer.</p>
131
123
<p>
132
 
 
133
124
</p>
134
125
<div class="variablelist"><table border="0">
135
126
<col align="left" valign="top">
136
127
<tbody><tr>
137
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
128
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
138
129
<td> a <a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter"><span class="type">GFilenameCompleter</span></a>.
139
130
</td>
140
131
</tr></tbody>
142
133
</div>
143
134
<hr>
144
135
<div class="refsect2" lang="en">
145
 
<a name="id2897218"></a><h3>
146
 
<a name="g-filename-completer-get-completion-suffix"></a>g_filename_completer_get_completion_suffix ()</h3>
147
 
<a class="indexterm" name="id2897230"></a><pre class="programlisting">char*               g_filename_completer_get_completion_suffix
 
136
<a name="g-filename-completer-get-completion-suffix"></a><h3>g_filename_completer_get_completion_suffix ()</h3>
 
137
<pre class="programlisting">char *              g_filename_completer_get_completion_suffix
148
138
                                                        (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer,
149
139
                                                         const char *initial_text);</pre>
150
140
<p>
151
141
Obtains a completion for <em class="parameter"><code>initial_text</code></em> from <em class="parameter"><code>completer</code></em>.</p>
152
142
<p>
153
 
 
154
143
</p>
155
144
<div class="variablelist"><table border="0">
156
145
<col align="left" valign="top">
157
146
<tbody>
158
147
<tr>
159
 
<td><p><span class="term"><em class="parameter"><code>completer</code></em>&#160;:</span></p></td>
 
148
<td><p><span class="term"><em class="parameter"><code>completer</code></em> :</span></p></td>
160
149
<td> the filename completer.
161
150
</td>
162
151
</tr>
163
152
<tr>
164
 
<td><p><span class="term"><em class="parameter"><code>initial_text</code></em>&#160;:</span></p></td>
 
153
<td><p><span class="term"><em class="parameter"><code>initial_text</code></em> :</span></p></td>
165
154
<td> text to be completed.
166
155
</td>
167
156
</tr>
168
157
<tr>
169
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
158
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
170
159
<td> a completed string, or <a
171
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
160
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
172
161
><code class="literal">NULL</code></a> if no completion exists. 
173
162
    This string is not owned by GIO, so remember to <a
174
163
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
181
170
</div>
182
171
<hr>
183
172
<div class="refsect2" lang="en">
184
 
<a name="id2897343"></a><h3>
185
 
<a name="g-filename-completer-get-completions"></a>g_filename_completer_get_completions ()</h3>
186
 
<a class="indexterm" name="id2897355"></a><pre class="programlisting">char**              g_filename_completer_get_completions
 
173
<a name="g-filename-completer-get-completions"></a><h3>g_filename_completer_get_completions ()</h3>
 
174
<pre class="programlisting">char **             g_filename_completer_get_completions
187
175
                                                        (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer,
188
176
                                                         const char *initial_text);</pre>
189
177
<p>
190
178
Gets an array of completion strings for a given initial text.</p>
191
179
<p>
192
 
 
193
180
</p>
194
181
<div class="variablelist"><table border="0">
195
182
<col align="left" valign="top">
196
183
<tbody>
197
184
<tr>
198
 
<td><p><span class="term"><em class="parameter"><code>completer</code></em>&#160;:</span></p></td>
 
185
<td><p><span class="term"><em class="parameter"><code>completer</code></em> :</span></p></td>
199
186
<td> the filename completer.
200
187
</td>
201
188
</tr>
202
189
<tr>
203
 
<td><p><span class="term"><em class="parameter"><code>initial_text</code></em>&#160;:</span></p></td>
 
190
<td><p><span class="term"><em class="parameter"><code>initial_text</code></em> :</span></p></td>
204
191
<td> text to be completed.
205
192
</td>
206
193
</tr>
207
194
<tr>
208
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
195
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
209
196
<td> array of strings with possible completions for <em class="parameter"><code>initial_text</code></em>.
210
197
This array must be freed by <a
211
198
href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#g-strfreev"
217
204
</div>
218
205
<hr>
219
206
<div class="refsect2" lang="en">
220
 
<a name="id2897456"></a><h3>
221
 
<a name="g-filename-completer-set-dirs-only"></a>g_filename_completer_set_dirs_only ()</h3>
222
 
<a class="indexterm" name="id2897468"></a><pre class="programlisting">void                g_filename_completer_set_dirs_only  (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer,
 
207
<a name="g-filename-completer-set-dirs-only"></a><h3>g_filename_completer_set_dirs_only ()</h3>
 
208
<pre class="programlisting">void                g_filename_completer_set_dirs_only  (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer,
223
209
                                                         <a
224
210
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
225
211
>gboolean</a> dirs_only);</pre>
226
212
<p>
227
213
If <em class="parameter"><code>dirs_only</code></em> is <a
228
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
214
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
229
215
><code class="literal">TRUE</code></a>, <em class="parameter"><code>completer</code></em> will only 
230
216
complete directory names, and not file names.</p>
231
217
<p>
232
 
 
233
218
</p>
234
219
<div class="variablelist"><table border="0">
235
220
<col align="left" valign="top">
236
221
<tbody>
237
222
<tr>
238
 
<td><p><span class="term"><em class="parameter"><code>completer</code></em>&#160;:</span></p></td>
 
223
<td><p><span class="term"><em class="parameter"><code>completer</code></em> :</span></p></td>
239
224
<td> the filename completer.
240
225
</td>
241
226
</tr>
242
227
<tr>
243
 
<td><p><span class="term"><em class="parameter"><code>dirs_only</code></em>&#160;:</span></p></td>
 
228
<td><p><span class="term"><em class="parameter"><code>dirs_only</code></em> :</span></p></td>
244
229
<td> a <a
245
230
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
246
231
><span class="type">gboolean</span></a>.
251
236
</div>
252
237
</div>
253
238
<div class="refsect1" lang="en">
254
 
<a name="id2884989"></a><h2>Signal Details</h2>
 
239
<a name="GFilenameCompleter.signal-details"></a><h2>Signal Details</h2>
255
240
<div class="refsect2" lang="en">
256
 
<a name="id2885000"></a><h3>
257
 
<a name="GFilenameCompleter-got-completion-data"></a>The <code class="literal">"got-completion-data"</code> signal</h3>
258
 
<a class="indexterm" name="id2885016"></a><pre class="programlisting">void                user_function                      (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *arg0,
 
241
<a name="GFilenameCompleter-got-completion-data"></a><h3>The <code class="literal">"got-completion-data"</code> signal</h3>
 
242
<pre class="programlisting">void                user_function                      (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *arg0,
259
243
                                                        <a
260
244
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
261
245
>gpointer</a>            user_data)      : Run Last</pre>
262
246
<p>
263
247
Emitted when the file name completion information comes available.</p>
264
248
<p>
265
 
 
266
249
</p>
267
250
<div class="variablelist"><table border="0">
268
251
<col align="left" valign="top">
269
252
<tbody><tr>
270
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
 
253
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
271
254
<td>user data set when the signal handler was connected.</td>
272
255
</tr></tbody>
273
256
</table></div>
274
257
</div>
275
258
</div>
276
 
<div class="refsect1" lang="en">
277
 
<a name="id2885076"></a><div class="refsect2" lang="en"><a name="id2885077"></a></div>
 
259
</div>
 
260
<div class="footer">
278
261
<hr>
279
 
<div class="refsect2" lang="en"><a name="id2885078"></a></div>
280
 
</div>
281
 
</div>
 
262
          Generated by GTK-Doc V1.11</div>
282
263
</body>
283
264
</html>