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>
30 #endif /* __cplusplus */
33 /* --- type macros --- */
34 #define G_TYPE_IS_OBJECT(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_OBJECT)
35 #define G_OBJECT(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), G_TYPE_OBJECT, GObject))
36 #define G_OBJECT_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_OBJECT, GObjectClass))
37 #define G_IS_OBJECT(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), G_TYPE_OBJECT))
38 #define G_IS_OBJECT_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_OBJECT))
39 #define G_OBJECT_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), G_TYPE_OBJECT, GObjectClass))
40 #define G_OBJECT_TYPE(object) (G_TYPE_FROM_INSTANCE (object))
41 #define G_OBJECT_TYPE_NAME(object) (g_type_name (G_OBJECT_TYPE (object)))
42 #define G_OBJECT_CLASS_TYPE(class) (G_TYPE_FROM_CLASS (class))
43 #define G_OBJECT_CLASS_NAME(class) (g_type_name (G_OBJECT_CLASS_TYPE (class)))
44 #define G_VALUE_HOLDS_OBJECT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_OBJECT))
47 /* --- typedefs & structures --- */
48 typedef struct _GObject GObject;
49 typedef struct _GObjectClass GObjectClass;
50 typedef struct _GObjectConstructParam GObjectConstructParam;
51 typedef void (*GObjectGetPropertyFunc) (GObject *object,
55 typedef void (*GObjectSetPropertyFunc) (GObject *object,
59 typedef void (*GObjectFinalizeFunc) (GObject *object);
62 GTypeInstance g_type_instance;
70 GTypeClass g_type_class;
72 /* private, these fields might vanish */
73 guint n_property_specs;
74 GParamSpec **property_specs;
75 GSList *construct_properties;
77 /* public overridable methods */
78 GObject* (*constructor) (GType type,
79 guint n_construct_properties,
80 GObjectConstructParam *construct_properties);
81 void (*set_property) (GObject *object,
85 void (*get_property) (GObject *object,
89 void (*shutdown) (GObject *object);
90 void (*finalize) (GObject *object);
93 void (*dispatch_properties_changed) (GObject *object,
98 void (*properties_changed) (GObject *object,
100 GParamSpec **pspecs);
101 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 gpointer g_object_new (GType object_type,
118 const gchar *first_property_name,
120 gpointer g_object_new_valist (GType object_type,
121 const gchar *first_property_name,
123 gpointer g_object_set (gpointer object,
124 const gchar *first_property_name,
126 void g_object_get (gpointer object,
127 const gchar *first_property_name,
129 gpointer g_object_connect (gpointer object,
130 const gchar *signal_spec,
132 gpointer g_object_disconnect (gpointer object,
133 const gchar *signal_spec,
135 void g_object_set_valist (GObject *object,
136 const gchar *first_property_name,
138 void g_object_get_valist (GObject *object,
139 const gchar *first_property_name,
141 void g_object_set_property (GObject *object,
142 const gchar *property_name,
143 const GValue *value);
144 void g_object_get_property (GObject *object,
145 const gchar *property_name,
147 void g_object_freeze_notify (GObject *object);
148 void g_object_notify (GObject *object,
149 const gchar *property_name);
150 void g_object_thaw_notify (GObject *object);
151 gpointer g_object_ref (gpointer object);
152 void g_object_unref (gpointer object);
153 gpointer g_object_get_qdata (GObject *object,
155 void g_object_set_qdata (GObject *object,
158 void g_object_set_qdata_full (GObject *object,
161 GDestroyNotify destroy);
162 gpointer g_object_steal_qdata (GObject *object,
164 gpointer g_object_get_data (GObject *object,
166 void g_object_set_data (GObject *object,
169 void g_object_set_data_full (GObject *object,
172 GDestroyNotify destroy);
173 gpointer g_object_steal_data (GObject *object,
175 void g_object_watch_closure (GObject *object,
177 GClosure* g_cclosure_new_object (GCallback callback_func,
179 GClosure* g_cclosure_new_object_swap (GCallback callback_func,
181 GClosure* g_closure_new_object (guint sizeof_closure,
183 void g_value_set_object (GValue *value,
185 gpointer g_value_get_object (const GValue *value);
186 GObject* g_value_dup_object (const GValue *value);
187 guint g_signal_connect_object (gpointer instance,
188 const gchar *detailed_signal,
195 /* --- implementation macros --- */
196 #define G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec) \
198 GObject *_object = (GObject*) (object); \
199 GParamSpec *_pspec = (GParamSpec*) (pspec); \
200 guint _property_id = (property_id); \
201 g_warning ("%s: invalid property id %u for \"%s\" of type `%s' in `%s'", \
205 g_type_name (G_PARAM_SPEC_TYPE (_pspec)), \
206 G_OBJECT_TYPE_NAME (_object)); \
213 #endif /* __cplusplus */
215 #endif /* __G_OBJECT_H__ */