Struct gtk4::FileFilter

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

FileFilter filters files by name or mime type.

FileFilter can be used to restrict the files being shown in a FileChooser. Files can be filtered based on their name (with add_pattern() or add_suffix()) or on their mime type (with add_mime_type()).

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, file filters are used by adding them to a FileChooser (see FileChooserExt::add_filter()), but it is also possible to manually use a file filter on any FilterListModel containing GFileInfo objects.

GtkFileFilter as GtkBuildable

The FileFilter implementation of the Buildable interface supports adding rules using the <mime-types> and <patterns> and <suffixes> elements and listing the rules within. Specifying a <mime-type> or <pattern> or <suffix> has the same effect as as calling add_mime_type() or add_pattern() or add_suffix().

An example of a UI definition fragment specifying FileFilter rules:

<object class="GtkFileFilter">
  <property name="name" translatable="yes">Text and Images</property>
  <mime-types>
    <mime-type>text/plain</mime-type>
    <mime-type>image/ *</mime-type>
  </mime-types>
  <patterns>
    <pattern>*.txt</pattern>
  </patterns>
  <suffixes>
    <suffix>png</suffix>
  </suffixes>
</object>

Implements

FilterExt, glib::ObjectExt, BuildableExt

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 add_mime_type(), add_pattern(), add_suffix() or add_pixbuf_formats().

To create a filter that accepts any file, use: ⚠️ The following code is in c ⚠️

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

Returns

a new FileFilter

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

Deserialize a file filter from a GVariant.

The variant must be in the format produced by to_gvariant().

variant

an a{sv} GVariant

Returns

a new FileFilter object

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.

Note that it depends on the platform whether pattern matching ignores case or not. On Windows, it does, on other platforms, it doesn’t.

pattern

a shell style glob

pub fn add_pixbuf_formats(&self)

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

This is equivalent to calling add_mime_type() for all the supported mime types.

pub fn add_suffix(&self, suffix: &str)

Available on crate feature v4_4 only.

Adds a suffix match rule to a filter.

This is similar to adding a match for the pattern “*.@suffix”.

In contrast to pattern matches, suffix matches are always case-insensitive.

suffix

filename suffix to match

pub fn attributes(&self) -> Vec<GString>

Gets the attributes that need to be filled in for the GFileInfo passed to this filter.

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

Returns

the attributes

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

Gets the human-readable name for the filter.

See set_name().

Returns

The human-readable name of the filter

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

Sets a human-readable name of the filter.

This is the string that will be displayed in the file chooser 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) -> Variant

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

Returns

a new, floating, GVariant

pub fn connect_name_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Trait Implementations

impl Clone for FileFilter

fn clone(&self) -> Self

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 Hash for FileFilter

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FileFilter

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for FileFilter

type Parent = Filter

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

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

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

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 FileFilter

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

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

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

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

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

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

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

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

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.

impl Eq for FileFilter

impl IsA<Buildable> for FileFilter

impl IsA<Filter> for FileFilter