Struct gtk::RecentFilter

#[repr(transparent)]
pub struct RecentFilter { /* private fields */ }

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 FileFilter::add_mime_type()), on the application that has registered them (with add_application()), or by a custom filter function (with gtk_recent_filter_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 RecentChooserExt::add_filter(), but it is also possible to manually use a filter on a file with gtk_recent_filter_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 RecentFilter rules:

⚠️ The following code is in xml ⚠️

<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>

Implements

glib::ObjectExt, BuildableExt, BuildableExtManual

Implementations

impl RecentFilter

pub fn new() -> RecentFilter

Creates a new RecentFilter with no rules added to it. Such filter does not accept any recently used resources, so is not particularly useful until you add rules with add_pattern(), add_mime_type(), add_application(), add_age(). To create a filter that accepts any recently used resource, use:

⚠️ The following code is in C ⚠️

GtkRecentFilter *filter = gtk_recent_filter_new ();
gtk_recent_filter_add_pattern (filter, "*");

Returns

a new RecentFilter

pub fn add_age(&self, days: i32)

Adds a rule that allows resources based on their age - that is, the number of days elapsed since they were last modified.

days

number of days

pub fn add_application(&self, application: &str)

Adds a rule that allows resources based on the name of the application that has registered them.

application

an application name

pub fn add_group(&self, group: &str)

Adds a rule that allows resources based on the name of the group to which they belong

group

a group name

pub fn add_mime_type(&self, mime_type: &str)

Adds a rule that allows resources based on their registered MIME type.

mime_type

a MIME type

pub fn add_pattern(&self, pattern: &str)

Adds a rule that allows resources based on a pattern matching their display name.

pattern

a file pattern

pub fn add_pixbuf_formats(&self)

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

pub fn name(&self) -> Option<GString>

Gets the human-readable name for the filter. See set_name().

Returns

the name of the filter, or None. The returned string is owned by the filter object and should not be freed.

pub fn needed(&self) -> RecentFilterFlags

Gets the fields that need to be filled in for the GtkRecentFilterInfo passed to gtk_recent_filter_filter()

This function will not typically be used by applications; it is intended principally for use in the implementation of RecentChooser.

Returns

bitfield of flags indicating needed fields when calling gtk_recent_filter_filter()

pub fn set_name(&self, name: &str)

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.

name

then human readable name of self

Trait Implementations

impl Clone for RecentFilter

fn clone(&self) -> Self

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RecentFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RecentFilter

fn default() -> Self

Returns the “default value” for a type.

impl Display for RecentFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for RecentFilter

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl Ord for RecentFilter

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for RecentFilter

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for RecentFilter

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for RecentFilter

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for RecentFilter

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for RecentFilter

impl IsA<Buildable> for RecentFilter