gio/gfileenumerator.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 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
  16  * Public 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  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_FILE_ENUMERATOR_H__
  24 #define __G_FILE_ENUMERATOR_H__
  25
  26 #include <glib-object.h>
  27 #include <gio/gioerror.h>
  28 #include <gio/gcancellable.h>
  29 #include <gio/gfileinfo.h>
  30 #include <gio/gasyncresult.h>
  31
  32 G_BEGIN_DECLS
  33
  34
  35 #define G_TYPE_FILE_ENUMERATOR         (g_file_enumerator_get_type ())
  36 #define G_FILE_ENUMERATOR(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_ENUMERATOR, GFileEnumerator))
  37 #define G_FILE_ENUMERATOR_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_ENUMERATOR, GFileEnumeratorClass))
  38 #define G_IS_FILE_ENUMERATOR(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_ENUMERATOR))
  39 #define G_IS_FILE_ENUMERATOR_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_ENUMERATOR))
  40 #define G_FILE_ENUMERATOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_ENUMERATOR, GFileEnumeratorClass))
  41
  42
  43 typedef struct _GFileEnumerator         GFileEnumerator;
  44 typedef struct _GFileEnumeratorClass    GFileEnumeratorClass;
  45 typedef struct _GFileEnumeratorPrivate  GFileEnumeratorPrivate;
  46
  47
  48 struct _GFileEnumerator
  49 {
  50   GObject parent;
  51
  52   /*< private >*/
  53   GFileEnumeratorPrivate *priv;
  54 };
  55
  56 struct _GFileEnumeratorClass
  57 {
  58   GObjectClass parent_class;
  59
  60   /* Virtual Table */
  61
  62   GFileInfo *(*next_file)         (GFileEnumerator              *enumerator,
  63                                    GCancellable                 *cancellable,
  64                                    GError                      **error);
  65   gboolean   (*close)             (GFileEnumerator              *enumerator,
  66                                    GCancellable                 *cancellable,
  67                                    GError                      **error);
  68
  69   void       (*next_files_async)  (GFileEnumerator                *enumerator,
  70                                    int                             num_files,
  71                                    int                             io_priority,
  72                                    GCancellable                   *cancellable,
  73                                    GAsyncReadyCallback             callback,
  74                                    gpointer                        user_data);
  75   GList *    (*next_files_finish) (GFileEnumerator                *enumerator,
  76                                    GAsyncResult                   *res,
  77                                    GError                        **error);
  78   void       (*close_async)       (GFileEnumerator                *enumerator,
  79                                    int                             io_priority,
  80                                    GCancellable                   *cancellable,
  81                                    GAsyncReadyCallback             callback,
  82                                    gpointer                        user_data);
  83   gboolean   (*close_finish)      (GFileEnumerator                *enumerator,
  84                                    GAsyncResult                   *res,
  85                                    GError                        **error);
  86
  87
  88     /* Padding for future expansion */
  89   void (*_g_reserved1) (void);
  90   void (*_g_reserved2) (void);
  91   void (*_g_reserved3) (void);
  92   void (*_g_reserved4) (void);
  93   void (*_g_reserved5) (void);
  94   void (*_g_reserved6) (void);
  95   void (*_g_reserved7) (void);
  96 };
  97
  98 GType g_file_enumerator_get_type (void) G_GNUC_CONST;
  99
 100 GFileInfo *g_file_enumerator_next_file         (GFileEnumerator      *enumerator,
 101                                                 GCancellable         *cancellable,
 102                                                 GError              **error);
 103 gboolean   g_file_enumerator_close             (GFileEnumerator      *enumerator,
 104                                                 GCancellable         *cancellable,
 105                                                 GError              **error);
 106 void       g_file_enumerator_next_files_async  (GFileEnumerator      *enumerator,
 107                                                 int                   num_files,
 108                                                 int                   io_priority,
 109                                                 GCancellable         *cancellable,
 110                                                 GAsyncReadyCallback   callback,
 111                                                 gpointer              user_data);
 112 GList *    g_file_enumerator_next_files_finish (GFileEnumerator      *enumerator,
 113                                                 GAsyncResult         *result,
 114                                                 GError              **error);
 115 void       g_file_enumerator_close_async       (GFileEnumerator      *enumerator,
 116                                                 int                   io_priority,
 117                                                 GCancellable         *cancellable,
 118                                                 GAsyncReadyCallback   callback,
 119                                                 gpointer              user_data);
 120 gboolean   g_file_enumerator_close_finish      (GFileEnumerator      *enumerator,
 121                                                 GAsyncResult         *result,
 122                                                 GError              **error);
 123 gboolean   g_file_enumerator_is_closed         (GFileEnumerator      *enumerator);
 124 gboolean   g_file_enumerator_has_pending       (GFileEnumerator      *enumerator);
 125 void       g_file_enumerator_set_pending       (GFileEnumerator      *enumerator,
 126                                                 gboolean              pending);
 127
 128 G_END_DECLS
 129
 130 #endif /* __G_FILE_ENUMERATOR_H__ */