Gtk.RecentFilter – gtk+-3.0 Reference Manual

RecentFilter

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_recent_filter_get_type ()" ) ]
public class RecentFilter : InitiallyUnowned, Buildable

A RecentFilter can be used to restrict the files being shown in a RecentChooser.

Files can be filtered based on their name (with add_pattern), on their mime type (with add_mime_type), on the application that has registered them (with add_application), or by a custom filter function (with add_custom).

Filtering by mime type 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 RecentFilter 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 RecentChooser, see add_filter, but it is also possible to manually use a filter on a file with filter.

Recently used files are supported since GTK+ 2.10.

GtkRecentFilter as GtkBuildable

The GtkRecentFilter 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>`, `<pattern>` or `<application >` has the same effect as calling add_mime_type, add_pattern or add_application.

An example of a UI definition fragment specifying `GtkRecentFilter` rules:

<object class="GtkRecentFilter">
	<mime-types>
		<mime-type>text/plain</mime-type>
		<mime-type>image/png</mime-type>
	</mime-types>
	<patterns>
		<pattern>*.txt</pattern>
		<pattern>*.png</pattern>
	</patterns>
	<applications>
		<application>gimp</application>
		<application>gedit</application>
		<application>glade</application>
	</applications>
</object>

Namespace: Gtk

Package: gtk+-3.0

Content:

Creation methods:

public RecentFilter ()
Creates a new RecentFilter with no rules added to it.

Methods:

public void add_age (int days)
Adds a rule that allows resources based on their age - that is, the number of days elapsed since they were last modified.
public void add_application (string application)
Adds a rule that allows resources based on the name of the application that has registered them.
public void add_custom (RecentFilterFlags needed, owned RecentFilterFunc func)
Adds a rule to a filter that allows resources based on a custom callback function.
public void add_group (string group)
Adds a rule that allows resources based on the name of the group to which they belong
public void add_mime_type (string mime_type)
Adds a rule that allows resources based on their registered MIME type.
public void add_pattern (string pattern)
Adds a rule that allows resources based on a pattern matching their display name.
public void add_pixbuf_formats ()
Adds a rule allowing image files in the formats supported by GdkPixbuf.
public bool filter (RecentFilterInfo 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 RecentFilterFlags get_needed ()
Gets the fields that need to be filled in for the RecentFilterInfo 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 recently used resources selector user interface if there is a selectable list of filters.

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

All known members inherited from interface Gtk.Buildable

2022 vala-language.org