Struct gtk::FileFilter

pub struct FileFilter(_, _);

A FileFilter can be used to restrict the files being shown in a FileChooser. Files can be filtered based on their name (with FileFilter::add_pattern), on their mime type (with FileFilter::add_mime_type), or by a custom filter function (with FileFilter::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 FileChooser::add_filter, but it is also possible to manually use a filter on a file with FileFilter::filter.

FileFilter as Buildable

The FileFilter implementation of the Buildable 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 FileFilter::add_mime_type or FileFilter::add_pattern.

An example of a UI definition fragment specifying FileFilter 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>

Implements

glib::object::ObjectExt, BuildableExt, BuildableExtManual

Implementations

impl FileFilter

pub fn new() -> FileFilter

Creates a new FileFilter with no rules added to it. Such a filter doesn’t accept any files, so is not particularly useful until you add rules with FileFilter::add_mime_type, FileFilter::add_pattern, or FileFilter::add_custom. To create a filter that accepts any file, use:

GtkFileFilter *filter = gtk_file_filter_new ();
gtk_file_filter_add_pattern (filter, "*");

Returns

a new FileFilter

pub fn from_gvariant(variant: &Variant) -> FileFilter

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

Adds a rule allowing a given mime type to self.

mime_type

name of a MIME type

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

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

pattern

a shell style glob

pub fn add_pixbuf_formats(&self)

Adds a rule allowing image files in the formats supported by gdk_pixbuf::Pixbuf.

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

Gets the human-readable name for the filter. See FileFilter::set_name.

Returns

The human-readable name of the filter, or None. This value is owned by GTK+ and must not be modified or freed.

pub fn get_needed(&self) -> FileFilterFlags

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

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

Returns

bitfield of flags indicating needed fields when calling FileFilter::filter

pub fn set_name(&self, name: Option<&str>)

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.

name

the human-readable-name for the filter, or None to remove any existing name.

pub fn to_gvariant(&self) -> Option<Variant>

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

Feature: v3_22

Returns

a new, floating, glib::Variant

Trait Implementations

impl Clone for FileFilter

fn clone(&self) -> FileFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileFilter

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

Formats the value using the given formatter.

impl Default for FileFilter

fn default() -> Self

Returns the "default value" for a type.

impl Display for FileFilter

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

Formats the value using the given formatter.

impl Eq for FileFilter

impl Hash for FileFilter

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

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 IsA<Buildable> for FileFilter

impl Ord for FileFilter

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for FileFilter

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for FileFilter

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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 FileFilter

fn static_type() -> Type

Returns the type identifier of Self.