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, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef __GTK_FILE_FILTER_H__
  20 #define __GTK_FILE_FILTER_H__
  21
  22 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  23 #error "Only <gtk/gtk.h> can be included directly."
  24 #endif
  25
  26 #include <glib-object.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define GTK_TYPE_FILE_FILTER              (gtk_file_filter_get_type ())
  31 #define GTK_FILE_FILTER(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FILE_FILTER, GtkFileFilter))
  32 #define GTK_IS_FILE_FILTER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FILE_FILTER))
  33
  34 typedef struct _GtkFileFilter     GtkFileFilter;
  35 typedef struct _GtkFileFilterInfo GtkFileFilterInfo;
  36
  37 /**
  38  * GtkFileFilterFlags:
  39  * @GTK_FILE_FILTER_FILENAME: the filename of the file being tested
  40  * @GTK_FILE_FILTER_URI: the URI for the file being tested
  41  * @GTK_FILE_FILTER_DISPLAY_NAME: the string that will be used to
  42  *   display the file in the file chooser
  43  * @GTK_FILE_FILTER_MIME_TYPE: the mime type of the file
  44  *
  45  * These flags indicate what parts of a #GtkFileFilterInfo struct
  46  * are filled or need to be filled.
  47  */
  48 typedef enum {
  49   GTK_FILE_FILTER_FILENAME     = 1 << 0,
  50   GTK_FILE_FILTER_URI          = 1 << 1,
  51   GTK_FILE_FILTER_DISPLAY_NAME = 1 << 2,
  52   GTK_FILE_FILTER_MIME_TYPE    = 1 << 3
  53 } GtkFileFilterFlags;
  54
  55 /**
  56  * GtkFileFilterFunc:
  57  * @filter_info: a #GtkFileFilterInfo that is filled according
  58  *   to the @needed flags passed to gtk_file_filter_add_custom()
  59  * @data: (closure): user data passed to gtk_file_filter_add_custom()
  60  *
  61  * The type of function that is used with custom filters, see
  62  * gtk_file_filter_add_custom().
  63  *
  64  * Returns: %TRUE if the file should be displayed
  65  */
  66 typedef gboolean (*GtkFileFilterFunc) (const GtkFileFilterInfo *filter_info,
  67                                        gpointer                 data);
  68
  69 /**
  70  * GtkFileFilterInfo:
  71  * @contains: Flags indicating which of the following fields need
  72  *   are filled
  73  * @filename: the filename of the file being tested
  74  * @uri: the URI for the file being tested
  75  * @display_name: the string that will be used to display the file
  76  *   in the file chooser
  77  * @mime_type: the mime type of the file
  78  *
  79  * A #GtkFileFilterInfo struct is used to pass information about the
  80  * tested file to gtk_file_filter_filter().
  81  */
  82 struct _GtkFileFilterInfo
  83 {
  84   GtkFileFilterFlags contains;
  85
  86   const gchar *filename;
  87   const gchar *uri;
  88   const gchar *display_name;
  89   const gchar *mime_type;
  90 };
  91
  92 GType gtk_file_filter_get_type (void) G_GNUC_CONST;
  93
  94 GtkFileFilter *       gtk_file_filter_new      (void);
  95 void                  gtk_file_filter_set_name (GtkFileFilter *filter,
  96                                                 const gchar   *name);
  97 const gchar *         gtk_file_filter_get_name (GtkFileFilter *filter);
  98
  99 void gtk_file_filter_add_mime_type      (GtkFileFilter      *filter,
 100                                          const gchar        *mime_type);
 101 void gtk_file_filter_add_pattern        (GtkFileFilter      *filter,
 102                                          const gchar        *pattern);
 103 void gtk_file_filter_add_pixbuf_formats (GtkFileFilter      *filter);
 104 void gtk_file_filter_add_custom         (GtkFileFilter      *filter,
 105                                          GtkFileFilterFlags  needed,
 106                                          GtkFileFilterFunc   func,
 107                                          gpointer            data,
 108                                          GDestroyNotify      notify);
 109
 110 GtkFileFilterFlags gtk_file_filter_get_needed (GtkFileFilter           *filter);
 111 gboolean           gtk_file_filter_filter     (GtkFileFilter           *filter,
 112                                                const GtkFileFilterInfo *filter_info);
 113
 114 G_END_DECLS
 115
 116 #endif /* __GTK_FILE_FILTER_H__ */