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.
 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 @Deprecated: Use g_object_new() instead.
 180
 181
 182 <!-- ##### FUNCTION gtk_object_sink ##### -->
 183 <para>
 184 Removes the floating reference from a #GtkObject, if it exists;
 185 otherwise does nothing. See the #GtkObject overview documentation at
 186 the top of the page.
 187 </para>
 188
 189 @object: the object to sink.
 190
 191
 192 <!-- ##### FUNCTION gtk_object_ref ##### -->
 193 <para>
 194 Increases the reference count of the object.
 195 </para>
 196
 197 @object: the object to reference.
 198 @Returns: @object.
 199 @Deprecated: Use g_object_ref() instead.
 200
 201
 202 <!-- ##### FUNCTION gtk_object_unref ##### -->
 203 <para>
 204 Decreases the reference count of an object.  When its reference count drops
 205 to 0, the object is finalized (i.e. its memory is freed).
 206 </para>
 207
 208 @object: the object to dereference.
 209 @Deprecated: Use g_object_unref() instead.
 210
 211
 212 <!-- ##### FUNCTION gtk_object_weakref ##### -->
 213 <para>
 214 Adds a weak reference callback to an object. 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 @Deprecated: Use g_object_weak_ref() instead.
 224
 225
 226 <!-- ##### FUNCTION gtk_object_weakunref ##### -->
 227 <para>
 228 Removes a weak reference callback to an object.
 229 </para>
 230
 231 @object: object stop weakly referencing.
 232 @notify: callback to search for.
 233 @data: data to search for.
 234 @Deprecated: Use g_object_weak_unref() instead.
 235
 236
 237 <!-- ##### FUNCTION gtk_object_destroy ##### -->
 238 <para>
 239 Emits the "destroy" signal notifying all reference holders that they should
 240 release the #GtkObject. See the overview documentation at the top of the
 241 page for more details.
 242 </para>
 243 <para>
 244 The memory for the object itself won't be deleted until
 245 its reference count actually drops to 0; gtk_object_destroy() merely asks
 246 reference holders to release their references, it does not free the object.
 247 </para>
 248
 249 @object: the object to destroy.
 250
 251
 252 <!-- ##### FUNCTION gtk_object_get ##### -->
 253 <para>
 254 Gets properties of an object.
 255 </para>
 256
 257 @object: a #GtkObject.
 258 @first_property_name: name of first property to get the value for.
 259 @Varargs: %NULL-terminated list of name-return location pairs.
 260 @Deprecated: Use g_object_get() instead.
 261
 262
 263 <!-- ##### FUNCTION gtk_object_set ##### -->
 264 <para>
 265 Sets properties on an object.
 266 </para>
 267 <para>
 268 <informalexample>
 269 <programlisting>
 270 void set_box_properties (GtkBox* box)
 271 {
 272   gtk_object_set (GTK_OBJECT (box), "homogeneous", TRUE,
 273                                     "spacing", 8,
 274                                     NULL);
 275 }
 276 </programlisting>
 277 </informalexample>
 278 </para>
 279
 280 @object: a #GtkObject.
 281 @first_property_name: name of the first property to set
 282 @Varargs: the value of the first argument, followed optionally
 283 by more name/value pairs, followed by %NULL.
 284 @Deprecated: Use g_object_set() instead.
 285
 286
 287 <!-- ##### FUNCTION gtk_object_set_data ##### -->
 288 <para>
 289 Each object carries around a table of associations from
 290 strings to pointers.  This function lets you set an association.
 291 </para>
 292 <para>
 293 If the object already had an association with that name,
 294 the old association will be destroyed.
 295 </para>
 296
 297 @object: object containing the associations.
 298 @key: name of the key.
 299 @data: data to associate with that key.
 300 @Deprecated: Use g_object_set_data() instead.
 301
 302
 303 <!-- ##### FUNCTION gtk_object_set_data_full ##### -->
 304 <para>
 305 Like gtk_object_set_data() except it adds notification
 306 for when the association is destroyed, either by
 307 gtk_object_remove_data() or when the object is destroyed.
 308 </para>
 309
 310 @object: object containing the associations.
 311 @key: name of the key.
 312 @data: data to associate with that key.
 313 @destroy: function to call when the association is destroyed.
 314 @Deprecated: Use g_object_set_data_full() instead.
 315
 316
 317 <!-- ##### FUNCTION gtk_object_remove_data ##### -->
 318 <para>
 319 Removes a specified datum from the object's data associations (the object_data).
 320 Subsequent calls to gtk_object_get_data() will return %NULL.
 321 </para>
 322 <para>
 323 If you specified a destroy handler with gtk_object_set_data_full(),
 324 it will be invoked.
 325 </para>
 326
 327 @object: the object maintaining the association.
 328 @key: name of the key for that association.
 329 @Deprecated: Use g_object_set_data() to set the object data to %NULL instead.
 330
 331
 332 <!-- ##### FUNCTION gtk_object_get_data ##### -->
 333 <para>
 334 Get a named field from the object's table of associations (the object_data).
 335 </para>
 336
 337 @object: the object maintaining the associations.
 338 @key: name of the key for that association.
 339 @Returns: the data if found, or %NULL if no such data exists.
 340 @Deprecated: Use g_object_get_data() instead.
 341
 342
 343 <!-- ##### FUNCTION gtk_object_remove_no_notify ##### -->
 344 <para>
 345 Remove a specified datum from the object's data associations (the object_data),
 346 without invoking the association's destroy handler.
 347 </para>
 348 <para>
 349 Just like gtk_object_remove_data() except that any destroy handler
 350 will be ignored.
 351 Therefore this only affects data set using gtk_object_set_data_full().
 352 </para>
 353
 354 @object: the object maintaining the association.
 355 @key: name of the key for that association.
 356 @Deprecated: Use g_object_steal_data() instead.
 357
 358
 359 <!-- ##### FUNCTION gtk_object_set_user_data ##### -->
 360 <para>
 361 For convenience, every object offers a generic user data
 362 pointer.  This function sets it.
 363 </para>
 364 <para>
 365 This function is equivalent to
 366 <literal>gtk_object_set_data (object, "user_data", data)</literal>.
 367 </para>
 368
 369 @object: the object whose user data should be set.
 370 @data: the new value for the user data.
 371 @Deprecated: Use g_object_set_data() instead.
 372
 373
 374 <!-- ##### FUNCTION gtk_object_get_user_data ##### -->
 375 <para>
 376 Get the object's user data pointer.
 377 </para>
 378 <para>
 379 This is intended to be a pointer for your convenience in
 380 writing applications.
 381 </para>
 382
 383 @object: the object.
 384 @Returns: the user data field for object.
 385 @Deprecated: Use g_object_get_data() instead.
 386
 387
 388 <!-- ##### FUNCTION gtk_object_add_arg_type ##### -->
 389 <para>
 390 Deprecated in favor of the #GObject property system including #GParamSpec.
 391 Add a new type of argument to an object class.
 392 Usually this is called when registering a new type of object.
 393 </para>
 394
 395 @arg_name: fully qualify object name, for example GtkObject::user_data.
 396 @arg_type: type of the argument.
 397 @arg_flags: bitwise-OR of the #GtkArgFlags enum.  (Whether the argument is
 398 settable or gettable, whether it is set when the object is constructed.)
 399 @arg_id: an internal number, passed in from here to the "set_arg" and
 400 "get_arg" handlers of the object.
 401
 402
 403 <!-- ##### FUNCTION gtk_object_set_data_by_id ##### -->
 404 <para>
 405 Just like gtk_object_set_data() except that it takes
 406 a #GQuark instead of a string, so it is slightly faster.
 407 </para>
 408 <para>
 409 Use gtk_object_data_try_key() and gtk_object_data_force_id()
 410 to get an id from a string.
 411 </para>
 412
 413 @object: object containing the associations.
 414 @data_id: quark of the key.
 415 @data: data to associate with that key.
 416 @Deprecated: Use g_object_set_qdata() instead.
 417
 418
 419 <!-- ##### FUNCTION gtk_object_set_data_by_id_full ##### -->
 420 <para>
 421 Just like gtk_object_set_data_full() except that it takes
 422 a #GQuark instead of a string, so it is slightly faster.
 423 </para>
 424 <para>
 425 Use gtk_object_data_try_key() and gtk_object_data_force_id()
 426 to get an id from a string.
 427 </para>
 428
 429 @object: object containing the associations.
 430 @data_id: quark of the key.
 431 @data: data to associate with that key.
 432 @destroy: function to call when the association is destroyed.
 433 @Deprecated: Use g_object_set_qdata_full() instead.
 434
 435
 436 <!-- ##### FUNCTION gtk_object_get_data_by_id ##### -->
 437 <para>
 438 Just like gtk_object_get_data() except that it takes
 439 a #GQuark instead of a string, so it is slightly faster.
 440 </para>
 441 <para>
 442 Use gtk_object_data_try_key() and gtk_object_data_force_id()
 443 to get an id from a string.
 444 </para>
 445
 446 @object: object containing the associations.
 447 @data_id: quark of the key.
 448 @Returns: the data if found, or %NULL if no such data exists.
 449 @Deprecated: Use g_object_get_qdata() instead.
 450
 451
 452 <!-- ##### FUNCTION gtk_object_remove_data_by_id ##### -->
 453 <para>
 454 Just like gtk_object_remove_data() except that it takes
 455 a #GQuark instead of a string, so it is slightly faster.
 456 </para>
 457 <para>
 458 Remove a specified datum from the object's data associations.
 459 Subsequent calls to gtk_object_get_data() will return %NULL.
 460 </para>
 461 <para>
 462 Use gtk_object_data_try_key() and gtk_object_data_force_id()
 463 to get an id from a string.
 464 </para>
 465
 466 @object: object containing the associations.
 467 @data_id: quark of the key.
 468 @Deprecated: Use g_object_set_qdata() with data of %NULL instead.
 469
 470
 471 <!-- ##### FUNCTION gtk_object_remove_no_notify_by_id ##### -->
 472 <para>
 473 Just like gtk_object_remove_no_notify() except that it takes
 474 a #GQuark instead of a string, so it is slightly faster.
 475 </para>
 476 <para>
 477 Use gtk_object_data_try_key() and gtk_object_data_force_id()
 478 to get an id from a string.
 479 </para>
 480
 481 @object: object containing the associations.
 482 @key_id: quark of the key.
 483 @Deprecated: Use g_object_steal_qdata() instead.
 484
 485
 486 <!-- ##### MACRO gtk_object_data_try_key ##### -->
 487 <para>
 488 Useless deprecated macro. Ignore it.
 489 </para>
 490
 491
 492
 493 <!-- ##### MACRO gtk_object_data_force_id ##### -->
 494 <para>
 495 Useless deprecated macro. Ignore it.
 496 </para>
 497
 498
 499
 500 <!-- ##### SIGNAL GtkObject::destroy ##### -->
 501 <para>
 502 Signals that all holders of a reference to the #GtkObject should release
 503 the reference that they hold. May result in finalization of the object
 504 if all references are released.
 505 </para>
 506
 507 @object: the object which received the signal.
 508
 509 <!-- ##### ARG GtkObject:user-data ##### -->
 510 <para>
 511
 512 </para>
 513