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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_FILE_ENUMERATOR_H__
  28 #define __G_FILE_ENUMERATOR_H__
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_FILE_ENUMERATOR         (g_file_enumerator_get_type ())
  35 #define G_FILE_ENUMERATOR(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_ENUMERATOR, GFileEnumerator))
  36 #define G_FILE_ENUMERATOR_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_ENUMERATOR, GFileEnumeratorClass))
  37 #define G_IS_FILE_ENUMERATOR(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_ENUMERATOR))
  38 #define G_IS_FILE_ENUMERATOR_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_ENUMERATOR))
  39 #define G_FILE_ENUMERATOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_ENUMERATOR, GFileEnumeratorClass))
  40
  41 /**
  42  * GFileEnumerator:
  43  * @parent_instance: The parent class.
  44  *
  45  * A per matched file iterator.
  46  **/
  47 typedef struct _GFileEnumeratorClass    GFileEnumeratorClass;
  48 typedef struct _GFileEnumeratorPrivate  GFileEnumeratorPrivate;
  49
  50 struct _GFileEnumerator
  51 {
  52   GObject parent_instance;
  53
  54   /*< private >*/
  55   GFileEnumeratorPrivate *priv;
  56 };
  57
  58 struct _GFileEnumeratorClass
  59 {
  60   GObjectClass parent_class;
  61
  62   /* Virtual Table */
  63
  64   GFileInfo * (* next_file)         (GFileEnumerator      *enumerator,
  65                                      GCancellable         *cancellable,
  66                                      GError              **error);
  67   gboolean    (* close_fn)          (GFileEnumerator      *enumerator,
  68                                      GCancellable         *cancellable,
  69                                      GError              **error);
  70
  71   void        (* next_files_async)  (GFileEnumerator      *enumerator,
  72                                      int                   num_files,
  73                                      int                   io_priority,
  74                                      GCancellable         *cancellable,
  75                                      GAsyncReadyCallback   callback,
  76                                      gpointer              user_data);
  77   GList *     (* next_files_finish) (GFileEnumerator      *enumerator,
  78                                      GAsyncResult         *res,
  79                                      GError              **error);
  80   void        (* close_async)       (GFileEnumerator      *enumerator,
  81                                      int                   io_priority,
  82                                      GCancellable         *cancellable,
  83                                      GAsyncReadyCallback   callback,
  84                                      gpointer              user_data);
  85   gboolean    (* close_finish)      (GFileEnumerator      *enumerator,
  86                                      GAsyncResult         *res,
  87                                      GError              **error);
  88
  89   /*< private >*/
  90   /* Padding for future expansion */
  91   void (*_g_reserved1) (void);
  92   void (*_g_reserved2) (void);
  93   void (*_g_reserved3) (void);
  94   void (*_g_reserved4) (void);
  95   void (*_g_reserved5) (void);
  96   void (*_g_reserved6) (void);
  97   void (*_g_reserved7) (void);
  98 };
  99
 100 GType      g_file_enumerator_get_type          (void) G_GNUC_CONST;
 101
 102 GFileInfo *g_file_enumerator_next_file         (GFileEnumerator      *enumerator,
 103                                                 GCancellable         *cancellable,
 104                                                 GError              **error);
 105 gboolean   g_file_enumerator_close             (GFileEnumerator      *enumerator,
 106                                                 GCancellable         *cancellable,
 107                                                 GError              **error);
 108 void       g_file_enumerator_next_files_async  (GFileEnumerator      *enumerator,
 109                                                 int                   num_files,
 110                                                 int                   io_priority,
 111                                                 GCancellable         *cancellable,
 112                                                 GAsyncReadyCallback   callback,
 113                                                 gpointer              user_data);
 114 GList *    g_file_enumerator_next_files_finish (GFileEnumerator      *enumerator,
 115                                                 GAsyncResult         *result,
 116                                                 GError              **error);
 117 void       g_file_enumerator_close_async       (GFileEnumerator      *enumerator,
 118                                                 int                   io_priority,
 119                                                 GCancellable         *cancellable,
 120                                                 GAsyncReadyCallback   callback,
 121                                                 gpointer              user_data);
 122 gboolean   g_file_enumerator_close_finish      (GFileEnumerator      *enumerator,
 123                                                 GAsyncResult         *result,
 124                                                 GError              **error);
 125 gboolean   g_file_enumerator_is_closed         (GFileEnumerator      *enumerator);
 126 gboolean   g_file_enumerator_has_pending       (GFileEnumerator      *enumerator);
 127 void       g_file_enumerator_set_pending       (GFileEnumerator      *enumerator,
 128                                                 gboolean              pending);
 129 GFile *    g_file_enumerator_get_container     (GFileEnumerator *enumerator);
 130
 131 G_END_DECLS
 132
 133 #endif /* __G_FILE_ENUMERATOR_H__ */