gtkobject.h 8.46 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10
 * 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
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
24
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 26
 */

27 28 29 30
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
31 32 33 34
#ifndef __GTK_OBJECT_H__
#define __GTK_OBJECT_H__


35
#include <gdkconfig.h>
Elliot Lee's avatar
Elliot Lee committed
36 37
#include <gtk/gtkenums.h>
#include <gtk/gtktypeutils.h>
38
#include <gtk/gtkdebug.h>
Elliot Lee's avatar
Elliot Lee committed
39

40

41
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
42

43 44 45
/* macros for casting a pointer to a GtkObject or GtkObjectClass pointer,
 * and to test whether `object' and `klass' are of type GTK_TYPE_OBJECT.
 * these are the standard macros for all GtkObject-derived classes.
46
 */
47 48 49 50 51 52
#define GTK_TYPE_OBJECT              (gtk_object_get_type ())
#define GTK_OBJECT(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_OBJECT, GtkObject))
#define GTK_OBJECT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_OBJECT, GtkObjectClass))
#define GTK_IS_OBJECT(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_OBJECT))
#define GTK_IS_OBJECT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_OBJECT))
#define GTK_OBJECT_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), GTK_TYPE_OBJECT, GtkObjectClass))
Elliot Lee's avatar
Elliot Lee committed
53

54
/* Macros for extracting various fields from GtkObject and GtkObjectClass.
Elliot Lee's avatar
Elliot Lee committed
55
 */
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
#ifndef GTK_DISABLE_DEPRECATED
/**
 * GTK_OBJECT_TYPE:
 * @object: a #GtkObject.
 *
 * Gets the type of an object.
 *
 * Deprecated: 2.20: Use G_OBJECT_TYPE() instead.
 */
#define GTK_OBJECT_TYPE                   G_OBJECT_TYPE
/**
 * GTK_OBJECT_TYPE_NAME:
 * @object: a #GtkObject.
 *
 * Gets the name of an object's type.
 *
 * Deprecated: 2.20: Use G_OBJECT_TYPE_NAME() instead.
 */
#define GTK_OBJECT_TYPE_NAME              G_OBJECT_TYPE_NAME
#endif
76

77
/* GtkObject only uses the first 4 bits of the flags field.
78 79 80
 * Derived objects may use the remaining bits. Though this
 * is a kinda nasty break up, it does make the size of
 * derived objects smaller.
81
 */
Tim Janik's avatar
Tim Janik committed
82
typedef enum
83
{
84
  GTK_IN_DESTRUCTION	= 1 << 0, /* Used internally during dispose */
85
#if !defined (GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION)
86
  GTK_FLOATING		= 1 << 1,
87
#endif
88 89
  GTK_RESERVED_1	= 1 << 2,
  GTK_RESERVED_2	= 1 << 3
90
} GtkObjectFlags;
91

92
/* Macros for extracting the object_flags from GtkObject.
Elliot Lee's avatar
Elliot Lee committed
93
 */
94
#define GTK_OBJECT_FLAGS(obj)		  (GTK_OBJECT (obj)->flags)
95
#ifndef GTK_DISABLE_DEPRECATED
96
#define GTK_OBJECT_FLOATING(obj)	  (g_object_is_floating (obj))
97
#endif
Elliot Lee's avatar
Elliot Lee committed
98

99
/* Macros for setting and clearing bits in the object_flags field of GtkObject.
Elliot Lee's avatar
Elliot Lee committed
100
 */
101
#define GTK_OBJECT_SET_FLAGS(obj,flag)	  G_STMT_START{ (GTK_OBJECT_FLAGS (obj) |= (flag)); }G_STMT_END
102 103
#define GTK_OBJECT_UNSET_FLAGS(obj,flag)  G_STMT_START{ (GTK_OBJECT_FLAGS (obj) &= ~(flag)); }G_STMT_END

104
typedef struct _GtkObjectClass	GtkObjectClass;
Elliot Lee's avatar
Elliot Lee committed
105 106 107 108


struct _GtkObject
{
109
  GInitiallyUnowned parent_instance;
110

111
  /* 32 bits of flags. GtkObject only uses 4 of these bits and
Elliot Lee's avatar
Elliot Lee committed
112
   *  GtkWidget uses the rest. This is done because structs are
113 114
   *  aligned on 4 or 8 byte boundaries. If a new bitfield were
   *  used in GtkWidget much space would be wasted.
Elliot Lee's avatar
Elliot Lee committed
115
   */
Tim Janik's avatar
Tim Janik committed
116
  guint32 GSEAL (flags);
Elliot Lee's avatar
Elliot Lee committed
117 118 119 120
};

struct _GtkObjectClass
{
121
  GInitiallyUnownedClass parent_class;
122

123 124 125 126 127 128 129
  /* Non overridable class methods to set and get per class arguments */
  void (*set_arg) (GtkObject *object,
		   GtkArg    *arg,
		   guint      arg_id);
  void (*get_arg) (GtkObject *object,
		   GtkArg    *arg,
		   guint      arg_id);
130

131 132 133
  /* Default signal handler for the ::destroy signal, which is
   *  invoked to request that references to the widget be dropped.
   *  If an object class overrides destroy() in order to perform class
134 135
   *  specific destruction then it must still invoke its superclass'
   *  implementation of the method after it is finished with its
136 137
   *  own cleanup. (See gtk_widget_real_destroy() for an example of
   *  how to do this).
Elliot Lee's avatar
Elliot Lee committed
138
   */
139
  void (*destroy)  (GtkObject *object);
Elliot Lee's avatar
Elliot Lee committed
140 141 142 143
};



144
/* Application-level methods */
Elliot Lee's avatar
Elliot Lee committed
145

146
GType gtk_object_get_type (void) G_GNUC_CONST;
147

148
#ifndef GTK_DISABLE_DEPRECATED
149
void gtk_object_sink	  (GtkObject *object);
150
#endif
151 152 153 154
void gtk_object_destroy	  (GtkObject *object);

/****************************************************************/

155
#ifndef GTK_DISABLE_DEPRECATED
156

157
GtkObject*	gtk_object_new		  (GType	       type,
158
					   const gchar	      *first_property_name,
159
					   ...);
160 161
GtkObject*	gtk_object_ref		  (GtkObject	      *object);
void		gtk_object_unref	  (GtkObject	      *object);
162
void gtk_object_weakref	  (GtkObject	    *object,
163
			   GDestroyNotify    notify,
164 165
			   gpointer	     data);
void gtk_object_weakunref (GtkObject	    *object,
166
			   GDestroyNotify    notify,
167
			   gpointer	     data);
Elliot Lee's avatar
Elliot Lee committed
168 169 170 171 172 173

/* Set 'data' to the "object_data" field of the object. The
 *  data is indexed by the "key". If there is already data
 *  associated with "key" then the new data will replace it.
 *  If 'data' is NULL then this call is equivalent to
 *  'gtk_object_remove_data'.
174 175 176 177 178 179
 *  The gtk_object_set_data_full variant acts just the same,
 *  but takes an additional argument which is a function to
 *  be called when the data is removed.
 *  `gtk_object_remove_data' is equivalent to the above,
 *  where 'data' is NULL
 *  `gtk_object_get_data' gets the data associated with "key".
Elliot Lee's avatar
Elliot Lee committed
180
 */
181 182 183 184 185 186
void	 gtk_object_set_data	     (GtkObject	     *object,
				      const gchar    *key,
				      gpointer	      data);
void	 gtk_object_set_data_full    (GtkObject	     *object,
				      const gchar    *key,
				      gpointer	      data,
187
				      GDestroyNotify  destroy);
188 189 190 191 192 193
void	 gtk_object_remove_data	     (GtkObject	     *object,
				      const gchar    *key);
gpointer gtk_object_get_data	     (GtkObject	     *object,
				      const gchar    *key);
void	 gtk_object_remove_no_notify (GtkObject	     *object,
				      const gchar    *key);
194 195 196 197 198

/* Set/get the "user_data" object data field of "object". It should
 *  be noted that these functions are no different than calling
 *  `gtk_object_set_data'/`gtk_object_get_data' with a key of "user_data".
 *  They are merely provided as a convenience.
Elliot Lee's avatar
Elliot Lee committed
199
 */
200 201 202
void	 gtk_object_set_user_data (GtkObject	*object,
				   gpointer	 data);
gpointer gtk_object_get_user_data (GtkObject	*object);
Elliot Lee's avatar
Elliot Lee committed
203

204

205 206 207
/* Object-level methods */

/* Object data method variants that operate on key ids. */
208 209 210 211 212 213
void gtk_object_set_data_by_id		(GtkObject	 *object,
					 GQuark		  data_id,
					 gpointer	  data);
void gtk_object_set_data_by_id_full	(GtkObject	 *object,
					 GQuark		  data_id,
					 gpointer	  data,
214
					 GDestroyNotify   destroy);
215 216 217 218 219 220
gpointer gtk_object_get_data_by_id	(GtkObject	 *object,
					 GQuark		  data_id);
void  gtk_object_remove_data_by_id	(GtkObject	 *object,
					 GQuark		  data_id);
void  gtk_object_remove_no_notify_by_id	(GtkObject	 *object,
					 GQuark		  key_id);
221 222
#define	gtk_object_data_try_key	    g_quark_try_string
#define	gtk_object_data_force_id    g_quark_from_string
Elliot Lee's avatar
Elliot Lee committed
223

224 225 226 227 228 229 230 231
/* GtkArg flag bits for gtk_object_add_arg_type
 */
typedef enum
{
  GTK_ARG_READABLE	 = G_PARAM_READABLE,
  GTK_ARG_WRITABLE	 = G_PARAM_WRITABLE,
  GTK_ARG_CONSTRUCT	 = G_PARAM_CONSTRUCT,
  GTK_ARG_CONSTRUCT_ONLY = G_PARAM_CONSTRUCT_ONLY,
Owen Taylor's avatar
Owen Taylor committed
232
  GTK_ARG_CHILD_ARG	 = 1 << 4
233 234 235 236
} GtkArgFlags;
#define	GTK_ARG_READWRITE	(GTK_ARG_READABLE | GTK_ARG_WRITABLE)
void	gtk_object_get		(GtkObject	*object,
				 const gchar	*first_property_name,
237
				 ...) G_GNUC_NULL_TERMINATED;
238 239
void	gtk_object_set		(GtkObject	*object,
				 const gchar	*first_property_name,
240
				 ...) G_GNUC_NULL_TERMINATED;
241 242 243 244
void	gtk_object_add_arg_type		(const gchar    *arg_name,
					 GType           arg_type,
					 guint           arg_flags,
					 guint           arg_id);
245

246
#endif /* GTK_DISABLE_DEPRECATED */
Elliot Lee's avatar
Elliot Lee committed
247

248
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
249 250

#endif /* __GTK_OBJECT_H__ */