gio/ginitable.h

   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, 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 #ifndef __G_INITABLE_H__
  24 #define __G_INITABLE_H__
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_INITABLE            (g_initable_get_type ())
  35 #define G_INITABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_INITABLE, GInitable))
  36 #define G_IS_INITABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_INITABLE))
  37 #define G_INITABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_INITABLE, GInitableIface))
  38 #define G_TYPE_IS_INITABLE(type)   (g_type_is_a ((type), G_TYPE_INITABLE))
  39
  40 /**
  41  * GInitable:
  42  *
  43  * Interface for initializable objects.
  44  *
  45  * Since: 2.22
  46  **/
  47 typedef struct _GInitableIface GInitableIface;
  48
  49 /**
  50  * GInitableIface:
  51  * @g_iface: The parent interface.
  52  * @init: Initializes the object.
  53  *
  54  * Provides an interface for initializing object such that initialization
  55  * may fail.
  56  *
  57  * Since: 2.22
  58  **/
  59 struct _GInitableIface
  60 {
  61   GTypeInterface g_iface;
  62
  63   /* Virtual Table */
  64
  65   gboolean    (* init) (GInitable    *initable,
  66                         GCancellable *cancellable,
  67                         GError      **error);
  68 };
  69
  70
  71 GLIB_AVAILABLE_IN_ALL
  72 GType    g_initable_get_type   (void) G_GNUC_CONST;
  73
  74 GLIB_AVAILABLE_IN_ALL
  75 gboolean g_initable_init       (GInitable     *initable,
  76                                 GCancellable  *cancellable,
  77                                 GError       **error);
  78
  79 GLIB_AVAILABLE_IN_ALL
  80 gpointer g_initable_new        (GType          object_type,
  81                                 GCancellable  *cancellable,
  82                                 GError       **error,
  83                                 const gchar   *first_property_name,
  84                                 ...);
  85 GLIB_AVAILABLE_IN_ALL
  86 gpointer g_initable_newv       (GType          object_type,
  87                                 guint          n_parameters,
  88                                 GParameter    *parameters,
  89                                 GCancellable  *cancellable,
  90                                 GError       **error);
  91 GLIB_AVAILABLE_IN_ALL
  92 GObject* g_initable_new_valist (GType          object_type,
  93                                 const gchar   *first_property_name,
  94                                 va_list        var_args,
  95                                 GCancellable  *cancellable,
  96                                 GError       **error);
  97
  98 G_END_DECLS
  99
 100
 101 #endif /* __G_INITABLE_H__ */