Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker GObject.InitiallyUnowned
Gtk.FileFilter

Class Gtk.FileFilter

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkFileFilter
Class :	FileFilter
Implements:	Gtk.Buildable
Extends:	GObject.InitiallyUnowned

A GtkFileFilter can be used to restrict the files being shown in a
GtkFileChooser. Files can be filtered based on their name (with
gtk_file_filter_add_pattern()), on their mime type (with
gtk_file_filter_add_mime_type()), or by a custom filter function
(with gtk_file_filter_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 GtkFileFilter 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 GtkFileChooser,
see gtk_file_chooser_add_filter(), but it is also possible
to manually use a filter on a file with gtk_file_filter_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> is the same
as calling gtk_recent_filter_add_mime_type() or gtk_recent_filter_add_pattern()

A UI definition fragment specifying GtkFileFilter rules

]]>

Properties
Properties		Defined By
	g_type_instance : GObject.TypeInstance	GObject.InitiallyUnowned
	qdata : GLib.Data read only	GObject.InitiallyUnowned
	ref_count : guint32 read only	GObject.InitiallyUnowned

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.FileFilter (Object *properties) Create a new Gtk.FileFilter Create a new Gtk.FileFilter Parameters: Object properties*
	add_child (Builder *builder, Object child, String type) : none Adds a child to buildable. Adds a child to buildable. type* is an optional string describing how the child should be added. Parameters: Gtk.Builder builder Required (not null) a GtkBuilder GObject.Object child Required (not null) child to add String type kind of child or NULL Returns: none	Gtk.Buildable
	add_custom (FileFilterFlags *needed, Function func, void *data, Function notify) : none Adds rule to a filter that allows files based on a custom callback function. Adds rule to a filter that allows files based on a custom callback function. The bitfield needed* 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. Parameters: Gtk.FileFilterFlags needed Required (not null) bitfield of flags indicating the information that the custom filter function needs. Function (FileFilterInfo *filter_info, void *data) : none Required (not null) callback function; if the function returns TRUE, then the file will be displayed. void data Required (not null) data to pass to func Function (void* *data) : none Required (not null) function to call to free data* when it is no longer needed. Returns: none	Gtk.FileFilter
	add_mime_type (String *mime_type) : none Adds a rule allowing a given mime type to filter. Adds a rule allowing a given mime type to filter. Parameters: String mime_type* Required (not null) name of a MIME type Returns: none	Gtk.FileFilter
	add_pattern (String *pattern) : none Adds a rule allowing a shell style glob to a filter. Adds a rule allowing a shell style glob to a filter. Parameters: String pattern* Required (not null) a shell style glob Returns: none	Gtk.FileFilter
	add_pixbuf_formats () : none Adds a rule allowing image files in the formats supported by GdkPixbuf. Adds a rule allowing image files in the formats supported by GdkPixbuf. Returns: none	Gtk.FileFilter
	construct_child (Builder *builder, String name) : GObject.Object Constructs a child of buildable* with the name name. Constructs a child of buildable with the name name. GtkBuilder calls this function if a "constructor" has been specified in the UI definition. Parameters: Gtk.Builder builder Required (not null) GtkBuilder used to construct this object String name Required (not null) name of child to construct Returns: GObject.Object the constructed child	Gtk.Buildable
	custom_finished (Builder *builder, Object child, String tagname, void *data) : none This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable. This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable. Parameters: Gtk.Builder builder* Required (not null) a GtkBuilder GObject.Object child child object or NULL for non-child tags String tagname Required (not null) the name of the tag void* data Required (not null) user data created in custom_tag_start Returns: none	Gtk.Buildable
	custom_tag_end (Builder *builder, Object child, String tagname, void *data) : none This is called at the end of each custom element handled by the buildable. This is called at the end of each custom element handled by the buildable. Parameters: Gtk.Builder builder* Required (not null) GtkBuilder used to construct this object GObject.Object child child object or NULL for non-child tags String tagname Required (not null) name of tag void* data Required (not null) user data that will be passed in to parser functions Returns: none	Gtk.Buildable
	custom_tag_start (Builder *builder, Object child, String tagname, Object out_values) : gboolean This is called for each unknown element under <child>. This is called for each unknown element under <child>. if it doesn't. Parameters: Gtk.Builder builder* Required (not null) a GtkBuilder used to construct this object GObject.Object child child object or NULL for non-child tags String tagname Required (not null) name of tag Object out_values GLib.MarkupParser parser void* data Returns: gboolean TRUE if a object has a custom implementation, FALSE	Gtk.Buildable
	filter (FileFilterInfo *filter_info) : gboolean Tests whether a file should be displayed according to filter. Tests whether a file should be displayed according to filter. The GtkFileFilterInfo* structure filter_info should include the fields returned from gtk_file_filter_get_needed(). This function will not typically be used by applications; it is intended principally for use in the implementation of GtkFileChooser. Parameters: Gtk.FileFilterInfo filter_info Required (not null) a GtkFileFilterInfo structure containing information about a file. Returns: gboolean TRUE if the file should be displayed	Gtk.FileFilter
	get_internal_child (Builder *builder, String childname) : GObject.Object Get the internal child called childname* of the buildable object. Get the internal child called childname of the buildable object. Parameters: Gtk.Builder builder Required (not null) a GtkBuilder String childname Required (not null) name of child Returns: GObject.Object the internal child of the buildable object	Gtk.Buildable
	get_name () : String Gets the human-readable name for the filter. Gets the human-readable name for the filter. See gtk_file_filter_set_name(). or NULL. This value is owned by GTK+ and must not be modified or freed. Returns: String The human-readable name of the filter,	Gtk.FileFilter
	get_needed () : Gtk.FileFilterFlags Gets the fields that need to be filled in for the structure passed to gtk_file_filter_filter() This function will not typically be used by applications; it is intended principally for use in the implementation of GtkFileChooser. Gets the fields that need to be filled in for the structure passed to gtk_file_filter_filter() This function will not typically be used by applications; it is intended principally for use in the implementation of GtkFileChooser. calling gtk_file_filter_filter() Returns: Gtk.FileFilterFlags bitfield of flags indicating needed fields when	Gtk.FileFilter
	parser_finished (Builder *builder) : none Called when the builder finishes the parsing of a GtkBuilder UI definition. Called when the builder finishes the parsing of a GtkBuilder UI definition. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() is called on a builder. Parameters: Gtk.Builder builder* Required (not null) a GtkBuilder Returns: none	Gtk.Buildable
	set_buildable_property (Builder *builder, String name, Value value) : none Sets the property name name* to value on the buildable object. Sets the property name name to value on the buildable object. Parameters: Gtk.Builder builder Required (not null) a GtkBuilder String name Required (not null) name of property GObject.Value value Required (not null) value of property Returns: none	Gtk.Buildable
	set_name (String *name) : none 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. 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. Parameters: String name* the human-readable-name for the filter, or NULL to remove any existing name. Returns: none	Gtk.FileFilter

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gtk.FileChooser Property	filter : Gtk.FileFilter
Gtk.FileChooser Method	add_filter (FileFilter *filter) : none Adds filter* to the list of filters that the user can select between.
Gtk.FileChooser Method	get_filter () : Gtk.FileFilter Gets the current filter; see gtk_file_chooser_set_filter().
Gtk.FileChooser Method	remove_filter (FileFilter *filter) : none Removes filter* from the list of filters that the user can select between.
Gtk.FileChooser Method	set_filter (FileFilter *filter*) : none Sets the current filter; only the files that pass the filter will be displayed.