1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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 Public
15 * 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.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #ifndef __GTK_OBJECT_H__
28 #define __GTK_OBJECT_H__
31 #include <gtk/gtkenums.h>
32 #include <gtk/gtktypeutils.h>
33 #include <gtk/gtkdebug.h>
37 /* macros for casting a pointer to a GtkObject or GtkObjectClass pointer,
38 * and to test whether `object' and `klass' are of type GTK_TYPE_OBJECT.
39 * these are the standard macros for all GtkObject-derived classes.
41 #define GTK_TYPE_OBJECT (gtk_object_get_type ())
42 #define GTK_OBJECT(object) (GTK_CHECK_CAST ((object), GTK_TYPE_OBJECT, GtkObject))
43 #define GTK_OBJECT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_OBJECT, GtkObjectClass))
44 #define GTK_IS_OBJECT(object) (GTK_CHECK_TYPE ((object), GTK_TYPE_OBJECT))
45 #define GTK_IS_OBJECT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_OBJECT))
46 #define GTK_OBJECT_GET_CLASS(object) (GTK_CHECK_GET_CLASS ((object), GTK_TYPE_OBJECT, GtkObjectClass))
48 /* Macros for extracting various fields from GtkObject and GtkObjectClass.
50 #define GTK_OBJECT_TYPE(object) (G_TYPE_FROM_INSTANCE (object))
51 #define GTK_OBJECT_TYPE_NAME(object) (g_type_name (GTK_OBJECT_TYPE (object)))
53 /* GtkObject only uses the first 4 bits of the flags field.
54 * Derived objects may use the remaining bits. Though this
55 * is a kinda nasty break up, it does make the size of
56 * derived objects smaller.
60 GTK_IN_DESTRUCTION = 1 << 0, /* Used internally during dispose */
61 GTK_FLOATING = 1 << 1,
62 GTK_RESERVED_1 = 1 << 2,
63 GTK_RESERVED_2 = 1 << 3
66 /* Macros for extracting the object_flags from GtkObject.
68 #define GTK_OBJECT_FLAGS(obj) (GTK_OBJECT (obj)->flags)
69 #define GTK_OBJECT_FLOATING(obj) ((GTK_OBJECT_FLAGS (obj) & GTK_FLOATING) != 0)
70 #define GTK_OBJECT_CONNECTED(obj) ((GTK_OBJECT_FLAGS (obj) & GTK_CONNECTED) != 0)
72 /* Macros for setting and clearing bits in the object_flags field of GtkObject.
74 #define GTK_OBJECT_SET_FLAGS(obj,flag) G_STMT_START{ (GTK_OBJECT_FLAGS (obj) |= (flag)); }G_STMT_END
75 #define GTK_OBJECT_UNSET_FLAGS(obj,flag) G_STMT_START{ (GTK_OBJECT_FLAGS (obj) &= ~(flag)); }G_STMT_END
77 typedef struct _GtkObjectClass GtkObjectClass;
80 /* The GtkObject structure is the base of the Gtk+ objects hierarchy,
81 * it ``inherits'' from the GtkTypeObject by mirroring its fields,
82 * which must always be kept in sync completely. The GtkObject defines
83 * the few basic items that all derived classes contain.
87 GObject parent_instance;
89 /* 32 bits of flags. GtkObject only uses 4 of these bits and
90 * GtkWidget uses the rest. This is done because structs are
91 * aligned on 4 or 8 byte boundaries. If a new bitfield were
92 * used in GtkWidget much space would be wasted.
97 /* The GtkObjectClass is the base of the Gtk+ objects classes hierarchy,
98 * it ``inherits'' from the GtkTypeClass by mirroring its fields, which
99 * must always be kept in sync completely. The GtkObjectClass defines
100 * the basic necessities for the object inheritance mechanism to work.
102 struct _GtkObjectClass
104 GObjectClass parent_class;
106 /* Non overridable class methods to set and get per class arguments */
107 void (*set_arg) (GtkObject *object,
110 void (*get_arg) (GtkObject *object,
114 /* The function that will end an objects life time. In one way ore
115 * another all three of them are defined for all objects. If an
116 * object class overrides one of the methods in order to perform class
117 * specific destruction then it must still invoke its superclass'
118 * implementation of the method after it is finished with its
119 * own cleanup. (See the destroy function for GtkWidget for
120 * an example of how to do this).
122 void (*destroy) (GtkObject *object);
127 /* Application-level methods */
129 GtkType gtk_object_get_type (void) G_GNUC_CONST;
131 GtkObject* gtk_object_new (GtkType type,
132 const gchar *first_property_name,
135 void gtk_object_sink (GtkObject *object);
136 void gtk_object_destroy (GtkObject *object);
138 /****************************************************************/
140 #ifndef GTK_DISABLE_DEPRECATED
142 GtkObject* gtk_object_ref (GtkObject *object);
143 void gtk_object_unref (GtkObject *object);
144 void gtk_object_weakref (GtkObject *object,
145 GtkDestroyNotify notify,
147 void gtk_object_weakunref (GtkObject *object,
148 GtkDestroyNotify notify,
151 /* Set 'data' to the "object_data" field of the object. The
152 * data is indexed by the "key". If there is already data
153 * associated with "key" then the new data will replace it.
154 * If 'data' is NULL then this call is equivalent to
155 * 'gtk_object_remove_data'.
156 * The gtk_object_set_data_full variant acts just the same,
157 * but takes an additional argument which is a function to
158 * be called when the data is removed.
159 * `gtk_object_remove_data' is equivalent to the above,
160 * where 'data' is NULL
161 * `gtk_object_get_data' gets the data associated with "key".
163 void gtk_object_set_data (GtkObject *object,
166 void gtk_object_set_data_full (GtkObject *object,
169 GtkDestroyNotify destroy);
170 void gtk_object_remove_data (GtkObject *object,
172 gpointer gtk_object_get_data (GtkObject *object,
174 void gtk_object_remove_no_notify (GtkObject *object,
177 /* Set/get the "user_data" object data field of "object". It should
178 * be noted that these functions are no different than calling
179 * `gtk_object_set_data'/`gtk_object_get_data' with a key of "user_data".
180 * They are merely provided as a convenience.
182 void gtk_object_set_user_data (GtkObject *object,
184 gpointer gtk_object_get_user_data (GtkObject *object);
187 /* Object-level methods */
189 /* Object data method variants that operate on key ids. */
190 void gtk_object_set_data_by_id (GtkObject *object,
193 void gtk_object_set_data_by_id_full (GtkObject *object,
196 GtkDestroyNotify destroy);
197 gpointer gtk_object_get_data_by_id (GtkObject *object,
199 void gtk_object_remove_data_by_id (GtkObject *object,
201 void gtk_object_remove_no_notify_by_id (GtkObject *object,
203 #define gtk_object_data_try_key g_quark_try_string
204 #define gtk_object_data_force_id g_quark_from_string
206 /* GtkArg flag bits for gtk_object_add_arg_type
210 GTK_ARG_READABLE = G_PARAM_READABLE,
211 GTK_ARG_WRITABLE = G_PARAM_WRITABLE,
212 GTK_ARG_CONSTRUCT = G_PARAM_CONSTRUCT,
213 GTK_ARG_CONSTRUCT_ONLY = G_PARAM_CONSTRUCT_ONLY,
214 GTK_ARG_CHILD_ARG = 1 << 4
216 #define GTK_ARG_READWRITE (GTK_ARG_READABLE | GTK_ARG_WRITABLE)
217 void gtk_object_get (GtkObject *object,
218 const gchar *first_property_name,
220 void gtk_object_set (GtkObject *object,
221 const gchar *first_property_name,
223 void gtk_object_add_arg_type (const gchar *arg_name,
228 #endif /* GTK_DISABLE_DEPRECATED */
232 #endif /* __GTK_OBJECT_H__ */