1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
19 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
20 #error "Only <glib-object.h> can be included directly."
23 #ifndef __G_OBJECT_H__
24 #define __G_OBJECT_H__
26 #include <gobject/gtype.h>
27 #include <gobject/gvalue.h>
28 #include <gobject/gparam.h>
29 #include <gobject/gclosure.h>
30 #include <gobject/gsignal.h>
34 /* --- type macros --- */
35 #define G_TYPE_IS_OBJECT(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_OBJECT)
36 #define G_OBJECT(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), G_TYPE_OBJECT, GObject))
37 #define G_OBJECT_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_OBJECT, GObjectClass))
38 #define G_IS_OBJECT(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), G_TYPE_OBJECT))
39 #define G_IS_OBJECT_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_OBJECT))
40 #define G_OBJECT_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), G_TYPE_OBJECT, GObjectClass))
41 #define G_OBJECT_TYPE(object) (G_TYPE_FROM_INSTANCE (object))
42 #define G_OBJECT_TYPE_NAME(object) (g_type_name (G_OBJECT_TYPE (object)))
43 #define G_OBJECT_CLASS_TYPE(class) (G_TYPE_FROM_CLASS (class))
44 #define G_OBJECT_CLASS_NAME(class) (g_type_name (G_OBJECT_CLASS_TYPE (class)))
45 #define G_VALUE_HOLDS_OBJECT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_OBJECT))
48 /* --- typedefs & structures --- */
49 typedef struct _GObject GObject
;
50 typedef struct _GObjectClass GObjectClass
;
51 typedef struct _GObjectConstructParam GObjectConstructParam
;
52 typedef void (*GObjectGetPropertyFunc
) (GObject
*object
,
56 typedef void (*GObjectSetPropertyFunc
) (GObject
*object
,
60 typedef void (*GObjectFinalizeFunc
) (GObject
*object
);
61 typedef void (*GWeakNotify
) (gpointer data
,
62 GObject
*where_the_object_was
);
65 GTypeInstance g_type_instance
;
73 GTypeClass g_type_class
;
76 GSList
*construct_properties
;
78 /* public overridable methods */
79 GObject
* (*constructor
) (GType type
,
80 guint n_construct_properties
,
81 GObjectConstructParam
*construct_properties
);
82 void (*set_property
) (GObject
*object
,
86 void (*get_property
) (GObject
*object
,
90 void (*dispose
) (GObject
*object
);
91 void (*finalize
) (GObject
*object
);
93 /* seldomly overidden */
94 void (*dispatch_properties_changed
) (GObject
*object
,
99 void (*notify
) (GObject
*object
,
104 struct _GObjectConstructParam
111 /* --- prototypes --- */
112 void g_object_class_install_property (GObjectClass
*oclass
,
115 GParamSpec
* g_object_class_find_property (GObjectClass
*oclass
,
116 const gchar
*property_name
);
117 GParamSpec
**g_object_class_list_properties (GObjectClass
*oclass
,
118 guint
*n_properties
);
119 gpointer
g_object_new (GType object_type
,
120 const gchar
*first_property_name
,
122 gpointer
g_object_newv (GType object_type
,
124 GParameter
*parameters
);
125 GObject
* g_object_new_valist (GType object_type
,
126 const gchar
*first_property_name
,
128 void g_object_set (gpointer object
,
129 const gchar
*first_property_name
,
131 void g_object_get (gpointer object
,
132 const gchar
*first_property_name
,
134 gpointer
g_object_connect (gpointer object
,
135 const gchar
*signal_spec
,
137 void g_object_disconnect (gpointer object
,
138 const gchar
*signal_spec
,
140 void g_object_set_valist (GObject
*object
,
141 const gchar
*first_property_name
,
143 void g_object_get_valist (GObject
*object
,
144 const gchar
*first_property_name
,
146 void g_object_set_property (GObject
*object
,
147 const gchar
*property_name
,
148 const GValue
*value
);
149 void g_object_get_property (GObject
*object
,
150 const gchar
*property_name
,
152 void g_object_freeze_notify (GObject
*object
);
153 void g_object_notify (GObject
*object
,
154 const gchar
*property_name
);
155 void g_object_thaw_notify (GObject
*object
);
156 gpointer
g_object_ref (gpointer object
);
157 void g_object_unref (gpointer object
);
158 void g_object_weak_ref (GObject
*object
,
161 void g_object_weak_unref (GObject
*object
,
164 void g_object_add_weak_pointer (GObject
*object
,
165 gpointer
*weak_pointer_location
);
166 void g_object_remove_weak_pointer (GObject
*object
,
167 gpointer
*weak_pointer_location
);
168 gpointer
g_object_get_qdata (GObject
*object
,
170 void g_object_set_qdata (GObject
*object
,
173 void g_object_set_qdata_full (GObject
*object
,
176 GDestroyNotify destroy
);
177 gpointer
g_object_steal_qdata (GObject
*object
,
179 gpointer
g_object_get_data (GObject
*object
,
181 void g_object_set_data (GObject
*object
,
184 void g_object_set_data_full (GObject
*object
,
187 GDestroyNotify destroy
);
188 gpointer
g_object_steal_data (GObject
*object
,
190 void g_object_watch_closure (GObject
*object
,
192 GClosure
* g_cclosure_new_object (GCallback callback_func
,
194 GClosure
* g_cclosure_new_object_swap (GCallback callback_func
,
196 GClosure
* g_closure_new_object (guint sizeof_closure
,
198 void g_value_set_object (GValue
*value
,
200 gpointer
g_value_get_object (const GValue
*value
);
201 GObject
* g_value_dup_object (const GValue
*value
);
202 gulong
g_signal_connect_object (gpointer instance
,
203 const gchar
*detailed_signal
,
206 GConnectFlags connect_flags
);
210 void g_object_run_dispose (GObject
*object
);
213 /* --- marshaller specific --- */
214 void g_value_set_object_take_ownership (GValue
*value
,
218 /* --- implementation macros --- */
219 #define G_OBJECT_WARN_INVALID_PSPEC(object, pname, property_id, pspec) \
221 GObject *_object = (GObject*) (object); \
222 GParamSpec *_pspec = (GParamSpec*) (pspec); \
223 guint _property_id = (property_id); \
224 g_warning ("%s: invalid %s id %u for \"%s\" of type `%s' in `%s'", \
229 g_type_name (G_PARAM_SPEC_TYPE (_pspec)), \
230 G_OBJECT_TYPE_NAME (_object)); \
232 #define G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec) \
233 G_OBJECT_WARN_INVALID_PSPEC ((object), "property", (property_id), (pspec))
237 #endif /* __G_OBJECT_H__ */