GI.Gtk.Objects.FileFilter

A GtkFileFilter can be used to restrict the files being shown in a FileChooser. Files can be filtered based on their name (with fileFilterAddPattern), on their mime type (with fileFilterAddMimeType), or by a custom filter function (with fileFilterAddCustom).

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 fileChooserAddFilter, but it is also possible to manually use a filter on a file with fileFilterFilter.

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 fileFilterAddMimeType or fileFilterAddPattern.

An example of a UI definition fragment specifying GtkFileFilter rules: > >class="GtkFileFilter" > mime-types > mime-typetextplain<mime-type> > mime-typeimage *<mime-type> > /mime-types > patterns > pattern*.txt/pattern > pattern*.png/pattern > /patterns >/object

Exported types

newtype FileFilter

Memory-managed wrapper type.

Constructors

FileFilter (ManagedPtr FileFilter)

Instances

GObject FileFilter

Defined in GI.Gtk.Objects.FileFilter

Methods

gobjectType :: IO GType

HasParentTypes FileFilter

Defined in GI.Gtk.Objects.FileFilter

type ParentTypes FileFilter

Defined in GI.Gtk.Objects.FileFilter

type ParentTypes FileFilter = Object ': (Buildable ': ([] :: [Type]))

class (GObject o, IsDescendantOf FileFilter o) => IsFileFilter o

Type class for types which can be safely cast to FileFilter, for instance with toFileFilter.

Instances

(GObject o, IsDescendantOf FileFilter o) => IsFileFilter o

Defined in GI.Gtk.Objects.FileFilter

toFileFilter :: (MonadIO m, IsFileFilter o) => o -> m FileFilter

Cast to FileFilter, for types for which this is known to be safe. For general casts, use castTo.

noFileFilter :: Maybe FileFilter

A convenience alias for Nothing :: Maybe FileFilter.

Methods

addCustom

fileFilterAddCustom

Arguments

:: (HasCallStack, MonadIO m, IsFileFilter a)

=> a

filter: a FileFilter

-> [FileFilterFlags]

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

-> FileFilterFunc

func: callback function; if the function returns True, then the file will be displayed.

-> m ()

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.

Since: 2.4

addMimeType

fileFilterAddMimeType

Arguments

:: (HasCallStack, MonadIO m, IsFileFilter a)

=> a

filter: A FileFilter

-> Text

mimeType: name of a MIME type

-> m ()

Adds a rule allowing a given mime type to filter.

Since: 2.4

addPattern

fileFilterAddPattern

Arguments

:: (HasCallStack, MonadIO m, IsFileFilter a)

=> a

filter: a FileFilter

-> Text

pattern: a shell style glob

-> m ()

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

Since: 2.4

addPixbufFormats

fileFilterAddPixbufFormats

Arguments

:: (HasCallStack, MonadIO m, IsFileFilter a)

=> a

filter: a FileFilter

-> m ()

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

Since: 2.6

filter

fileFilterFilter

Arguments

:: (HasCallStack, MonadIO m, IsFileFilter a)

=> a

filter: a FileFilter

-> FileFilterInfo

filterInfo: a FileFilterInfo containing information about a file.

-> m Bool

Returns: True if the file should be displayed

Tests whether a file should be displayed according to filter. The FileFilterInfo filterInfo should include the fields returned from fileFilterGetNeeded.

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

Since: 2.4

getName

fileFilterGetName

Arguments

:: (HasCallStack, MonadIO m, IsFileFilter a)

=> a

filter: a FileFilter

-> m (Maybe Text)

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

Gets the human-readable name for the filter. See fileFilterSetName.

Since: 2.4

getNeeded

fileFilterGetNeeded

Arguments

:: (HasCallStack, MonadIO m, IsFileFilter a)

=> a

filter: a FileFilter

-> m [FileFilterFlags]

Returns: bitfield of flags indicating needed fields when calling fileFilterFilter

Gets the fields that need to be filled in for the FileFilterInfo passed to fileFilterFilter

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

Since: 2.4

new

fileFilterNew

Arguments

:: (HasCallStack, MonadIO m)

=> m FileFilter

Returns: a 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 fileFilterAddMimeType, fileFilterAddPattern, or fileFilterAddCustom. To create a filter that accepts any file, use:

C code

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

Since: 2.4

newFromGvariant

fileFilterNewFromGvariant

Arguments

:: (HasCallStack, MonadIO m)

=> GVariant

variant: an a{sv} GVariant

-> m FileFilter

Returns: a new FileFilter object

Deserialize a file filter from an a{sv} variant in the format produced by fileFilterToGvariant.

Since: 3.22

setName

fileFilterSetName

Arguments

:: (HasCallStack, MonadIO m, IsFileFilter a)

=> a

filter: a FileFilter

-> Maybe Text

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

-> m ()

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.

Since: 2.4

toGvariant

fileFilterToGvariant

Arguments

:: (HasCallStack, MonadIO m, IsFileFilter a)

=> a

filter: a FileFilter

-> m GVariant

Returns: a new, floating, GVariant

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

Since: 3.22