glib (2.79.0)
1 /* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright (C) 2009 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
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 typedef struct _GInitableIface GInitableIface;
41
42 /**
43 * GInitableIface:
44 * @g_iface: The parent interface.
45 * @init: Initializes the object.
46 *
47 * Provides an interface for initializing object such that initialization
48 * may fail.
49 *
50 * Since: 2.22
51 **/
52 struct _GInitableIface
53 {
54 GTypeInterface g_iface;
55
56 /* Virtual Table */
57
58 gboolean (* init) (GInitable *initable,
59 GCancellable *cancellable,
60 GError **error);
61 };
62
63
64 GIO_AVAILABLE_IN_ALL
65 GType g_initable_get_type (void) G_GNUC_CONST;
66
67 GIO_AVAILABLE_IN_ALL
68 gboolean g_initable_init (GInitable *initable,
69 GCancellable *cancellable,
70 GError **error);
71
72 GIO_AVAILABLE_IN_ALL
73 gpointer g_initable_new (GType object_type,
74 GCancellable *cancellable,
75 GError **error,
76 const gchar *first_property_name,
77 ...);
78
79 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
80
81 GIO_DEPRECATED_IN_2_54_FOR(g_object_new_with_properties and g_initable_init)
82 gpointer g_initable_newv (GType object_type,
83 guint n_parameters,
84 GParameter *parameters,
85 GCancellable *cancellable,
86 GError **error);
87
88 G_GNUC_END_IGNORE_DEPRECATIONS
89
90 GIO_AVAILABLE_IN_ALL
91 GObject* g_initable_new_valist (GType object_type,
92 const gchar *first_property_name,
93 va_list var_args,
94 GCancellable *cancellable,
95 GError **error);
96
97 G_END_DECLS
98
99
100 #endif /* __G_INITABLE_H__ */
Browse
Usage
Versions