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

   1 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Long_Description ##### -->
   2 <para>
   3 The #GtkData object is a very simple object intended to be used as a base
   4 class for objects which contain data (i.e. the 'Model' in the object-oriented
   5 Model/View/Controller framework).
   6 </para>
   7 <para>
   8 Currently it is not very useful since all it provides is a "disconnect" signal.
   9 This signal could be emitted by a #GtkData subclass to notify any 'Views'
  10 that they should disconnect from the #GtkData (the 'Model'), possibly just
  11 before the #GtkData is destroyed.
  12 </para>
  13
  14
  15 <!-- ##### SECTION ./tmpl/gtkdata.sgml:See_Also ##### -->
  16 <para>
  17
  18 </para>
  19
  20
  21 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Short_Description ##### -->
  22 abstract base class for objects containing data.
  23
  24
  25 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Title ##### -->
  26 GtkData
  27
  28
  29 <!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
  30 Debugging
  31
  32
  33 <!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Title ##### -->
  34 gtkenums.sgml
  35
  36
  37 <!-- ##### SECTION ./tmpl/gtkimcontextsimple.sgml:Title ##### -->
  38 GtkIMContextSimple
  39
  40
  41 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
  42 <refsect2>
  43 <title>What are Signal Marshallers?</title>
  44 <para>
  45 Marshals are functions which all have the same prototype:
  46 they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
  47 and an array of argument values.
  48 The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
  49 </para>
  50 <para>
  51 They then call a native function:  the GtkObject is the first
  52 parameter passed in.  The arguments are passed in the native
  53 calling convention:  chars, shorts, ints, longs may be packed
  54 on the stack, or tucked in registers:  it doesn't matter
  55 because the same calling convention will be generated
  56 inside the gtkmarshal code as is expected where you define
  57 your handlers.
  58 </para>
  59 <para>
  60 So the function named:
  61 <programlisting>
  62 gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
  63 </programlisting>
  64 will call the #GtkSignalFunc assuming it was a function with signature:
  65 <programlisting>
  66 gboolean sigfunc(gpointer,gint,gint,guint);
  67 </programlisting>
  68 </para>
  69 </refsect2>
  70 <refsect2>
  71 <title>Writing Custom Marshals</title>
  72 <para>
  73 Marshals are primarily used as arguments to gtk_signal_new().
  74 Sometimes, you may find that a marshaller you need isn't available
  75 in the standard list.  Then you have to write your own.
  76 </para>
  77 <para>
  78 If you wish to define a signal with a new type of argument list.
  79 Suppose you want 2 pointers and 2 integers.
  80 You would write:
  81 <programlisting>
  82 typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
  83                         gpointer, gpointer, gint, gint
  84 );
  85
  86 void marshal_INT__POINTER_POINTER_INT_INT(GtkObject*    object,
  87                                            GtkSignalFunc func,
  88                                            gpointer      func_data,
  89                                            GtkArg*       args)
  90 {
  91         GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
  92         gint* return_val;
  93         return_val = GTK_RETLOC_INT(args[4]);
  94         rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
  95         *return_val = (*rfunc)(object,
  96                                GTK_VALUE_POINTER(args[0]),
  97                                GTK_VALUE_POINTER(args[1]),
  98                                GTK_VALUE_INT(args[2]),
  99                                GTK_VALUE_INT(args[3]),
 100                                func_data);
 101 }
 102 </programlisting>
 103 </para>
 104 </refsect2>
 105
 106
 107 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
 108 <para>
 109 <variablelist>
 110
 111 <varlistentry>
 112 <term>#GtkSignal</term>
 113 <listitem><para>The signal handling functions (of which marshallers are
 114 really an implementation detail).</para></listitem>
 115 </varlistentry>
 116
 117 </variablelist>
 118 </para>
 119
 120
 121 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Short_Description ##### -->
 122 Functions to adapt C structures to native calling convention.
 123
 124
 125 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
 126 Signal Marshallers
 127
 128
 129 <!-- ##### SECTION ./tmpl/gtkprivate.sgml:Title ##### -->
 130 Private Information
 131
 132
 133 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Long_Description ##### -->
 134 <para>
 135
 136 </para>
 137
 138
 139 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:See_Also ##### -->
 140 <para>
 141
 142 </para>
 143
 144
 145 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Short_Description ##### -->
 146
 147
 148
 149 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Title ##### -->
 150 GtkModelSimple
 151
 152
 153 <!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
 154 <para>
 155 A macro to check whether a child widget of the CList
 156 has the focus.
 157 </para>
 158
 159 @clist: The #GtkCList widget to check.
 160
 161 <!-- ##### MACRO GTK_ICON_SIZE_BUTTON ##### -->
 162 <para>
 163
 164 </para>
 165
 166
 167 <!-- ##### MACRO GTK_ICON_SIZE_DIALOG ##### -->
 168 <para>
 169
 170 </para>
 171
 172
 173 <!-- ##### MACRO GTK_ICON_SIZE_LARGE_TOOLBAR ##### -->
 174 <para>
 175
 176 </para>
 177
 178
 179 <!-- ##### MACRO GTK_ICON_SIZE_MENU ##### -->
 180 <para>
 181
 182 </para>
 183
 184
 185 <!-- ##### MACRO GTK_ICON_SIZE_SMALL_TOOLBAR ##### -->
 186 <para>
 187
 188 </para>
 189
 190
 191 <!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
 192 <para>
 193 Test whether a GtkObject's arguments have been prepared.
 194 </para>
 195
 196 @obj: the object to examine.
 197
 198 <!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
 199 <para>
 200 Get the number of signals defined by this object.
 201 </para>
 202
 203 @obj: the object to query.
 204
 205 <!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
 206 <para>
 207 Get the array of signals defined for this object.
 208 </para>
 209
 210 @obj: the object to fetch the signals from.
 211
 212 <!-- ##### MACRO GTK_TREE_SELECTION ##### -->
 213 <para>
 214 A macro that returns a GList that contains the selection of the root tree of @obj.
 215 </para>
 216
 217 @obj: A pointer to the #GtkTree. @obj will accept any pointer, but it the pointer does not point to a #GtkTree, the results are undefined.
 218
 219 <!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
 220 <para>
 221 The first "flat" (no struct) enumerated type value.
 222 </para>
 223
 224
 225 <!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
 226 <para>
 227 The last "flat" (no struct) enumerated type value.
 228 </para>
 229
 230
 231 <!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
 232 <para>
 233 Hide the name of gtk_identifier_get_type
 234 </para>
 235
 236
 237 <!-- ##### MACRO GTK_TYPE_MAKE ##### -->
 238 <para>
 239 Combine a fundemantal type and a sequence number to create a gtk type.
 240 </para>
 241
 242 @parent_t:
 243 @seqno:
 244
 245 <!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
 246 <para>
 247 No idea.
 248 </para>
 249
 250
 251 <!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
 252 <para>
 253 Convert a gtk type into its sequence number
 254 </para>
 255
 256 @type:
 257
 258 <!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
 259 <para>
 260 The first structured enumerated type value.
 261 </para>
 262
 263
 264 <!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
 265 <para>
 266 The last structured enumerated type value.
 267 </para>
 268
 269
 270 <!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
 271 <para>
 272
 273 </para>
 274
 275
 276 <!-- ##### MACRO GTK_VALUE_ARGS ##### -->
 277 <para>
 278 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
 279 </para>
 280
 281 @a:
 282
 283 <!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
 284 <para>
 285 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
 286 </para>
 287
 288 @a:
 289
 290 <!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
 291 <para>
 292 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
 293 </para>
 294
 295 @a:
 296
 297 <!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
 298 <para>
 299 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
 300 </para>
 301
 302 @a:
 303
 304 <!-- ##### ARG GtkAccelLabel:accel-width ##### -->
 305 <para>
 306
 307 </para>
 308
 309
 310 <!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
 311 <para>
 312
 313 </para>
 314
 315
 316 <!-- ##### STRUCT GtkData ##### -->
 317 <para>
 318 The #GtkData-struct struct contains no public fields.
 319 </para>
 320
 321
 322 <!-- ##### SIGNAL GtkData::disconnect ##### -->
 323 <para>
 324 Emitted to notify any views on the #GtkData object to disconnect from it,
 325 possibly because the #GtkData object is about to be destroyed.
 326 </para>
 327
 328 @data: the object which received the signal.
 329
 330 <!-- ##### SIGNAL GtkEditable::activate ##### -->
 331 <para>
 332 Indicates that the user has activated the widget
 333 in some fashion. Generally, this will be done
 334 with a keystroke. (The default binding for this
 335 action is Return for #GtkEntry and
 336 Control-Return for #GtkText.)
 337 </para>
 338
 339 @editable: the object which received the signal.
 340
 341 <!-- ##### SIGNAL GtkEditable::changed ##### -->
 342 <para>
 343 Indicates that the user has changed the contents
 344 of the widget.
 345 </para>
 346
 347 @editable: the object which received the signal.
 348
 349 <!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
 350 <para>
 351 An action signal. Causes the characters in the current selection to
 352 be copied to the clipboard.
 353 </para>
 354
 355 @editable: the object which received the signal.
 356
 357 <!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
 358 <para>
 359 An action signal. Causes the characters in the current
 360 selection to be copied to the clipboard and then deleted from
 361 the widget.
 362 </para>
 363
 364 @editable: the object which received the signal.
 365
 366 <!-- ##### SIGNAL GtkEditable::delete-text ##### -->
 367 <para>
 368 This signal is emitted when text is deleted from
 369 the widget by the user. The default handler for
 370 this signal will normally be responsible for inserting
 371 the text, so by connecting to this signal and then
 372 stopping the signal with gtk_signal_emit_stop(), it
 373 is possible to modify the inserted text, or prevent
 374 it from being inserted entirely. The @start_pos
 375 and @end_pos parameters are interpreted as for
 376 gtk_editable_delete_text()
 377 </para>
 378
 379 @editable: the object which received the signal.
 380 @start_pos: the starting position.
 381 @end_pos: the end position.
 382
 383 <!-- ##### SIGNAL GtkEditable::insert-text ##### -->
 384 <para>
 385 This signal is emitted when text is inserted into
 386 the widget by the user. The default handler for
 387 this signal will normally be responsible for inserting
 388 the text, so by connecting to this signal and then
 389 stopping the signal with gtk_signal_emit_stop(), it
 390 is possible to modify the inserted text, or prevent
 391 it from being inserted entirely.
 392 </para>
 393
 394 @editable: the object which received the signal.
 395 @new_text: the new text to insert.
 396 @new_text_length: the length of the new text.
 397 @position: the position at which to insert the new text.
 398            this is an in-out paramter. After the signal
 399            emission is finished, it should point after
 400            the newly inserted text.
 401
 402 <!-- ##### SIGNAL GtkEditable::kill-char ##### -->
 403 <para>
 404 An action signal. Delete a single character.
 405 </para>
 406
 407 @editable: the object which received the signal.
 408 @direction: the direction in which to delete. Positive
 409    indicates forward deletion, negative, backwards deletion.
 410
 411 <!-- ##### SIGNAL GtkEditable::kill-line ##### -->
 412 <para>
 413 An action signal. Delete a single line.
 414 </para>
 415
 416 @editable: the object which received the signal.
 417 @direction: the direction in which to delete. Positive
 418    indicates forward deletion, negative, backwards deletion.
 419
 420 <!-- ##### SIGNAL GtkEditable::kill-word ##### -->
 421 <para>
 422 An action signal. Delete a single word.
 423 </para>
 424
 425 @editable: the object which received the signal.
 426 @direction: the direction in which to delete. Positive
 427    indicates forward deletion, negative, backwards deletion.
 428
 429 <!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
 430 <para>
 431 An action signal. Move the cursor position.
 432 </para>
 433
 434 @editable: the object which received the signal.
 435 @x: horizontal distance to move the cursor.
 436 @y: vertical distance to move the cursor.
 437
 438 <!-- ##### SIGNAL GtkEditable::move-page ##### -->
 439 <para>
 440 An action signal. Move the cursor by pages.
 441 </para>
 442
 443 @editable: the object which received the signal.
 444 @x: Number of pages to move the cursor horizontally.
 445 @y: Number of pages to move the cursor vertically.
 446
 447 <!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
 448 <para>
 449 An action signal. Move the cursor to the given column.
 450 </para>
 451
 452 @editable: the object which received the signal.
 453 @column: the column to move to. (A negative value indicates
 454          the last column)
 455
 456 <!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
 457 <para>
 458 An action signal. Move the cursor to the given row.
 459 </para>
 460
 461 @editable: the object which received the signal.
 462 @row: the row to move to. (A negative value indicates
 463       the last row)
 464
 465 <!-- ##### SIGNAL GtkEditable::move-word ##### -->
 466 <para>
 467 An action signal. Move the cursor by words.
 468 </para>
 469
 470 @editable: the object which received the signal.
 471 @num_words: The number of words to move the
 472 cursor. (Can be negative).
 473
 474 <!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
 475 <para>
 476 An action signal. Causes the contents of the clipboard to
 477 be pasted into the editable widget at the current cursor
 478 position.
 479 </para>
 480
 481 @editable: the object which received the signal.
 482
 483 <!-- ##### SIGNAL GtkEditable::set-editable ##### -->
 484 <para>
 485 Determines if the user can edit the text in the editable
 486 widget or not. This is meant to be overriden by
 487 child classes and should not generally useful to
 488 applications.
 489 </para>
 490
 491 @editable: the object which received the signal.
 492 @is_editable: %TRUE if the user is allowed to edit the text
 493   in the widget.
 494
 495 <!-- ##### ARG GtkEditable:editable ##### -->
 496 <para>
 497 A boolean indicating whether the widget is editable by
 498 the user.
 499 </para>
 500
 501
 502 <!-- ##### ARG GtkEditable:text-position ##### -->
 503 <para>
 504 The position of the cursor.
 505 </para>
 506
 507
 508 <!-- ##### USER_FUNCTION GtkEmissionHook ##### -->
 509 <para>
 510 A simple function pointer to get invoked when the
 511 signal is emitted.  This allows you tie a hook to the signal type,
 512 so that it will trap all emissions of that signal, from any object.
 513 </para>
 514 <para>
 515 You may not attach these to signals created with the
 516 #GTK_RUN_NO_HOOKS flag.
 517 </para>
 518
 519 @object:
 520 @signal_id:
 521 @n_params:
 522 @params:
 523 @data:
 524 @Returns:
 525
 526 <!-- ##### ENUM GtkFontFilterType ##### -->
 527 <para>
 528 A set of bit flags used to specify the filter being set
 529 when calling gtk_font_selection_dialog_set_filter() or
 530 gtk_font_selection_set_filter().
 531 </para>
 532
 533 @GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user.
 534 @GTK_FONT_FILTER_USER: the user filter, which can be changed from within the
 535 'Filter' page of the #GtkFontSelection widget.
 536
 537 <!-- ##### ENUM GtkFontType ##### -->
 538 <para>
 539 A set of bit flags used to specify the type of fonts shown
 540 when calling gtk_font_selection_dialog_set_filter() or
 541 gtk_font_selection_set_filter().
 542 </para>
 543
 544 @GTK_FONT_BITMAP: bitmap fonts.
 545 @GTK_FONT_SCALABLE: scalable fonts.
 546 @GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts.
 547 @GTK_FONT_ALL: a bitwise combination of all of the above.
 548
 549 <!-- ##### ARG GtkFrame:shadow-type ##### -->
 550 <para>
 551
 552 </para>
 553
 554
 555 <!-- ##### ARG GtkHScale:adjustment ##### -->
 556 <para>
 557 the #GtkAdjustment which sets the range of the scale.
 558 </para>
 559
 560
 561 <!-- ##### ARG GtkHScrollbar:adjustment ##### -->
 562 <para>
 563
 564 </para>
 565
 566
 567 <!-- ##### STRUCT GtkIMContextSimple ##### -->
 568 <para>
 569
 570 </para>
 571
 572 @object:
 573 @tables:
 574 @compose_buffer:
 575 @tentative_match:
 576 @tentative_match_len:
 577
 578 <!-- ##### ARG GtkLabel:accel-keyval ##### -->
 579 <para>
 580
 581 </para>
 582
 583
 584 <!-- ##### ARG GtkObject:object-signal ##### -->
 585 <para>
 586 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 587 the signal to the object, so that the user data and objects
 588 and swapped when the signal handler is invoked.
 589 </para>
 590 <para>
 591 This is useful for handlers that are primarily notifying
 592 other objects and could just invoke an already existing function
 593 if the parameters were swapped.
 594 See gtk_signal_connect_object() for more details.
 595 </para>
 596
 597
 598 <!-- ##### ARG GtkObject:object-signal-after ##### -->
 599 <para>
 600 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 601 the signal to the object, so that the user data and objects
 602 and swapped when the signal handler is invoked,
 603 and so that the handler is invoked after all others.
 604 </para>
 605 <para>
 606 See gtk_signal_connect_object_after() for more details.
 607 </para>
 608
 609
 610 <!-- ##### ARG GtkObject:signal ##### -->
 611 <para>
 612 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 613 the signal to the object.
 614 </para>
 615
 616
 617 <!-- ##### ARG GtkObject:signal-after ##### -->
 618 <para>
 619 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 620 the signal to the object, so that the signal is always run
 621 after other user handlers and the default handler.
 622 </para>
 623
 624
 625 <!-- ##### ARG GtkPaned:handle-size ##### -->
 626 <para>
 627
 628 </para>
 629
 630
 631 <!-- ##### STRUCT GtkPatternSpec ##### -->
 632 <para>
 633
 634 </para>
 635
 636 @match_type:
 637 @pattern_length:
 638 @pattern:
 639 @pattern_reversed:
 640 @user_data:
 641 @seq_id:
 642
 643 <!-- ##### ENUM GtkPrivateFlags ##### -->
 644 <para>
 645
 646 </para>
 647
 648 @PRIVATE_GTK_USER_STYLE:
 649 @PRIVATE_GTK_RESIZE_PENDING:
 650 @PRIVATE_GTK_RESIZE_NEEDED:
 651 @PRIVATE_GTK_LEAVE_PENDING:
 652 @PRIVATE_GTK_HAS_SHAPE_MASK:
 653 @PRIVATE_GTK_IN_REPARENT:
 654 @PRIVATE_GTK_DIRECTION_SET:
 655 @PRIVATE_GTK_DIRECTION_LTR:
 656
 657 <!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
 658 <para>
 659 A function which you can use to clean up when the
 660 signal handler is destroyed.
 661 </para>
 662 <para>
 663 For example, if your handler requires a few variables
 664 that you made into a struct and allocated (using g_new()
 665 or something), then you will probably want to free
 666 it as soon as the hook is destroyed.  This will
 667 allow you to do that. (For this in particular
 668 it is convenient to pass g_free() as a #GtkSignalDestroy
 669 function).
 670 </para>
 671
 672 @data: The user data associated with the hook that is being
 673 destroyed.
 674
 675 <!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
 676 <para>
 677 This is currently a hack left in for a scheme wrapper library.
 678 It may be removed.
 679 </para>
 680 <para>
 681 Don't use it.
 682 </para>
 683
 684 @object: The object which emits the signal.
 685 @data: The user data associated with the hook.
 686 @nparams: The number of parameters to the function.
 687 @args: The actual values of the arguments.
 688 @arg_types: The types of the arguments.
 689 @return_type: The type of the return value from the function
 690 or #GTK_TYPE_NONE for no return value.
 691
 692 <!-- ##### STRUCT GtkSignalQuery ##### -->
 693 <para>
 694 This structure contains all the information about a particular
 695 signal:  its name, the type it affects, the signature of the handlers,
 696 and its unique identifying integer.
 697 </para>
 698
 699 @object_type:
 700 @signal_id:
 701 @signal_name:
 702 @is_user_signal:
 703 @signal_flags:
 704 @return_val:
 705 @nparams:
 706 @params:
 707
 708 <!-- ##### ARG GtkSpinButton:shadow-type ##### -->
 709 <para>
 710 the type of border that surrounds the arrows of a spin button.
 711 </para>
 712
 713
 714 <!-- ##### STRUCT GtkStatusbarMsg ##### -->
 715 <para>
 716 Holds the data for a statusbar message. <structfield>text</structfield> holds the actual text string. <structfield>context_id</structfield> is the context that this message is associated with, and <structfield>message_id</structfield> is this particular message's identifier. However, these fields should not be modified directly.
 717 </para>
 718
 719 @text:
 720 @context_id:
 721 @message_id:
 722
 723 <!-- ##### ARG GtkTextTag:justify ##### -->
 724 <para>
 725 A #GtkJustification for the text. This is only used when the tag is
 726 applied to the first character in a paragraph.
 727 </para>
 728
 729
 730 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
 731 <para>
 732 Pixel width of the left margin of the text for lines after the first
 733 line in a wrapped paragraph.
 734 </para>
 735
 736
 737 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
 738 <para>
 739
 740 </para>
 741
 742
 743 <!-- ##### ARG GtkTextTag:offset ##### -->
 744 <para>
 745 Pixels to offset the text horizontally or vertically, useful to
 746 produce superscript and subscript.
 747 </para>
 748
 749
 750 <!-- ##### ARG GtkVScale:adjustment ##### -->
 751 <para>
 752 the #GtkAdjustment which sets the range of the scale.
 753 </para>
 754
 755
 756 <!-- ##### ARG GtkVScrollbar:adjustment ##### -->
 757 <para>
 758
 759 </para>
 760
 761
 762 <!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
 763 <para>
 764
 765 </para>
 766
 767 @widget: the object which received the signal.
 768 @arg1:
 769 @Returns:
 770
 771 <!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
 772 <para>
 773
 774 </para>
 775
 776 @widget: the object which received the signal.
 777 @message:
 778
 779 <!-- ##### SIGNAL GtkWidget::draw ##### -->
 780 <para>
 781
 782 </para>
 783
 784 @widget: the object which received the signal.
 785 @area:
 786
 787 <!-- ##### SIGNAL GtkWidget::draw-default ##### -->
 788 <para>
 789
 790 </para>
 791
 792 @widget: the object which received the signal.
 793
 794 <!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
 795 <para>
 796
 797 </para>
 798
 799 @widget: the object which received the signal.
 800
 801 <!-- ##### FUNCTION gtk_button_box_child_requisition ##### -->
 802 <para>\r
 803 This is an internally used function and should never be called from an\r
 804 application.\r
 805 </para>
 806
 807 @widget:
 808 @nvis_children:
 809 @width:
 810 @height:
 811
 812 <!-- ##### FUNCTION gtk_button_box_get_child_ipadding_default ##### -->
 813 <para>\r
 814 The internal padding of a button is the amount of space between the outside\r
 815 of the button and the widget it contains. This function gets the default\r
 816 amount of horizontal and vertical padding, placing the results in @ipad_x\r
 817 and @ipad_y, respectively.\r
 818 </para>
 819
 820 @ipad_x: the default horizontal internal button padding.
 821 @ipad_y: the default vertical internal button padding.
 822
 823 <!-- ##### FUNCTION gtk_button_box_get_child_size_default ##### -->
 824 <para>\r
 825 Retrieves the default minimum width and height for all button boxes, and\r
 826 places the values in @min_width and @min_height, respectively.\r
 827 </para>
 828
 829 @min_width: the default minimum width of a child widget.
 830 @min_height: the default minimum height of a child widget.
 831
 832 <!-- ##### FUNCTION gtk_button_box_set_child_ipadding_default ##### -->
 833 <para>\r
 834 Sets the default number of pixels that pad each button in every button box.\r
 835 </para>
 836
 837 @ipad_x: new default horizontal padding.
 838 @ipad_y: new default vertical padding.
 839
 840 <!-- ##### FUNCTION gtk_button_box_set_child_size_default ##### -->
 841 <para>\r
 842 Sets the default size of child buttons.\r
 843 </para>
 844
 845 @min_width: minimum default width for child buttons.
 846 @min_height: minimum default height for child buttons.
 847
 848 <!-- ##### FUNCTION gtk_button_new_accel ##### -->
 849 <para>
 850
 851 </para>
 852
 853 @uline_label:
 854 @accel_group:
 855 @Returns:
 856
 857 <!-- ##### FUNCTION gtk_button_new_stock ##### -->
 858 <para>
 859
 860 </para>
 861
 862 @stock_id:
 863 @accel_group:
 864 @Returns:
 865
 866 <!-- ##### FUNCTION gtk_clist_construct ##### -->
 867 <para>
 868 Initializes a previously allocated #GtkCList widget for use.  This should not
 869 normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
 870 </para>
 871
 872 @clist: A pointer to an uninitialized #GtkCList widget.
 873 @columns: The number of columns the #GtkCList should have.
 874 @titles: An array of strings that should be used as the titles i
 875 of the columns.  There should be enough strings in the array for
 876 the number of columns specified.
 877
 878 <!-- ##### FUNCTION gtk_color_selection_get_old_color ##### -->
 879 <para>
 880
 881 </para>
 882
 883 @colorsel:
 884 @color:
 885
 886 <!-- ##### FUNCTION gtk_color_selection_get_use_opacity ##### -->
 887 <para>
 888
 889 </para>
 890
 891 @colorsel:
 892 @Returns:
 893
 894 <!-- ##### FUNCTION gtk_color_selection_get_use_palette ##### -->
 895 <para>
 896
 897 </para>
 898
 899 @colorsel:
 900 @Returns:
 901
 902 <!-- ##### FUNCTION gtk_color_selection_set_old_color ##### -->
 903 <para>
 904
 905 </para>
 906
 907 @colorsel:
 908 @color:
 909
 910 <!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
 911 <para>
 912 Controls whether opacity can be set with the #GtkColorSelection.
 913 If this functionality is enabled, the necessary additional widgets
 914 are added to the #GtkColorSelection and the opacity value can be
 915 retrieved via the fourth value in the color array returned by
 916 the gtk_color_selection_get_color() function.
 917 </para>
 918
 919 @colorsel: a #GtkColorSelection.
 920 @use_opacity: a boolean indicating whether the opacity selection
 921 is enabled.
 922
 923 <!-- ##### FUNCTION gtk_color_selection_set_use_opacity ##### -->
 924 <para>
 925
 926 </para>
 927
 928 @colorsel:
 929 @use_opacity:
 930
 931 <!-- ##### FUNCTION gtk_color_selection_set_use_palette ##### -->
 932 <para>
 933
 934 </para>
 935
 936 @colorsel:
 937 @use_palette:
 938
 939 <!-- ##### FUNCTION gtk_ctree_construct ##### -->
 940 <para>
 941 This function is not usually used by users.
 942 </para>
 943
 944 @ctree:
 945 @columns:
 946 @tree_column:
 947 @titles:
 948
 949 <!-- ##### FUNCTION gtk_editable_changed ##### -->
 950 <para>
 951 Causes the "changed" signal to be emitted.
 952 </para>
 953
 954 @editable: a #GtkEditable widget.
 955
 956 <!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
 957 <para>
 958 Claim or disclaim ownership of the PRIMARY X selection.
 959 </para>
 960
 961 @editable: a #GtkEditable widget.
 962 @claim: if %TRUE, claim the selection, otherwise, disclaim it.
 963 @time: the timestamp for claiming the selection.
 964
 965 <!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
 966 <para>
 967 Sets one of the two font filters, to limit the fonts shown.
 968 </para>
 969
 970 @fsd: a #GtkFontSelectionDialog.
 971 @filter_type: which of the two font filters to set, either
 972 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
 973 can be changed by the user, but the base filter is permanent.
 974 @font_type: the types of font to be shown. This is a bitwise combination of
 975 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
 976 or #GTK_FONT_ALL to show all three font types.
 977 @foundries: a NULL-terminated array of strings containing foundry names which
 978 will be shown, or NULL to show all foundries.
 979 @weights: a NULL-terminated array of strings containing weight names which
 980 will be shown, or NULL to show all weights.
 981 @slants: a NULL-terminated array of strings containing slant names which
 982 will be shown, or NULL to show all slants.
 983 @setwidths: a NULL-terminated array of strings containing setwidth names which
 984 will be shown, or NULL to show all setwidths.
 985 @spacings: a NULL-terminated array of strings containing spacings which
 986 will be shown, or NULL to show all spacings.
 987 @charsets: a NULL-terminated array of strings containing charset names which
 988 will be shown, or NULL to show all charsets.
 989
 990 <!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
 991 <para>
 992 Sets one of the two font filters, to limit the fonts shown.
 993 </para>
 994
 995 @fontsel: a #GtkFontSelection.
 996 @filter_type: which of the two font filters to set, either
 997 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
 998 can be changed by the user, but the base filter is permanent.
 999 @font_type: the types of font to be shown. This is a bitwise combination of
1000 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
1001 or #GTK_FONT_ALL to show all three font types.
1002 @foundries: a NULL-terminated array of strings containing foundry names which
1003 will be shown, or NULL to show all foundries.
1004 @weights: a NULL-terminated array of strings containing weight names which
1005 will be shown, or NULL to show all weights.
1006 @slants: a NULL-terminated array of strings containing slant names which
1007 will be shown, or NULL to show all slants.
1008 @setwidths: a NULL-terminated array of strings containing setwidth names which
1009 will be shown, or NULL to show all setwidths.
1010 @spacings: a NULL-terminated array of strings containing spacings which
1011 will be shown, or NULL to show all spacings.
1012 @charsets: a NULL-terminated array of strings containing charset names which
1013 will be shown, or NULL to show all charsets.
1014
1015 <!-- ##### FUNCTION gtk_identifier_get_type ##### -->
1016 <para>
1017 Get the type of GtkIdentifier.
1018 </para>
1019
1020 @Returns: GtkType -- the enumerated type of something.
1021
1022 <!-- ##### FUNCTION gtk_label_set_markup_with_accel ##### -->
1023 <para>
1024
1025 </para>
1026
1027 @label:
1028 @str:
1029 @Returns:
1030
1031 <!-- ##### FUNCTION gtk_list_store_set_cell ##### -->
1032 <para>
1033
1034 </para>
1035
1036 @store:
1037 @iter:
1038 @column:
1039 @value:
1040
1041 <!-- ##### FUNCTION gtk_menu_ensure_uline_accel_group ##### -->
1042 <para>
1043
1044 </para>
1045
1046 @menu:
1047 @Returns:
1048
1049 <!-- ##### FUNCTION gtk_menu_get_uline_accel_group ##### -->
1050 <para>
1051
1052 </para>
1053
1054 @menu:
1055 @Returns:
1056
1057 <!-- ##### FUNCTION gtk_object_arg_get ##### -->
1058 <para>
1059 Private function to get an argument and argument info from an object.
1060 </para>
1061
1062 @object: the object whose argument should be retrieved.
1063 @arg: the argument, for the name on input, the rest is filled on output.
1064 @info: a #GtkArgInfo structure to optionally fill in.
1065
1066 <!-- ##### FUNCTION gtk_object_arg_get_info ##### -->
1067 <para>
1068 Query information about an argument type.
1069 </para>
1070
1071 @object_type: type of object to query about.
1072 @arg_name: name of the argument.
1073 @info_p: pointer to be filled in with a pointer to the GtkArgInfo.
1074 @Returns: an error message, or NULL on success.
1075 It is the caller's responsibility to call g_free() in the event of error.
1076
1077 <!-- ##### FUNCTION gtk_object_arg_set ##### -->
1078 <para>
1079 Private function to set an argument and argument info to an object.
1080 </para>
1081
1082 @object: the object whose argument should be set.
1083 @arg: the argument.
1084 @info: infomation about this type of argument in general.
1085
1086 <!-- ##### FUNCTION gtk_object_args_collect ##### -->
1087 <para>
1088 Private: Gets an array of #GtkArgs from a va_list C structure.
1089 </para>
1090
1091 @object_type: the type of object to collect arguments for.
1092 @arg_list_p: pointer to be filled in with a list of parsed arguments.
1093 @info_list_p: optional pointer for a returned list #GtkArgInfos.
1094 @first_arg_name: name of first argument.
1095 @var_args: value of first argument, followed by more key/value pairs,
1096 terminated by NULL.
1097 @Returns: an error message, or NULL on success.
1098 It is the caller's responsibility to call g_free() in the event of error.
1099
1100 <!-- ##### FUNCTION gtk_object_class_add_signals ##### -->
1101 <para>
1102 Add an array of signals to a #GtkObjectClass.
1103 Usually this is called when registering a new type of object.
1104 </para>
1105
1106 @klass: the object class to append signals to.
1107 @signals: the signals to append.
1108 @nsignals: the number of signals being appended.
1109
1110 <!-- ##### FUNCTION gtk_object_class_user_signal_new ##### -->
1111 <para>
1112 Define a signal-handler for a new signal on an already defined
1113 object.
1114 </para>
1115 <para>
1116 See the signal documentation for more general information.
1117 </para>
1118
1119 @klass: the object class to define the signal for.
1120 @name: the name of the signal.
1121 @signal_flags: the default emission behavior for the signal.
1122 See gtk_signal_new().
1123 @marshaller: a function that will take an array of GtkArgs
1124 and invoke the appropriate handler with the normal calling
1125 conventions.
1126 @return_val: specify the return-value type for the signal
1127 (or GTK_TYPE_NONE for no return-value).
1128 @nparams: specify the number of parameters the signal
1129 receives from the caller of gtk_signal_emit().
1130 @Varargs: list of nparams #GtkTypes to pass to the signal handlers.
1131 @Returns: the signal id.  (See #GtkSignals)
1132
1133 <!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### -->
1134 <para>
1135 Define a signal-handler for a new signal on an already defined
1136 object.
1137 </para>
1138
1139 @klass: the object class to define the signal for.
1140 @name: the name of the signal.
1141 @signal_flags: the default emission behavior for the signal.
1142 See gtk_signal_new().
1143 @marshaller: takes a GtkObject, a #GtkSignalFunc, and an array
1144 of arguments, and invokes the function using the appropriate
1145 calling conventions.  Usually just select a function
1146 out of gtkmarshal.h.
1147 @return_val: specify the return-value type for the signal (possibly
1148 #GTK_TYPE_NONE).
1149 @nparams: specify the number of parameters the signal
1150 receives from the caller of gtk_signal_emit().
1151 @params: array of #GtkTypes the signal handlers for this signal
1152 should have in their prototype (of length nparams).
1153 @Returns: the signal id.  (See #GtkSignals)
1154
1155 <!-- ##### FUNCTION gtk_object_constructed ##### -->
1156 <para>
1157 Mark an allocated object as constructed.
1158 This is used for situations
1159 that require precise control of the construction process.
1160 </para>
1161 <para>
1162 This is done when gtk_object_default_construct() is inadequate.
1163 In #GtkCList the need arises because #GtkCList does construction work that
1164 must happen <emphasis>after</emphasis> its derivers.  This work
1165 cannot be done in an initializer function, so an alternate
1166 constructor is mandatory.  It calls gtk_object_constructed() to
1167 indicate it has done its job, so that no other constructor will
1168 be invoked.
1169 </para>
1170 <para>
1171 Normally this function is just automatically run from
1172 gtk_object_default_construct().
1173 </para>
1174
1175 @object: object which has been constructed.  This is usually
1176 done automatically by gtk_object_new() and gtk_object_newv().
1177
1178 <!-- ##### FUNCTION gtk_object_default_construct ##### -->
1179 <para>
1180 This function is called to construct arguments that haven't been initialized
1181 but have the #GTK_ARG_CONSTRUCT flag set.
1182 </para>
1183 <para>
1184 All number arguments are set to 0.  All pointers and strings
1185 are set to NULL.
1186 </para>
1187 <para>
1188 Normally invoked by gtk_object_new() automatically; gtk_type_new() can
1189 be used to bypass it.
1190 </para>
1191
1192 @object: the object to initialize.
1193
1194 <!-- ##### FUNCTION gtk_object_getv ##### -->
1195 <para>
1196 Gets an array of argument values from an object.
1197 </para>
1198
1199 @object: the object to get arguments from.
1200 @n_args: the number of arguments to query.
1201 @args: the arguments to fill in.
1202
1203 <!-- ##### FUNCTION gtk_object_newv ##### -->
1204 <para>
1205 Construct an object with an array of arguments.
1206 </para>
1207
1208 @object_type: the type of the object to create.
1209 @n_args: the number of arguments to set.
1210 @args: an array of n_args arguments (which are name and value pairs).
1211 @Returns: the new GtkObject.
1212
1213 <!-- ##### FUNCTION gtk_object_query_args ##### -->
1214 <para>
1215 Get all the arguments that may be used for a given type.
1216 </para>
1217 <para>
1218 In Java, this type of mechanism is called
1219 <wordasword>introspection</wordasword>.  It is used by applications
1220 like Glade, that have to determine what can be done to an object
1221 at run-time.
1222 </para>
1223
1224 @class_type: the GtkType of the ObjectClass
1225 (returned from GTK_OBJECT_CLASS(class)-&gt;type for example).
1226 @arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to
1227 each argument.  You must g_free() this if you request it.
1228 @n_args: the number of arguments is returned in this field.
1229 @Returns: an array of arguments, that you must deallocate with g_free().
1230
1231 <!-- ##### FUNCTION gtk_object_setv ##### -->
1232 <para>
1233 Set an array of arguments.
1234 </para>
1235
1236 @object: the object whose arguments should be set.
1237 @n_args: the number of arguments to set.
1238 @args: the desired values, as an array of #GtkArgs (which contain
1239 the names, types, and values of the arguments).
1240
1241 <!-- ##### FUNCTION gtk_paned_compute_position ##### -->
1242 <para>
1243 Internal function used by #GtkHPaned and #GtkVPaned
1244 </para>
1245
1246 @paned:
1247 @allocation:
1248 @child1_req:
1249 @child2_req:
1250
1251 <!-- ##### FUNCTION gtk_paned_set_handle_size ##### -->
1252 <para>
1253 Set the the handle size to @size x @size pixels.
1254 </para>
1255
1256 @paned: a paned widget
1257 @size: the size in pixels
1258
1259 <!-- ##### FUNCTION gtk_pattern_match ##### -->
1260 <para>
1261
1262 </para>
1263
1264 @pspec:
1265 @string_length:
1266 @string:
1267 @string_reversed:
1268 @Returns:
1269
1270 <!-- ##### FUNCTION gtk_pattern_match_simple ##### -->
1271 <para>
1272
1273 </para>
1274
1275 @pattern:
1276 @string:
1277 @Returns:
1278
1279 <!-- ##### FUNCTION gtk_pattern_match_string ##### -->
1280 <para>
1281
1282 </para>
1283
1284 @pspec:
1285 @string:
1286 @Returns:
1287
1288 <!-- ##### FUNCTION gtk_pattern_spec_free_segs ##### -->
1289 <para>
1290
1291 </para>
1292
1293 @pspec:
1294
1295 <!-- ##### FUNCTION gtk_pattern_spec_init ##### -->
1296 <para>
1297
1298 </para>
1299
1300 @pspec:
1301 @pattern:
1302
1303 <!-- ##### FUNCTION gtk_rc_init ##### -->
1304 <para>
1305 Internal function.
1306 </para>
1307
1308
1309 <!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
1310 <para>
1311
1312 </para>
1313
1314 @ruler: the gtkruler
1315
1316 <!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
1317 <para>
1318
1319 </para>
1320
1321 @ruler: the gtkruler
1322
1323 <!-- ##### FUNCTION gtk_signal_add_emission_hook ##### -->
1324 <para>
1325 Add an emission hook for a type of signal, for any object.
1326 </para>
1327
1328 @signal_id: the type of signal to hook for.
1329 @hook_func: the function to invoke to handle the emission hook.
1330 @data: the user data passed in to hook_func.
1331 @Returns: the id (that you may pass as a parameter
1332 to gtk_signal_remove_emission_hook()).
1333 @i:
1334 @h:
1335 @d:
1336
1337 <!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
1338 <para>
1339 Add an emission hook for a type of signal, for any object.
1340 (with control of what happens when the hook is
1341 destroyed).
1342 </para>
1343
1344 @signal_id: the type of signal add the hook for.
1345 @hook_func: the function to invoke to handle the hook.
1346 @data: the user data passed in to hook_func.
1347 @destroy: a function to invoke when the hook is destroyed,
1348 to clean up any allocation done just for this
1349 signal handler.
1350 @Returns: the id (that you may pass as a parameter
1351 to gtk_signal_remove_emission_hook()).
1352
1353 <!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
1354 <para>
1355 Returns whether a connection id is valid (and optionally not blocked).
1356 </para>
1357
1358 @object: the object to search for the desired handler.
1359 @handler_id: the connection id.
1360 @may_be_blocked: whether it is acceptable to return a blocked
1361 handler.
1362 @Returns: TRUE if the signal exists and wasn't blocked,
1363 unless #may_be_blocked was specified.  FALSE otherwise.
1364
1365 <!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
1366 <para>
1367 Destroy all the signal handlers connected to an object.
1368 This is done automatically when the object is destroyed.
1369 </para>
1370 <para>
1371 This function is labeled private.
1372 </para>
1373
1374 @object: the object whose signal handlers should be destroyed.
1375
1376 <!-- ##### FUNCTION gtk_signal_init ##### -->
1377 <para>
1378
1379 </para>
1380
1381
1382 <!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
1383 <para>
1384 Find out the recursion depth of emissions for a particular type
1385 of signal and object.  (So it will
1386 always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
1387 This is a way to avoid recursion:  you can see if
1388 you are currently running in that signal handler and emit it only
1389 if you are.
1390 </para>
1391 <para>Another way to look at it is that this number increases
1392 by one when #gtk_signal_emit(), et al, are called,
1393 and decreases by one when #gtk_signal_emit() returns.
1394 </para>
1395
1396 @object: the object with the signal handler.
1397 @signal_id: the signal id.
1398 @Returns: the recursion depth of emissions of this signal for this
1399 object.
1400
1401 <!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
1402 <para>
1403 Find out the recursion depth of emissions for a particular type
1404 of signal and object.  Just like gtk_signal_n_emissions()
1405 except it will lookup the signal id for you.
1406 </para>
1407
1408 @object: the object with the signal handler.
1409 @name: the signal name.
1410 @Returns: the recursion depth of emissions of this signal for this
1411 object.
1412
1413 <!-- ##### FUNCTION gtk_signal_query ##### -->
1414 <para>
1415 Obtain information about a signal.
1416 </para>
1417
1418 @signal_id: the signal type identifier.
1419 @Returns: a pointer to a GtkSignalQuery structure
1420 which contains all the information, or NULL.
1421 The pointer is allocated just for you:  you must g_free() it.
1422
1423 <!-- ##### FUNCTION gtk_signal_remove_emission_hook ##### -->
1424 <para>
1425 Delete an emission hook. (see gtk_signal_add_emission_hook())
1426 </para>
1427
1428 @signal_id: the id of the signal type.
1429 @hook_id: the id of the emission handler, returned by add_emission_hook().
1430 @i:
1431 @h:
1432
1433 <!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
1434 <para>
1435 These set default functions to call when the user didn't
1436 supply a function when connecting.  (These are rarely
1437 used, and probably only for language bindings)
1438 </para>
1439 <para>
1440 By default, there are no such functions.
1441 </para>
1442
1443 @marshal_func: the function to invoke on every handlers for which there
1444 isn't a function pointer.  May be NULL.
1445 @destroy_func: the function to invoke when each hook is destroyed.
1446 May be NULL.
1447
1448 <!-- ##### FUNCTION gtk_spin_button_set_shadow_type ##### -->
1449 <para>
1450 Creates a border around the arrows of a #GtkSpinButton. The type of border is determined by @shadow_type.
1451 </para>
1452
1453 @spin_button: a #GtkSpinButton
1454 @shadow_type: the new border type.
1455
1456 <!-- ##### FUNCTION gtk_trace_referencing ##### -->
1457 <para>
1458 Private: print debugging information while doing a gtk_object_ref() or
1459 a gtk_object_unref().
1460 </para>
1461
1462 @object: object to reference or unreference.
1463 @func: name of caller's function to print (used within macros).
1464 @dummy: unused.
1465 @line: line number (used within macros).
1466 @do_ref: whether to reference or unreference.
1467
1468 <!-- ##### FUNCTION gtk_tree_model_ref_iter ##### -->
1469 <para>
1470
1471 </para>
1472
1473 @tree_model:
1474 @iter:
1475
1476 <!-- ##### FUNCTION gtk_tree_model_sort_set_compare ##### -->
1477 <para>
1478
1479 </para>
1480
1481 @tree_model_sort:
1482 @func:
1483
1484 <!-- ##### FUNCTION gtk_tree_model_sort_set_sort_column ##### -->
1485 <para>
1486
1487 </para>
1488
1489 @tree_model_sort:
1490 @sort_col:
1491
1492 <!-- ##### FUNCTION gtk_tree_model_unref_iter ##### -->
1493 <para>
1494
1495 </para>
1496
1497 @tree_model:
1498 @iter:
1499
1500 <!-- ##### FUNCTION gtk_tree_store_set_cell ##### -->
1501 <para>
1502
1503 </para>
1504
1505 @tree_store:
1506 @iter:
1507 @column:
1508 @value:
1509
1510 <!-- ##### FUNCTION gtk_type_check_class_cast ##### -->
1511 <para>
1512 Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make
1513 sure that it's okay to cast something of that @klass into a @cast_type.
1514 </para>
1515
1516 @klass: GtkTypeClass*
1517 @cast_type: GtkType
1518 @Returns: Always return @klass.
1519
1520 <!-- ##### FUNCTION gtk_type_check_object_cast ##### -->
1521 <para>
1522 Given a pointer to a GtkTypeObject @type_object, and a GtkType @cast_type,
1523 make sure that it's okay to cast @type_object into a @cast_type.
1524 </para>
1525
1526 @type_object: GtkTypeObject*
1527 @cast_type: GtkType
1528 @Returns: the same GtkTypeObject* as @type_object
1529
1530 <!-- ##### FUNCTION gtk_type_children_types ##### -->
1531 <para>
1532 Return the pointer to the type's children's types.
1533 </para>
1534
1535 @type: GtkType
1536 @Returns: pointer to a GList
1537
1538 <!-- ##### FUNCTION gtk_type_describe_heritage ##### -->
1539 <para>
1540 Print the types @type inherits from.
1541 </para>
1542
1543 @type: GtkType
1544
1545 <!-- ##### FUNCTION gtk_type_describe_tree ##### -->
1546 <para>
1547 Given a @type, describe all of its children, and their children.  Only
1548 show the size if @show_size is true.
1549 </para>
1550
1551 @type: GtkType
1552 @show_size: gboolean
1553
1554 <!-- ##### FUNCTION gtk_type_free ##### -->
1555 <para>
1556 Given the type of an object and a pointer to it, the object is freed.
1557 </para>
1558
1559 @type: GtkType
1560 @mem: gpointer to the object
1561
1562 <!-- ##### FUNCTION gtk_type_get_varargs_type ##### -->
1563 <para>
1564 Get the varargs type associated with @foreign_type
1565 </para>
1566
1567 @foreign_type: GtkType
1568 @Returns: GtkType
1569
1570 <!-- ##### FUNCTION gtk_type_parent_class ##### -->
1571 <para>
1572 Return the class of the parent.  Initialize the class if necessary.
1573 Return NULL if anything goes wrong.
1574 </para>
1575
1576 @type: GtkType
1577 @Returns: gpointer to the klass.
1578
1579 <!-- ##### FUNCTION gtk_type_query ##### -->
1580 <para>
1581 Given a type, return various interesting parameters of the type.
1582 </para>
1583
1584 @type: GtkType
1585 @Returns: GtkTypeQuery*
1586
1587 <!-- ##### FUNCTION gtk_type_register_enum ##### -->
1588 <para>
1589 Register a new set of enum @values and give them the name in
1590 @type_name.
1591 </para>
1592
1593 @type_name: must not be null.
1594 @values: GtkEnumValue*
1595 @Returns:
1596
1597 <!-- ##### FUNCTION gtk_type_register_flags ##### -->
1598 <para>
1599 Register a new set of flags @values and give them the name in
1600 @type_name.
1601 </para>
1602
1603 @type_name: must not be null.
1604 @values: GtkFlagValue*
1605 @Returns:
1606
1607 <!-- ##### FUNCTION gtk_type_set_chunk_alloc ##### -->
1608 <para>
1609 Set the mem_chunk size so it will hold @n_chunks of the objects of that @type.
1610 </para>
1611
1612 @type: There must be an unlocked TypeNode associated with this type otherwise nothing happens.
1613 @n_chunks:
1614
1615 <!-- ##### FUNCTION gtk_type_set_varargs_type ##### -->
1616 <para>
1617 Set the varargs type for a fundamental type @foreign_type.
1618 </para>
1619
1620 @foreign_type: Must be a GtkType with a sequence number of zero.  Must not be a
1621 fundamental type.
1622 @varargs_type: Must be a GtkType which is either structured or flag, or NONE.
1623
1624 <!-- ##### FUNCTION gtk_widget_activate_mnemonic ##### -->
1625 <para>
1626
1627 </para>
1628
1629 @widget:
1630 @group_cycling:
1631 @Returns:
1632
1633 <!-- ##### FUNCTION gtk_widget_popup ##### -->
1634 <para>
1635
1636 </para>
1637
1638 @widget:
1639 @x:
1640 @y:
1641
1642 <!-- ##### FUNCTION gtk_window_activate_mnemonic ##### -->
1643 <para>
1644
1645 </para>
1646
1647 @window:
1648 @keyval:
1649 @modifier:
1650 @Returns:
1651
1652 <!-- ##### FUNCTION gtk_window_get_default_accel_group ##### -->
1653 <para>
1654
1655 </para>
1656
1657 @window:
1658 @Returns:
1659
1660 <!-- ##### FUNCTION gtk_window_set_decorations_hint ##### -->
1661 <para>
1662
1663 </para>
1664
1665 @window:
1666 @decorations:
1667
1668 <!-- ##### FUNCTION gtk_window_set_functions_hint ##### -->
1669 <para>
1670
1671 </para>
1672
1673 @window:
1674 @functions:
1675