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_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 /**
  40  * GtkFileFilterFlags:
  41  * @GTK_FILE_FILTER_FILENAME: the filename of the file being tested
  42  * @GTK_FILE_FILTER_URI: the URI for the file being tested
  43  * @GTK_FILE_FILTER_DISPLAY_NAME: the string that will be used to
  44  *   display the file in the file chooser
  45  * @GTK_FILE_FILTER_MIME_TYPE: the mime type of the file
  46  *
  47  * These flags indicate what parts of a #GtkFileFilterInfo struct
  48  * are filled or need to be filled.
  49  */
  50 typedef enum {
  51   GTK_FILE_FILTER_FILENAME     = 1 << 0,
  52   GTK_FILE_FILTER_URI          = 1 << 1,
  53   GTK_FILE_FILTER_DISPLAY_NAME = 1 << 2,
  54   GTK_FILE_FILTER_MIME_TYPE    = 1 << 3
  55 } GtkFileFilterFlags;
  56
  57 /**
  58  * GtkFileFilterFunc:
  59  * @filter_info: a #GtkFileFilterInfo that is filled according
  60  *   to the @needed flags passed to gtk_file_filter_add_custom()
  61  * @data: (closure): user data passed to gtk_file_filter_add_custom()
  62  *
  63  * The type of function that is used with custom filters, see
  64  * gtk_file_filter_add_custom().
  65  *
  66  * @Returns: %TRUE if the file should be displayed
  67  */
  68 typedef gboolean (*GtkFileFilterFunc) (const GtkFileFilterInfo *filter_info,
  69                                        gpointer                 data);
  70
  71 /**
  72  * GtkFileFilterInfo:
  73  * @contains: Flags indicating which of the following fields need
  74  *   are filled
  75  * @filename: the filename of the file being tested
  76  * @uri: the URI for the file being tested
  77  * @display_name: the string that will be used to display the file
  78  *   in the file chooser
  79  * @mime_type: the mime type of the file
  80  *
  81  * A #GtkFileFilterInfo struct is used to pass information about the
  82  * tested file to gtk_file_filter_filter().
  83  */
  84 struct _GtkFileFilterInfo
  85 {
  86   GtkFileFilterFlags contains;
  87
  88   const gchar *filename;
  89   const gchar *uri;
  90   const gchar *display_name;
  91   const gchar *mime_type;
  92 };
  93
  94 GType gtk_file_filter_get_type (void) G_GNUC_CONST;
  95
  96 GtkFileFilter *       gtk_file_filter_new      (void);
  97 void                  gtk_file_filter_set_name (GtkFileFilter *filter,
  98                                                 const gchar   *name);
  99 const gchar *         gtk_file_filter_get_name (GtkFileFilter *filter);
 100
 101 void gtk_file_filter_add_mime_type      (GtkFileFilter      *filter,
 102                                          const gchar        *mime_type);
 103 void gtk_file_filter_add_pattern        (GtkFileFilter      *filter,
 104                                          const gchar        *pattern);
 105 void gtk_file_filter_add_pixbuf_formats (GtkFileFilter      *filter);
 106 void gtk_file_filter_add_custom         (GtkFileFilter      *filter,
 107                                          GtkFileFilterFlags  needed,
 108                                          GtkFileFilterFunc   func,
 109                                          gpointer            data,
 110                                          GDestroyNotify      notify);
 111
 112 GtkFileFilterFlags gtk_file_filter_get_needed (GtkFileFilter           *filter);
 113 gboolean           gtk_file_filter_filter     (GtkFileFilter           *filter,
 114                                                const GtkFileFilterInfo *filter_info);
 115
 116 G_END_DECLS
 117
 118 #endif /* __GTK_FILE_FILTER_H__ */