1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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.
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.
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.
20 * Author: Alexander Larsson <alexl@redhat.com>
23 #ifndef __G_FILE_ENUMERATOR_H__
24 #define __G_FILE_ENUMERATOR_H__
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>
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))
44 * @parent: The parent class.
46 * A per matched file iterator.
48 typedef struct _GFileEnumerator GFileEnumerator;
49 typedef struct _GFileEnumeratorClass GFileEnumeratorClass;
50 typedef struct _GFileEnumeratorPrivate GFileEnumeratorPrivate;
53 struct _GFileEnumerator
58 GFileEnumeratorPrivate *priv;
61 struct _GFileEnumeratorClass
63 GObjectClass parent_class;
67 GFileInfo *(*next_file) (GFileEnumerator *enumerator,
68 GCancellable *cancellable,
70 gboolean (*close_fn) (GFileEnumerator *enumerator,
71 GCancellable *cancellable,
74 void (*next_files_async) (GFileEnumerator *enumerator,
77 GCancellable *cancellable,
78 GAsyncReadyCallback callback,
80 GList * (*next_files_finish) (GFileEnumerator *enumerator,
83 void (*close_async) (GFileEnumerator *enumerator,
85 GCancellable *cancellable,
86 GAsyncReadyCallback callback,
88 gboolean (*close_finish) (GFileEnumerator *enumerator,
93 /* Padding for future expansion */
94 void (*_g_reserved1) (void);
95 void (*_g_reserved2) (void);
96 void (*_g_reserved3) (void);
97 void (*_g_reserved4) (void);
98 void (*_g_reserved5) (void);
99 void (*_g_reserved6) (void);
100 void (*_g_reserved7) (void);
103 GType g_file_enumerator_get_type (void) G_GNUC_CONST;
105 GFileInfo *g_file_enumerator_next_file (GFileEnumerator *enumerator,
106 GCancellable *cancellable,
108 gboolean g_file_enumerator_close (GFileEnumerator *enumerator,
109 GCancellable *cancellable,
111 void g_file_enumerator_next_files_async (GFileEnumerator *enumerator,
114 GCancellable *cancellable,
115 GAsyncReadyCallback callback,
117 GList * g_file_enumerator_next_files_finish (GFileEnumerator *enumerator,
118 GAsyncResult *result,
120 void g_file_enumerator_close_async (GFileEnumerator *enumerator,
122 GCancellable *cancellable,
123 GAsyncReadyCallback callback,
125 gboolean g_file_enumerator_close_finish (GFileEnumerator *enumerator,
126 GAsyncResult *result,
128 gboolean g_file_enumerator_is_closed (GFileEnumerator *enumerator);
129 gboolean g_file_enumerator_has_pending (GFileEnumerator *enumerator);
130 void g_file_enumerator_set_pending (GFileEnumerator *enumerator,
135 #endif /* __G_FILE_ENUMERATOR_H__ */