class Gtk::FileFilter

• Gtk::FileFilter
• Gtk::Filter
• GObject::Object
• Reference
• Object

Overview

Gtk::FileFilter filters files by name or mime type.

Gtk::FileFilter can be used to restrict the files being shown in a Gtk::FileChooser. Files can be filtered based on their name (with Gtk::FileFilter#add_pattern or Gtk::FileFilter#add_suffix) or on their mime type (with Gtk::FileFilter#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 Gtk::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 Gtk::FileChooser (see Gtk::FileChooser#add_filter), but it is also possible to manually use a file filter on any Gtk::FilterListModel containing GFileInfo objects.

Gtk::FileFilter as Gtk::Buildable

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

An example of a UI definition fragment specifying Gtk::FileFilter rules:

WARNING ⚠️ The following code is in xml ⚠️

<object class="Gtk::FileFilter">
  <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>

Included Modules

• Gtk::Buildable

Defined in:

Constructors

• .new : self

  Creates a new Gtk::FileFilter with no rules added to it.

• .new(*, name : String | Nil = nil)
• .new_from_gvariant(variant : _) : self

  Deserialize a file filter from a GVariant.

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #add_mime_type(mime_type : String) : Nil

  Adds a rule allowing a given mime type to filter.

• #add_pattern(pattern : String) : Nil

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

• #add_pixbuf_formats : Nil

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

• #add_suffix(suffix : String) : Nil

  Adds a suffix match rule to a filter.

• #attributes : Enumerable(String)

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

• #hash(hasher)

  See Object#hash(hasher)

• #name : String | Nil

  Gets the human-readable name for the filter.

• #name=(value : String) : String
• #name=(value : Nil) : Nil

  Set #name property to nil.

• #name=(name : String | Nil) : Nil

  Sets a human-readable name of the filter.

• #name? : String | Nil

  Same as #name, but can return nil.

• #to_gvariant : GLib::Variant

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

Constructor Detail

Gtk::FileFilter *filter = gtk_file_filter_new ();
gtk_file_filter_add_pattern (filter, "*");

Class Method Detail

Instance Method Detail