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