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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gtkfilefilter: GTK+ 2 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="prev" href="GtkFileChooserWidget.html" title="GtkFileChooserWidget">
<link rel="next" href="GtkFontButton.html" title="GtkFontButton">
<meta name="generator" content="GTK-Doc V1.33.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="#gtk2-gtkfilefilter.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#gtk2-gtkfilefilter.object-hierarchy" class="shortcut">Object Hierarchy</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="SelectorWidgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkFileChooserWidget.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkFontButton.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gtk2-gtkfilefilter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtk2-gtkfilefilter.top_of_page"></a>gtkfilefilter</span></h2>
<p>gtkfilefilter</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gtk2-gtkfilefilter.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">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilterFunc" title="GtkFileFilterFunc ()">*GtkFileFilterFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="returnvalue">GtkFileFilter</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk2-gtkfilefilter.html#gtk-file-filter-new" title="gtk_file_filter_new ()">gtk_file_filter_new</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="gtk2-gtkfilefilter.html#gtk-file-filter-set-name" title="gtk_file_filter_set_name ()">gtk_file_filter_set_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="gtk2-gtkfilefilter.html#gtk-file-filter-get-name" title="gtk_file_filter_get_name ()">gtk_file_filter_get_name</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="gtk2-gtkfilefilter.html#gtk-file-filter-add-mime-type" title="gtk_file_filter_add_mime_type ()">gtk_file_filter_add_mime_type</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="gtk2-gtkfilefilter.html#gtk-file-filter-add-pattern" title="gtk_file_filter_add_pattern ()">gtk_file_filter_add_pattern</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="gtk2-gtkfilefilter.html#gtk-file-filter-add-pixbuf-formats" title="gtk_file_filter_add_pixbuf_formats ()">gtk_file_filter_add_pixbuf_formats</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="gtk2-gtkfilefilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()">gtk_file_filter_add_custom</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags"><span class="returnvalue">GtkFileFilterFlags</span></a>
</td>
<td class="function_name">
<a class="link" href="gtk2-gtkfilefilter.html#gtk-file-filter-get-needed" title="gtk_file_filter_get_needed ()">gtk_file_filter_get_needed</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gtk2-gtkfilefilter.html#gtk-file-filter-filter" title="gtk_file_filter_filter ()">gtk_file_filter_filter</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GtkFileFilter"></a><div class="refsect1">
<a name="gtk2-gtkfilefilter.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="gtk2-gtkfilefilter.html#GtkFileFilter-struct" title="GtkFileFilter">GtkFileFilter</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo">GtkFileFilterInfo</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags">GtkFileFilterFlags</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gtk2-gtkfilefilter.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
<span class="lineart">╰──</span> GtkFileFilter
</pre>
</div>
<div class="refsect1">
<a name="gtk2-gtkfilefilter.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtk.h>
</pre>
</div>
<div class="refsect1">
<a name="gtk2-gtkfilefilter.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="gtk2-gtkfilefilter.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GtkFileFilterFunc"></a><h3>GtkFileFilterFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
<span class="c_punctuation">(</span>*GtkFileFilterFunc<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> *filter_info</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-filter-new"></a><h3>gtk_file_filter_new ()</h3>
<pre class="programlisting"><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="returnvalue">GtkFileFilter</span></a> *
gtk_file_filter_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a> with no rules added to it.
Such a filter doesn't accept any files, so is not
particularly useful until you add rules with
<a class="link" href="gtk2-gtkfilefilter.html#gtk-file-filter-add-mime-type" title="gtk_file_filter_add_mime_type ()"><code class="function">gtk_file_filter_add_mime_type()</code></a>, <a class="link" href="gtk2-gtkfilefilter.html#gtk-file-filter-add-pattern" title="gtk_file_filter_add_pattern ()"><code class="function">gtk_file_filter_add_pattern()</code></a>,
or <a class="link" href="gtk2-gtkfilefilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()"><code class="function">gtk_file_filter_add_custom()</code></a>. To create a filter
that accepts any file, use:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="n">GtkFileFilter</span> <span class="o">*</span><span class="n">filter</span> <span class="o">=</span> <span class="n">gtk_file_filter_new</span> <span class="p">();</span>
<span class="n">gtk_file_filter_add_pattern</span> <span class="p">(</span><span class="n">filter</span><span class="p">,</span> <span class="s">"*"</span><span class="p">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<div class="refsect3">
<a name="gtk-file-filter-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-filter-set-name"></a><h3>gtk_file_filter_set_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_file_filter_set_name (<em class="parameter"><code><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Sets the human-readable name of the filter; this is the string
that will be displayed in the file selector user interface if
there is a selectable list of filters.</p>
<div class="refsect3">
<a name="gtk-file-filter-set-name.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>filter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>the human-readable-name for the filter, or <code class="literal">NULL</code>
to remove any existing name. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-filter-get-name"></a><h3>gtk_file_filter_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gtk_file_filter_get_name (<em class="parameter"><code><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>);</pre>
<p>Gets the human-readable name for the filter. See <a class="link" href="gtk2-gtkfilefilter.html#gtk-file-filter-set-name" title="gtk_file_filter_set_name ()"><code class="function">gtk_file_filter_set_name()</code></a>.</p>
<div class="refsect3">
<a name="gtk-file-filter-get-name.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>filter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-file-filter-get-name.returns"></a><h4>Returns</h4>
<p> The human-readable name of the filter,
or <code class="literal">NULL</code>. This value is owned by GTK+ and must not
be modified or freed.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-filter-add-mime-type"></a><h3>gtk_file_filter_add_mime_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_file_filter_add_mime_type (<em class="parameter"><code><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *mime_type</code></em>);</pre>
<p>Adds a rule allowing a given mime type to <em class="parameter"><code>filter</code></em>
.</p>
<div class="refsect3">
<a name="gtk-file-filter-add-mime-type.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>filter</p></td>
<td class="parameter_description"><p>A <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mime_type</p></td>
<td class="parameter_description"><p>name of a MIME type</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-filter-add-pattern"></a><h3>gtk_file_filter_add_pattern ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_file_filter_add_pattern (<em class="parameter"><code><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pattern</code></em>);</pre>
<p>Adds a rule allowing a shell style glob to a filter.</p>
<div class="refsect3">
<a name="gtk-file-filter-add-pattern.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>filter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pattern</p></td>
<td class="parameter_description"><p>a shell style glob</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-filter-add-pixbuf-formats"></a><h3>gtk_file_filter_add_pixbuf_formats ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_file_filter_add_pixbuf_formats (<em class="parameter"><code><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>);</pre>
<p>Adds a rule allowing image files in the formats supported
by GdkPixbuf.</p>
<div class="refsect3">
<a name="gtk-file-filter-add-pixbuf-formats.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>filter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-6.html#api-index-2.6">2.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-filter-add-custom"></a><h3>gtk_file_filter_add_custom ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_file_filter_add_custom (<em class="parameter"><code><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags"><span class="type">GtkFileFilterFlags</span></a> needed</code></em>,
<em class="parameter"><code><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilterFunc" title="GtkFileFilterFunc ()"><span class="type">GtkFileFilterFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
<p>Adds rule to a filter that allows files based on a custom callback
function. The bitfield <em class="parameter"><code>needed</code></em>
which is passed in provides information
about what sorts of information that the filter function needs;
this allows GTK+ to avoid retrieving expensive information when
it isn't needed by the filter.</p>
<div class="refsect3">
<a name="gtk-file-filter-add-custom.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>filter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>needed</p></td>
<td class="parameter_description"><p>bitfield of flags indicating the information that the custom
filter function needs.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>callback function; if the function returns <code class="literal">TRUE</code>, then
the file will be displayed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>data to pass to <em class="parameter"><code>func</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>notify</p></td>
<td class="parameter_description"><p>function to call to free <em class="parameter"><code>data</code></em>
when it is no longer needed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-filter-get-needed"></a><h3>gtk_file_filter_get_needed ()</h3>
<pre class="programlisting"><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags"><span class="returnvalue">GtkFileFilterFlags</span></a>
gtk_file_filter_get_needed (<em class="parameter"><code><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>);</pre>
<p>Gets the fields that need to be filled in for the structure
passed to <a class="link" href="gtk2-gtkfilefilter.html#gtk-file-filter-filter" title="gtk_file_filter_filter ()"><code class="function">gtk_file_filter_filter()</code></a></p>
<p>This function will not typically be used by applications; it
is intended principally for use in the implementation of
<a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>.</p>
<div class="refsect3">
<a name="gtk-file-filter-get-needed.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>filter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-file-filter-get-needed.returns"></a><h4>Returns</h4>
<p> bitfield of flags indicating needed fields when
calling <a class="link" href="gtk2-gtkfilefilter.html#gtk-file-filter-filter" title="gtk_file_filter_filter ()"><code class="function">gtk_file_filter_filter()</code></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-filter-filter"></a><h3>gtk_file_filter_filter ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_file_filter_filter (<em class="parameter"><code><a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code>const <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> *filter_info</code></em>);</pre>
<p>Tests whether a file should be displayed according to <em class="parameter"><code>filter</code></em>
.
The <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> structure <em class="parameter"><code>filter_info</code></em>
should include
the fields returned from <a class="link" href="gtk2-gtkfilefilter.html#gtk-file-filter-get-needed" title="gtk_file_filter_get_needed ()"><code class="function">gtk_file_filter_get_needed()</code></a>.</p>
<p>This function will not typically be used by applications; it
is intended principally for use in the implementation of
<a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>.</p>
<div class="refsect3">
<a name="gtk-file-filter-filter.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>filter</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filter_info</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-gtkfilefilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> structure containing information
about a file.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-file-filter-filter.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the file should be displayed</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="gtk2-gtkfilefilter.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkFileFilter-struct"></a><h3>GtkFileFilter</h3>
<pre class="programlisting">typedef struct _GtkFileFilter GtkFileFilter;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkFileFilterInfo"></a><h3>struct GtkFileFilterInfo</h3>
<pre class="programlisting">struct GtkFileFilterInfo {
GtkFileFilterFlags contains;
const gchar *filename;
const gchar *uri;
const gchar *display_name;
const gchar *mime_type;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkFileFilterFlags"></a><h3>enum GtkFileFilterFlags</h3>
<div class="refsect3">
<a name="GtkFileFilterFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GTK-FILE-FILTER-FILENAME:CAPS"></a>GTK_FILE_FILTER_FILENAME</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-FILE-FILTER-URI:CAPS"></a>GTK_FILE_FILTER_URI</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-FILE-FILTER-DISPLAY-NAME:CAPS"></a>GTK_FILE_FILTER_DISPLAY_NAME</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-FILE-FILTER-MIME-TYPE:CAPS"></a>GTK_FILE_FILTER_MIME_TYPE</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>
|
