ginitable.h 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. /* GIO - GLib Input, Output and Streaming Library
  2. *
  3. * Copyright (C) 2009 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, see <http://www.gnu.org/licenses/>.
  17. *
  18. * Author: Alexander Larsson <alexl@redhat.com>
  19. */
  20. #ifndef __G_INITABLE_H__
  21. #define __G_INITABLE_H__
  22. #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  23. #error "Only <gio/gio.h> can be included directly."
  24. #endif
  25. #include <gio/giotypes.h>
  26. G_BEGIN_DECLS
  27. #define G_TYPE_INITABLE (g_initable_get_type ())
  28. #define G_INITABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_INITABLE, GInitable))
  29. #define G_IS_INITABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_INITABLE))
  30. #define G_INITABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_INITABLE, GInitableIface))
  31. #define G_TYPE_IS_INITABLE(type) (g_type_is_a ((type), G_TYPE_INITABLE))
  32. /**
  33. * GInitable:
  34. *
  35. * Interface for initializable objects.
  36. *
  37. * Since: 2.22
  38. **/
  39. typedef struct _GInitableIface GInitableIface;
  40. /**
  41. * GInitableIface:
  42. * @g_iface: The parent interface.
  43. * @init: Initializes the object.
  44. *
  45. * Provides an interface for initializing object such that initialization
  46. * may fail.
  47. *
  48. * Since: 2.22
  49. **/
  50. struct _GInitableIface
  51. {
  52. GTypeInterface g_iface;
  53. /* Virtual Table */
  54. gboolean (* init) (GInitable *initable,
  55. GCancellable *cancellable,
  56. GError **error);
  57. };
  58. GLIB_AVAILABLE_IN_ALL
  59. GType g_initable_get_type (void) G_GNUC_CONST;
  60. GLIB_AVAILABLE_IN_ALL
  61. gboolean g_initable_init (GInitable *initable,
  62. GCancellable *cancellable,
  63. GError **error);
  64. GLIB_AVAILABLE_IN_ALL
  65. gpointer g_initable_new (GType object_type,
  66. GCancellable *cancellable,
  67. GError **error,
  68. const gchar *first_property_name,
  69. ...);
  70. GLIB_AVAILABLE_IN_ALL
  71. gpointer g_initable_newv (GType object_type,
  72. guint n_parameters,
  73. GParameter *parameters,
  74. GCancellable *cancellable,
  75. GError **error);
  76. GLIB_AVAILABLE_IN_ALL
  77. GObject* g_initable_new_valist (GType object_type,
  78. const gchar *first_property_name,
  79. va_list var_args,
  80. GCancellable *cancellable,
  81. GError **error);
  82. G_END_DECLS
  83. #endif /* __G_INITABLE_H__ */