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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
27 #ifndef __G_FILE_ENUMERATOR_H__
28 #define __G_FILE_ENUMERATOR_H__
30 #include <gio/giotypes.h>
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))
44 * A per matched file iterator.
46 typedef struct _GFileEnumeratorClass GFileEnumeratorClass
;
47 typedef struct _GFileEnumeratorPrivate GFileEnumeratorPrivate
;
49 struct _GFileEnumerator
51 GObject parent_instance
;
54 GFileEnumeratorPrivate
*priv
;
57 struct _GFileEnumeratorClass
59 GObjectClass parent_class
;
63 GFileInfo
* (* next_file
) (GFileEnumerator
*enumerator
,
64 GCancellable
*cancellable
,
66 gboolean (* close_fn
) (GFileEnumerator
*enumerator
,
67 GCancellable
*cancellable
,
70 void (* next_files_async
) (GFileEnumerator
*enumerator
,
73 GCancellable
*cancellable
,
74 GAsyncReadyCallback callback
,
76 GList
* (* next_files_finish
) (GFileEnumerator
*enumerator
,
79 void (* close_async
) (GFileEnumerator
*enumerator
,
81 GCancellable
*cancellable
,
82 GAsyncReadyCallback callback
,
84 gboolean (* close_finish
) (GFileEnumerator
*enumerator
,
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);
99 GType
g_file_enumerator_get_type (void) G_GNUC_CONST
;
101 GFileInfo
*g_file_enumerator_next_file (GFileEnumerator
*enumerator
,
102 GCancellable
*cancellable
,
104 gboolean
g_file_enumerator_close (GFileEnumerator
*enumerator
,
105 GCancellable
*cancellable
,
107 void g_file_enumerator_next_files_async (GFileEnumerator
*enumerator
,
110 GCancellable
*cancellable
,
111 GAsyncReadyCallback callback
,
113 GList
* g_file_enumerator_next_files_finish (GFileEnumerator
*enumerator
,
114 GAsyncResult
*result
,
116 void g_file_enumerator_close_async (GFileEnumerator
*enumerator
,
118 GCancellable
*cancellable
,
119 GAsyncReadyCallback callback
,
121 gboolean
g_file_enumerator_close_finish (GFileEnumerator
*enumerator
,
122 GAsyncResult
*result
,
124 gboolean
g_file_enumerator_is_closed (GFileEnumerator
*enumerator
);
125 gboolean
g_file_enumerator_has_pending (GFileEnumerator
*enumerator
);
126 void g_file_enumerator_set_pending (GFileEnumerator
*enumerator
,
128 GFile
* g_file_enumerator_get_container (GFileEnumerator
*enumerator
);
132 #endif /* __G_FILE_ENUMERATOR_H__ */