]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtktypeutils.h
Bug 566733 – Add GIcon to GtkAction, GtkToolButton
[~andy/gtk] / gtk / gtktypeutils.h
index ed6ff88e5af8c47d1151913cc58f60f963539cd7..48b664c2a7b24fc56ced2ed58583b3f830ace610 100644 (file)
  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  * file for a list of people on the GTK+ Team.  See the ChangeLog
  * files for a list of changes.  These files are distributed with
- * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  */
 
+#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
 #ifndef __GTK_TYPE_UTILS_H__
 #define __GTK_TYPE_UTILS_H__
 
+/* enum types generated by glib-mkenums
+ */
+#include <gtk/gtktypebuiltins.h>
+
+G_BEGIN_DECLS
+
+/* urg */
+#define GTK_TYPE_IDENTIFIER (gtk_identifier_get_type ())
+GType gtk_identifier_get_type (void) G_GNUC_CONST;
+
+/* --- typedefs --- */
+/* here we come with some necessary forward declarations for structures and
+ * provide some fundamental function signatures
+ */
+typedef struct _GtkArg              GtkArg;
+typedef struct _GtkObject           GtkObject; /* object forward declaration */
+typedef gboolean (*GtkFunction)            (gpointer      data);
+typedef void (*GtkCallbackMarshal)  (GtkObject    *object,
+                                    gpointer      data,
+                                    guint         n_args,
+                                    GtkArg       *args);
 
-#include <glib-object.h>
+/* This used to be defined in gtkitemfactory.h, but moved over here after
+ * the complete deprecation of that header
+ */
+typedef gchar * (*GtkTranslateFunc) (const gchar  *path,
+                                    gpointer      func_data);
 
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+/* Everything below is deprecated and superseded by GType API
+ */
 
+#ifndef GTK_DISABLE_DEPRECATED
 
 /* Fundamental Types
  * many of these are just aliases for GLib types to maintain
  * compatibility
  */
-typedef enum   /*< skip >*/
-{
-  GTK_TYPE_INVALID     = G_TYPE_INVALID,
-  GTK_TYPE_NONE                = G_TYPE_NONE,
-  GTK_TYPE_ENUM                = G_TYPE_ENUM,
-  GTK_TYPE_FLAGS       = G_TYPE_FLAGS,
-
-  /* GtkArg types */
-  GTK_TYPE_CHAR                = G_TYPE_CHAR,
-  GTK_TYPE_UCHAR       = G_TYPE_UCHAR,
-  GTK_TYPE_BOOL                = G_TYPE_BOOLEAN,
-  GTK_TYPE_INT         = G_TYPE_INT,
-  GTK_TYPE_UINT                = G_TYPE_UINT,
-  GTK_TYPE_LONG                = G_TYPE_LONG,
-  GTK_TYPE_ULONG       = G_TYPE_ULONG,
-  GTK_TYPE_FLOAT       = G_TYPE_FLOAT,
-  GTK_TYPE_DOUBLE      = G_TYPE_DOUBLE,
-  GTK_TYPE_STRING      = G_TYPE_STRING,
-  GTK_TYPE_BOXED       = G_TYPE_BOXED,
-  GTK_TYPE_POINTER     = G_TYPE_POINTER
-} GtkFundamentalType;
 
+#define GTK_TYPE_INVALID G_TYPE_INVALID
+#define GTK_TYPE_NONE    G_TYPE_NONE
+#define GTK_TYPE_ENUM    G_TYPE_ENUM
+#define GTK_TYPE_FLAGS   G_TYPE_FLAGS
+
+/* GtkArg types */
+#define GTK_TYPE_CHAR    G_TYPE_CHAR
+#define GTK_TYPE_UCHAR   G_TYPE_UCHAR
+#define GTK_TYPE_BOOL    G_TYPE_BOOLEAN
+#define GTK_TYPE_INT     G_TYPE_INT
+#define GTK_TYPE_UINT    G_TYPE_UINT
+#define GTK_TYPE_LONG    G_TYPE_LONG
+#define GTK_TYPE_ULONG   G_TYPE_ULONG
+#define GTK_TYPE_FLOAT   G_TYPE_FLOAT
+#define GTK_TYPE_DOUBLE  G_TYPE_DOUBLE
+#define GTK_TYPE_STRING  G_TYPE_STRING
+#define GTK_TYPE_BOXED   G_TYPE_BOXED
+#define GTK_TYPE_POINTER G_TYPE_POINTER
+
+typedef GType GtkFundamentalType;
 
 /* --- type macros --- */
 #define GTK_CLASS_NAME(class)          (g_type_name (G_TYPE_FROM_CLASS (class)))
 #define GTK_CLASS_TYPE(class)          (G_TYPE_FROM_CLASS (class))
 #define GTK_TYPE_IS_OBJECT(type)       (g_type_is_a ((type), GTK_TYPE_OBJECT))
 
-
 /* outdated macros that really shouldn't e used anymore,
  * use the GLib type system instead
  */
-#ifndef        GTK_DISABLE_COMPAT_H
 #define        GTK_TYPE_FUNDAMENTAL_LAST        (G_TYPE_LAST_RESERVED_FUNDAMENTAL - 1)
 #define        GTK_TYPE_FUNDAMENTAL_MAX         (G_TYPE_FUNDAMENTAL_MAX)
-#endif /* GTK_DISABLE_COMPAT_H */
 
-/* glib macro wrappers (compatibility) */
+#define        GTK_FUNDAMENTAL_TYPE    G_TYPE_FUNDAMENTAL
 #define GTK_STRUCT_OFFSET      G_STRUCT_OFFSET
+
+/* glib macro wrappers (compatibility) */
 #define        GTK_CHECK_CAST          G_TYPE_CHECK_INSTANCE_CAST
 #define        GTK_CHECK_CLASS_CAST    G_TYPE_CHECK_CLASS_CAST
 #define GTK_CHECK_GET_CLASS    G_TYPE_INSTANCE_GET_CLASS
 #define        GTK_CHECK_TYPE          G_TYPE_CHECK_INSTANCE_TYPE
 #define        GTK_CHECK_CLASS_TYPE    G_TYPE_CHECK_CLASS_TYPE
-#define        GTK_FUNDAMENTAL_TYPE    G_TYPE_FUNDAMENTAL
 
 /* glib type wrappers (compatibility) */
-typedef GType                  GtkType;
-typedef GTypeInstance          GtkTypeObject;
-typedef GTypeClass             GtkTypeClass;
-typedef GBaseInitFunc          GtkClassInitFunc;
-typedef GInstanceInitFunc      GtkObjectInitFunc;
-
 
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+typedef GType                   GtkType;
+typedef GTypeInstance           GtkTypeObject;
+typedef GTypeClass              GtkTypeClass;
+typedef GBaseInitFunc           GtkClassInitFunc;
+typedef GInstanceInitFunc       GtkObjectInitFunc;
+typedef GSignalCMarshaller      GtkSignalMarshaller;
 
-/* Builtin Types
- */
-#include <gtk/gtktypebuiltins.h>
+typedef void (*GtkDestroyNotify)    (gpointer data);
+typedef void (*GtkSignalFunc)       (void);
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+#define GTK_SIGNAL_FUNC(f)         G_CALLBACK(f)
 
+#endif /* GTK_DISABLE_DEPRECATED */
 
-/* --- typedefs --- */
-/* here we come with some necessary forward declarations for structures and
- * provide some fundamental function signatures
- */
-typedef struct _GtkArg              GtkArg;
-typedef struct _GtkObject           GtkObject; /* object forward declaration */
-typedef struct _GtkTypeInfo         GtkTypeInfo;
-typedef gint (*GtkFunction)        (gpointer      data);
-typedef void (*GtkDestroyNotify)    (gpointer      data);
-typedef void (*GtkCallbackMarshal)  (GtkObject    *object,
-                                    gpointer      data,
-                                    guint         n_args,
-                                    GtkArg       *args);
-typedef void (*GtkSignalFunc)       (void);
-typedef GSignalCMarshaller          GtkSignalMarshaller;
-#define GTK_SIGNAL_FUNC(f)         ((GtkSignalFunc) (f))
+#if !defined (GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION)
 
+/* Used by gtk_container_foreach_unmarshal () */
 
 /* GtkArg, used to hold differently typed values */
 struct _GtkArg
 {
-  GtkType type;
+  GType type;
   gchar *name;
-  
+
   /* this union only defines the required storage types for
    * the possibile values, thus there is no gint enum_data field,
    * because that would just be a mere alias for gint int_data.
@@ -151,10 +158,10 @@ struct _GtkArg
     gchar *string_data;
     GtkObject *object_data;
     gpointer pointer_data;
-    
+
     /* structured values */
     struct {
-      GtkSignalFunc f;
+      GCallback f;
       gpointer d;
     } signal_data;
   } d;
@@ -162,7 +169,7 @@ struct _GtkArg
 
 /* argument value access macros, these must not contain casts,
  * to allow the usage of these macros in combination with the
- * adress operator, e.g. &GTK_VALUE_CHAR (*arg)
+ * address operator, e.g. &GTK_VALUE_CHAR (*arg)
  */
 #define GTK_VALUE_CHAR(a)      ((a).d.char_data)
 #define GTK_VALUE_UCHAR(a)     ((a).d.uchar_data)
@@ -181,6 +188,10 @@ struct _GtkArg
 #define GTK_VALUE_POINTER(a)   ((a).d.pointer_data)
 #define GTK_VALUE_SIGNAL(a)    ((a).d.signal_data)
 
+#endif /* !GTK_DISABLE_DEPRECATED || GTK_COMPILATION */
+
+#ifndef GTK_DISABLE_DEPRECATED
+
 /* return location macros, these all narrow down to
  * pointer types, because return values need to be
  * passed by reference
@@ -206,6 +217,8 @@ struct _GtkArg
  * g_type_register_static() or
  * g_type_register_dynamic() instead
  */
+typedef struct _GtkTypeInfo GtkTypeInfo;
+
 struct _GtkTypeInfo
 {
   gchar                        *type_name;
@@ -217,22 +230,18 @@ struct _GtkTypeInfo
   gpointer              reserved_2;
   GtkClassInitFunc      base_class_init_func;
 };
-GtkType                gtk_type_unique (GtkType           parent_type,
-                                const GtkTypeInfo *gtkinfo);
-gpointer       gtk_type_class  (GtkType         type) G_GNUC_CONST;
-gpointer       gtk_type_new    (GtkType         type);
-
-
-/* deprecated, use g_type_init() instead */
-void           gtk_type_init   (GTypeDebugFlags debug_flags);
 
+void            gtk_type_init   (GTypeDebugFlags    debug_flags);
+GtkType         gtk_type_unique (GtkType            parent_type,
+                                 const GtkTypeInfo *gtkinfo);
+gpointer        gtk_type_class  (GtkType            type);
+gpointer        gtk_type_new    (GtkType            type);
 
 /* --- compatibility defines --- */
-#define        gtk_type_name                    g_type_name
-#define        gtk_type_from_name               g_type_from_name
-#define        gtk_type_parent                  g_type_parent
-#define        gtk_type_is_a                    g_type_is_a
-
+#define        gtk_type_name(type)              g_type_name (type)
+#define        gtk_type_from_name(name)         g_type_from_name (name)
+#define        gtk_type_parent(type)            g_type_parent (type)
+#define        gtk_type_is_a(type, is_a_type)   g_type_is_a ((type), (is_a_type))
 
 /* enum/flags compatibility functions, we strongly
  * recommend to use the glib enum/flags classes directly
@@ -246,23 +255,8 @@ GtkEnumValue*      gtk_type_enum_find_value        (GtkType         enum_type,
 GtkFlagValue*  gtk_type_flags_find_value       (GtkType         flags_type,
                                                 const gchar    *value_name);
 
-#ifdef G_OS_WIN32
-#  ifdef GTK_COMPILATION
-#    define GTKTYPEUTILS_VAR __declspec(dllexport)
-#  else
-#    define GTKTYPEUTILS_VAR extern __declspec(dllimport)
-#  endif
-#else
-#  define GTKTYPEUTILS_VAR extern
-#endif
-
-/* urg */
-GTKTYPEUTILS_VAR GType GTK_TYPE_IDENTIFIER;
-
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+#endif /* GTK_DISABLE_DEPRECATED */
 
+G_END_DECLS
 
 #endif /* __GTK_TYPE_UTILS_H__ */