Pileus Git - ~andy/gtk/blob - gtk/gtkfilefilter.h

   1 /* GTK - The GIMP Toolkit
   2  * gtkfilefilter.h: Filters for selecting a file subset
   3  * Copyright (C) 2003, Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __GTK_FILE_FILTER_H__
  22 #define __GTK_FILE_FILTER_H__
  23
  24 #include <glib-object.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define GTK_TYPE_FILE_FILTER              (gtk_file_filter_get_type ())
  29 #define GTK_FILE_FILTER(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FILE_FILTER, GtkFileFilter))
  30 #define GTK_IS_FILE_FILTER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FILE_FILTER))
  31
  32 typedef struct _GtkFileFilter     GtkFileFilter;
  33 typedef struct _GtkFileFilterInfo GtkFileFilterInfo;
  34
  35 typedef enum {
  36   GTK_FILE_FILTER_FILENAME     = 1 << 0,
  37   GTK_FILE_FILTER_URI          = 1 << 1,
  38   GTK_FILE_FILTER_DISPLAY_NAME = 1 << 2,
  39   GTK_FILE_FILTER_MIME_TYPE    = 1 << 3
  40 } GtkFileFilterFlags;
  41
  42 typedef gboolean (*GtkFileFilterFunc) (const GtkFileFilterInfo *filter_info,
  43                                        gpointer                 data);
  44
  45 struct _GtkFileFilterInfo
  46 {
  47   GtkFileFilterFlags contains;
  48
  49   const gchar *filename;
  50   const gchar *uri;
  51   const gchar *display_name;
  52   const gchar *mime_type;
  53 };
  54
  55 GType gtk_file_filter_get_type (void) G_GNUC_CONST;
  56
  57 GtkFileFilter *       gtk_file_filter_new      (void);
  58 void                  gtk_file_filter_set_name (GtkFileFilter *filter,
  59                                                 const gchar   *name);
  60 G_CONST_RETURN gchar *gtk_file_filter_get_name (GtkFileFilter *filter);
  61
  62 void gtk_file_filter_add_mime_type      (GtkFileFilter      *filter,
  63                                          const gchar        *mime_type);
  64 void gtk_file_filter_add_pattern        (GtkFileFilter      *filter,
  65                                          const gchar        *pattern);
  66 void gtk_file_filter_add_pixbuf_formats (GtkFileFilter      *filter);
  67 void gtk_file_filter_add_custom         (GtkFileFilter      *filter,
  68                                          GtkFileFilterFlags  needed,
  69                                          GtkFileFilterFunc   func,
  70                                          gpointer            data,
  71                                          GDestroyNotify      notify);
  72
  73 GtkFileFilterFlags gtk_file_filter_get_needed (GtkFileFilter           *filter);
  74 gboolean           gtk_file_filter_filter     (GtkFileFilter           *filter,
  75                                                const GtkFileFilterInfo *filter_info);
  76
  77 G_END_DECLS
  78
  79 #endif /* __GTK_FILE_FILTER_H__ */