Graphics.UI.Gtk.Selectors.FileFilter

A filter for selecting a file subset

• Module available since Gtk+ version 2.4

Detail

A FileFilter 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.

Class Hierarchy

| GObject
| +----Object
| +----FileFilter

Types

data FileFilter

Instances

Eq FileFilter

Defined in Graphics.UI.Gtk.Types

Methods

(==) :: FileFilter -> FileFilter -> Bool

(/=) :: FileFilter -> FileFilter -> Bool

Ord FileFilter

Defined in Graphics.UI.Gtk.Types

Methods

compare :: FileFilter -> FileFilter -> Ordering

(<) :: FileFilter -> FileFilter -> Bool

(<=) :: FileFilter -> FileFilter -> Bool

(>) :: FileFilter -> FileFilter -> Bool

(>=) :: FileFilter -> FileFilter -> Bool

max :: FileFilter -> FileFilter -> FileFilter

min :: FileFilter -> FileFilter -> FileFilter

GObjectClass FileFilter

Defined in Graphics.UI.Gtk.Types

Methods

toGObject :: FileFilter -> GObject

unsafeCastGObject :: GObject -> FileFilter

FileFilterClass FileFilter

Defined in Graphics.UI.Gtk.Types

ObjectClass FileFilter

Defined in Graphics.UI.Gtk.Types

class ObjectClass o => FileFilterClass o

Instances

FileFilterClass FileFilter

Defined in Graphics.UI.Gtk.Types

castToFileFilter :: GObjectClass obj => obj -> FileFilter

gTypeFileFilter :: GType

toFileFilter :: FileFilterClass o => o -> FileFilter

data FileFilterFlags

Constructors

FileFilterFilename

FileFilterUri

FileFilterDisplayName

FileFilterMimeType

Instances

Bounded FileFilterFlags

Defined in Graphics.UI.Gtk.Selectors.FileFilter

Methods

minBound :: FileFilterFlags

maxBound :: FileFilterFlags

Enum FileFilterFlags

Defined in Graphics.UI.Gtk.Selectors.FileFilter

Methods

succ :: FileFilterFlags -> FileFilterFlags

pred :: FileFilterFlags -> FileFilterFlags

toEnum :: Int -> FileFilterFlags

fromEnum :: FileFilterFlags -> Int

enumFrom :: FileFilterFlags -> [FileFilterFlags]

enumFromThen :: FileFilterFlags -> FileFilterFlags -> [FileFilterFlags]

enumFromTo :: FileFilterFlags -> FileFilterFlags -> [FileFilterFlags]

enumFromThenTo :: FileFilterFlags -> FileFilterFlags -> FileFilterFlags -> [FileFilterFlags]

Eq FileFilterFlags

Defined in Graphics.UI.Gtk.Selectors.FileFilter

Methods

(==) :: FileFilterFlags -> FileFilterFlags -> Bool

(/=) :: FileFilterFlags -> FileFilterFlags -> Bool

Show FileFilterFlags

Defined in Graphics.UI.Gtk.Selectors.FileFilter

Methods

showsPrec :: Int -> FileFilterFlags -> ShowS

show :: FileFilterFlags -> String

showList :: [FileFilterFlags] -> ShowS

Flags FileFilterFlags

Defined in Graphics.UI.Gtk.Selectors.FileFilter

Constructors

fileFilterNew :: IO 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.

Methods

fileFilterSetName

Arguments

:: GlibString string

=> FileFilter

-> string

name - the human-readable-name for the filter

-> IO ()

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.

fileFilterGetName

Arguments

:: GlibString string

=> FileFilter

-> IO string

returns The human-readable name of the filter

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

fileFilterAddMimeType

Arguments

:: GlibString string

=> FileFilter

-> string

mimeType - name of a MIME type

-> IO ()

Adds a rule allowing a given mime type to filter.

fileFilterAddPattern

Arguments

:: GlibString string

=> FileFilter

-> string

pattern - a shell style glob

-> IO ()

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

fileFilterAddCustom

Arguments

:: GlibString string

=> FileFilter

-> [FileFilterFlags]

needed - list of flags indicating the information that the custom filter function needs.

-> (Maybe string -> Maybe string -> Maybe string -> Maybe string -> IO Bool)

(filename uri displayName mimeType -> ...) - filter function; if the function returns True, then the file will be displayed.

-> IO ()

Adds rule to a filter that allows files based on a custom callback function. The list of flags 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.

fileFilterAddPixbufFormats :: FileFilter -> IO ()

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

• Available since Gtk+ version 2.6

Attributes

fileFilterName :: GlibString string => Attr FileFilter string

'name' property. See fileFilterGetName and fileFilterSetName