/usr/share/doc/libgtk-3-doc/gtk3/GtkFileFilter.html is in libgtk-3-doc 3.4.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="SelectorWidgets.html" title="Selectors (Color/File/Font)">
<link rel="prev" href="GtkFileChooserWidget.html" title="GtkFileChooserWidget">
<link rel="next" href="GtkFontChooser.html" title="GtkFontChooser">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkFileChooserWidget.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="SelectorWidgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ 3 Reference Manual</th>
<td><a accesskey="n" href="GtkFontChooser.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkFileFilter.synopsis" class="shortcut">Top</a>
|
<a href="#GtkFileFilter.description" class="shortcut">Description</a>
|
<a href="#GtkFileFilter.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GtkFileFilter.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</td></tr>
</table>
<div class="refentry">
<a name="GtkFileFilter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkFileFilter.top_of_page"></a>GtkFileFilter</span></h2>
<p>GtkFileFilter — A filter for selecting a file subset</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkFileFilter.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a class="link" href="GtkFileFilter.html#GtkFileFilter-struct" title="GtkFileFilter">GtkFileFilter</a>;
struct <a class="link" href="GtkFileFilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo">GtkFileFilterInfo</a>;
enum <a class="link" href="GtkFileFilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags">GtkFileFilterFlags</a>;
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (<a class="link" href="GtkFileFilter.html#GtkFileFilterFunc" title="GtkFileFilterFunc ()">*GtkFileFilterFunc</a>) (<em class="parameter"><code>const <a class="link" href="GtkFileFilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> *filter_info</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
<a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="returnvalue">GtkFileFilter</span></a> * <a class="link" href="GtkFileFilter.html#gtk-file-filter-new" title="gtk_file_filter_new ()">gtk_file_filter_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="GtkFileFilter.html#gtk-file-filter-set-name" title="gtk_file_filter_set_name ()">gtk_file_filter_set_name</a> (<em class="parameter"><code><a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GtkFileFilter.html#gtk-file-filter-get-name" title="gtk_file_filter_get_name ()">gtk_file_filter_get_name</a> (<em class="parameter"><code><a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GtkFileFilter.html#gtk-file-filter-add-mime-type" title="gtk_file_filter_add_mime_type ()">gtk_file_filter_add_mime_type</a> (<em class="parameter"><code><a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mime_type</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GtkFileFilter.html#gtk-file-filter-add-pattern" title="gtk_file_filter_add_pattern ()">gtk_file_filter_add_pattern</a> (<em class="parameter"><code><a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pattern</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GtkFileFilter.html#gtk-file-filter-add-pixbuf-formats" title="gtk_file_filter_add_pixbuf_formats ()">gtk_file_filter_add_pixbuf_formats</a> (<em class="parameter"><code><a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GtkFileFilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()">gtk_file_filter_add_custom</a> (<em class="parameter"><code><a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code><a class="link" href="GtkFileFilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags"><span class="type">GtkFileFilterFlags</span></a> needed</code></em>,
<em class="parameter"><code><a class="link" href="GtkFileFilter.html#GtkFileFilterFunc" title="GtkFileFilterFunc ()"><span class="type">GtkFileFilterFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);
<a class="link" href="GtkFileFilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags"><span class="returnvalue">GtkFileFilterFlags</span></a> <a class="link" href="GtkFileFilter.html#gtk-file-filter-get-needed" title="gtk_file_filter_get_needed ()">gtk_file_filter_get_needed</a> (<em class="parameter"><code><a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkFileFilter.html#gtk-file-filter-filter" title="gtk_file_filter_filter ()">gtk_file_filter_filter</a> (<em class="parameter"><code><a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code>const <a class="link" href="GtkFileFilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> *filter_info</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GtkFileFilter.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----GtkFileFilter
</pre>
</div>
<div class="refsect1">
<a name="GtkFileFilter.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkFileFilter implements
<a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkFileFilter.description"></a><h2>Description</h2>
<p>
A GtkFileFilter can be used to restrict the files being shown in a
<a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>. Files can be filtered based on their name (with
<a class="link" href="GtkFileFilter.html#gtk-file-filter-add-pattern" title="gtk_file_filter_add_pattern ()"><code class="function">gtk_file_filter_add_pattern()</code></a>), on their mime type (with
<a class="link" href="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>), or by a custom filter function
(with <a class="link" href="GtkFileFilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()"><code class="function">gtk_file_filter_add_custom()</code></a>).
</p>
<p>
Filtering by mime types handles aliasing and subclassing of mime
types; e.g. a filter for text/plain also matches a file with mime
type application/rtf, since application/rtf is a subclass of
text/plain. Note that <a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> allows wildcards for the
subtype of a mime type, so you can e.g. filter for image/*.
</p>
<p>
Normally, filters are used by adding them to a <a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>,
see <a class="link" href="GtkFileChooser.html#gtk-file-chooser-add-filter" title="gtk_file_chooser_add_filter ()"><code class="function">gtk_file_chooser_add_filter()</code></a>, but it is also possible
to manually use a filter on a file with <a class="link" href="GtkFileFilter.html#gtk-file-filter-filter" title="gtk_file_filter_filter ()"><code class="function">gtk_file_filter_filter()</code></a>.
</p>
<p>
</p>
<div class="refsect2">
<a name="GtkFileFilter-BUILDER-UI"></a><h3>GtkFileFilter as GtkBuildable</h3>
<p>
The GtkFileFilter implementation of the GtkBuildable interface
supports adding rules using the <mime-types>, <patterns> and
<applications> elements and listing the rules within. Specifying
a <mime-type> or <pattern> is the same
as calling <a class="link" href="GtkRecentFilter.html#gtk-recent-filter-add-mime-type" title="gtk_recent_filter_add_mime_type ()"><code class="function">gtk_recent_filter_add_mime_type()</code></a> or <a class="link" href="GtkRecentFilter.html#gtk-recent-filter-add-pattern" title="gtk_recent_filter_add_pattern ()"><code class="function">gtk_recent_filter_add_pattern()</code></a>
</p>
<p>
</p>
<div class="example">
<a name="idp52828320"></a><p class="title"><b>Example 90. A UI definition fragment specifying GtkFileFilter rules</b></p>
<div class="example-contents"><pre class="programlisting">
<object class="GtkFileFilter">
<mime-types>
<mime-type>text/plain</mime-type>
<mime-type>image/&ast;</mime-type>
</mime-types>
<patterns>
<pattern>*.txt</pattern>
<pattern>*.png</pattern>
</patterns>
</object>
</pre></div>
</div>
<p><br class="example-break">
</p>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="GtkFileFilter.details"></a><h2>Details</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>
<p>
A <a class="link" href="GtkFileFilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> struct is used to pass information about the
tested file to <a class="link" href="GtkFileFilter.html#gtk-file-filter-filter" title="gtk_file_filter_filter ()"><code class="function">gtk_file_filter_filter()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="GtkFileFilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags"><span class="type">GtkFileFilterFlags</span></a> <em class="structfield"><code><a name="GtkFileFilterInfo.contains"></a>contains</code></em>;</span></p></td>
<td>Flags indicating which of the following fields need
are filled</td>
</tr>
<tr>
<td><p><span class="term">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GtkFileFilterInfo.filename"></a>filename</code></em>;</span></p></td>
<td>the filename of the file being tested</td>
</tr>
<tr>
<td><p><span class="term">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GtkFileFilterInfo.uri"></a>uri</code></em>;</span></p></td>
<td>the URI for the file being tested</td>
</tr>
<tr>
<td><p><span class="term">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GtkFileFilterInfo.display-name"></a>display_name</code></em>;</span></p></td>
<td>the string that will be used to display the file
in the file chooser</td>
</tr>
<tr>
<td><p><span class="term">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GtkFileFilterInfo.mime-type"></a>mime_type</code></em>;</span></p></td>
<td>the mime type of the file</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GtkFileFilterFlags"></a><h3>enum GtkFileFilterFlags</h3>
<pre class="programlisting">typedef enum {
GTK_FILE_FILTER_FILENAME = 1 << 0,
GTK_FILE_FILTER_URI = 1 << 1,
GTK_FILE_FILTER_DISPLAY_NAME = 1 << 2,
GTK_FILE_FILTER_MIME_TYPE = 1 << 3
} GtkFileFilterFlags;
</pre>
<p>
These flags indicate what parts of a <a class="link" href="GtkFileFilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> struct
are filled or need to be filled.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GTK-FILE-FILTER-FILENAME:CAPS"></a><span class="term"><code class="literal">GTK_FILE_FILTER_FILENAME</code></span></p></td>
<td>the filename of the file being tested
</td>
</tr>
<tr>
<td><p><a name="GTK-FILE-FILTER-URI:CAPS"></a><span class="term"><code class="literal">GTK_FILE_FILTER_URI</code></span></p></td>
<td>the URI for the file being tested
</td>
</tr>
<tr>
<td><p><a name="GTK-FILE-FILTER-DISPLAY-NAME:CAPS"></a><span class="term"><code class="literal">GTK_FILE_FILTER_DISPLAY_NAME</code></span></p></td>
<td>the string that will be used to
display the file in the file chooser
</td>
</tr>
<tr>
<td><p><a name="GTK-FILE-FILTER-MIME-TYPE:CAPS"></a><span class="term"><code class="literal">GTK_FILE_FILTER_MIME_TYPE</code></span></p></td>
<td>the mime type of the file
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GtkFileFilterFunc"></a><h3>GtkFileFilterFunc ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (*GtkFileFilterFunc) (<em class="parameter"><code>const <a class="link" href="GtkFileFilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> *filter_info</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
The type of function that is used with custom filters, see
<a class="link" href="GtkFileFilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()"><code class="function">gtk_file_filter_add_custom()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter_info</code></em> :</span></p></td>
<td>a <a class="link" href="GtkFileFilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> that is filled according
to the <em class="parameter"><code>needed</code></em> flags passed to <a class="link" href="GtkFileFilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()"><code class="function">gtk_file_filter_add_custom()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>user data passed to <a class="link" href="GtkFileFilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()"><code class="function">gtk_file_filter_add_custom()</code></a>. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the file should be displayed</td>
</tr>
</tbody>
</table></div>
</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="GtkFileFilter.html" title="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="GtkFileFilter.html" title="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="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="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="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"><pre class="programlisting">
GtkFileFilter *filter = gtk_file_filter_new ();
gtk_file_filter_add_pattern (filter, "*");
</pre></div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.4</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="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>a <a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the human-readable-name for the filter, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
to remove any existing name. <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>
<p class="since">Since 2.4</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 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gtk_file_filter_get_name (<em class="parameter"><code><a class="link" href="GtkFileFilter.html" title="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="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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>a <a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The human-readable name of the filter,
or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. This value is owned by GTK+ and must not
be modified or freed.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</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="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>A <a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
<td>name of a MIME type</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</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="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pattern</code></em>);</pre>
<p>
Adds a rule allowing a shell style glob to a filter.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>a <a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pattern</code></em> :</span></p></td>
<td>a shell style glob</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</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="GtkFileFilter.html" title="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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>a <a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.6</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="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code><a class="link" href="GtkFileFilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags"><span class="type">GtkFileFilterFlags</span></a> needed</code></em>,
<em class="parameter"><code><a class="link" href="GtkFileFilter.html#GtkFileFilterFunc" title="GtkFileFilterFunc ()"><span class="type">GtkFileFilterFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> 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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>a <a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>needed</code></em> :</span></p></td>
<td>bitfield of flags indicating the information that the custom
filter function needs.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>callback function; if the function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then
the file will be displayed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>data to pass to <em class="parameter"><code>func</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
<td>function to call to free <em class="parameter"><code>data</code></em> when it is no longer needed.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</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="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="GtkFileFilter.html" title="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="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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>a <a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>bitfield of flags indicating needed fields when
calling <a class="link" href="GtkFileFilter.html#gtk-file-filter-filter" title="gtk_file_filter_filter ()"><code class="function">gtk_file_filter_filter()</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-filter-filter"></a><h3>gtk_file_filter_filter ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_file_filter_filter (<em class="parameter"><code><a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a> *filter</code></em>,
<em class="parameter"><code>const <a class="link" href="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="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="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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>a <a class="link" href="GtkFileFilter.html" title="GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter_info</code></em> :</span></p></td>
<td>a <a class="link" href="GtkFileFilter.html#GtkFileFilterInfo" title="struct GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> structure containing information
about a file.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the file should be displayed</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
</div>
<div class="refsect1">
<a name="GtkFileFilter.see-also"></a><h2>See Also</h2>
<a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|