Pileus Git - ~andy/gtk/blob - gtk/gtkobject.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 /*
  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/.
  25  */
  26
  27 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  28 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GTK_OBJECT_H__
  32 #define __GTK_OBJECT_H__
  33
  34
  35 #include <gdkconfig.h>
  36 #include <gtk/gtkenums.h>
  37 #include <gtk/gtktypeutils.h>
  38 #include <gtk/gtkdebug.h>
  39
  40
  41 G_BEGIN_DECLS
  42
  43 /* macros for casting a pointer to a GtkObject or GtkObjectClass pointer,
  44  * and to test whether `object' and `klass' are of type GTK_TYPE_OBJECT.
  45  * these are the standard macros for all GtkObject-derived classes.
  46  */
  47 #define GTK_TYPE_OBJECT              (gtk_object_get_type ())
  48 #define GTK_OBJECT(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_OBJECT, GtkObject))
  49 #define GTK_OBJECT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_OBJECT, GtkObjectClass))
  50 #define GTK_IS_OBJECT(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_OBJECT))
  51 #define GTK_IS_OBJECT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_OBJECT))
  52 #define GTK_OBJECT_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), GTK_TYPE_OBJECT, GtkObjectClass))
  53
  54 /* Macros for extracting various fields from GtkObject and GtkObjectClass.
  55  */
  56 #define GTK_OBJECT_TYPE(object)           (G_TYPE_FROM_INSTANCE (object))
  57 #define GTK_OBJECT_TYPE_NAME(object)      (g_type_name (GTK_OBJECT_TYPE (object)))
  58
  59 /* GtkObject only uses the first 4 bits of the flags field.
  60  * Derived objects may use the remaining bits. Though this
  61  * is a kinda nasty break up, it does make the size of
  62  * derived objects smaller.
  63  */
  64 typedef enum
  65 {
  66   GTK_IN_DESTRUCTION    = 1 << 0, /* Used internally during dispose */
  67 #if !defined (GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION)
  68   GTK_FLOATING          = 1 << 1,
  69 #endif
  70   GTK_RESERVED_1        = 1 << 2,
  71   GTK_RESERVED_2        = 1 << 3
  72 } GtkObjectFlags;
  73
  74 /* Macros for extracting the object_flags from GtkObject.
  75  */
  76 #define GTK_OBJECT_FLAGS(obj)             (GTK_OBJECT (obj)->flags)
  77 #ifndef GTK_DISABLE_DEPRECATED
  78 #define GTK_OBJECT_FLOATING(obj)          (g_object_is_floating (obj))
  79 #endif
  80
  81 /* Macros for setting and clearing bits in the object_flags field of GtkObject.
  82  */
  83 #define GTK_OBJECT_SET_FLAGS(obj,flag)    G_STMT_START{ (GTK_OBJECT_FLAGS (obj) |= (flag)); }G_STMT_END
  84 #define GTK_OBJECT_UNSET_FLAGS(obj,flag)  G_STMT_START{ (GTK_OBJECT_FLAGS (obj) &= ~(flag)); }G_STMT_END
  85
  86 typedef struct _GtkObjectClass  GtkObjectClass;
  87
  88
  89 struct _GtkObject
  90 {
  91   GInitiallyUnowned parent_instance;
  92
  93   /* 32 bits of flags. GtkObject only uses 4 of these bits and
  94    *  GtkWidget uses the rest. This is done because structs are
  95    *  aligned on 4 or 8 byte boundaries. If a new bitfield were
  96    *  used in GtkWidget much space would be wasted.
  97    */
  98   guint32 GSEAL (flags);
  99 };
 100
 101 struct _GtkObjectClass
 102 {
 103   GInitiallyUnownedClass parent_class;
 104
 105   /* Non overridable class methods to set and get per class arguments */
 106   void (*set_arg) (GtkObject *object,
 107                    GtkArg    *arg,
 108                    guint      arg_id);
 109   void (*get_arg) (GtkObject *object,
 110                    GtkArg    *arg,
 111                    guint      arg_id);
 112
 113   /* Default signal handler for the ::destroy signal, which is
 114    *  invoked to request that references to the widget be dropped.
 115    *  If an object class overrides destroy() in order to perform class
 116    *  specific destruction then it must still invoke its superclass'
 117    *  implementation of the method after it is finished with its
 118    *  own cleanup. (See gtk_widget_real_destroy() for an example of
 119    *  how to do this).
 120    */
 121   void (*destroy)  (GtkObject *object);
 122 };
 123
 124
 125
 126 /* Application-level methods */
 127
 128 GType gtk_object_get_type (void) G_GNUC_CONST;
 129
 130 #ifndef GTK_DISABLE_DEPRECATED
 131 void gtk_object_sink      (GtkObject *object);
 132 #endif
 133 void gtk_object_destroy   (GtkObject *object);
 134
 135 /****************************************************************/
 136
 137 #ifndef GTK_DISABLE_DEPRECATED
 138
 139 GtkObject*      gtk_object_new            (GType               type,
 140                                            const gchar        *first_property_name,
 141                                            ...);
 142 GtkObject*      gtk_object_ref            (GtkObject          *object);
 143 void            gtk_object_unref          (GtkObject          *object);
 144 void gtk_object_weakref   (GtkObject        *object,
 145                            GDestroyNotify    notify,
 146                            gpointer          data);
 147 void gtk_object_weakunref (GtkObject        *object,
 148                            GDestroyNotify    notify,
 149                            gpointer          data);
 150
 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".
 162  */
 163 void     gtk_object_set_data         (GtkObject      *object,
 164                                       const gchar    *key,
 165                                       gpointer        data);
 166 void     gtk_object_set_data_full    (GtkObject      *object,
 167                                       const gchar    *key,
 168                                       gpointer        data,
 169                                       GDestroyNotify  destroy);
 170 void     gtk_object_remove_data      (GtkObject      *object,
 171                                       const gchar    *key);
 172 gpointer gtk_object_get_data         (GtkObject      *object,
 173                                       const gchar    *key);
 174 void     gtk_object_remove_no_notify (GtkObject      *object,
 175                                       const gchar    *key);
 176
 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.
 181  */
 182 void     gtk_object_set_user_data (GtkObject    *object,
 183                                    gpointer      data);
 184 gpointer gtk_object_get_user_data (GtkObject    *object);
 185
 186
 187 /* Object-level methods */
 188
 189 /* Object data method variants that operate on key ids. */
 190 void gtk_object_set_data_by_id          (GtkObject       *object,
 191                                          GQuark           data_id,
 192                                          gpointer         data);
 193 void gtk_object_set_data_by_id_full     (GtkObject       *object,
 194                                          GQuark           data_id,
 195                                          gpointer         data,
 196                                          GDestroyNotify   destroy);
 197 gpointer gtk_object_get_data_by_id      (GtkObject       *object,
 198                                          GQuark           data_id);
 199 void  gtk_object_remove_data_by_id      (GtkObject       *object,
 200                                          GQuark           data_id);
 201 void  gtk_object_remove_no_notify_by_id (GtkObject       *object,
 202                                          GQuark           key_id);
 203 #define gtk_object_data_try_key     g_quark_try_string
 204 #define gtk_object_data_force_id    g_quark_from_string
 205
 206 /* GtkArg flag bits for gtk_object_add_arg_type
 207  */
 208 typedef enum
 209 {
 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
 215 } GtkArgFlags;
 216 #define GTK_ARG_READWRITE       (GTK_ARG_READABLE | GTK_ARG_WRITABLE)
 217 void    gtk_object_get          (GtkObject      *object,
 218                                  const gchar    *first_property_name,
 219                                  ...) G_GNUC_NULL_TERMINATED;
 220 void    gtk_object_set          (GtkObject      *object,
 221                                  const gchar    *first_property_name,
 222                                  ...) G_GNUC_NULL_TERMINATED;
 223 void    gtk_object_add_arg_type         (const gchar    *arg_name,
 224                                          GType           arg_type,
 225                                          guint           arg_flags,
 226                                          guint           arg_id);
 227
 228 #endif /* GTK_DISABLE_DEPRECATED */
 229
 230 G_END_DECLS
 231
 232 #endif /* __GTK_OBJECT_H__ */