]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtktypeutils.h
Add GtkScrollable interface
[~andy/gtk] / gtk / gtktypeutils.h
index 3f390c3f4365355e7565f3c01338ed4d442f9590..51760cf0a91af562932f11efd299683a812e3453 100644 (file)
  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
  *
  * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.         See the GNU
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Library General Public
+ * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-#ifndef __GTK_TYPE_UTILS_H__
-#define __GTK_TYPE_UTILS_H__
-
-
-#include <gdk/gdk.h>
 
+/*
+ * 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/.
+ */
 
-#ifdef __cplusplus
-extern "C" {
-#pragma }
-#endif /* __cplusplus */
+#if !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__
 
-/* Fundamental Types
+/* enum types generated by glib-mkenums
  */
-typedef enum
-{
-  G_SV (GTK_TYPE_INVALID,      invalid),
-  G_SV (GTK_TYPE_NONE,         none),
-  G_SV (GTK_TYPE_CHAR,         char),
-  G_SV (GTK_TYPE_BOOL,         bool),
-  G_SV (GTK_TYPE_INT,          int),
-  G_SV (GTK_TYPE_UINT,         uint),
-  G_SV (GTK_TYPE_LONG,         long),
-  G_SV (GTK_TYPE_ULONG,                ulong),
-  G_SV (GTK_TYPE_FLOAT,                float),
-  G_SV (GTK_TYPE_DOUBLE,       double),
-  G_SV (GTK_TYPE_STRING,       string),
-  G_SV (GTK_TYPE_ENUM,         enum),
-  G_SV (GTK_TYPE_FLAGS,                flags),
-  G_SV (GTK_TYPE_BOXED,                boxed),
-  G_SV (GTK_TYPE_FOREIGN,      foreign),
-  G_SV (GTK_TYPE_CALLBACK,     callback),
-  G_SV (GTK_TYPE_ARGS,         args),
-  
-  G_SV (GTK_TYPE_POINTER,      pointer),
+#include <gtk/gtktypebuiltins.h>
 
-  /* It'd be great if GTK_TYPE_POINTER and GTK_TYPE_C_CALLBACK
-   * could be removed eventually
-   */
-  G_SV (GTK_TYPE_SIGNAL,       signal),
-  G_SV (GTK_TYPE_C_CALLBACK,   c-callback),
-  
-  G_SV (GTK_TYPE_OBJECT,       object)
-  
-} G_ENUM (GtkFundamentalType);
+G_BEGIN_DECLS
 
-typedef guint GtkType;
+/* urg */
+#define GTK_TYPE_IDENTIFIER (gtk_identifier_get_type ())
+GType gtk_identifier_get_type (void) G_GNUC_CONST;
 
-/* Builtin Types
+/* --- typedefs --- */
+/* here we come with some necessary forward declarations for structures and
+ * provide some fundamental function signatures
  */
-#include <gtk/gtktypebuiltins.h>
+typedef struct _GtkArg              GtkArg;
 
-/* Macros
+/**
+ * GtkFunction:
+ * @data: #gpointer
+ *
+ * Defines a function pointer.
+ *
+ * Returns: #gint
  */
-#define GTK_TYPE_MAKE(parent_t, seqno)         (((seqno) << 8) | GTK_FUNDAMENTAL_TYPE (parent_t))
-#define GTK_FUNDAMENTAL_TYPE(type)             ((GtkFundamentalType) ((type) & 0xFF))
-#define GTK_TYPE_SEQNO(type)           ((type) > 0xFF ? (type) >> 8 : (type))
-
-typedef struct _GtkArg        GtkArg;
-typedef struct _GtkObject      GtkObject;   /* forward declaration of object type */
-typedef struct _GtkTypeInfo    GtkTypeInfo;
-typedef struct _GtkEnumValue   GtkEnumValue;
-typedef struct _GtkEnumValue   GtkFlagValue;
+typedef gboolean (*GtkFunction)            (gpointer      data);
+
+/**
+ * GtkCallbackMarshal:
+ * @object: #GObject*
+ * @data: #gpointer
+ * @n_args: #guint
+ * @args: #GtkArg*
+ *
+ * Defines a function pointer.
+ */
+typedef void (*GtkCallbackMarshal)  (GObject      *object,
+                                    gpointer      data,
+                                    guint         n_args,
+                                    GtkArg       *args);
 
-typedef void (*GtkClassInitFunc)  (gpointer klass);
-typedef void (*GtkObjectInitFunc) (gpointer object);
-typedef void (*GtkArgGetFunc) (GtkObject *object, GtkArg *arg, guint arg_id);
-typedef void (*GtkArgSetFunc) (GtkObject *object, GtkArg *arg, guint arg_id);
-typedef gint (*GtkFunction) (gpointer data);
-typedef void (*GtkCallbackMarshal) (GtkObject *object,
-                                   gpointer data,
-                                   guint n_args,
-                                   GtkArg *args);
-typedef void (*GtkDestroyNotify) (gpointer data);
+/* 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);
 
+#if defined (GTK_COMPILATION)
+/**
+ * GtkArg:
+ *
+ * This is a structure that we use to pass in typed values (and names).
+ */
 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.
+   * use the GTK_VALUE_*() and GTK_RETLOC_*() macros to access
+   * the discrete memebers.
+   */
   union {
+    /* flat values */
     gchar char_data;
+    guchar uchar_data;
+    gboolean bool_data;
     gint int_data;
     guint uint_data;
-    gint bool_data;
     glong long_data;
     gulong ulong_data;
     gfloat float_data;
     gdouble double_data;
     gchar *string_data;
+    GObject *object_data;
     gpointer pointer_data;
-    GtkObject *object_data;
-    struct {
-      GtkCallbackMarshal marshal;
-      gpointer data;
-      GtkDestroyNotify notify;
-    } callback_data;
-    struct {
-      gpointer data;
-      GtkDestroyNotify notify;
-    } foreign_data;
-    struct {
-      gint n_args;
-      GtkArg *args;
-    } args_data;
+
+    /* structured values */
     struct {
-      GtkFunction f;
+      GCallback f;
       gpointer d;
     } signal_data;
-    struct {
-      GtkFunction func;
-      gpointer func_data;
-    } c_callback_data;
   } d;
 };
+#endif /* GTK_COMPILATION */
 
-#define GTK_VALUE_CHAR(a)      ((a).d.char_data)
-#define GTK_VALUE_BOOL(a)      ((a).d.bool_data)
-#define GTK_VALUE_INT(a)       ((a).d.int_data)
-#define GTK_VALUE_UINT(a)      ((a).d.uint_data)
-#define GTK_VALUE_LONG(a)      ((a).d.long_data)
-#define GTK_VALUE_ULONG(a)     ((a).d.ulong_data)
-#define GTK_VALUE_FLOAT(a)     ((a).d.float_data)
-#define GTK_VALUE_DOUBLE(a)    ((a).d.double_data)
-#define GTK_VALUE_STRING(a)    ((a).d.string_data)
-#define GTK_VALUE_ENUM(a)      ((a).d.int_data)
-#define GTK_VALUE_FLAGS(a)     ((a).d.int_data)
-#define GTK_VALUE_BOXED(a)     ((a).d.pointer_data)
-#define GTK_VALUE_FOREIGN(a)   ((a).d.foreign_data)
-#define GTK_VALUE_CALLBACK(a)  ((a).d.callback_data)
-#define GTK_VALUE_ARGS(a)      ((a).d.args_data)
-#define GTK_VALUE_OBJECT(a)    ((a).d.object_data)
-#define GTK_VALUE_POINTER(a)   ((a).d.pointer_data)
-#define GTK_VALUE_SIGNAL(a)    ((a).d.signal_data)
-#define GTK_VALUE_C_CALLBACK(a) ((a).d.c_callback_data)
-
-#define GTK_RETLOC_CHAR(a)     ((gchar*)(a).d.pointer_data)
-#define GTK_RETLOC_BOOL(a)     ((gint*)(a).d.pointer_data)
-#define GTK_RETLOC_INT(a)      ((gint*)(a).d.pointer_data)
-#define GTK_RETLOC_UINT(a)     ((guint*)(a).d.pointer_data)
-#define GTK_RETLOC_LONG(a)     ((glong*)(a).d.pointer_data)
-#define GTK_RETLOC_ULONG(a)    ((gulong*)(a).d.pointer_data)
-#define GTK_RETLOC_FLOAT(a)    ((gfloat*)(a).d.pointer_data)
-#define GTK_RETLOC_DOUBLE(a)   ((gdouble*)(a).d.pointer_data)
-#define GTK_RETLOC_STRING(a)   ((gchar**)(a).d.pointer_data)
-#define GTK_RETLOC_ENUM(a)     ((gint*)(a).d.pointer_data)
-#define GTK_RETLOC_FLAGS(a)    ((gint*)(a).d.pointer_data)
-#define GTK_RETLOC_BOXED(a)    ((gpointer*)(a).d.pointer_data)
-#define GTK_RETLOC_OBJECT(a)   ((GtkObject**)(a).d.pointer_data)
-#define GTK_RETLOC_POINTER(a)  ((gpointer*)(a).d.pointer_data)
-
-struct _GtkTypeInfo
-{
-  gchar *type_name;
-  guint object_size;
-  guint class_size;
-  GtkClassInitFunc class_init_func;
-  GtkObjectInitFunc object_init_func;
-  GtkArgSetFunc arg_set_func;
-  GtkArgGetFunc arg_get_func;
-};
-
-struct _GtkEnumValue
-{
-  guint  value;
-  gchar        *value_name;
-  gchar *value_nick;
-};
-
-
-void           gtk_type_init                   (void);
-GtkType                gtk_type_unique                 (GtkType         parent_type,
-                                                GtkTypeInfo    *type_info);
-void           gtk_type_set_chunk_alloc        (GtkType         type,
-                                                guint           n_chunks);
-gchar*         gtk_type_name                   (guint           type);
-GtkType                gtk_type_from_name              (const gchar    *name);
-GtkType                gtk_type_parent                 (GtkType         type);
-gpointer       gtk_type_class                  (GtkType         type);
-gpointer       gtk_type_parent_class           (GtkType         type);
-GList*         gtk_type_children_types         (GtkType         type);
-gpointer       gtk_type_new                    (GtkType         type);
-void           gtk_type_free                   (GtkType         type,
-                                                gpointer        mem);
-void           gtk_type_describe_heritage      (GtkType         type);
-void           gtk_type_describe_tree          (GtkType         type,
-                                                gboolean        show_size);
-gint           gtk_type_is_a                   (GtkType         type,
-                                                GtkType         is_a_type);
-void           gtk_type_get_arg                (GtkObject      *object,
-                                                GtkType         type,
-                                                GtkArg         *arg,
-                                                guint           arg_id);
-void           gtk_type_set_arg                (GtkObject      *object,
-                                                GtkType         type,
-                                                GtkArg         *arg,
-                                                guint           arg_id);
-GtkArg*                gtk_arg_copy                    (GtkArg         *src_arg,
-                                                GtkArg         *dest_arg);
-GtkType                gtk_type_register_enum          (const gchar    *type_name,
-                                                GtkEnumValue   *values);
-GtkType                gtk_type_register_flags         (const gchar    *type_name,
-                                                GtkFlagValue   *values);
-GtkEnumValue*  gtk_type_enum_get_values        (GtkType        enum_type);
-GtkFlagValue*  gtk_type_flags_get_values       (GtkType        flags_type);
-
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
-
+G_END_DECLS
 
 #endif /* __GTK_TYPE_UTILS_H__ */