File: //usr/local/ssl/share/gtk-doc/html/gtk/gtk-gtkfilefilter.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkFileFilter</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ 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.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</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+ Reference Manual</th>
<td><a accesskey="n" href="GtkFontButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3433374" class="shortcut">Top</a>
 | 
<a href="#id3433754" class="shortcut">Description</a>
 | 
<a href="#id3433715" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gtk-gtkfilefilter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3433374"></a><span class="refentrytitle">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">
<h2>Synopsis</h2>
<a name="GtkFileFilter"></a><pre class="synopsis">
#include <gtk/gtk.h>
<a href="gtk-gtkfilefilter.html#GtkFileFilter-struct">GtkFileFilter</a>;
<a href="gtk-gtkfilefilter.html#GtkFileFilterInfo">GtkFileFilterInfo</a>;
enum <a href="gtk-gtkfilefilter.html#GtkFileFilterFlags">GtkFileFilterFlags</a>;
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> (<a href="gtk-gtkfilefilter.html#GtkFileFilterFunc">*GtkFileFilterFunc</a>) (const <a href="gtk-gtkfilefilter.html#GtkFileFilterInfo">GtkFileFilterInfo</a> *filter_info,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a>* <a href="gtk-gtkfilefilter.html#gtk-file-filter-new">gtk_file_filter_new</a> (void);
void <a href="gtk-gtkfilefilter.html#gtk-file-filter-set-name">gtk_file_filter_set_name</a> (<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="gtk-gtkfilefilter.html#gtk-file-filter-get-name">gtk_file_filter_get_name</a> (<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter);
void <a href="gtk-gtkfilefilter.html#gtk-file-filter-add-mime-type">gtk_file_filter_add_mime_type</a> (<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *mime_type);
void <a href="gtk-gtkfilefilter.html#gtk-file-filter-add-pattern">gtk_file_filter_add_pattern</a> (<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *pattern);
void <a href="gtk-gtkfilefilter.html#gtk-file-filter-add-pixbuf-formats">gtk_file_filter_add_pixbuf_formats</a>
(<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter);
void <a href="gtk-gtkfilefilter.html#gtk-file-filter-add-custom">gtk_file_filter_add_custom</a> (<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
<a href="gtk-gtkfilefilter.html#GtkFileFilterFlags">GtkFileFilterFlags</a> needed,
<a href="gtk-gtkfilefilter.html#GtkFileFilterFunc">GtkFileFilterFunc</a> func,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data,
<a
href="../glib/glib-Datasets.html#GDestroyNotify"
>GDestroyNotify</a> notify);
<a href="gtk-gtkfilefilter.html#GtkFileFilterFlags">GtkFileFilterFlags</a> <a href="gtk-gtkfilefilter.html#gtk-file-filter-get-needed">gtk_file_filter_get_needed</a>
(<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="gtk-gtkfilefilter.html#gtk-file-filter-filter">gtk_file_filter_filter</a> (<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
const <a href="gtk-gtkfilefilter.html#GtkFileFilterInfo">GtkFileFilterInfo</a> *filter_info);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3433715"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
+----GtkFileFilter
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3433754"></a><h2>Description</h2>
<p>
A GtkFileFilter can be used to restrict the files being shown
in a <a href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>. Files can be filtered based on their name
(with <a href="gtk-gtkfilefilter.html#gtk-file-filter-add-pattern"><code class="function">gtk_file_filter_add_pattern()</code></a>), on their mime type (with
<a href="gtk-gtkfilefilter.html#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 href="gtk-gtkfilefilter.html#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 href="gtk-gtkfilefilter.html#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 href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>,
see <a href="GtkFileChooser.html#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 href="gtk-gtkfilefilter.html#gtk-file-filter-filter"><code class="function">gtk_file_filter_filter()</code></a>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3433866"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3433876"></a><h3>
<a name="GtkFileFilter-struct"></a>GtkFileFilter</h3>
<a class="indexterm" name="id3433890"></a><pre class="programlisting">typedef struct _GtkFileFilter GtkFileFilter;</pre>
<p>
The <span class="structname">GtkFileFilter</span> struct contains
only private fields and should not be directly accessed.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3433911"></a><h3>
<a name="GtkFileFilterInfo"></a>GtkFileFilterInfo</h3>
<a class="indexterm" name="id3433923"></a><pre class="programlisting">typedef struct {
GtkFileFilterFlags contains;
const gchar *filename;
const gchar *uri;
const gchar *display_name;
const gchar *mime_type;
} GtkFileFilterInfo;
</pre>
<p>
A <span class="structname">GtkFileFilterInfo</span> struct is used
to pass information about the tested file to
<a href="gtk-gtkfilefilter.html#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>
<span class="term"><a href="gtk-gtkfilefilter.html#GtkFileFilterFlags">GtkFileFilterFlags</a> <em class="structfield"><code>contains</code></em>;</span></td>
<td>Flags indicating which of the following fields need
are filled
</td>
</tr>
<tr>
<td>
<span class="term">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>filename</code></em>;</span></td>
<td>the filename of the file being tested
</td>
</tr>
<tr>
<td>
<span class="term">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>uri</code></em>;</span></td>
<td>the URI for the file being tested
</td>
</tr>
<tr>
<td>
<span class="term">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>display_name</code></em>;</span></td>
<td>the string that will be used to display the file
in the file chooser
</td>
</tr>
<tr>
<td>
<span class="term">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>mime_type</code></em>;</span></td>
<td>the mime type of the file
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3434071"></a><h3>
<a name="GtkFileFilterFlags"></a>enum GtkFileFilterFlags</h3>
<a class="indexterm" name="id3434084"></a><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 href="gtk-gtkfilefilter.html#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>
<span class="term"><a name="GTK-FILE-FILTER-FILENAME:CAPS"></a><code class="literal">GTK_FILE_FILTER_FILENAME</code></span></td>
<td>the filename of the file being tested
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-FILE-FILTER-URI:CAPS"></a><code class="literal">GTK_FILE_FILTER_URI</code></span></td>
<td>the URI for the file being tested
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-FILE-FILTER-DISPLAY-NAME:CAPS"></a><code class="literal">GTK_FILE_FILTER_DISPLAY_NAME</code></span></td>
<td>the string that will be used to
display the file in the file chooser
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-FILE-FILTER-MIME-TYPE:CAPS"></a><code class="literal">GTK_FILE_FILTER_MIME_TYPE</code></span></td>
<td>the mime type of the file
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3434212"></a><h3>
<a name="GtkFileFilterFunc"></a>GtkFileFilterFunc ()</h3>
<a class="indexterm" name="id3434225"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> (*GtkFileFilterFunc) (const <a href="gtk-gtkfilefilter.html#GtkFileFilterInfo">GtkFileFilterInfo</a> *filter_info,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<p>
The type of function that is used with custom filters,
see <a href="gtk-gtkfilefilter.html#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>
<span class="term"><em class="parameter"><code>filter_info</code></em> :</span></td>
<td>a <a href="gtk-gtkfilefilter.html#GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> that is filled according
to the <em class="parameter"><code>needed</code></em> flags passed to <a href="gtk-gtkfilefilter.html#gtk-file-filter-add-custom"><code class="function">gtk_file_filter_add_custom()</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>user data passed to <a href="gtk-gtkfilefilter.html#gtk-file-filter-add-custom"><code class="function">gtk_file_filter_add_custom()</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
<a
href="../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" lang="en">
<a name="id3434362"></a><h3>
<a name="gtk-file-filter-new"></a>gtk_file_filter_new ()</h3>
<a class="indexterm" name="id3434376"></a><pre class="programlisting"><a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a>* gtk_file_filter_new (void);</pre>
<p>
Creates a new <a href="gtk-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 href="gtk-gtkfilefilter.html#gtk-file-filter-add-mime-type"><code class="function">gtk_file_filter_add_mime_type()</code></a>, <a href="gtk-gtkfilefilter.html#gtk-file-filter-add-pattern"><code class="function">gtk_file_filter_add_pattern()</code></a>,
or <a href="gtk-gtkfilefilter.html#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>
<p>
</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>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <a href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr></tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3434486"></a><h3>
<a name="gtk-file-filter-set-name"></a>gtk_file_filter_set_name ()</h3>
<a class="indexterm" name="id3434501"></a><pre class="programlisting">void gtk_file_filter_set_name (<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
<td> a <a href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the human-readable-name for the filter, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
to remove any existing name.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3434599"></a><h3>
<a name="gtk-file-filter-get-name"></a>gtk_file_filter_get_name ()</h3>
<a class="indexterm" name="id3434615"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gtk_file_filter_get_name (<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter);</pre>
<p>
Gets the human-readable name for the filter. See <a href="gtk-gtkfilefilter.html#gtk-file-filter-set-name"><code class="function">gtk_file_filter_set_name()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
<td> a <a href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The human-readable name of the filter,
or <a
href="../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>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3434712"></a><h3>
<a name="gtk-file-filter-add-mime-type"></a>gtk_file_filter_add_mime_type ()</h3>
<a class="indexterm" name="id3434728"></a><pre class="programlisting">void gtk_file_filter_add_mime_type (<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *mime_type);</pre>
<p>
Adds a rule allowing a given mime type to <em class="parameter"><code>filter</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
<td> A <a href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>mime_type</code></em> :</span></td>
<td> name of a MIME type
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3434819"></a><h3>
<a name="gtk-file-filter-add-pattern"></a>gtk_file_filter_add_pattern ()</h3>
<a class="indexterm" name="id3434835"></a><pre class="programlisting">void gtk_file_filter_add_pattern (<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *pattern);</pre>
<p>
Adds a rule allowing a shell style glob to a filter.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
<td> a <a href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>pattern</code></em> :</span></td>
<td> a shell style glob
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3434920"></a><h3>
<a name="gtk-file-filter-add-pixbuf-formats"></a>gtk_file_filter_add_pixbuf_formats ()</h3>
<a class="indexterm" name="id3434936"></a><pre class="programlisting">void gtk_file_filter_add_pixbuf_formats
(<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter);</pre>
<p>
Adds a rule allowing image files in the formats supported
by GdkPixbuf.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
<td> a <a href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr></tbody>
</table></div>
<p>Since 2.6
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3435000"></a><h3>
<a name="gtk-file-filter-add-custom"></a>gtk_file_filter_add_custom ()</h3>
<a class="indexterm" name="id3435016"></a><pre class="programlisting">void gtk_file_filter_add_custom (<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
<a href="gtk-gtkfilefilter.html#GtkFileFilterFlags">GtkFileFilterFlags</a> needed,
<a href="gtk-gtkfilefilter.html#GtkFileFilterFunc">GtkFileFilterFunc</a> func,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data,
<a
href="../glib/glib-Datasets.html#GDestroyNotify"
>GDestroyNotify</a> notify);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
<td> a <a href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>needed</code></em> :</span></td>
<td> bitfield of flags indicating the information that the custom
filter function needs.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>func</code></em> :</span></td>
<td> callback function; if the function returns <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>, then
the file will be displayed.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td> data to pass to <em class="parameter"><code>func</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>notify</code></em> :</span></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>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3435201"></a><h3>
<a name="gtk-file-filter-get-needed"></a>gtk_file_filter_get_needed ()</h3>
<a class="indexterm" name="id3435217"></a><pre class="programlisting"><a href="gtk-gtkfilefilter.html#GtkFileFilterFlags">GtkFileFilterFlags</a> gtk_file_filter_get_needed
(<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter);</pre>
<p>
Gets the fields that need to be filled in for the structure
passed to <a href="gtk-gtkfilefilter.html#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 href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
<td> a <a href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> bitfield of flags indicating needed fields when
calling <a href="gtk-gtkfilefilter.html#gtk-file-filter-filter"><code class="function">gtk_file_filter_filter()</code></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3435327"></a><h3>
<a name="gtk-file-filter-filter"></a>gtk_file_filter_filter ()</h3>
<a class="indexterm" name="id3435343"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_file_filter_filter (<a href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
const <a href="gtk-gtkfilefilter.html#GtkFileFilterInfo">GtkFileFilterInfo</a> *filter_info);</pre>
<p>
Tests whether a file should be displayed according to <em class="parameter"><code>filter</code></em>.
The <a href="gtk-gtkfilefilter.html#GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> structure <em class="parameter"><code>filter_info</code></em> should include
the fields returned from <a href="gtk-gtkfilefilter.html#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 href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
<td> a <a href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>filter_info</code></em> :</span></td>
<td> a <a href="gtk-gtkfilefilter.html#GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> structure containing information
about a file.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../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>Since 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3435505"></a><h2>See Also</h2>
<p>
<a href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>
</p>
</div>
</div>
</body>
</html>