gtk-0.12.5.4: Binding to the Gtk+ graphical user interface library.

Portabilityportable (depends on GHC)
Stabilityprovisional
Maintainergtk2hs-users@lists.sourceforge.net
Safe HaskellNone

Graphics.UI.Gtk.Recent.RecentFilter

Contents

Description

A filter for selecting a subset of recently used files

  • Module available since Gtk+ version 2.10

Synopsis

Detail

A RecentFilter can be used to restrict the files being shown in a RecentChooser. Files can be filtered based on their name (with recentFilterAddPattern), on their mime type (with fileFilterAddMimeType), on the application that has registered them (with recentFilterAddApplication), or by a custom filter function (with recentFilterAddCustom).

Filtering by mime type 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 RecentFilter 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 RecentChooser, see recentChooserAddFilter, but it is also possible to manually use a filter on a file with recentFilterFilter.

Recently used files are supported since Gtk+ 2.10.

Class Hierarchy

 | GObject
 | +----Object
 | +----RecentFilter

Types

Enums

data RecentFilterFlags Source

These flags indicate what parts of a RecentFilterInfo struct are filled or need to be filled.

Instances

Bounded RecentFilterFlags 
Enum RecentFilterFlags

Creates a new RecentFilter with no rules added to it. Such filter does not accept any recently used resources, so is not particularly useful until you add rules with recentFilterAddPattern, recentFilterAddMimeType, recentFilterAddApplication, recentFilterAddAge. To create a filter that accepts any recently used resource, use:

 filter <- recentFilterNew
 recentFilterAddPattern filter "*"
  • Available since Gtk+ version 2.10
Eq RecentFilterFlags 
Show RecentFilterFlags 

Constructors

Methods

recentFilterGetNameSource

Arguments

:: RecentFilterClass self 
=> self 
-> IO String

returns the name of the filter

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

  • Available since Gtk+ version 2.10

recentFilterSetNameSource

Arguments

:: RecentFilterClass self 
=> self 
-> String

name - then human readable name of filter

-> IO () 

Sets the human-readable name of the filter; this is the string that will be displayed in the recently used resources selector user interface if there is a selectable list of filters.

  • Available since Gtk+ version 2.10

recentFilterAddMimeTypeSource

Arguments

:: RecentFilterClass self 
=> self 
-> String

mimeType - a MIME type

-> IO () 

Adds a rule that allows resources based on their registered MIME type.

  • Available since Gtk+ version 2.10

recentFilterAddPatternSource

Arguments

:: RecentFilterClass self 
=> self 
-> String

pattern - a file pattern

-> IO () 

Adds a rule that allows resources based on a pattern matching their display name.

  • Available since Gtk+ version 2.10

recentFilterAddPixbufFormats :: RecentFilterClass self => self -> IO ()Source

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

recentFilterAddApplicationSource

Arguments

:: RecentFilterClass self 
=> self 
-> String

application - an application name

-> IO () 

Adds a rule that allows resources based on the name of the application that has registered them.

  • Available since Gtk+ version 2.10

recentFilterAddGroupSource

Arguments

:: RecentFilterClass self 
=> self 
-> String

group - a group name

-> IO () 

Adds a rule that allows resources based on the name of the group to which they belong

  • Available since Gtk+ version 2.10

recentFilterAddAgeSource

Arguments

:: RecentFilterClass self 
=> self 
-> Int

days - number of days

-> IO () 

Adds a rule that allows resources based on their age - that is, the number of days elapsed since they were last modified.

  • Available since Gtk+ version 2.10