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 #ifndef __G_OBJECT_H__
20 #define __G_OBJECT_H__
22 #include <gobject/gtype.h>
23 #include <gobject/gvalue.h>
24 #include <gobject/gparam.h>
25 #include <gobject/gclosure.h>
26 #include <gobject/gsignal.h>
30 /* --- type macros --- */
31 #define G_TYPE_IS_OBJECT(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_OBJECT)
32 #define G_OBJECT(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), G_TYPE_OBJECT, GObject))
33 #define G_OBJECT_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_OBJECT, GObjectClass))
34 #define G_IS_OBJECT(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), G_TYPE_OBJECT))
35 #define G_IS_OBJECT_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_OBJECT))
36 #define G_OBJECT_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), G_TYPE_OBJECT, GObjectClass))
37 #define G_OBJECT_TYPE(object) (G_TYPE_FROM_INSTANCE (object))
38 #define G_OBJECT_TYPE_NAME(object) (g_type_name (G_OBJECT_TYPE (object)))
39 #define G_OBJECT_CLASS_TYPE(class) (G_TYPE_FROM_CLASS (class))
40 #define G_OBJECT_CLASS_NAME(class) (g_type_name (G_OBJECT_CLASS_TYPE (class)))
41 #define G_VALUE_HOLDS_OBJECT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_OBJECT))
44 /* --- typedefs & structures --- */
45 typedef struct _GObject GObject
;
46 typedef struct _GObjectClass GObjectClass
;
47 typedef struct _GObjectConstructParam GObjectConstructParam
;
48 typedef void (*GObjectGetPropertyFunc
) (GObject
*object
,
52 typedef void (*GObjectSetPropertyFunc
) (GObject
*object
,
56 typedef void (*GObjectFinalizeFunc
) (GObject
*object
);
57 typedef void (*GWeakNotify
) (gpointer data
,
58 GObject
*where_the_object_was
);
61 GTypeInstance g_type_instance
;
69 GTypeClass g_type_class
;
72 GSList
*construct_properties
;
74 /* public overridable methods */
75 GObject
* (*constructor
) (GType type
,
76 guint n_construct_properties
,
77 GObjectConstructParam
*construct_properties
);
78 void (*set_property
) (GObject
*object
,
82 void (*get_property
) (GObject
*object
,
86 void (*dispose
) (GObject
*object
);
87 void (*finalize
) (GObject
*object
);
89 /* seldomly overidden */
90 void (*dispatch_properties_changed
) (GObject
*object
,
95 void (*notify
) (GObject
*object
,
98 struct _GObjectConstructParam
105 /* --- prototypes --- */
106 void g_object_class_install_property (GObjectClass
*oclass
,
109 GParamSpec
* g_object_class_find_property (GObjectClass
*oclass
,
110 const gchar
*property_name
);
111 GParamSpec
**g_object_class_list_properties (GObjectClass
*oclass
,
112 guint
*n_properties
);
113 gpointer
g_object_new (GType object_type
,
114 const gchar
*first_property_name
,
116 gpointer
g_object_newv (GType object_type
,
118 GParameter
*parameters
);
119 GObject
* g_object_new_valist (GType object_type
,
120 const gchar
*first_property_name
,
122 void g_object_set (gpointer object
,
123 const gchar
*first_property_name
,
125 void g_object_get (gpointer object
,
126 const gchar
*first_property_name
,
128 gpointer
g_object_connect (gpointer object
,
129 const gchar
*signal_spec
,
131 void g_object_disconnect (gpointer object
,
132 const gchar
*signal_spec
,
134 void g_object_set_valist (GObject
*object
,
135 const gchar
*first_property_name
,
137 void g_object_get_valist (GObject
*object
,
138 const gchar
*first_property_name
,
140 void g_object_set_property (GObject
*object
,
141 const gchar
*property_name
,
142 const GValue
*value
);
143 void g_object_get_property (GObject
*object
,
144 const gchar
*property_name
,
146 void g_object_freeze_notify (GObject
*object
);
147 void g_object_notify (GObject
*object
,
148 const gchar
*property_name
);
149 void g_object_thaw_notify (GObject
*object
);
150 gpointer
g_object_ref (gpointer object
);
151 void g_object_unref (gpointer object
);
152 void g_object_weak_ref (GObject
*object
,
155 void g_object_weak_unref (GObject
*object
,
158 void g_object_add_weak_pointer (GObject
*object
,
159 gpointer
*weak_pointer_location
);
160 void g_object_remove_weak_pointer (GObject
*object
,
161 gpointer
*weak_pointer_location
);
162 gpointer
g_object_get_qdata (GObject
*object
,
164 void g_object_set_qdata (GObject
*object
,
167 void g_object_set_qdata_full (GObject
*object
,
170 GDestroyNotify destroy
);
171 gpointer
g_object_steal_qdata (GObject
*object
,
173 gpointer
g_object_get_data (GObject
*object
,
175 void g_object_set_data (GObject
*object
,
178 void g_object_set_data_full (GObject
*object
,
181 GDestroyNotify destroy
);
182 gpointer
g_object_steal_data (GObject
*object
,
184 void g_object_watch_closure (GObject
*object
,
186 GClosure
* g_cclosure_new_object (GCallback callback_func
,
188 GClosure
* g_cclosure_new_object_swap (GCallback callback_func
,
190 GClosure
* g_closure_new_object (guint sizeof_closure
,
192 void g_value_set_object (GValue
*value
,
194 gpointer
g_value_get_object (const GValue
*value
);
195 GObject
* g_value_dup_object (const GValue
*value
);
196 guint
g_signal_connect_object (gpointer instance
,
197 const gchar
*detailed_signal
,
200 GConnectFlags connect_flags
);
204 void g_object_run_dispose (GObject
*object
);
207 /* --- implementation macros --- */
208 #define G_OBJECT_WARN_INVALID_PSPEC(object, pname, property_id, pspec) \
210 GObject *_object = (GObject*) (object); \
211 GParamSpec *_pspec = (GParamSpec*) (pspec); \
212 guint _property_id = (property_id); \
213 g_warning ("%s: invalid %s id %u for \"%s\" of type `%s' in `%s'", \
218 g_type_name (G_PARAM_SPEC_TYPE (_pspec)), \
219 G_OBJECT_TYPE_NAME (_object)); \
221 #define G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec) \
222 G_OBJECT_WARN_INVALID_PSPEC ((object), "property id", (property_id), (pspec))
226 #endif /* __G_OBJECT_H__ */