| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gtk.Objects.FileFilter
Description
Filters files by name or mime type.
GtkFileFilter can be used to restrict the files being shown in a
file chooser. Files can be filtered based on their name (with
fileFilterAddPattern or fileFilterAddSuffix)
or on their mime type (with fileFilterAddMimeType).
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 GtkFileFilter 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 file chooser
(see fileDialogSetFilters), but it is also possible to
manually use a file filter on any FilterListModel containing
GFileInfo objects.
GtkFileFilter as GtkBuildable
The GtkFileFilter implementation of the GtkBuildable 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
fileFilterAddMimeType or
fileFilterAddPattern or
fileFilterAddSuffix.
An example of a UI definition fragment specifying GtkFileFilter
rules:
xml code
<object class="GtkFileFilter">
<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>Synopsis
- newtype FileFilter = FileFilter (ManagedPtr FileFilter)
- class (GObject o, IsDescendantOf FileFilter o) => IsFileFilter o
- toFileFilter :: (MonadIO m, IsFileFilter o) => o -> m FileFilter
- fileFilterAddMimeType :: (HasCallStack, MonadIO m, IsFileFilter a) => a -> Text -> m ()
- fileFilterAddPattern :: (HasCallStack, MonadIO m, IsFileFilter a) => a -> Text -> m ()
- fileFilterAddPixbufFormats :: (HasCallStack, MonadIO m, IsFileFilter a) => a -> m ()
- fileFilterAddSuffix :: (HasCallStack, MonadIO m, IsFileFilter a) => a -> Text -> m ()
- fileFilterGetAttributes :: (HasCallStack, MonadIO m, IsFileFilter a) => a -> m [Text]
- fileFilterGetName :: (HasCallStack, MonadIO m, IsFileFilter a) => a -> m (Maybe Text)
- fileFilterNew :: (HasCallStack, MonadIO m) => m FileFilter
- fileFilterNewFromGvariant :: (HasCallStack, MonadIO m) => GVariant -> m FileFilter
- fileFilterSetName :: (HasCallStack, MonadIO m, IsFileFilter a) => a -> Maybe Text -> m ()
- fileFilterToGvariant :: (HasCallStack, MonadIO m, IsFileFilter a) => a -> m GVariant
- constructFileFilterMimeTypes :: (IsFileFilter o, MonadIO m) => [Text] -> m (GValueConstruct o)
- clearFileFilterName :: (MonadIO m, IsFileFilter o) => o -> m ()
- constructFileFilterName :: (IsFileFilter o, MonadIO m) => Text -> m (GValueConstruct o)
- getFileFilterName :: (MonadIO m, IsFileFilter o) => o -> m (Maybe Text)
- setFileFilterName :: (MonadIO m, IsFileFilter o) => o -> Text -> m ()
- constructFileFilterPatterns :: (IsFileFilter o, MonadIO m) => [Text] -> m (GValueConstruct o)
- constructFileFilterSuffixes :: (IsFileFilter o, MonadIO m) => [Text] -> m (GValueConstruct o)
Exported types
newtype FileFilter Source #
Memory-managed wrapper type.
Constructors
| FileFilter (ManagedPtr FileFilter) |
Instances
| Eq FileFilter Source # | |
Defined in GI.Gtk.Objects.FileFilter | |
| GObject FileFilter Source # | |
Defined in GI.Gtk.Objects.FileFilter | |
| ManagedPtrNewtype FileFilter Source # | |
Defined in GI.Gtk.Objects.FileFilter Methods | |
| TypedObject FileFilter Source # | |
Defined in GI.Gtk.Objects.FileFilter | |
| HasParentTypes FileFilter Source # | |
Defined in GI.Gtk.Objects.FileFilter | |
| IsGValue (Maybe FileFilter) Source # | Convert |
Defined in GI.Gtk.Objects.FileFilter Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe FileFilter -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe FileFilter) # | |
| type ParentTypes FileFilter Source # | |
Defined in GI.Gtk.Objects.FileFilter | |
class (GObject o, IsDescendantOf FileFilter o) => IsFileFilter o Source #
Type class for types which can be safely cast to FileFilter, for instance with toFileFilter.
Instances
| (GObject o, IsDescendantOf FileFilter o) => IsFileFilter o Source # | |
Defined in GI.Gtk.Objects.FileFilter | |
toFileFilter :: (MonadIO m, IsFileFilter o) => o -> m FileFilter Source #
Cast to FileFilter, for types for which this is known to be safe. For general casts, use castTo.
Methods
Click to display all available methods, including inherited ones
Methods
addMimeType, addPattern, addPixbufFormats, addSuffix, bindProperty, bindPropertyFull, changed, forceFloating, freezeNotify, getv, isFloating, match, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, toGvariant, unref, watchClosure.
Getters
getAttributes, getBuildableId, getData, getName, getProperty, getQdata, getStrictness.
Setters
addMimeType
fileFilterAddMimeType Source #
Arguments
| :: (HasCallStack, MonadIO m, IsFileFilter a) | |
| => a |
|
| -> Text |
|
| -> m () |
Adds a rule allowing a given mime type.
addPattern
Arguments
| :: (HasCallStack, MonadIO m, IsFileFilter a) | |
| => a |
|
| -> Text |
|
| -> m () |
Adds a rule allowing a shell style glob pattern.
Note that it depends on the platform whether pattern matching ignores case or not. On Windows, it does, on other platforms, it doesn't.
addPixbufFormats
fileFilterAddPixbufFormats Source #
Arguments
| :: (HasCallStack, MonadIO m, IsFileFilter a) | |
| => a |
|
| -> m () |
Adds a rule allowing image files in the formats supported by GdkPixbuf.
This is equivalent to calling fileFilterAddMimeType
for all the supported mime types.
addSuffix
Arguments
| :: (HasCallStack, MonadIO m, IsFileFilter a) | |
| => a |
|
| -> Text |
|
| -> m () |
Adds a suffix match rule to a filter.
This is similar to adding a match for the pattern "*.suffix"
An exaple to filter files with the suffix ".sub":
c code
gtk_file_filter_add_suffix (filter, "sub");
Filters with multiple dots are allowed.
In contrast to pattern matches, suffix matches are *always* case-insensitive.
Since: 4.4
getAttributes
fileFilterGetAttributes Source #
Arguments
| :: (HasCallStack, MonadIO m, IsFileFilter a) | |
| => a |
|
| -> m [Text] | Returns: the attributes |
Gets the attributes that need to be filled in for the GFileInfo
passed to this filter.
This function will not typically be used by applications; it is intended for use in file chooser implementation.
getName
Arguments
| :: (HasCallStack, MonadIO m, IsFileFilter a) | |
| => a |
|
| -> m (Maybe Text) | Returns: the human-readable name of the filter |
Gets the human-readable name for the filter.
See fileFilterSetName.
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m FileFilter | Returns: a new |
Creates a new GtkFileFilter 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,
fileFilterAddSuffix or
fileFilterAddPixbufFormats.
To create a filter that accepts any file, use:
c code
GtkFileFilter *filter = gtk_file_filter_new (); gtk_file_filter_add_pattern (filter, "*");
newFromGvariant
fileFilterNewFromGvariant Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => GVariant |
|
| -> m FileFilter | Returns: a new |
Deserialize a file filter from a GVariant.
The variant must be in the format produced by
fileFilterToGvariant.
setName
Arguments
| :: (HasCallStack, MonadIO m, IsFileFilter a) | |
| => a |
|
| -> Maybe Text |
|
| -> m () |
Sets a human-readable name of the filter.
This is the string that will be displayed in the user interface if there is a selectable list of filters.
toGvariant
Arguments
| :: (HasCallStack, MonadIO m, IsFileFilter a) | |
| => a |
|
| -> m GVariant | Returns: a new, floating, |
Serialize a file filter to an a{sv} variant.
Properties
mimeTypes
The MIME types that this filter matches.
Since: 4.10
constructFileFilterMimeTypes :: (IsFileFilter o, MonadIO m) => [Text] -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “mime-types” property. This is rarely needed directly, but it is used by new.
name
The human-readable name of the filter.
This is the string that will be displayed in the user interface if there is a selectable list of filters.
clearFileFilterName :: (MonadIO m, IsFileFilter o) => o -> m () Source #
Set the value of the “name” property to Nothing.
When overloading is enabled, this is equivalent to
clear #name
constructFileFilterName :: (IsFileFilter o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “name” property. This is rarely needed directly, but it is used by new.
getFileFilterName :: (MonadIO m, IsFileFilter o) => o -> m (Maybe Text) Source #
Get the value of the “name” property.
When overloading is enabled, this is equivalent to
get fileFilter #name
setFileFilterName :: (MonadIO m, IsFileFilter o) => o -> Text -> m () Source #
Set the value of the “name” property.
When overloading is enabled, this is equivalent to
setfileFilter [ #name:=value ]
patterns
The patterns that this filter matches.
Since: 4.10
constructFileFilterPatterns :: (IsFileFilter o, MonadIO m) => [Text] -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “patterns” property. This is rarely needed directly, but it is used by new.
suffixes
The suffixes that this filter matches.
Since: 4.10
constructFileFilterSuffixes :: (IsFileFilter o, MonadIO m) => [Text] -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “suffixes” property. This is rarely needed directly, but it is used by new.