Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkobject.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkObject
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The base class of the GTK+ type hierarchy.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <refsect2>
   9 <title>Description</title>
  10 <para>
  11 #GtkObject is the base class for all widgets, and for a few
  12 non-widget objects such as #GtkAdjustment. #GtkObject predates
  13 #GObject; non-widgets that derive from #GtkObject rather than
  14 #GObject do so for backward compatibility reasons.
  15 </para>
  16 <para>
  17 The most interesting difference between #GtkObject and #GObject is the
  18 "floating" reference count. A #GObject is created with a reference count of 1,
  19 owned by the creator of the #GObject. (The owner of a reference is the code
  20 section that has the right to call g_object_unref() in order to remove that
  21 reference.)  A #GtkObject is created with a reference count of 1 also, but it
  22 isn't owned by anyone; calling g_object_unref() on the newly-created #GtkObject
  23 is incorrect. Instead, the initial reference count of a #GtkObject is "floating".
  24 The floating reference can be removed by anyone at any time, by calling
  25 gtk_object_sink(). gtk_object_sink() does nothing if an object is already
  26 sunk (has no floating reference).
  27 </para>
  28 <para>
  29 When you add a widget to its parent container, the parent container
  30 will do this:
  31 <informalexample><programlisting>
  32   g_object_ref (G_OBJECT (child_widget));
  33   gtk_object_sink (GTK_OBJECT (child_widget));
  34 </programlisting></informalexample>
  35 This means that the container now owns a reference to the child widget (since
  36 it called g_object_ref()), and the child widget has no floating reference.
  37 </para>
  38 <para>
  39 The purpose of the floating reference is to keep the child widget alive
  40 until you add it to a parent container:
  41 <informalexample><programlisting>
  42    button = gtk_button_new (<!-- -->);
  43    /* button has one floating reference to keep it alive */
  44    gtk_container_add (GTK_CONTAINER (container), button);
  45    /* button has one non-floating reference owned by the container */
  46 </programlisting></informalexample>
  47 </para>
  48 <para>
  49 #GtkWindow is a special case, because GTK+ itself will ref/sink it on creation.
  50 That is, after calling gtk_window_new(), the #GtkWindow will have one
  51 reference which is owned by GTK+, and no floating references.
  52 </para>
  53
  54 <para>
  55 One more factor comes into play: the "destroy" signal, emitted by the
  56 gtk_object_destroy() method. The "destroy" signal asks all code owning a
  57 reference to an object to release said reference. So, for example, if you call
  58 gtk_object_destroy() on a #GtkWindow, GTK+ will release the reference count that
  59 it owns; if you call gtk_object_destroy() on a #GtkButton, then the button will
  60 be removed from its parent container and the parent container will release its
  61 reference to the button.  Because these references are released, calling
  62 gtk_object_destroy() should result in freeing all memory associated with an
  63 object, unless some buggy code fails to release its references in response to
  64 the "destroy" signal. Freeing memory (referred to as
  65 <firstterm>finalization</firstterm> only happens if the reference count reaches
  66 zero.
  67 </para>
  68
  69 <para>
  70 Some simple rules for handling #GtkObject:
  71 <itemizedlist>
  72 <listitem><para>
  73 Never call g_object_unref() unless you have previously called g_object_ref(),
  74 even if you created the #GtkObject. (Note: this is <emphasis>not</emphasis>
  75 true for #GObject; for #GObject, the creator of the object owns a reference.)
  76 </para></listitem>
  77 <listitem><para>
  78 Call gtk_object_destroy() to get rid of most objects in most cases.
  79 In particular, widgets are almost always destroyed in this way.
  80 </para></listitem>
  81 <listitem><para> Because of the floating reference count, you don't need to
  82 worry about reference counting for widgets and toplevel windows, unless you
  83 explicitly call g_object_ref() yourself.</para></listitem>
  84 </itemizedlist>
  85 </para>
  86
  87 </refsect2>
  88
  89 <!-- ##### SECTION See_Also ##### -->
  90 <para>
  91 #GObject
  92 </para>
  93
  94 <!-- ##### STRUCT GtkObject ##### -->
  95 <para>
  96 The object itself.  You should never use these members directly -
  97  use the accessing macros instead.
  98 </para>
  99
 100
 101 <!-- ##### MACRO GTK_OBJECT_TYPE ##### -->
 102 <para>
 103 Gets the type of an object.
 104 </para>
 105
 106 @object: a #GtkObject.
 107
 108
 109 <!-- ##### MACRO GTK_OBJECT_TYPE_NAME ##### -->
 110 <para>
 111 Gets the name of an objects type.
 112 </para>
 113
 114 @object: a #GtkObject.
 115
 116
 117 <!-- ##### ENUM GtkObjectFlags ##### -->
 118 <para>
 119 Tells about the state of the object.
 120 </para>
 121
 122 @GTK_IN_DESTRUCTION: the object is currently being destroyed. This is used
 123   internally by GTK+ to prevent reinvokations during destruction.
 124 @GTK_FLOATING: the object is orphaned.  Objects that take strong hold of an
 125   object may gtk_object_sink() it, after obtaining their own references, if
 126   they believe they are nearly primary ownership of the object.
 127 GTK_CONNECTED: signals are connected to this object.
 128 @GTK_RESERVED_1: reserved for future use
 129 @GTK_RESERVED_2: reserved for future use
 130
 131 <!-- ##### MACRO GTK_OBJECT_FLAGS ##### -->
 132 <para>
 133 Gets the #GtkObjectFlags for an object without directly
 134 accessing its members.
 135 </para>
 136
 137 @obj: the object whose flags are returned.
 138
 139
 140 <!-- ##### MACRO GTK_OBJECT_FLOATING ##### -->
 141 <para>
 142 Evaluates to %TRUE if the object still has its floating reference count.
 143 See the overview documentation for #GtkObject.
 144 </para>
 145
 146 @obj: the object to examine.
 147
 148
 149 <!-- ##### ENUM GtkArgFlags ##### -->
 150 <para>
 151 Possible flags indicating how an argument should be treated.
 152 Deprecated in favor of #GParamSpec features.
 153 </para>
 154
 155 @GTK_ARG_READABLE: the argument is readable. (i.e. can be queried)
 156 @GTK_ARG_WRITABLE: the argument is writable. (i.e. settable)
 157 @GTK_ARG_CONSTRUCT: the argument needs construction.
 158 @GTK_ARG_CONSTRUCT_ONLY: the argument needs construction (and will
 159 be set once during object creation), but is otherwise cannot be
 160 set.  Hence this flag is not allowed with #GTK_ARG_WRITABLE,
 161 and is redundant with #GTK_ARG_CONSTRUCT.
 162 @GTK_ARG_CHILD_ARG: an argument type that applies to (and may be different for)
 163 each child.  Used by #GtkContainer.
 164
 165 <!-- ##### FUNCTION gtk_object_new ##### -->
 166 <para>
 167 Constructs an object given its arguments, enumerated in the call to the
 168 function. Deprecated in favor of g_object_new().
 169 </para>
 170
 171 @type: the type identifying this object.  Returned by gtk_type_unique()
 172 (although for a properly-written object it should be accessible through
 173 a #GTK_TYPE_FOO macro.)
 174 @first_property_name: name of the first property to set when constructing
 175    the object.
 176 @Varargs: the first argument's value, followed by any number of
 177 name/argument-value pairs, terminated with %NULL.
 178 @Returns: the new #GtkObject.
 179
 180
 181 <!-- ##### FUNCTION gtk_object_sink ##### -->
 182 <para>
 183 Removes the floating reference from a #GtkObject, if it exists;
 184 otherwise does nothing. See the #GtkObject overview documentation at
 185 the top of the page.
 186 </para>
 187
 188 @object: the object to sink.
 189
 190
 191 <!-- ##### FUNCTION gtk_object_ref ##### -->
 192 <para>
 193 Increases the reference count of the object.
 194 Deprecated in favor of g_object_ref().
 195 </para>
 196
 197 @object: the object to reference.
 198 @Returns: @object.
 199
 200
 201 <!-- ##### FUNCTION gtk_object_unref ##### -->
 202 <para>
 203 Decreases the reference count of an object.  When its reference count drops
 204 to 0, the object is finalized (i.e. its memory is freed).  Deprecated in
 205 favor of g_object_unref().
 206 </para>
 207
 208 @object: the object to dereference.
 209
 210
 211 <!-- ##### FUNCTION gtk_object_weakref ##### -->
 212 <para>
 213 Adds a weak reference callback to an object. Deprecated in favor of
 214 g_object_weak_ref(). Weak references are used for notification when an object is
 215 finalized. They are called "weak references" because they allow you to safely
 216 hold a pointer to an object without calling g_object_ref() (g_object_ref() adds
 217 a strong reference, that is, forces the object to stay alive).
 218 </para>
 219
 220 @object: object to weakly reference.
 221 @notify: callback to invoke before the object is freed.
 222 @data: extra data to pass to #notify.
 223
 224
 225 <!-- ##### FUNCTION gtk_object_weakunref ##### -->
 226 <para>
 227 Removes a weak reference callback to an object.
 228 </para>
 229
 230 @object: object stop weakly referencing.
 231 @notify: callback to search for.
 232 @data: data to search for.
 233
 234
 235 <!-- ##### FUNCTION gtk_object_destroy ##### -->
 236 <para>
 237 Emits the "destroy" signal notifying all reference holders that they should
 238 release the #GtkObject. See the overview documentation at the top of the
 239 page for more details.
 240 </para>
 241 <para>
 242 The memory for the object itself won't be deleted until
 243 its reference count actually drops to 0; gtk_object_destroy() merely asks
 244 reference holders to release their references, it does not free the object.
 245 </para>
 246
 247 @object: the object to destroy.
 248
 249
 250 <!-- ##### FUNCTION gtk_object_get ##### -->
 251 <para>
 252 Gets properties of an object. Deprecated in favor of g_object_get().
 253 </para>
 254
 255 @object: a #GtkObject.
 256 @first_property_name: name of first property to get the value for.
 257 @Varargs: %NULL-terminated list of name-return location pairs.
 258
 259
 260 <!-- ##### FUNCTION gtk_object_set ##### -->
 261 <para>
 262 Sets properties on an object. Deprecated in favor of g_object_set().
 263 </para>
 264 <para>
 265 <informalexample>
 266 <programlisting>
 267 void set_box_properties (GtkBox* box)
 268 {
 269   gtk_object_set (GTK_OBJECT (box), "homogeneous", TRUE,
 270                                     "spacing", 8,
 271                                     NULL);
 272 }
 273 </programlisting>
 274 </informalexample>
 275 </para>
 276
 277 @object: a #GtkObject.
 278 @first_property_name: name of the first property to set
 279 @Varargs: the value of the first argument, followed optionally
 280 by more name/value pairs, followed by %NULL.
 281
 282
 283 <!-- ##### FUNCTION gtk_object_set_data ##### -->
 284 <para>
 285 Deprecated in favor of g_object_set_data().
 286 Each object carries around a table of associations from
 287 strings to pointers.  This function lets you set an association.
 288 </para>
 289 <para>
 290 If the object already had an association with that name,
 291 the old association will be destroyed.
 292 </para>
 293
 294 @object: object containing the associations.
 295 @key: name of the key.
 296 @data: data to associate with that key.
 297
 298
 299 <!-- ##### FUNCTION gtk_object_set_data_full ##### -->
 300 <para>
 301 Deprecated in favor of g_object_set_data_full().
 302 Like gtk_object_set_data() except it adds notification
 303 for when the association is destroyed, either by
 304 gtk_object_remove_data() or when the object is destroyed.
 305 </para>
 306
 307 @object: object containing the associations.
 308 @key: name of the key.
 309 @data: data to associate with that key.
 310 @destroy: function to call when the association is destroyed.
 311
 312
 313 <!-- ##### FUNCTION gtk_object_remove_data ##### -->
 314 <para>
 315 Deprecated in favor of setting object data to %NULL using g_object_set_data().
 316 Removes a specified datum from the object's data associations (the object_data).
 317 Subsequent calls to gtk_object_get_data() will return %NULL.
 318 </para>
 319 <para>
 320 If you specified a destroy handler with gtk_object_set_data_full(),
 321 it will be invoked.
 322 </para>
 323
 324 @object: the object maintaining the association.
 325 @key: name of the key for that association.
 326
 327
 328 <!-- ##### FUNCTION gtk_object_get_data ##### -->
 329 <para>
 330 Deprecated in favor of g_object_get_data().
 331 Get a named field from the object's table of associations (the object_data).
 332 </para>
 333
 334 @object: the object maintaining the associations.
 335 @key: name of the key for that association.
 336 @Returns: the data if found, or %NULL if no such data exists.
 337
 338
 339 <!-- ##### FUNCTION gtk_object_remove_no_notify ##### -->
 340 <para>
 341 Deprecated in favor of g_object_steal_data().
 342 Remove a specified datum from the object's data associations (the object_data),
 343 without invoking the association's destroy handler.
 344 </para>
 345 <para>
 346 Just like gtk_object_remove_data() except that any destroy handler
 347 will be ignored.
 348 Therefore this only affects data set using gtk_object_set_data_full().
 349 </para>
 350
 351 @object: the object maintaining the association.
 352 @key: name of the key for that association.
 353
 354
 355 <!-- ##### FUNCTION gtk_object_set_user_data ##### -->
 356 <para>
 357 Deprecated in favor of g_object_set_data().
 358 For convenience, every object offers a generic user data
 359 pointer.  This function sets it.
 360 </para>
 361 <para>
 362 This function is equivalent to
 363 <literal>gtk_object_set_data (object, "user_data", data)</literal>.
 364 </para>
 365
 366 @object: the object whose user data should be set.
 367 @data: the new value for the user data.
 368
 369
 370 <!-- ##### FUNCTION gtk_object_get_user_data ##### -->
 371 <para>
 372 Deprecated in favor of g_object_get_data().
 373 Get the object's user data pointer.
 374 </para>
 375 <para>
 376 This is intended to be a pointer for your convenience in
 377 writing applications.
 378 </para>
 379
 380 @object: the object.
 381 @Returns: the user data field for object.
 382
 383
 384 <!-- ##### FUNCTION gtk_object_add_arg_type ##### -->
 385 <para>
 386 Deprecated in favor of the #GObject property system including #GParamSpec.
 387 Add a new type of argument to an object class.
 388 Usually this is called when registering a new type of object.
 389 </para>
 390
 391 @arg_name: fully qualify object name, for example GtkObject::user_data.
 392 @arg_type: type of the argument.
 393 @arg_flags: bitwise-OR of the #GtkArgFlags enum.  (Whether the argument is
 394 settable or gettable, whether it is set when the object is constructed.)
 395 @arg_id: an internal number, passed in from here to the "set_arg" and
 396 "get_arg" handlers of the object.
 397
 398
 399 <!-- ##### FUNCTION gtk_object_set_data_by_id ##### -->
 400 <para>
 401 Deprecated in favor of g_object_set_qdata().
 402 Just like gtk_object_set_data() except that it takes
 403 a #GQuark instead of a string, so it is slightly faster.
 404 </para>
 405 <para>
 406 Use gtk_object_data_try_key() and gtk_object_data_force_id()
 407 to get an id from a string.
 408 </para>
 409
 410 @object: object containing the associations.
 411 @data_id: quark of the key.
 412 @data: data to associate with that key.
 413
 414
 415 <!-- ##### FUNCTION gtk_object_set_data_by_id_full ##### -->
 416 <para>
 417 Deprecated in favor of g_object_set_qdata_full().
 418 Just like gtk_object_set_data_full() except that it takes
 419 a #GQuark instead of a string, so it is slightly faster.
 420 </para>
 421 <para>
 422 Use gtk_object_data_try_key() and gtk_object_data_force_id()
 423 to get an id from a string.
 424 </para>
 425
 426 @object: object containing the associations.
 427 @data_id: quark of the key.
 428 @data: data to associate with that key.
 429 @destroy: function to call when the association is destroyed.
 430
 431
 432 <!-- ##### FUNCTION gtk_object_get_data_by_id ##### -->
 433 <para>
 434 Deprecated in favor of g_object_get_qdata().
 435 Just like gtk_object_get_data() except that it takes
 436 a #GQuark instead of a string, so it is slightly faster.
 437 </para>
 438 <para>
 439 Use gtk_object_data_try_key() and gtk_object_data_force_id()
 440 to get an id from a string.
 441 </para>
 442
 443 @object: object containing the associations.
 444 @data_id: quark of the key.
 445 @Returns: the data if found, or %NULL if no such data exists.
 446
 447
 448 <!-- ##### FUNCTION gtk_object_remove_data_by_id ##### -->
 449 <para>
 450 Deprecated in favor of g_object_set_qdata() called with data of %NULL.
 451 Just like gtk_object_remove_data() except that it takes
 452 a #GQuark instead of a string, so it is slightly faster.
 453 </para>
 454 <para>
 455 Remove a specified datum from the object's data associations.
 456 Subsequent calls to gtk_object_get_data() will return %NULL.
 457 </para>
 458 <para>
 459 Use gtk_object_data_try_key() and gtk_object_data_force_id()
 460 to get an id from a string.
 461 </para>
 462
 463 @object: object containing the associations.
 464 @data_id: quark of the key.
 465
 466
 467 <!-- ##### FUNCTION gtk_object_remove_no_notify_by_id ##### -->
 468 <para>
 469 Deprecated in favor of g_object_steal_qdata().
 470 Just like gtk_object_remove_no_notify() except that it takes
 471 a #GQuark instead of a string, so it is slightly faster.
 472 </para>
 473 <para>
 474 Use gtk_object_data_try_key() and gtk_object_data_force_id()
 475 to get an id from a string.
 476 </para>
 477
 478 @object: object containing the associations.
 479 @key_id: quark of the key.
 480 <!-- # Unused Parameters # -->
 481 @data_id:
 482
 483
 484 <!-- ##### MACRO gtk_object_data_try_key ##### -->
 485 <para>
 486 Useless deprecated macro. Ignore it.
 487 </para>
 488
 489
 490
 491 <!-- ##### MACRO gtk_object_data_force_id ##### -->
 492 <para>
 493 Useless deprecated macro. Ignore it.
 494 </para>
 495
 496
 497
 498 <!-- ##### SIGNAL GtkObject::destroy ##### -->
 499 <para>
 500 Signals that all holders of a reference to the #GtkObject should release
 501 the reference that they hold. May result in finalization of the object
 502 if all references are released.
 503 </para>
 504
 505 @object: the object which received the signal.
 506
 507 <!-- ##### ARG GtkObject:user-data ##### -->
 508 <para>
 509
 510 </para>
 511