Struct gtk::FileFilter

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

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

An example of a UI definition fragment specifying GtkFileFilter rules:

⚠️ The following code is in xml ⚠️

<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::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 add_mime_type(), add_pattern(), or add_custom(). 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 an a{sv} variant in the format produced by to_gvariant().

variant

an a{sv} glib::Variant

Returns

a new FileFilter object

pub fn add_custom<P: Fn(&FileFilterInfo) -> bool + 'static>(
    &self,
    needed: FileFilterFlags,
    func: P
)

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.

needed

bitfield of flags indicating the information that the custom filter function needs.

func

callback function; if the function returns true, then the file will be displayed.

notify

function to call to free data when it is no longer needed.

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

pub fn filter(&self, filter_info: &FileFilterInfo) -> bool

Tests whether a file should be displayed according to self. The FileFilterInfo filter_info should include the fields returned from needed().

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

filter_info

a FileFilterInfo containing information about a file.

Returns

true if the file should be displayed

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, or None. This value is owned by GTK+ and must not be modified or freed.

pub fn needed(&self) -> FileFilterFlags

Gets the fields that need to be filled in for the FileFilterInfo passed to 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 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.

Returns

a new, floating, glib::Variant

Trait Implementations

impl Clone for FileFilter

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

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.

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 FileFilter

type Parent = Object

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

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 FileFilter

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 FileFilter

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FileFilter

impl IsA<Buildable> for FileFilter