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 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 #error "Only <gtk/gtk.h> can be included directly."
31 #ifndef __GTK_TYPE_UTILS_H__
32 #define __GTK_TYPE_UTILS_H__
34 /* enum types generated by glib-mkenums
36 #include <gtk/gtktypebuiltins.h>
41 #define GTK_TYPE_IDENTIFIER (gtk_identifier_get_type ())
42 GType gtk_identifier_get_type (void) G_GNUC_CONST;
44 /* --- typedefs --- */
45 /* here we come with some necessary forward declarations for structures and
46 * provide some fundamental function signatures
48 typedef struct _GtkArg GtkArg;
49 typedef struct _GtkObject GtkObject; /* object forward declaration */
50 typedef gboolean (*GtkFunction) (gpointer data);
51 typedef void (*GtkCallbackMarshal) (GtkObject *object,
56 /* This used to be defined in gtkitemfactory.h, but moved over here after
57 * the complete deprecation of that header
59 typedef gchar * (*GtkTranslateFunc) (const gchar *path,
63 /* Everything below is deprecated and superseded by GType API
66 #ifndef GTK_DISABLE_DEPRECATED
69 * many of these are just aliases for GLib types to maintain
73 #define GTK_TYPE_INVALID G_TYPE_INVALID
74 #define GTK_TYPE_NONE G_TYPE_NONE
75 #define GTK_TYPE_ENUM G_TYPE_ENUM
76 #define GTK_TYPE_FLAGS G_TYPE_FLAGS
79 #define GTK_TYPE_CHAR G_TYPE_CHAR
80 #define GTK_TYPE_UCHAR G_TYPE_UCHAR
81 #define GTK_TYPE_BOOL G_TYPE_BOOLEAN
82 #define GTK_TYPE_INT G_TYPE_INT
83 #define GTK_TYPE_UINT G_TYPE_UINT
84 #define GTK_TYPE_LONG G_TYPE_LONG
85 #define GTK_TYPE_ULONG G_TYPE_ULONG
86 #define GTK_TYPE_FLOAT G_TYPE_FLOAT
87 #define GTK_TYPE_DOUBLE G_TYPE_DOUBLE
88 #define GTK_TYPE_STRING G_TYPE_STRING
89 #define GTK_TYPE_BOXED G_TYPE_BOXED
90 #define GTK_TYPE_POINTER G_TYPE_POINTER
92 typedef GType GtkFundamentalType;
94 /* --- type macros --- */
95 #define GTK_CLASS_NAME(class) (g_type_name (G_TYPE_FROM_CLASS (class)))
96 #define GTK_CLASS_TYPE(class) (G_TYPE_FROM_CLASS (class))
97 #define GTK_TYPE_IS_OBJECT(type) (g_type_is_a ((type), GTK_TYPE_OBJECT))
99 /* outdated macros that really shouldn't e used anymore,
100 * use the GLib type system instead
102 #define GTK_TYPE_FUNDAMENTAL_LAST (G_TYPE_LAST_RESERVED_FUNDAMENTAL - 1)
103 #define GTK_TYPE_FUNDAMENTAL_MAX (G_TYPE_FUNDAMENTAL_MAX)
105 #define GTK_FUNDAMENTAL_TYPE G_TYPE_FUNDAMENTAL
106 #define GTK_STRUCT_OFFSET G_STRUCT_OFFSET
108 /* glib macro wrappers (compatibility) */
109 #define GTK_CHECK_CAST G_TYPE_CHECK_INSTANCE_CAST
110 #define GTK_CHECK_CLASS_CAST G_TYPE_CHECK_CLASS_CAST
111 #define GTK_CHECK_GET_CLASS G_TYPE_INSTANCE_GET_CLASS
112 #define GTK_CHECK_TYPE G_TYPE_CHECK_INSTANCE_TYPE
113 #define GTK_CHECK_CLASS_TYPE G_TYPE_CHECK_CLASS_TYPE
115 /* glib type wrappers (compatibility) */
117 typedef GType GtkType;
118 typedef GTypeInstance GtkTypeObject;
119 typedef GTypeClass GtkTypeClass;
120 typedef GBaseInitFunc GtkClassInitFunc;
121 typedef GInstanceInitFunc GtkObjectInitFunc;
122 typedef GSignalCMarshaller GtkSignalMarshaller;
124 typedef void (*GtkDestroyNotify) (gpointer data);
125 typedef void (*GtkSignalFunc) (void);
127 #define GTK_SIGNAL_FUNC(f) G_CALLBACK(f)
129 #endif /* GTK_DISABLE_DEPRECATED */
131 #if !defined (GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION)
133 /* Used by gtk_container_foreach_unmarshal () */
135 /* GtkArg, used to hold differently typed values */
141 /* this union only defines the required storage types for
142 * the possibile values, thus there is no gint enum_data field,
143 * because that would just be a mere alias for gint int_data.
144 * use the GTK_VALUE_*() and GTK_RETLOC_*() macros to access
145 * the discrete memebers.
159 GtkObject *object_data;
160 gpointer pointer_data;
162 /* structured values */
170 /* argument value access macros, these must not contain casts,
171 * to allow the usage of these macros in combination with the
172 * address operator, e.g. >K_VALUE_CHAR (*arg)
174 #define GTK_VALUE_CHAR(a) ((a).d.char_data)
175 #define GTK_VALUE_UCHAR(a) ((a).d.uchar_data)
176 #define GTK_VALUE_BOOL(a) ((a).d.bool_data)
177 #define GTK_VALUE_INT(a) ((a).d.int_data)
178 #define GTK_VALUE_UINT(a) ((a).d.uint_data)
179 #define GTK_VALUE_LONG(a) ((a).d.long_data)
180 #define GTK_VALUE_ULONG(a) ((a).d.ulong_data)
181 #define GTK_VALUE_FLOAT(a) ((a).d.float_data)
182 #define GTK_VALUE_DOUBLE(a) ((a).d.double_data)
183 #define GTK_VALUE_STRING(a) ((a).d.string_data)
184 #define GTK_VALUE_ENUM(a) ((a).d.int_data)
185 #define GTK_VALUE_FLAGS(a) ((a).d.uint_data)
186 #define GTK_VALUE_BOXED(a) ((a).d.pointer_data)
187 #define GTK_VALUE_OBJECT(a) ((a).d.object_data)
188 #define GTK_VALUE_POINTER(a) ((a).d.pointer_data)
189 #define GTK_VALUE_SIGNAL(a) ((a).d.signal_data)
191 #endif /* !GTK_DISABLE_DEPRECATED || GTK_COMPILATION */
193 #ifndef GTK_DISABLE_DEPRECATED
195 /* return location macros, these all narrow down to
196 * pointer types, because return values need to be
197 * passed by reference
199 #define GTK_RETLOC_CHAR(a) ((gchar*) (a).d.pointer_data)
200 #define GTK_RETLOC_UCHAR(a) ((guchar*) (a).d.pointer_data)
201 #define GTK_RETLOC_BOOL(a) ((gboolean*) (a).d.pointer_data)
202 #define GTK_RETLOC_INT(a) ((gint*) (a).d.pointer_data)
203 #define GTK_RETLOC_UINT(a) ((guint*) (a).d.pointer_data)
204 #define GTK_RETLOC_LONG(a) ((glong*) (a).d.pointer_data)
205 #define GTK_RETLOC_ULONG(a) ((gulong*) (a).d.pointer_data)
206 #define GTK_RETLOC_FLOAT(a) ((gfloat*) (a).d.pointer_data)
207 #define GTK_RETLOC_DOUBLE(a) ((gdouble*) (a).d.pointer_data)
208 #define GTK_RETLOC_STRING(a) ((gchar**) (a).d.pointer_data)
209 #define GTK_RETLOC_ENUM(a) ((gint*) (a).d.pointer_data)
210 #define GTK_RETLOC_FLAGS(a) ((guint*) (a).d.pointer_data)
211 #define GTK_RETLOC_BOXED(a) ((gpointer*) (a).d.pointer_data)
212 #define GTK_RETLOC_OBJECT(a) ((GtkObject**) (a).d.pointer_data)
213 #define GTK_RETLOC_POINTER(a) ((gpointer*) (a).d.pointer_data)
214 /* GTK_RETLOC_SIGNAL() - no such thing */
216 /* type registration, it is recommended to use
217 * g_type_register_static() or
218 * g_type_register_dynamic() instead
220 typedef struct _GtkTypeInfo GtkTypeInfo;
227 GtkClassInitFunc class_init_func;
228 GtkObjectInitFunc object_init_func;
231 GtkClassInitFunc base_class_init_func;
234 void gtk_type_init (GTypeDebugFlags debug_flags);
235 GtkType gtk_type_unique (GtkType parent_type,
236 const GtkTypeInfo *gtkinfo);
237 gpointer gtk_type_class (GtkType type);
238 gpointer gtk_type_new (GtkType type);
240 /* --- compatibility defines --- */
241 #define gtk_type_name(type) g_type_name (type)
242 #define gtk_type_from_name(name) g_type_from_name (name)
243 #define gtk_type_parent(type) g_type_parent (type)
244 #define gtk_type_is_a(type, is_a_type) g_type_is_a ((type), (is_a_type))
246 /* enum/flags compatibility functions, we strongly
247 * recommend to use the glib enum/flags classes directly
249 typedef GEnumValue GtkEnumValue;
250 typedef GFlagsValue GtkFlagValue;
251 GtkEnumValue* gtk_type_enum_get_values (GtkType enum_type);
252 GtkFlagValue* gtk_type_flags_get_values (GtkType flags_type);
253 GtkEnumValue* gtk_type_enum_find_value (GtkType enum_type,
254 const gchar *value_name);
255 GtkFlagValue* gtk_type_flags_find_value (GtkType flags_type,
256 const gchar *value_name);
258 #endif /* GTK_DISABLE_DEPRECATED */
262 #endif /* __GTK_TYPE_UTILS_H__ */