Description:

[ CCode ( type_id = "gtk_file_filter_get_type ()" ) ]
public class FileFilter : InitiallyUnowned, Buildable

A GtkFileFilter can be used to restrict the files being shown in a FileChooser.

Files can be filtered based on their name (with add_pattern), on their mime type (with add_mime_type), or by a custom filter function (with add_custom).

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 FileFilter allows wildcards for the subtype of a mime type, so you can e.g. filter for image/\*.

Normally, filters are used by adding them to a FileChooser, see add_filter, but it is also possible to manually use a filter on a file with filter.

GtkFileFilter as GtkBuildable

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>` has the same effect as as calling add_mime_type or add_pattern.

An example of a UI definition fragment specifying GtkFileFilter rules:

<object class="GtkFileFilter">
	<mime-types>
		<mime-type>text/plain</mime-type>
		<mime-type>image/ *</mime-type>
	</mime-types>
	<patterns>
		<pattern>*.txt</pattern>
		<pattern>*.png</pattern>
	</patterns>
</object>

Namespace: Gtk

Package: gtk+-3.0

Content:

Creation methods:

public FileFilter ()

Creates a new FileFilter with no rules added to it.

public FileFilter.from_gvariant (Variant variant)

Deserialize a file filter from an a{sv} variant in the format produced by to_gvariant.

Methods:

public void add_custom (FileFilterFlags needed, owned FileFilterFunc func)

Adds rule to a filter that allows files based on a custom callback function.

public void add_mime_type (string mime_type)

Adds a rule allowing a given mime type to this.

public void add_pattern (string pattern)

Adds a rule allowing a shell style glob to a filter.

public void add_pixbuf_formats ()

Adds a rule allowing image files in the formats supported by GdkPixbuf.

public bool filter (FileFilterInfo filter_info)

Tests whether a file should be displayed according to this.

public unowned string? get_filter_name ()

Gets the human-readable name for the filter.

public FileFilterFlags get_needed ()

Gets the fields that need to be filled in for the FileFilterInfo passed to filter

public void set_filter_name (string? name)

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.

public Variant to_gvariant ()

Serialize a file filter to an a{sv} variant.

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref