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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  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  *
  44  * A per matched file iterator.
  45  **/
  46 typedef struct _GFileEnumeratorClass    GFileEnumeratorClass;
  47 typedef struct _GFileEnumeratorPrivate  GFileEnumeratorPrivate;
  48
  49 struct _GFileEnumerator
  50 {
  51   GObject parent_instance;
  52
  53   /*< private >*/
  54   GFileEnumeratorPrivate *priv;
  55 };
  56
  57 struct _GFileEnumeratorClass
  58 {
  59   GObjectClass parent_class;
  60
  61   /* Virtual Table */
  62
  63   GFileInfo * (* next_file)         (GFileEnumerator      *enumerator,
  64                                      GCancellable         *cancellable,
  65                                      GError              **error);
  66   gboolean    (* close_fn)          (GFileEnumerator      *enumerator,
  67                                      GCancellable         *cancellable,
  68                                      GError              **error);
  69
  70   void        (* next_files_async)  (GFileEnumerator      *enumerator,
  71                                      int                   num_files,
  72                                      int                   io_priority,
  73                                      GCancellable         *cancellable,
  74                                      GAsyncReadyCallback   callback,
  75                                      gpointer              user_data);
  76   GList *     (* next_files_finish) (GFileEnumerator      *enumerator,
  77                                      GAsyncResult         *result,
  78                                      GError              **error);
  79   void        (* close_async)       (GFileEnumerator      *enumerator,
  80                                      int                   io_priority,
  81                                      GCancellable         *cancellable,
  82                                      GAsyncReadyCallback   callback,
  83                                      gpointer              user_data);
  84   gboolean    (* close_finish)      (GFileEnumerator      *enumerator,
  85                                      GAsyncResult         *result,
  86                                      GError              **error);
  87
  88   /*< private >*/
  89   /* Padding for future expansion */
  90   void (*_g_reserved1) (void);
  91   void (*_g_reserved2) (void);
  92   void (*_g_reserved3) (void);
  93   void (*_g_reserved4) (void);
  94   void (*_g_reserved5) (void);
  95   void (*_g_reserved6) (void);
  96   void (*_g_reserved7) (void);
  97 };
  98
  99 GLIB_AVAILABLE_IN_ALL
 100 GType      g_file_enumerator_get_type          (void) G_GNUC_CONST;
 101
 102 GLIB_AVAILABLE_IN_ALL
 103 GFileInfo *g_file_enumerator_next_file         (GFileEnumerator      *enumerator,
 104                                                 GCancellable         *cancellable,
 105                                                 GError              **error);
 106 GLIB_AVAILABLE_IN_ALL
 107 gboolean   g_file_enumerator_close             (GFileEnumerator      *enumerator,
 108                                                 GCancellable         *cancellable,
 109                                                 GError              **error);
 110 GLIB_AVAILABLE_IN_ALL
 111 void       g_file_enumerator_next_files_async  (GFileEnumerator      *enumerator,
 112                                                 int                   num_files,
 113                                                 int                   io_priority,
 114                                                 GCancellable         *cancellable,
 115                                                 GAsyncReadyCallback   callback,
 116                                                 gpointer              user_data);
 117 GLIB_AVAILABLE_IN_ALL
 118 GList *    g_file_enumerator_next_files_finish (GFileEnumerator      *enumerator,
 119                                                 GAsyncResult         *result,
 120                                                 GError              **error);
 121 GLIB_AVAILABLE_IN_ALL
 122 void       g_file_enumerator_close_async       (GFileEnumerator      *enumerator,
 123                                                 int                   io_priority,
 124                                                 GCancellable         *cancellable,
 125                                                 GAsyncReadyCallback   callback,
 126                                                 gpointer              user_data);
 127 GLIB_AVAILABLE_IN_ALL
 128 gboolean   g_file_enumerator_close_finish      (GFileEnumerator      *enumerator,
 129                                                 GAsyncResult         *result,
 130                                                 GError              **error);
 131 GLIB_AVAILABLE_IN_ALL
 132 gboolean   g_file_enumerator_is_closed         (GFileEnumerator      *enumerator);
 133 GLIB_AVAILABLE_IN_ALL
 134 gboolean   g_file_enumerator_has_pending       (GFileEnumerator      *enumerator);
 135 GLIB_AVAILABLE_IN_ALL
 136 void       g_file_enumerator_set_pending       (GFileEnumerator      *enumerator,
 137                                                 gboolean              pending);
 138 GLIB_AVAILABLE_IN_ALL
 139 GFile *    g_file_enumerator_get_container     (GFileEnumerator *enumerator);
 140 GLIB_AVAILABLE_IN_2_36
 141 GFile *    g_file_enumerator_get_child         (GFileEnumerator *enumerator,
 142                                                 GFileInfo       *info);
 143
 144 G_END_DECLS
 145
 146 #endif /* __G_FILE_ENUMERATOR_H__ */