gfileenumerator.h 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. /* GIO - GLib Input, Output and Streaming Library
  2. *
  3. * Copyright (C) 2006-2007 Red Hat, Inc.
  4. *
  5. * SPDX-License-Identifier: LGPL-2.1-or-later
  6. *
  7. * This library is free software; you can redistribute it and/or
  8. * modify it under the terms of the GNU Lesser General Public
  9. * License as published by the Free Software Foundation; either
  10. * version 2.1 of the License, or (at your option) any later version.
  11. *
  12. * This library is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * Lesser General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Lesser General
  18. * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19. *
  20. * Author: Alexander Larsson <alexl@redhat.com>
  21. */
  22. #ifndef __G_FILE_ENUMERATOR_H__
  23. #define __G_FILE_ENUMERATOR_H__
  24. #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25. #error "Only <gio/gio.h> can be included directly."
  26. #endif
  27. #include <gio/giotypes.h>
  28. G_BEGIN_DECLS
  29. #define G_TYPE_FILE_ENUMERATOR (g_file_enumerator_get_type ())
  30. #define G_FILE_ENUMERATOR(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_ENUMERATOR, GFileEnumerator))
  31. #define G_FILE_ENUMERATOR_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_ENUMERATOR, GFileEnumeratorClass))
  32. #define G_IS_FILE_ENUMERATOR(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_ENUMERATOR))
  33. #define G_IS_FILE_ENUMERATOR_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_ENUMERATOR))
  34. #define G_FILE_ENUMERATOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_ENUMERATOR, GFileEnumeratorClass))
  35. typedef struct _GFileEnumeratorClass GFileEnumeratorClass;
  36. typedef struct _GFileEnumeratorPrivate GFileEnumeratorPrivate;
  37. struct _GFileEnumerator
  38. {
  39. GObject parent_instance;
  40. /*< private >*/
  41. GFileEnumeratorPrivate *priv;
  42. };
  43. struct _GFileEnumeratorClass
  44. {
  45. GObjectClass parent_class;
  46. /* Virtual Table */
  47. GFileInfo * (* next_file) (GFileEnumerator *enumerator,
  48. GCancellable *cancellable,
  49. GError **error);
  50. gboolean (* close_fn) (GFileEnumerator *enumerator,
  51. GCancellable *cancellable,
  52. GError **error);
  53. void (* next_files_async) (GFileEnumerator *enumerator,
  54. int num_files,
  55. int io_priority,
  56. GCancellable *cancellable,
  57. GAsyncReadyCallback callback,
  58. gpointer user_data);
  59. GList * (* next_files_finish) (GFileEnumerator *enumerator,
  60. GAsyncResult *result,
  61. GError **error);
  62. void (* close_async) (GFileEnumerator *enumerator,
  63. int io_priority,
  64. GCancellable *cancellable,
  65. GAsyncReadyCallback callback,
  66. gpointer user_data);
  67. gboolean (* close_finish) (GFileEnumerator *enumerator,
  68. GAsyncResult *result,
  69. GError **error);
  70. /*< private >*/
  71. /* Padding for future expansion */
  72. void (*_g_reserved1) (void);
  73. void (*_g_reserved2) (void);
  74. void (*_g_reserved3) (void);
  75. void (*_g_reserved4) (void);
  76. void (*_g_reserved5) (void);
  77. void (*_g_reserved6) (void);
  78. void (*_g_reserved7) (void);
  79. };
  80. GIO_AVAILABLE_IN_ALL
  81. GType g_file_enumerator_get_type (void) G_GNUC_CONST;
  82. GIO_AVAILABLE_IN_ALL
  83. GFileInfo *g_file_enumerator_next_file (GFileEnumerator *enumerator,
  84. GCancellable *cancellable,
  85. GError **error);
  86. GIO_AVAILABLE_IN_ALL
  87. gboolean g_file_enumerator_close (GFileEnumerator *enumerator,
  88. GCancellable *cancellable,
  89. GError **error);
  90. GIO_AVAILABLE_IN_ALL
  91. void g_file_enumerator_next_files_async (GFileEnumerator *enumerator,
  92. int num_files,
  93. int io_priority,
  94. GCancellable *cancellable,
  95. GAsyncReadyCallback callback,
  96. gpointer user_data);
  97. GIO_AVAILABLE_IN_ALL
  98. GList * g_file_enumerator_next_files_finish (GFileEnumerator *enumerator,
  99. GAsyncResult *result,
  100. GError **error);
  101. GIO_AVAILABLE_IN_ALL
  102. void g_file_enumerator_close_async (GFileEnumerator *enumerator,
  103. int io_priority,
  104. GCancellable *cancellable,
  105. GAsyncReadyCallback callback,
  106. gpointer user_data);
  107. GIO_AVAILABLE_IN_ALL
  108. gboolean g_file_enumerator_close_finish (GFileEnumerator *enumerator,
  109. GAsyncResult *result,
  110. GError **error);
  111. GIO_AVAILABLE_IN_ALL
  112. gboolean g_file_enumerator_is_closed (GFileEnumerator *enumerator);
  113. GIO_AVAILABLE_IN_ALL
  114. gboolean g_file_enumerator_has_pending (GFileEnumerator *enumerator);
  115. GIO_AVAILABLE_IN_ALL
  116. void g_file_enumerator_set_pending (GFileEnumerator *enumerator,
  117. gboolean pending);
  118. GIO_AVAILABLE_IN_ALL
  119. GFile * g_file_enumerator_get_container (GFileEnumerator *enumerator);
  120. GIO_AVAILABLE_IN_2_36
  121. GFile * g_file_enumerator_get_child (GFileEnumerator *enumerator,
  122. GFileInfo *info);
  123. GIO_AVAILABLE_IN_2_44
  124. gboolean g_file_enumerator_iterate (GFileEnumerator *direnum,
  125. GFileInfo **out_info,
  126. GFile **out_child,
  127. GCancellable *cancellable,
  128. GError **error);
  129. G_END_DECLS
  130. #endif /* __G_FILE_ENUMERATOR_H__ */