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_TYPE_UTILS_H__
28 #define __GTK_TYPE_UTILS_H__
31 #include <glib-object.h>
36 #endif /* __cplusplus */
40 * many of these are just aliases for GLib types to maintain
43 typedef enum /*< skip >*/
45 GTK_TYPE_INVALID = G_TYPE_INVALID,
46 GTK_TYPE_NONE = G_TYPE_NONE,
47 GTK_TYPE_ENUM = G_TYPE_ENUM,
48 GTK_TYPE_FLAGS = G_TYPE_FLAGS,
51 GTK_TYPE_CHAR = G_TYPE_CHAR,
52 GTK_TYPE_UCHAR = G_TYPE_UCHAR,
53 GTK_TYPE_BOOL = G_TYPE_BOOLEAN,
54 GTK_TYPE_INT = G_TYPE_INT,
55 GTK_TYPE_UINT = G_TYPE_UINT,
56 GTK_TYPE_LONG = G_TYPE_LONG,
57 GTK_TYPE_ULONG = G_TYPE_ULONG,
58 GTK_TYPE_FLOAT = G_TYPE_FLOAT,
59 GTK_TYPE_DOUBLE = G_TYPE_DOUBLE,
60 GTK_TYPE_STRING = G_TYPE_STRING,
61 GTK_TYPE_BOXED = G_TYPE_GTK_BOXED,
62 GTK_TYPE_POINTER = G_TYPE_GTK_POINTER,
63 GTK_TYPE_SIGNAL = G_TYPE_GTK_SIGNAL
67 /* --- type macros --- */
68 #define GTK_CLASS_NAME(class) (g_type_name (G_TYPE_FROM_CLASS (class)))
69 #define GTK_CLASS_TYPE(class) (G_TYPE_FROM_CLASS (class))
70 #define GTK_TYPE_IS_OBJECT(type) (g_type_is_a ((type), GTK_TYPE_OBJECT))
73 /* outdated macros that really shouldn't e used anymore,
74 * use the GLib type system instead
76 #ifndef GTK_DISABLE_COMPAT_H
77 #define GTK_TYPE_FUNDAMENTAL_LAST (G_TYPE_LAST_RESERVED_FUNDAMENTAL - 1)
78 #define GTK_TYPE_FUNDAMENTAL_MAX (G_TYPE_FUNDAMENTAL_MAX)
79 #endif /* GTK_DISABLE_COMPAT_H */
81 /* glib macro wrappers (compatibility) */
82 #define GTK_STRUCT_OFFSET G_STRUCT_OFFSET
83 #define GTK_CHECK_CAST G_TYPE_CHECK_INSTANCE_CAST
84 #define GTK_CHECK_CLASS_CAST G_TYPE_CHECK_CLASS_CAST
85 #define GTK_CHECK_GET_CLASS G_TYPE_INSTANCE_GET_CLASS
86 #define GTK_CHECK_TYPE G_TYPE_CHECK_INSTANCE_TYPE
87 #define GTK_CHECK_CLASS_TYPE G_TYPE_CHECK_CLASS_TYPE
88 #define GTK_FUNDAMENTAL_TYPE G_TYPE_FUNDAMENTAL
90 /* glib type wrappers (compatibility) */
91 typedef GType GtkType;
92 typedef GTypeInstance GtkTypeObject;
93 typedef GTypeClass GtkTypeClass;
94 typedef GBaseInitFunc GtkClassInitFunc;
95 typedef GInstanceInitFunc GtkObjectInitFunc;
100 #endif /* __cplusplus */
104 #include <gtk/gtktypebuiltins.h>
108 #endif /* __cplusplus */
111 /* --- typedefs --- */
112 /* here we come with some necessary forward declarations for structures and
113 * provide some fundamental function signatures
115 typedef struct _GtkArg GtkArg;
116 typedef struct _GtkObject GtkObject; /* object forward declaration */
117 typedef struct _GtkTypeInfo GtkTypeInfo;
118 typedef gint (*GtkFunction) (gpointer data);
119 typedef void (*GtkDestroyNotify) (gpointer data);
120 typedef void (*GtkCallbackMarshal) (GtkObject *object,
124 typedef void (*GtkSignalFunc) ();
125 typedef void (*GtkSignalMarshaller) (GtkObject *object,
129 #define GTK_SIGNAL_FUNC(f) ((GtkSignalFunc) (f))
132 /* GtkArg, used to hold differently typed values */
138 /* this union only defines the required storage types for
139 * the possibile values, thus there is no gint enum_data field,
140 * because that would just be a mere alias for gint int_data.
141 * use the GTK_VALUE_*() and GTK_RETLOC_*() macros to access
142 * the discrete memebers.
156 GtkObject *object_data;
157 gpointer pointer_data;
159 /* structured values */
167 /* argument value access macros, these must not contain casts,
168 * to allow the usage of these macros in combination with the
169 * adress operator, e.g. >K_VALUE_CHAR (*arg)
171 #define GTK_VALUE_CHAR(a) ((a).d.char_data)
172 #define GTK_VALUE_UCHAR(a) ((a).d.uchar_data)
173 #define GTK_VALUE_BOOL(a) ((a).d.bool_data)
174 #define GTK_VALUE_INT(a) ((a).d.int_data)
175 #define GTK_VALUE_UINT(a) ((a).d.uint_data)
176 #define GTK_VALUE_LONG(a) ((a).d.long_data)
177 #define GTK_VALUE_ULONG(a) ((a).d.ulong_data)
178 #define GTK_VALUE_FLOAT(a) ((a).d.float_data)
179 #define GTK_VALUE_DOUBLE(a) ((a).d.double_data)
180 #define GTK_VALUE_STRING(a) ((a).d.string_data)
181 #define GTK_VALUE_ENUM(a) ((a).d.int_data)
182 #define GTK_VALUE_FLAGS(a) ((a).d.uint_data)
183 #define GTK_VALUE_BOXED(a) ((a).d.pointer_data)
184 #define GTK_VALUE_OBJECT(a) ((a).d.object_data)
185 #define GTK_VALUE_POINTER(a) ((a).d.pointer_data)
186 #define GTK_VALUE_SIGNAL(a) ((a).d.signal_data)
188 /* return location macros, these all narrow down to
189 * pointer types, because return values need to be
190 * passed by reference
192 #define GTK_RETLOC_CHAR(a) ((gchar*) (a).d.pointer_data)
193 #define GTK_RETLOC_UCHAR(a) ((guchar*) (a).d.pointer_data)
194 #define GTK_RETLOC_BOOL(a) ((gboolean*) (a).d.pointer_data)
195 #define GTK_RETLOC_INT(a) ((gint*) (a).d.pointer_data)
196 #define GTK_RETLOC_UINT(a) ((guint*) (a).d.pointer_data)
197 #define GTK_RETLOC_LONG(a) ((glong*) (a).d.pointer_data)
198 #define GTK_RETLOC_ULONG(a) ((gulong*) (a).d.pointer_data)
199 #define GTK_RETLOC_FLOAT(a) ((gfloat*) (a).d.pointer_data)
200 #define GTK_RETLOC_DOUBLE(a) ((gdouble*) (a).d.pointer_data)
201 #define GTK_RETLOC_STRING(a) ((gchar**) (a).d.pointer_data)
202 #define GTK_RETLOC_ENUM(a) ((gint*) (a).d.pointer_data)
203 #define GTK_RETLOC_FLAGS(a) ((guint*) (a).d.pointer_data)
204 #define GTK_RETLOC_BOXED(a) ((gpointer*) (a).d.pointer_data)
205 #define GTK_RETLOC_OBJECT(a) ((GtkObject**) (a).d.pointer_data)
206 #define GTK_RETLOC_POINTER(a) ((gpointer*) (a).d.pointer_data)
207 /* GTK_RETLOC_SIGNAL() - no such thing */
209 /* type registration, it is recommended to use
210 * g_type_register_static() or
211 * g_type_register_dynamic() instead
218 GtkClassInitFunc class_init_func;
219 GtkObjectInitFunc object_init_func;
222 GtkClassInitFunc base_class_init_func;
224 GtkType gtk_type_unique (GtkType parent_type,
225 const GtkTypeInfo *gtkinfo);
226 gpointer gtk_type_class (GtkType type);
227 gpointer gtk_type_new (GtkType type);
230 /* --- initialize the type system --- */
231 void gtk_type_init (void);
234 /* --- compatibility defines --- */
235 #define gtk_type_name g_type_name
236 #define gtk_type_from_name g_type_from_name
237 #define gtk_type_parent g_type_parent
238 #define gtk_type_is_a g_type_is_a
241 /* enum/flags compatibility functions, we strongly
242 * recommend to use the glib enum/flags classes directly
244 typedef GEnumValue GtkEnumValue;
245 typedef GFlagsValue GtkFlagValue;
246 GtkEnumValue* gtk_type_enum_get_values (GtkType enum_type);
247 GtkFlagValue* gtk_type_flags_get_values (GtkType flags_type);
248 GtkEnumValue* gtk_type_enum_find_value (GtkType enum_type,
249 const gchar *value_name);
250 GtkFlagValue* gtk_type_flags_find_value (GtkType flags_type,
251 const gchar *value_name);
254 # ifdef GTK_COMPILATION
255 # define GTKTYPEUTILS_VAR __declspec(dllexport)
257 # define GTKTYPEUTILS_VAR extern __declspec(dllimport)
260 # define GTKTYPEUTILS_VAR extern
264 GTKTYPEUTILS_VAR GType GTK_TYPE_IDENTIFIER;
269 #endif /* __cplusplus */
272 #endif /* __GTK_TYPE_UTILS_H__ */