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 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  22 #error "Only <gtk/gtk.h> can be included directly."
  23 #endif
  24
  25 #ifndef __GTK_FILE_FILTER_H__
  26 #define __GTK_FILE_FILTER_H__
  27
  28 #include <glib-object.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GTK_TYPE_FILE_FILTER              (gtk_file_filter_get_type ())
  33 #define GTK_FILE_FILTER(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FILE_FILTER, GtkFileFilter))
  34 #define GTK_IS_FILE_FILTER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FILE_FILTER))
  35
  36 typedef struct _GtkFileFilter     GtkFileFilter;
  37 typedef struct _GtkFileFilterInfo GtkFileFilterInfo;
  38
  39 typedef enum {
  40   GTK_FILE_FILTER_FILENAME     = 1 << 0,
  41   GTK_FILE_FILTER_URI          = 1 << 1,
  42   GTK_FILE_FILTER_DISPLAY_NAME = 1 << 2,
  43   GTK_FILE_FILTER_MIME_TYPE    = 1 << 3
  44 } GtkFileFilterFlags;
  45
  46 typedef gboolean (*GtkFileFilterFunc) (const GtkFileFilterInfo *filter_info,
  47                                        gpointer                 data);
  48
  49 struct _GtkFileFilterInfo
  50 {
  51   GtkFileFilterFlags contains;
  52
  53   const gchar *filename;
  54   const gchar *uri;
  55   const gchar *display_name;
  56   const gchar *mime_type;
  57 };
  58
  59 GType gtk_file_filter_get_type (void) G_GNUC_CONST;
  60
  61 GtkFileFilter *       gtk_file_filter_new      (void);
  62 void                  gtk_file_filter_set_name (GtkFileFilter *filter,
  63                                                 const gchar   *name);
  64 G_CONST_RETURN gchar *gtk_file_filter_get_name (GtkFileFilter *filter);
  65
  66 void gtk_file_filter_add_mime_type      (GtkFileFilter      *filter,
  67                                          const gchar        *mime_type);
  68 void gtk_file_filter_add_pattern        (GtkFileFilter      *filter,
  69                                          const gchar        *pattern);
  70 void gtk_file_filter_add_pixbuf_formats (GtkFileFilter      *filter);
  71 void gtk_file_filter_add_custom         (GtkFileFilter      *filter,
  72                                          GtkFileFilterFlags  needed,
  73                                          GtkFileFilterFunc   func,
  74                                          gpointer            data,
  75                                          GDestroyNotify      notify);
  76
  77 GtkFileFilterFlags gtk_file_filter_get_needed (GtkFileFilter           *filter);
  78 gboolean           gtk_file_filter_filter     (GtkFileFilter           *filter,
  79                                                const GtkFileFilterInfo *filter_info);
  80
  81 G_END_DECLS
  82
  83 #endif /* __GTK_FILE_FILTER_H__ */