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

   1 <!-- ##### SECTION ./tmpl/gtkarg.sgml:Long_Description ##### -->
   2 <para>
   3 All the functions in here are marked a Non-public.
   4 We describe it anyway because it is occasionally useful
   5 to understand how the work is done.
   6 </para>
   7 <para>
   8 Arguments are a way of describing a named parameter to a function.
   9 They have two important roles within gtk+:
  10 <itemizedlist>
  11 <listitem>
  12 <para>
  13 they describe <wordasword>object properties</wordasword>.
  14 This means that they present an interface to get and set a named-type
  15 for any type of object in a consistent way.
  16 (All the relevant functions to do this start with gtk_object_set
  17 or gtk_object_get).
  18 </para>
  19 </listitem>
  20 <listitem>
  21 <para>
  22 they describe <wordasword>signal arguments</wordasword>.
  23 This is a lot less often needed but still useful.
  24 Usually if you are just emitting or creating a particular signal
  25 it is more convenient to just use gtk_signal_emit() or gtk_signal_new().
  26 However if you are writing a function to emit or create an arbitrary
  27 signal, you must use gtk_signal_emitv() or gtk_signal_newv().
  28 </para>
  29 </listitem>
  30 </itemizedlist>
  31 </para>
  32
  33
  34 <!-- ##### SECTION ./tmpl/gtkarg.sgml:See_Also ##### -->
  35 <para>
  36 #GtkObject.
  37 </para>
  38
  39
  40 <!-- ##### SECTION ./tmpl/gtkarg.sgml:Short_Description ##### -->
  41 Utility function to manipulate lists of named, typed arguments.
  42
  43
  44 <!-- ##### SECTION ./tmpl/gtkarg.sgml:Title ##### -->
  45 Implementation of Object Properties
  46
  47
  48 <!-- ##### SECTION ./tmpl/gtkcellrenderertextpixbuf.sgml:Long_Description ##### -->
  49 <para>
  50
  51 </para>
  52
  53
  54 <!-- ##### SECTION ./tmpl/gtkcellrenderertextpixbuf.sgml:See_Also ##### -->
  55 <para>
  56
  57 </para>
  58
  59
  60 <!-- ##### SECTION ./tmpl/gtkcellrenderertextpixbuf.sgml:Short_Description ##### -->
  61
  62
  63
  64 <!-- ##### SECTION ./tmpl/gtkcellrenderertextpixbuf.sgml:Title ##### -->
  65 GtkCellRendererTextPixbuf
  66
  67
  68 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Long_Description ##### -->
  69 <para>
  70 The #GtkData object is a very simple object intended to be used as a base
  71 class for objects which contain data (i.e. the 'Model' in the object-oriented
  72 Model/View/Controller framework).
  73 </para>
  74 <para>
  75 Currently it is not very useful since all it provides is a "disconnect" signal.
  76 This signal could be emitted by a #GtkData subclass to notify any 'Views'
  77 that they should disconnect from the #GtkData (the 'Model'), possibly just
  78 before the #GtkData is destroyed.
  79 </para>
  80
  81
  82 <!-- ##### SECTION ./tmpl/gtkdata.sgml:See_Also ##### -->
  83 <para>
  84
  85 </para>
  86
  87
  88 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Short_Description ##### -->
  89 abstract base class for objects containing data.
  90
  91
  92 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Title ##### -->
  93 GtkData
  94
  95
  96 <!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
  97 Debugging
  98
  99
 100 <!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Title ##### -->
 101 gtkenums.sgml
 102
 103
 104 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
 105 <refsect2>
 106 <title>What are Signal Marshallers?</title>
 107 <para>
 108 Marshals are functions which all have the same prototype:
 109 they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
 110 and an array of argument values.
 111 The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
 112 </para>
 113 <para>
 114 They then call a native function:  the GtkObject is the first
 115 parameter passed in.  The arguments are passed in the native
 116 calling convention:  chars, shorts, ints, longs may be packed
 117 on the stack, or tucked in registers:  it doesn't matter
 118 because the same calling convention will be generated
 119 inside the gtkmarshal code as is expected where you define
 120 your handlers.
 121 </para>
 122 <para>
 123 So the function named:
 124 <programlisting>
 125 gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
 126 </programlisting>
 127 will call the #GtkSignalFunc assuming it was a function with signature:
 128 <programlisting>
 129 gboolean sigfunc(gpointer,gint,gint,guint);
 130 </programlisting>
 131 </para>
 132 </refsect2>
 133 <refsect2>
 134 <title>Writing Custom Marshals</title>
 135 <para>
 136 Marshals are primarily used as arguments to gtk_signal_new().
 137 Sometimes, you may find that a marshaller you need isn't available
 138 in the standard list.  Then you have to write your own.
 139 </para>
 140 <para>
 141 If you wish to define a signal with a new type of argument list.
 142 Suppose you want 2 pointers and 2 integers.
 143 You would write:
 144 <programlisting>
 145 typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
 146                         gpointer, gpointer, gint, gint
 147 );
 148
 149 void marshal_INT__POINTER_POINTER_INT_INT(GtkObject*    object,
 150                                            GtkSignalFunc func,
 151                                            gpointer      func_data,
 152                                            GtkArg*       args)
 153 {
 154         GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
 155         gint* return_val;
 156         return_val = GTK_RETLOC_INT(args[4]);
 157         rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
 158         *return_val = (*rfunc)(object,
 159                                GTK_VALUE_POINTER(args[0]),
 160                                GTK_VALUE_POINTER(args[1]),
 161                                GTK_VALUE_INT(args[2]),
 162                                GTK_VALUE_INT(args[3]),
 163                                func_data);
 164 }
 165 </programlisting>
 166 </para>
 167 </refsect2>
 168
 169
 170 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
 171 <para>
 172 <variablelist>
 173
 174 <varlistentry>
 175 <term>#GtkSignal</term>
 176 <listitem><para>The signal handling functions (of which marshallers are
 177 really an implementation detail).</para></listitem>
 178 </varlistentry>
 179
 180 </variablelist>
 181 </para>
 182
 183
 184 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Short_Description ##### -->
 185 Functions to adapt C structures to native calling convention.
 186
 187
 188 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
 189 Signal Marshallers
 190
 191
 192 <!-- ##### SECTION ./tmpl/gtkpacker.sgml:Long_Description ##### -->
 193 <para>
 194
 195 </para>
 196
 197
 198 <!-- ##### SECTION ./tmpl/gtkpacker.sgml:See_Also ##### -->
 199 <para>
 200
 201 </para>
 202
 203
 204 <!-- ##### SECTION ./tmpl/gtkpacker.sgml:Short_Description ##### -->
 205
 206
 207
 208 <!-- ##### SECTION ./tmpl/gtkpacker.sgml:Title ##### -->
 209 GtkPacker
 210
 211
 212 <!-- ##### SECTION ./tmpl/gtkprivate.sgml:Title ##### -->
 213 Private Information
 214
 215
 216 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Long_Description ##### -->
 217 <para>
 218
 219 </para>
 220
 221
 222 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:See_Also ##### -->
 223 <para>
 224
 225 </para>
 226
 227
 228 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Short_Description ##### -->
 229
 230
 231
 232 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Title ##### -->
 233 GtkModelSimple
 234
 235
 236 <!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
 237 <para>
 238 A macro to check whether a child widget of the CList
 239 has the focus.
 240 </para>
 241
 242 @clist: The #GtkCList widget to check.
 243
 244 <!-- ##### MACRO GTK_ICON_SIZE_BUTTON ##### -->
 245 <para>
 246
 247 </para>
 248
 249
 250 <!-- ##### MACRO GTK_ICON_SIZE_DIALOG ##### -->
 251 <para>
 252
 253 </para>
 254
 255
 256 <!-- ##### MACRO GTK_ICON_SIZE_LARGE_TOOLBAR ##### -->
 257 <para>
 258
 259 </para>
 260
 261
 262 <!-- ##### MACRO GTK_ICON_SIZE_MENU ##### -->
 263 <para>
 264
 265 </para>
 266
 267
 268 <!-- ##### MACRO GTK_ICON_SIZE_SMALL_TOOLBAR ##### -->
 269 <para>
 270
 271 </para>
 272
 273
 274 <!-- ##### MACRO GTK_IS_TIPS_QUERY ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @obj:
 280
 281 <!-- ##### MACRO GTK_IS_TIPS_QUERY_CLASS ##### -->
 282 <para>
 283
 284 </para>
 285
 286 @klass:
 287
 288 <!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
 289 <para>
 290 Test whether a GtkObject's arguments have been prepared.
 291 </para>
 292
 293 @obj: the object to examine.
 294
 295 <!-- ##### MACRO GTK_OBJECT_DESTROYED ##### -->
 296 <para>
 297 Test whether a GtkObject has had gtk_object_destroy() invoked on it.
 298 </para>
 299
 300 @obj: the object to examine.
 301
 302 <!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
 303 <para>
 304 Get the number of signals defined by this object.
 305 </para>
 306
 307 @obj: the object to query.
 308
 309 <!-- ##### MACRO GTK_OBJECT_SET_FLAGS ##### -->
 310 <para>
 311 Turns on certain object flags.  (Private)
 312 </para>
 313
 314 @obj: the object to affect.
 315 @flag: the flags to set.
 316
 317 <!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
 318 <para>
 319 Get the array of signals defined for this object.
 320 </para>
 321
 322 @obj: the object to fetch the signals from.
 323
 324 <!-- ##### MACRO GTK_OBJECT_UNSET_FLAGS ##### -->
 325 <para>
 326 Turns off certain object flags.  (Private)
 327 </para>
 328
 329 @obj: the object to affect.
 330 @flag: the flags to unset.
 331
 332 <!-- ##### MACRO GTK_STOCK_BUTTON_APPLY ##### -->
 333 <para>
 334
 335 </para>
 336
 337
 338 <!-- ##### MACRO GTK_STOCK_BUTTON_CANCEL ##### -->
 339 <para>
 340
 341 </para>
 342
 343
 344 <!-- ##### MACRO GTK_STOCK_BUTTON_CLOSE ##### -->
 345 <para>
 346
 347 </para>
 348
 349
 350 <!-- ##### MACRO GTK_STOCK_BUTTON_NO ##### -->
 351 <para>
 352
 353 </para>
 354
 355
 356 <!-- ##### MACRO GTK_STOCK_BUTTON_OK ##### -->
 357 <para>
 358
 359 </para>
 360
 361
 362 <!-- ##### MACRO GTK_STOCK_BUTTON_YES ##### -->
 363 <para>
 364
 365 </para>
 366
 367
 368 <!-- ##### MACRO GTK_TIPS_QUERY ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @obj:
 374
 375 <!-- ##### MACRO GTK_TIPS_QUERY_CLASS ##### -->
 376 <para>
 377
 378 </para>
 379
 380 @klass:
 381
 382 <!-- ##### MACRO GTK_TIPS_QUERY_GET_CLASS ##### -->
 383 <para>
 384
 385 </para>
 386
 387 @obj:
 388
 389 <!-- ##### MACRO GTK_TREE_MODEL_GET_IFACE ##### -->
 390 <para>
 391
 392 </para>
 393
 394 @obj:
 395
 396 <!-- ##### MACRO GTK_TREE_SELECTION ##### -->
 397 <para>
 398 A macro that returns a GList that contains the selection of the root tree of @obj.
 399 </para>
 400
 401 @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.
 402
 403 <!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
 404 <para>
 405 The first "flat" (no struct) enumerated type value.
 406 </para>
 407
 408
 409 <!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
 410 <para>
 411 The last "flat" (no struct) enumerated type value.
 412 </para>
 413
 414
 415 <!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
 416 <para>
 417 Hide the name of gtk_identifier_get_type
 418 </para>
 419
 420
 421 <!-- ##### MACRO GTK_TYPE_MAKE ##### -->
 422 <para>
 423 Combine a fundemantal type and a sequence number to create a gtk type.
 424 </para>
 425
 426 @parent_t:
 427 @seqno:
 428
 429 <!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
 430 <para>
 431 No idea.
 432 </para>
 433
 434
 435 <!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
 436 <para>
 437 Convert a gtk type into its sequence number
 438 </para>
 439
 440 @type:
 441
 442 <!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
 443 <para>
 444 The first structured enumerated type value.
 445 </para>
 446
 447
 448 <!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
 449 <para>
 450 The last structured enumerated type value.
 451 </para>
 452
 453
 454 <!-- ##### MACRO GTK_TYPE_TIPS_QUERY ##### -->
 455 <para>
 456
 457 </para>
 458
 459
 460 <!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
 461 <para>
 462
 463 </para>
 464
 465
 466 <!-- ##### MACRO GTK_TYPE_TREE_VIEW_COLUMN ##### -->
 467 <para>
 468
 469 </para>
 470
 471
 472 <!-- ##### MACRO GTK_VALUE_ARGS ##### -->
 473 <para>
 474 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
 475 </para>
 476
 477 @a:
 478
 479 <!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
 480 <para>
 481 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
 482 </para>
 483
 484 @a:
 485
 486 <!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
 487 <para>
 488 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
 489 </para>
 490
 491 @a:
 492
 493 <!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
 494 <para>
 495 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
 496 </para>
 497
 498 @a:
 499
 500 <!-- ##### USER_FUNCTION GValueCompareFunc ##### -->
 501 <para>
 502
 503 </para>
 504
 505 @a:
 506 @b:
 507 @Returns:
 508
 509 <!-- ##### STRUCT GtkAccelEntry ##### -->
 510 <para>
 511 This is a private struct used by GTK+ internally, don't worry about it.
 512 </para>
 513
 514 @accel_group:
 515 @accelerator_key:
 516 @accelerator_mods:
 517 @accel_flags:
 518 @object:
 519 @signal_id:
 520
 521 <!-- ##### ARG GtkAccelLabel:accel-object ##### -->
 522 <para>
 523
 524 </para>
 525
 526
 527 <!-- ##### ARG GtkAccelLabel:accel-width ##### -->
 528 <para>
 529
 530 </para>
 531
 532
 533 <!-- ##### USER_FUNCTION GtkAccelMapNotify ##### -->
 534 <para>
 535
 536 </para>
 537
 538 @data:
 539 @accel_path_quark:
 540 @accel_key:
 541 @accel_mods:
 542 @accel_group:
 543 @old_accel_key:
 544 @old_accel_mods:
 545
 546 <!-- ##### USER_FUNCTION GtkArgGetFunc ##### -->
 547 <para>
 548 Define a function pointer.  Deprecated.
 549 </para>
 550
 551 @object:
 552 @arg:
 553 @arg_id:
 554
 555 <!-- ##### STRUCT GtkArgInfo ##### -->
 556 <para>
 557 A structure containing information about the argument.
 558 Returned by gtk_arg_get_info().
 559 </para>
 560
 561 @class_type: if the argument is an object, this is the object class type.
 562 @name: the name of the argument.
 563 @type: the type of the argument; it may be an object's type
 564 or a fundamental type.
 565 @arg_flags: flags applicable to the argument (i.e. readable, writable,
 566 and whether it needs to be constructed).
 567 @full_name: the object name and argument name separated by ::,
 568 e.g. "GtkObject::user_data" or "GtkButton::label".
 569 @arg_id: the unique argument identified.
 570 @seq_id: ???
 571
 572 <!-- ##### USER_FUNCTION GtkArgSetFunc ##### -->
 573 <para>
 574 Define a function pointer.  Deprecated.
 575 </para>
 576
 577 @object:
 578 @arg:
 579 @arg_id:
 580
 581 <!-- ##### STRUCT GtkCellRendererTextPixbuf ##### -->
 582 <para>
 583
 584 </para>
 585
 586 @parent:
 587
 588 <!-- ##### ARG GtkColorSelection:previous-alpha ##### -->
 589 <para>
 590
 591 </para>
 592
 593
 594 <!-- ##### ARG GtkColorSelection:previous-color ##### -->
 595 <para>
 596
 597 </para>
 598
 599
 600 <!-- ##### SIGNAL GtkContainer::focus ##### -->
 601 <para>
 602
 603 </para>
 604
 605 @container: the object which received the signal.
 606 @direction:
 607 @Returns:
 608
 609 <!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
 610 <para>
 611
 612 </para>
 613
 614
 615 <!-- ##### STRUCT GtkData ##### -->
 616 <para>
 617 The #GtkData-struct struct contains no public fields.
 618 </para>
 619
 620
 621 <!-- ##### SIGNAL GtkData::disconnect ##### -->
 622 <para>
 623 Emitted to notify any views on the #GtkData object to disconnect from it,
 624 possibly because the #GtkData object is about to be destroyed.
 625 </para>
 626
 627 @data: the object which received the signal.
 628
 629 <!-- ##### SIGNAL GtkEditable::activate ##### -->
 630 <para>
 631 Indicates that the user has activated the widget
 632 in some fashion. Generally, this will be done
 633 with a keystroke. (The default binding for this
 634 action is Return for #GtkEntry and
 635 Control-Return for #GtkText.)
 636 </para>
 637
 638 @editable: the object which received the signal.
 639
 640 <!-- ##### SIGNAL GtkEditable::changed ##### -->
 641 <para>
 642 Indicates that the user has changed the contents
 643 of the widget.
 644 </para>
 645
 646 @editable: the object which received the signal.
 647
 648 <!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
 649 <para>
 650 An action signal. Causes the characters in the current selection to
 651 be copied to the clipboard.
 652 </para>
 653
 654 @editable: the object which received the signal.
 655
 656 <!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
 657 <para>
 658 An action signal. Causes the characters in the current
 659 selection to be copied to the clipboard and then deleted from
 660 the widget.
 661 </para>
 662
 663 @editable: the object which received the signal.
 664
 665 <!-- ##### SIGNAL GtkEditable::delete-text ##### -->
 666 <para>
 667 This signal is emitted when text is deleted from
 668 the widget by the user. The default handler for
 669 this signal will normally be responsible for inserting
 670 the text, so by connecting to this signal and then
 671 stopping the signal with gtk_signal_emit_stop(), it
 672 is possible to modify the inserted text, or prevent
 673 it from being inserted entirely. The @start_pos
 674 and @end_pos parameters are interpreted as for
 675 gtk_editable_delete_text()
 676 </para>
 677
 678 @editable: the object which received the signal.
 679 @start_pos: the starting position.
 680 @end_pos: the end position.
 681
 682 <!-- ##### SIGNAL GtkEditable::insert-text ##### -->
 683 <para>
 684 This signal is emitted when text is inserted into
 685 the widget by the user. The default handler for
 686 this signal will normally be responsible for inserting
 687 the text, so by connecting to this signal and then
 688 stopping the signal with gtk_signal_emit_stop(), it
 689 is possible to modify the inserted text, or prevent
 690 it from being inserted entirely.
 691 </para>
 692
 693 @editable: the object which received the signal.
 694 @new_text: the new text to insert.
 695 @new_text_length: the length of the new text.
 696 @position: the position at which to insert the new text.
 697            this is an in-out paramter. After the signal
 698            emission is finished, it should point after
 699            the newly inserted text.
 700
 701 <!-- ##### SIGNAL GtkEditable::kill-char ##### -->
 702 <para>
 703 An action signal. Delete a single character.
 704 </para>
 705
 706 @editable: the object which received the signal.
 707 @direction: the direction in which to delete. Positive
 708    indicates forward deletion, negative, backwards deletion.
 709
 710 <!-- ##### SIGNAL GtkEditable::kill-line ##### -->
 711 <para>
 712 An action signal. Delete a single line.
 713 </para>
 714
 715 @editable: the object which received the signal.
 716 @direction: the direction in which to delete. Positive
 717    indicates forward deletion, negative, backwards deletion.
 718
 719 <!-- ##### SIGNAL GtkEditable::kill-word ##### -->
 720 <para>
 721 An action signal. Delete a single word.
 722 </para>
 723
 724 @editable: the object which received the signal.
 725 @direction: the direction in which to delete. Positive
 726    indicates forward deletion, negative, backwards deletion.
 727
 728 <!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
 729 <para>
 730 An action signal. Move the cursor position.
 731 </para>
 732
 733 @editable: the object which received the signal.
 734 @x: horizontal distance to move the cursor.
 735 @y: vertical distance to move the cursor.
 736
 737 <!-- ##### SIGNAL GtkEditable::move-page ##### -->
 738 <para>
 739 An action signal. Move the cursor by pages.
 740 </para>
 741
 742 @editable: the object which received the signal.
 743 @x: Number of pages to move the cursor horizontally.
 744 @y: Number of pages to move the cursor vertically.
 745
 746 <!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
 747 <para>
 748 An action signal. Move the cursor to the given column.
 749 </para>
 750
 751 @editable: the object which received the signal.
 752 @column: the column to move to. (A negative value indicates
 753          the last column)
 754
 755 <!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
 756 <para>
 757 An action signal. Move the cursor to the given row.
 758 </para>
 759
 760 @editable: the object which received the signal.
 761 @row: the row to move to. (A negative value indicates
 762       the last row)
 763
 764 <!-- ##### SIGNAL GtkEditable::move-word ##### -->
 765 <para>
 766 An action signal. Move the cursor by words.
 767 </para>
 768
 769 @editable: the object which received the signal.
 770 @num_words: The number of words to move the
 771 cursor. (Can be negative).
 772
 773 <!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
 774 <para>
 775 An action signal. Causes the contents of the clipboard to
 776 be pasted into the editable widget at the current cursor
 777 position.
 778 </para>
 779
 780 @editable: the object which received the signal.
 781
 782 <!-- ##### SIGNAL GtkEditable::set-editable ##### -->
 783 <para>
 784 Determines if the user can edit the text in the editable
 785 widget or not. This is meant to be overriden by
 786 child classes and should not generally useful to
 787 applications.
 788 </para>
 789
 790 @editable: the object which received the signal.
 791 @is_editable: %TRUE if the user is allowed to edit the text
 792   in the widget.
 793
 794 <!-- ##### ARG GtkEditable:editable ##### -->
 795 <para>
 796 A boolean indicating whether the widget is editable by
 797 the user.
 798 </para>
 799
 800
 801 <!-- ##### ARG GtkEditable:text-position ##### -->
 802 <para>
 803 The position of the cursor.
 804 </para>
 805
 806
 807 <!-- ##### USER_FUNCTION GtkEmissionHook ##### -->
 808 <para>
 809 A simple function pointer to get invoked when the
 810 signal is emitted.  This allows you tie a hook to the signal type,
 811 so that it will trap all emissions of that signal, from any object.
 812 </para>
 813 <para>
 814 You may not attach these to signals created with the
 815 #GTK_RUN_NO_HOOKS flag.
 816 </para>
 817
 818 @object:
 819 @signal_id:
 820 @n_params:
 821 @params:
 822 @data:
 823 @Returns:
 824
 825 <!-- ##### SIGNAL GtkEntry::changed ##### -->
 826 <para>
 827
 828 </para>
 829
 830 @entry: the object which received the signal.
 831
 832 <!-- ##### SIGNAL GtkEntry::delete-text ##### -->
 833 <para>
 834
 835 </para>
 836
 837 @entry: the object which received the signal.
 838 @arg1:
 839 @arg2:
 840
 841 <!-- ##### SIGNAL GtkEntry::insert-text ##### -->
 842 <para>
 843
 844 </para>
 845
 846 @entry: the object which received the signal.
 847 @arg1:
 848 @arg2:
 849 @arg3:
 850
 851 <!-- ##### ARG GtkEntry:text-position ##### -->
 852 <para>
 853
 854 </para>
 855
 856
 857 <!-- ##### ENUM GtkFontFilterType ##### -->
 858 <para>
 859 A set of bit flags used to specify the filter being set
 860 when calling gtk_font_selection_dialog_set_filter() or
 861 gtk_font_selection_set_filter().
 862 </para>
 863
 864 @GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user.
 865 @GTK_FONT_FILTER_USER: the user filter, which can be changed from within the
 866 'Filter' page of the #GtkFontSelection widget.
 867
 868 <!-- ##### ENUM GtkFontType ##### -->
 869 <para>
 870 A set of bit flags used to specify the type of fonts shown
 871 when calling gtk_font_selection_dialog_set_filter() or
 872 gtk_font_selection_set_filter().
 873 </para>
 874
 875 @GTK_FONT_BITMAP: bitmap fonts.
 876 @GTK_FONT_SCALABLE: scalable fonts.
 877 @GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts.
 878 @GTK_FONT_ALL: a bitwise combination of all of the above.
 879
 880 <!-- ##### ARG GtkHScale:adjustment ##### -->
 881 <para>
 882 the #GtkAdjustment which sets the range of the scale.
 883 </para>
 884
 885
 886 <!-- ##### ARG GtkHScrollbar:adjustment ##### -->
 887 <para>
 888
 889 </para>
 890
 891
 892 <!-- ##### USER_FUNCTION GtkImageLoader ##### -->
 893 <para>
 894 A GtkImageLoader is used to load a filename found in
 895 a RC file.
 896 </para>
 897
 898 @window: the window for creating image
 899 @colormap: the colormap for this image
 900 @mask: a pointer to the location to store the mask
 901 @transparent_color: the transparent color for the image
 902 @filename: filename to load
 903 @Returns: a #GtkPixmap representing @filename
 904
 905 <!-- ##### ARG GtkLabel:accel-keyval ##### -->
 906 <para>
 907
 908 </para>
 909
 910
 911 <!-- ##### SIGNAL GtkMenuBar::cycle-focus ##### -->
 912 <para>
 913
 914 </para>
 915
 916 @menubar: the object which received the signal.
 917 @arg1:
 918
 919 <!-- ##### ARG GtkObject:object-signal ##### -->
 920 <para>
 921 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 922 the signal to the object, so that the user data and objects
 923 and swapped when the signal handler is invoked.
 924 </para>
 925 <para>
 926 This is useful for handlers that are primarily notifying
 927 other objects and could just invoke an already existing function
 928 if the parameters were swapped.
 929 See gtk_signal_connect_object() for more details.
 930 </para>
 931
 932
 933 <!-- ##### ARG GtkObject:object-signal-after ##### -->
 934 <para>
 935 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 936 the signal to the object, so that the user data and objects
 937 and swapped when the signal handler is invoked,
 938 and so that the handler is invoked after all others.
 939 </para>
 940 <para>
 941 See gtk_signal_connect_object_after() for more details.
 942 </para>
 943
 944
 945 <!-- ##### ARG GtkObject:signal ##### -->
 946 <para>
 947 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 948 the signal to the object.
 949 </para>
 950
 951
 952 <!-- ##### ARG GtkObject:signal-after ##### -->
 953 <para>
 954 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 955 the signal to the object, so that the signal is always run
 956 after other user handlers and the default handler.
 957 </para>
 958
 959
 960 <!-- ##### SIGNAL GtkOldEditable::changed ##### -->
 961 <para>
 962
 963 </para>
 964
 965 @oldeditable: the object which received the signal.
 966
 967 <!-- ##### SIGNAL GtkOldEditable::delete-text ##### -->
 968 <para>
 969
 970 </para>
 971
 972 @oldeditable: the object which received the signal.
 973 @arg1:
 974 @arg2:
 975
 976 <!-- ##### SIGNAL GtkOldEditable::insert-text ##### -->
 977 <para>
 978
 979 </para>
 980
 981 @oldeditable: the object which received the signal.
 982 @arg1:
 983 @arg2:
 984 @arg3:
 985
 986 <!-- ##### STRUCT GtkPacker ##### -->
 987 <para>
 988
 989 </para>
 990
 991 @parent:
 992 @children:
 993 @spacing:
 994 @default_border_width:
 995 @default_pad_x:
 996 @default_pad_y:
 997 @default_i_pad_x:
 998 @default_i_pad_y:
 999
1000 <!-- ##### ARG GtkPacker:default-border-width ##### -->
1001 <para>
1002
1003 </para>
1004
1005
1006 <!-- ##### ARG GtkPacker:default-ipad-x ##### -->
1007 <para>
1008
1009 </para>
1010
1011
1012 <!-- ##### ARG GtkPacker:default-ipad-y ##### -->
1013 <para>
1014
1015 </para>
1016
1017
1018 <!-- ##### ARG GtkPacker:default-pad-x ##### -->
1019 <para>
1020
1021 </para>
1022
1023
1024 <!-- ##### ARG GtkPacker:default-pad-y ##### -->
1025 <para>
1026
1027 </para>
1028
1029
1030 <!-- ##### ARG GtkPacker:spacing ##### -->
1031 <para>
1032
1033 </para>
1034
1035
1036 <!-- ##### STRUCT GtkPackerChild ##### -->
1037 <para>
1038
1039 </para>
1040
1041 @widget:
1042 @anchor:
1043 @side:
1044 @options:
1045 @use_default:
1046 @border_width:
1047 @pad_x:
1048 @pad_y:
1049 @i_pad_x:
1050 @i_pad_y:
1051
1052 <!-- ##### ENUM GtkPackerOptions ##### -->
1053 <para>
1054
1055 </para>
1056
1057 @GTK_PACK_EXPAND:
1058 @GTK_FILL_X:
1059 @GTK_FILL_Y:
1060
1061 <!-- ##### ARG GtkPaned:handle-size ##### -->
1062 <para>
1063
1064 </para>
1065
1066
1067 <!-- ##### STRUCT GtkPatternSpec ##### -->
1068 <para>
1069
1070 </para>
1071
1072 @match_type:
1073 @pattern_length:
1074 @pattern:
1075 @pattern_reversed:
1076 @user_data:
1077 @seq_id:
1078
1079 <!-- ##### ENUM GtkPrivateFlags ##### -->
1080 <para>
1081
1082 </para>
1083
1084 @PRIVATE_GTK_USER_STYLE:
1085 @PRIVATE_GTK_RESIZE_PENDING:
1086 @PRIVATE_GTK_RESIZE_NEEDED:
1087 @PRIVATE_GTK_LEAVE_PENDING:
1088 @PRIVATE_GTK_HAS_SHAPE_MASK:
1089 @PRIVATE_GTK_IN_REPARENT:
1090 @PRIVATE_GTK_DIRECTION_SET:
1091 @PRIVATE_GTK_DIRECTION_LTR:
1092
1093 <!-- ##### ARG GtkScrolledWindow:shadow ##### -->
1094 <para>
1095
1096 </para>
1097
1098
1099 <!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
1100 <para>
1101 A function which you can use to clean up when the
1102 signal handler is destroyed.
1103 </para>
1104 <para>
1105 For example, if your handler requires a few variables
1106 that you made into a struct and allocated (using g_new()
1107 or something), then you will probably want to free
1108 it as soon as the hook is destroyed.  This will
1109 allow you to do that. (For this in particular
1110 it is convenient to pass g_free() as a #GtkSignalDestroy
1111 function).
1112 </para>
1113
1114 @data: The user data associated with the hook that is being
1115 destroyed.
1116
1117 <!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
1118 <para>
1119 This is currently a hack left in for a scheme wrapper library.
1120 It may be removed.
1121 </para>
1122 <para>
1123 Don't use it.
1124 </para>
1125
1126 @object: The object which emits the signal.
1127 @data: The user data associated with the hook.
1128 @nparams: The number of parameters to the function.
1129 @args: The actual values of the arguments.
1130 @arg_types: The types of the arguments.
1131 @return_type: The type of the return value from the function
1132 or #GTK_TYPE_NONE for no return value.
1133
1134 <!-- ##### STRUCT GtkSignalQuery ##### -->
1135 <para>
1136 This structure contains all the information about a particular
1137 signal:  its name, the type it affects, the signature of the handlers,
1138 and its unique identifying integer.
1139 </para>
1140
1141 @object_type:
1142 @signal_id:
1143 @signal_name:
1144 @is_user_signal:
1145 @signal_flags:
1146 @return_val:
1147 @nparams:
1148 @params:
1149
1150 <!-- ##### ARG GtkSpinButton:shadow-type ##### -->
1151 <para>
1152 the type of border that surrounds the arrows of a spin button.
1153 </para>
1154
1155
1156 <!-- ##### STRUCT GtkStatusbarMsg ##### -->
1157 <para>
1158 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.
1159 </para>
1160
1161 @text:
1162 @context_id:
1163 @message_id:
1164
1165 <!-- ##### STRUCT GtkTextBTreeNode ##### -->
1166 <para>
1167
1168 </para>
1169
1170
1171 <!-- ##### ARG GtkTextTag:justify ##### -->
1172 <para>
1173 A #GtkJustification for the text. This is only used when the tag is
1174 applied to the first character in a paragraph.
1175 </para>
1176
1177
1178 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
1179 <para>
1180 Pixel width of the left margin of the text for lines after the first
1181 line in a wrapped paragraph.
1182 </para>
1183
1184
1185 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
1186 <para>
1187
1188 </para>
1189
1190
1191 <!-- ##### ARG GtkTextTag:offset ##### -->
1192 <para>
1193 Pixels to offset the text horizontally or vertically, useful to
1194 produce superscript and subscript.
1195 </para>
1196
1197
1198 <!-- ##### ARG GtkTextView:height-lines ##### -->
1199 <para>
1200
1201 </para>
1202
1203
1204 <!-- ##### ARG GtkTextView:justify ##### -->
1205 <para>
1206
1207 </para>
1208
1209
1210 <!-- ##### ARG GtkTextView:width-columns ##### -->
1211 <para>
1212
1213 </para>
1214
1215
1216 <!-- ##### SIGNAL GtkTreeModel::row-changed ##### -->
1217 <para>
1218
1219 </para>
1220
1221 @treemodel: the object which received the signal.
1222 @arg1:
1223 @arg2:
1224
1225 <!-- ##### SIGNAL GtkTreeModel::row-deleted ##### -->
1226 <para>
1227
1228 </para>
1229
1230 @treemodel: the object which received the signal.
1231 @arg1:
1232
1233 <!-- ##### SIGNAL GtkTreeModel::row-has-child-toggled ##### -->
1234 <para>
1235
1236 </para>
1237
1238 @treemodel: the object which received the signal.
1239 @arg1:
1240 @arg2:
1241
1242 <!-- ##### SIGNAL GtkTreeModel::row-inserted ##### -->
1243 <para>
1244
1245 </para>
1246
1247 @treemodel: the object which received the signal.
1248 @arg1:
1249 @arg2:
1250
1251 <!-- ##### SIGNAL GtkTreeModel::rows-reordered ##### -->
1252 <para>
1253
1254 </para>
1255
1256 @treemodel: the object which received the signal.
1257 @arg1:
1258 @arg2:
1259 @arg3:
1260
1261 <!-- ##### STRUCT GtkTreeSelectionClass ##### -->
1262 <para>
1263
1264 </para>
1265
1266
1267 <!-- ##### ENUM GtkTreeSelectionMode ##### -->
1268 <para>
1269
1270 </para>
1271
1272 @GTK_TREE_SELECTION_SINGLE:
1273 @GTK_TREE_SELECTION_MULTI:
1274
1275 <!-- ##### USER_FUNCTION GtkTreeViewDraggableFunc ##### -->
1276 <para>
1277
1278 </para>
1279
1280 @tree_view:
1281 @context:
1282 @path:
1283 @user_data:
1284 @Returns:
1285
1286 <!-- ##### USER_FUNCTION GtkTreeViewDroppableFunc ##### -->
1287 <para>
1288
1289 </para>
1290
1291 @tree_view:
1292 @context:
1293 @path:
1294 @pos:
1295 @user_data:
1296 @Returns:
1297
1298 <!-- ##### ARG GtkVScale:adjustment ##### -->
1299 <para>
1300 the #GtkAdjustment which sets the range of the scale.
1301 </para>
1302
1303
1304 <!-- ##### ARG GtkVScrollbar:adjustment ##### -->
1305 <para>
1306
1307 </para>
1308
1309
1310 <!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
1311 <para>
1312
1313 </para>
1314
1315 @widget: the object which received the signal.
1316 @arg1:
1317 @Returns:
1318
1319 <!-- ##### SIGNAL GtkWidget::add-accelerator ##### -->
1320 <para>
1321
1322 </para>
1323
1324 @widget: the object which received the signal.
1325 @accel_signal_id:
1326 @accel_group:
1327 @accel_key:
1328 @accel_mods:
1329 @accel_flags:
1330
1331 <!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
1332 <para>
1333
1334 </para>
1335
1336 @widget: the object which received the signal.
1337 @message:
1338
1339 <!-- ##### SIGNAL GtkWidget::draw ##### -->
1340 <para>
1341
1342 </para>
1343
1344 @widget: the object which received the signal.
1345 @area:
1346
1347 <!-- ##### SIGNAL GtkWidget::draw-default ##### -->
1348 <para>
1349
1350 </para>
1351
1352 @widget: the object which received the signal.
1353
1354 <!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
1355 <para>
1356
1357 </para>
1358
1359 @widget: the object which received the signal.
1360
1361 <!-- ##### SIGNAL GtkWidget::remove-accelerator ##### -->
1362 <para>
1363
1364 </para>
1365
1366 @widget: the object which received the signal.
1367 @accel_group:
1368 @accel_key:
1369 @accel_mods:
1370
1371 <!-- ##### ARG GtkWidget:height ##### -->
1372 <para>
1373
1374 </para>
1375
1376
1377 <!-- ##### ARG GtkWidget:width ##### -->
1378 <para>
1379
1380 </para>
1381
1382
1383 <!-- ##### ARG GtkWidget:x ##### -->
1384 <para>
1385
1386 </para>
1387
1388
1389 <!-- ##### ARG GtkWidget:y ##### -->
1390 <para>
1391
1392 </para>
1393
1394
1395 <!-- ##### SIGNAL GtkWindow::accels-changed ##### -->
1396 <para>
1397
1398 </para>
1399
1400 @window: the object which received the signal.
1401
1402 <!-- ##### ARG GtkWindow:auto-shrink ##### -->
1403 <para>
1404 If the window shrinks automatically when widgets within it shrink.
1405 </para>
1406
1407
1408 <!-- ##### ARG GtkWindow:icon-list ##### -->
1409 <para>
1410
1411 </para>
1412
1413
1414 <!-- ##### FUNCTION gtk_accel_group_activate ##### -->
1415 <para>
1416
1417 </para>
1418
1419 @accel_group:
1420 @accel_key:
1421 @accel_mods:
1422 @Returns:
1423
1424 <!-- ##### FUNCTION gtk_accel_group_add ##### -->
1425 <para>
1426
1427 </para>
1428
1429 @accel_group:
1430 @path:
1431 @accel_key:
1432 @accel_mods:
1433 @accel_flags:
1434 @object:
1435 @accel_signal:
1436
1437 <!-- ##### FUNCTION gtk_accel_group_attach ##### -->
1438 <para>
1439
1440 </para>
1441
1442 @accel_group:
1443 @object:
1444
1445 <!-- ##### FUNCTION gtk_accel_group_create_add ##### -->
1446 <para>
1447
1448 </para>
1449
1450 @class_type:
1451 @signal_flags:
1452 @handler_offset:
1453 @Returns:
1454
1455 <!-- ##### FUNCTION gtk_accel_group_create_remove ##### -->
1456 <para>
1457
1458 </para>
1459
1460 @class_type:
1461 @signal_flags:
1462 @handler_offset:
1463 @Returns:
1464
1465 <!-- ##### FUNCTION gtk_accel_group_detach ##### -->
1466 <para>
1467
1468 </para>
1469
1470 @accel_group:
1471 @object:
1472
1473 <!-- ##### FUNCTION gtk_accel_group_entries_from_object ##### -->
1474 <para>
1475
1476 </para>
1477
1478 @object:
1479 @Returns:
1480
1481 <!-- ##### FUNCTION gtk_accel_group_get_default ##### -->
1482 <para>
1483
1484 </para>
1485
1486 @Returns:
1487
1488 <!-- ##### FUNCTION gtk_accel_group_get_entry ##### -->
1489 <para>
1490
1491 </para>
1492
1493 @accel_group:
1494 @accel_key:
1495 @accel_mods:
1496 @Returns:
1497
1498 <!-- ##### FUNCTION gtk_accel_group_get_type ##### -->
1499 <para>
1500
1501 </para>
1502
1503 @Returns:
1504
1505 <!-- ##### FUNCTION gtk_accel_group_handle_add ##### -->
1506 <para>
1507
1508 </para>
1509
1510 @object:
1511 @accel_signal_id:
1512 @accel_group:
1513 @accel_key:
1514 @accel_mods:
1515 @accel_flags:
1516
1517 <!-- ##### FUNCTION gtk_accel_group_handle_remove ##### -->
1518 <para>
1519
1520 </para>
1521
1522 @object:
1523 @accel_group:
1524 @accel_key:
1525 @accel_mods:
1526
1527 <!-- ##### FUNCTION gtk_accel_group_lock_entry ##### -->
1528 <para>
1529
1530 </para>
1531
1532 @accel_group:
1533 @accel_key:
1534 @accel_mods:
1535
1536 <!-- ##### FUNCTION gtk_accel_group_remove ##### -->
1537 <para>
1538
1539 </para>
1540
1541 @accel_group:
1542 @accel_key:
1543 @accel_mods:
1544 @object:
1545
1546 <!-- ##### FUNCTION gtk_accel_group_unlock_entry ##### -->
1547 <para>
1548
1549 </para>
1550
1551 @accel_group:
1552 @accel_key:
1553 @accel_mods:
1554
1555 <!-- ##### FUNCTION gtk_accel_label_get_accel_object ##### -->
1556 <para>
1557
1558 </para>
1559
1560 @accel_label:
1561 @Returns:
1562
1563 <!-- ##### FUNCTION gtk_accel_label_set_accel_object ##### -->
1564 <para>
1565
1566 </para>
1567
1568 @accel_label:
1569 @accel_object:
1570
1571 <!-- ##### FUNCTION gtk_accel_map_add_notifer ##### -->
1572 <para>
1573
1574 </para>
1575
1576 @accel_path:
1577 @notify_data:
1578 @notify_func:
1579 @accel_group:
1580
1581 <!-- ##### FUNCTION gtk_accel_map_remove_notifer ##### -->
1582 <para>
1583
1584 </para>
1585
1586 @accel_path:
1587 @notify_data:
1588 @notify_func:
1589
1590 <!-- ##### FUNCTION gtk_arg_copy ##### -->
1591 <para>
1592 It will either copy data into an existing argument or allocate a new argument
1593 and copy the data.  Strings are duplicated.  All other pointers and
1594 values are copied (shallowly-- that is the pointers themselves are
1595 copied, not the data they point to.)
1596 </para>
1597 <para>
1598 You should call gtk_arg_reset() on dest_arg before calling this
1599 if the argument may contain string data that you want freed.
1600 </para>
1601
1602 @src_arg: the argument to duplicate.
1603 @dest_arg: the argument to copy over (or NULL to create a new #GtkArg).
1604 @Returns: the new #GtkArg (or dest_arg, if it was not NULL).
1605
1606 <!-- ##### FUNCTION gtk_arg_free ##### -->
1607 <para>
1608 Frees the argument, and optionally its contents.
1609 </para>
1610
1611 @arg: the argument to free.
1612 @free_contents: whether to free the string, if it is a string.
1613
1614 <!-- ##### FUNCTION gtk_arg_get_info ##### -->
1615 <para>
1616 Private: get information about an argument.
1617 </para>
1618
1619 @object_type: the type of object.
1620 @arg_info_hash_table: the hashtable of #GtkArgInfos.
1621 @arg_name: the name of the argument to lookup.
1622 @info_p: the argument info.
1623 @Returns: an error message on failure, or NULL otherwise.
1624
1625 <!-- ##### FUNCTION gtk_arg_info_equal ##### -->
1626 <para>
1627 A #GCompareFunc for hashing #GtkArgInfos.
1628 </para>
1629
1630 @arg_info_1: a #GtkArgInfo.
1631 @arg_info_2: a #GtkArgInfo.
1632 @Returns: whether the arguments are the same.
1633
1634 <!-- ##### FUNCTION gtk_arg_info_hash ##### -->
1635 <para>
1636 A #GHashFunc for hashing #GtkArgInfos.
1637 </para>
1638
1639 @arg_info: a #GtkArgInfo.
1640 @Returns: a hash value for that #GtkArgInfo.
1641
1642 <!-- ##### FUNCTION gtk_arg_name_strip_type ##### -->
1643 <para>
1644 Given a fully qualified argument name (e.g. "GtkButton::label")
1645 it returns just the argument name (e.g. "label") unless
1646 the argument name was invalid, in which case it returns NULL.
1647 </para>
1648
1649 @arg_name: the fully-qualified argument name.
1650 @Returns: the base argument name.
1651
1652 <!-- ##### FUNCTION gtk_arg_new ##### -->
1653 <para>
1654 Creates a new argument of a certain type, set to 0 or NULL.
1655 </para>
1656
1657 @arg_type: the type of the argument.
1658 @Returns: the newly created #GtkArg.
1659
1660 <!-- ##### FUNCTION gtk_arg_reset ##### -->
1661 <para>
1662
1663 </para>
1664
1665 @arg:
1666
1667 <!-- ##### FUNCTION gtk_arg_to_valueloc ##### -->
1668 <para>
1669
1670 </para>
1671
1672 @arg:
1673 @value_pointer:
1674
1675 <!-- ##### FUNCTION gtk_arg_type_new_static ##### -->
1676 <para>
1677 Create a new argument registered with a class.
1678 </para>
1679
1680 @base_class_type: the basic type having the arguments, almost alway
1681 GTK_TYPE_OBJECT, except if your defining a different type argument
1682 that gets a different namespace.  #GtkContainer does this to define
1683 per-child arguments of the container.
1684 @arg_name: name of the argument to create.  (must be a static constant string)
1685 @class_n_args_offset: offset into the base class structure that tells
1686 the number of arguments.
1687 @arg_info_hash_table: hashtable of #GtkArgInfos.
1688 @arg_type: type of the argument.
1689 @arg_flags: flags of the argument.
1690 @arg_id: ???
1691 @Returns: the new #GtkArgInfo.
1692
1693 <!-- ##### FUNCTION gtk_arg_values_equal ##### -->
1694 <para>
1695
1696 </para>
1697
1698 @arg1:
1699 @arg2:
1700 @Returns:
1701
1702 <!-- ##### FUNCTION gtk_args_collect ##### -->
1703 <para>
1704 Private:  given a hashtable of argument information it takes a vararg
1705 list and parses it into arguments (in the form of lists of #GtkArgs
1706 and lists of #GtkArgInfos.
1707 </para>
1708 <para>
1709 The list of arguments starts with first_arg_name then the first argument's
1710 value.  Followed by any number of additional name/argument pairs,
1711 terminated with NULL.
1712 </para>
1713
1714 @object_type: the type of object we are collecting arguments for.
1715 @arg_info_hash_table: a hashtable mapping from names of arguments
1716 to their #GtkArgInfos.
1717 @arg_list_p: a returned list of arguments obtained from parsing the
1718 varargs.
1719 @info_list_p: a returned list of the #GtkArgInfos.
1720 @first_arg_name: the name of the first argument.
1721 @var_args: a va_list containing the value of the first argument,
1722 followed by name/value pairs, followed by NULL.
1723 @Returns: an error message on failure, or NULL otherwise.
1724
1725 <!-- ##### FUNCTION gtk_args_collect_cleanup ##### -->
1726 <para>
1727 Private: erase lists of arguments returned from gtk_args_collect().
1728 </para>
1729
1730 @arg_list: arg_list_p returned from gtk_args_collect().
1731 @info_list: info_list_p returned from gtk_args_collect().
1732
1733 <!-- ##### FUNCTION gtk_args_query ##### -->
1734 <para>
1735 Private: from a class type and its arginfo hashtable,
1736 get an array of #GtkArgs that this object accepts.
1737 </para>
1738
1739 @class_type: the class type.
1740 @arg_info_hash_table: the hashtable of #GtkArgInfos.
1741 @arg_flags: returned array of argument flags.
1742 @n_args_p: the number of arguments this object accepts.
1743 @Returns: the array of arguments (or NULL on error).
1744
1745 <!-- ##### FUNCTION gtk_button_box_child_requisition ##### -->
1746 <para>\r
1747 This is an internally used function and should never be called from an\r
1748 application.\r
1749 </para>
1750
1751 @widget:
1752 @nvis_children:
1753 @width:
1754 @height:
1755
1756 <!-- ##### FUNCTION gtk_button_box_get_child_ipadding_default ##### -->
1757 <para>\r
1758 The internal padding of a button is the amount of space between the outside\r
1759 of the button and the widget it contains. This function gets the default\r
1760 amount of horizontal and vertical padding, placing the results in @ipad_x\r
1761 and @ipad_y, respectively.\r
1762 </para>
1763
1764 @ipad_x: the default horizontal internal button padding.
1765 @ipad_y: the default vertical internal button padding.
1766
1767 <!-- ##### FUNCTION gtk_button_box_get_child_size_default ##### -->
1768 <para>\r
1769 Retrieves the default minimum width and height for all button boxes, and\r
1770 places the values in @min_width and @min_height, respectively.\r
1771 </para>
1772
1773 @min_width: the default minimum width of a child widget.
1774 @min_height: the default minimum height of a child widget.
1775
1776 <!-- ##### FUNCTION gtk_button_box_set_child_ipadding_default ##### -->
1777 <para>\r
1778 Sets the default number of pixels that pad each button in every button box.\r
1779 </para>
1780
1781 @ipad_x: new default horizontal padding.
1782 @ipad_y: new default vertical padding.
1783
1784 <!-- ##### FUNCTION gtk_button_box_set_child_size_default ##### -->
1785 <para>\r
1786 Sets the default size of child buttons.\r
1787 </para>
1788
1789 @min_width: minimum default width for child buttons.
1790 @min_height: minimum default height for child buttons.
1791
1792 <!-- ##### FUNCTION gtk_button_new_accel ##### -->
1793 <para>
1794
1795 </para>
1796
1797 @uline_label:
1798 @accel_group:
1799 @Returns:
1800
1801 <!-- ##### FUNCTION gtk_button_new_stock ##### -->
1802 <para>
1803
1804 </para>
1805
1806 @stock_id:
1807 @accel_group:
1808 @Returns:
1809
1810 <!-- ##### FUNCTION gtk_cell_renderer_event ##### -->
1811 <para>
1812
1813 </para>
1814
1815 @cell:
1816 @event:
1817 @widget:
1818 @path:
1819 @background_area:
1820 @cell_area:
1821 @flags:
1822 @Returns:
1823
1824 <!-- ##### FUNCTION gtk_cell_renderer_text_pixbuf_new ##### -->
1825 <para>
1826
1827 </para>
1828
1829 @Returns:
1830
1831 <!-- ##### FUNCTION gtk_clist_construct ##### -->
1832 <para>
1833 Initializes a previously allocated #GtkCList widget for use.  This should not
1834 normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
1835 </para>
1836
1837 @clist: A pointer to an uninitialized #GtkCList widget.
1838 @columns: The number of columns the #GtkCList should have.
1839 @titles: An array of strings that should be used as the titles i
1840 of the columns.  There should be enough strings in the array for
1841 the number of columns specified.
1842
1843 <!-- ##### FUNCTION gtk_color_selection_get_old_color ##### -->
1844 <para>
1845
1846 </para>
1847
1848 @colorsel:
1849 @color:
1850
1851 <!-- ##### FUNCTION gtk_color_selection_get_use_opacity ##### -->
1852 <para>
1853
1854 </para>
1855
1856 @colorsel:
1857 @Returns:
1858
1859 <!-- ##### FUNCTION gtk_color_selection_get_use_palette ##### -->
1860 <para>
1861
1862 </para>
1863
1864 @colorsel:
1865 @Returns:
1866
1867 <!-- ##### FUNCTION gtk_color_selection_set_old_color ##### -->
1868 <para>
1869
1870 </para>
1871
1872 @colorsel:
1873 @color:
1874
1875 <!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
1876 <para>
1877 Controls whether opacity can be set with the #GtkColorSelection.
1878 If this functionality is enabled, the necessary additional widgets
1879 are added to the #GtkColorSelection and the opacity value can be
1880 retrieved via the fourth value in the color array returned by
1881 the gtk_color_selection_get_color() function.
1882 </para>
1883
1884 @colorsel: a #GtkColorSelection.
1885 @use_opacity: a boolean indicating whether the opacity selection
1886 is enabled.
1887
1888 <!-- ##### FUNCTION gtk_color_selection_set_use_opacity ##### -->
1889 <para>
1890
1891 </para>
1892
1893 @colorsel:
1894 @use_opacity:
1895
1896 <!-- ##### FUNCTION gtk_color_selection_set_use_palette ##### -->
1897 <para>
1898
1899 </para>
1900
1901 @colorsel:
1902 @use_palette:
1903
1904 <!-- ##### FUNCTION gtk_container_add_child_arg_type ##### -->
1905 <para>
1906
1907 </para>
1908
1909 @arg_name:
1910 @arg_type:
1911 @arg_flags:
1912 @arg_id:
1913
1914 <!-- ##### FUNCTION gtk_container_add_with_args ##### -->
1915 <para>
1916
1917 </para>
1918
1919 @container:
1920 @widget:
1921 @first_arg_name:
1922 @Varargs:
1923
1924 <!-- ##### FUNCTION gtk_container_addv ##### -->
1925 <para>
1926
1927 </para>
1928
1929 @container:
1930 @widget:
1931 @n_args:
1932 @args:
1933
1934 <!-- ##### FUNCTION gtk_container_arg_get ##### -->
1935 <para>
1936
1937 </para>
1938
1939 @container:
1940 @child:
1941 @arg:
1942 @info:
1943
1944 <!-- ##### FUNCTION gtk_container_arg_set ##### -->
1945 <para>
1946
1947 </para>
1948
1949 @container:
1950 @child:
1951 @arg:
1952 @info:
1953
1954 <!-- ##### FUNCTION gtk_container_child_arg_get_info ##### -->
1955 <para>
1956
1957 </para>
1958
1959 @object_type:
1960 @arg_name:
1961 @info_p:
1962 @Returns:
1963
1964 <!-- ##### FUNCTION gtk_container_child_args_collect ##### -->
1965 <para>
1966
1967 </para>
1968
1969 @object_type:
1970 @arg_list_p:
1971 @info_list_p:
1972 @first_arg_name:
1973 @args:
1974 @Returns:
1975
1976 <!-- ##### FUNCTION gtk_container_child_getv ##### -->
1977 <para>
1978
1979 </para>
1980
1981 @container:
1982 @child:
1983 @n_args:
1984 @args:
1985
1986 <!-- ##### FUNCTION gtk_container_child_setv ##### -->
1987 <para>
1988
1989 </para>
1990
1991 @container:
1992 @child:
1993 @n_args:
1994 @args:
1995
1996 <!-- ##### FUNCTION gtk_container_dequeue_resize_handler ##### -->
1997 <para>
1998
1999 </para>
2000
2001 @container:
2002
2003 <!-- ##### FUNCTION gtk_container_focus ##### -->
2004 <para>
2005
2006 </para>
2007
2008 @container:
2009 @direction:
2010 @Returns:
2011
2012 <!-- ##### FUNCTION gtk_container_query_child_args ##### -->
2013 <para>
2014
2015 </para>
2016
2017 @class_type:
2018 @arg_flags:
2019 @nargs:
2020 @Returns:
2021
2022 <!-- ##### FUNCTION gtk_ctree_construct ##### -->
2023 <para>
2024 This function is not usually used by users.
2025 </para>
2026
2027 @ctree:
2028 @columns:
2029 @tree_column:
2030 @titles:
2031
2032 <!-- ##### FUNCTION gtk_drag_dest_handle_event ##### -->
2033 <para>
2034 Internal function.
2035 </para>
2036
2037 @toplevel:
2038 @event:
2039
2040 <!-- ##### FUNCTION gtk_drag_source_handle_event ##### -->
2041 <para>
2042 Internal function.
2043 </para>
2044
2045 @widget:
2046 @event:
2047
2048 <!-- ##### FUNCTION gtk_editable_changed ##### -->
2049 <para>
2050 Causes the "changed" signal to be emitted.
2051 </para>
2052
2053 @editable: a #GtkEditable widget.
2054
2055 <!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
2056 <para>
2057 Claim or disclaim ownership of the PRIMARY X selection.
2058 </para>
2059
2060 @editable: a #GtkEditable widget.
2061 @claim: if %TRUE, claim the selection, otherwise, disclaim it.
2062 @time: the timestamp for claiming the selection.
2063
2064 <!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
2065 <para>
2066 Sets one of the two font filters, to limit the fonts shown.
2067 </para>
2068
2069 @fsd: a #GtkFontSelectionDialog.
2070 @filter_type: which of the two font filters to set, either
2071 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
2072 can be changed by the user, but the base filter is permanent.
2073 @font_type: the types of font to be shown. This is a bitwise combination of
2074 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
2075 or #GTK_FONT_ALL to show all three font types.
2076 @foundries: a NULL-terminated array of strings containing foundry names which
2077 will be shown, or NULL to show all foundries.
2078 @weights: a NULL-terminated array of strings containing weight names which
2079 will be shown, or NULL to show all weights.
2080 @slants: a NULL-terminated array of strings containing slant names which
2081 will be shown, or NULL to show all slants.
2082 @setwidths: a NULL-terminated array of strings containing setwidth names which
2083 will be shown, or NULL to show all setwidths.
2084 @spacings: a NULL-terminated array of strings containing spacings which
2085 will be shown, or NULL to show all spacings.
2086 @charsets: a NULL-terminated array of strings containing charset names which
2087 will be shown, or NULL to show all charsets.
2088
2089 <!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
2090 <para>
2091 Sets one of the two font filters, to limit the fonts shown.
2092 </para>
2093
2094 @fontsel: a #GtkFontSelection.
2095 @filter_type: which of the two font filters to set, either
2096 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
2097 can be changed by the user, but the base filter is permanent.
2098 @font_type: the types of font to be shown. This is a bitwise combination of
2099 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
2100 or #GTK_FONT_ALL to show all three font types.
2101 @foundries: a NULL-terminated array of strings containing foundry names which
2102 will be shown, or NULL to show all foundries.
2103 @weights: a NULL-terminated array of strings containing weight names which
2104 will be shown, or NULL to show all weights.
2105 @slants: a NULL-terminated array of strings containing slant names which
2106 will be shown, or NULL to show all slants.
2107 @setwidths: a NULL-terminated array of strings containing setwidth names which
2108 will be shown, or NULL to show all setwidths.
2109 @spacings: a NULL-terminated array of strings containing spacings which
2110 will be shown, or NULL to show all spacings.
2111 @charsets: a NULL-terminated array of strings containing charset names which
2112 will be shown, or NULL to show all charsets.
2113
2114 <!-- ##### FUNCTION gtk_identifier_get_type ##### -->
2115 <para>
2116 Get the type of GtkIdentifier.
2117 </para>
2118
2119 @Returns: GtkType -- the enumerated type of something.
2120
2121 <!-- ##### FUNCTION gtk_image_menu_item_add_image ##### -->
2122 <para>
2123
2124 </para>
2125
2126 @image_menu_item:
2127 @child:
2128
2129 <!-- ##### FUNCTION gtk_image_menu_item_get_type ##### -->
2130 <para>
2131
2132 </para>
2133
2134 @Returns:
2135
2136 <!-- ##### FUNCTION gtk_item_factory_dump_items ##### -->
2137 <para>
2138
2139 </para>
2140
2141 @path_pspec:
2142 @modified_only:
2143 @print_func:
2144 @func_data:
2145
2146 <!-- ##### FUNCTION gtk_item_factory_dump_rc ##### -->
2147 <para>
2148
2149 </para>
2150
2151 @file_name:
2152 @path_pspec:
2153 @modified_only:
2154
2155 <!-- ##### FUNCTION gtk_item_factory_parse_rc ##### -->
2156 <para>
2157
2158 </para>
2159
2160 @file_name:
2161
2162 <!-- ##### FUNCTION gtk_item_factory_parse_rc_scanner ##### -->
2163 <para>
2164
2165 </para>
2166
2167 @scanner:
2168
2169 <!-- ##### FUNCTION gtk_item_factory_parse_rc_string ##### -->
2170 <para>
2171
2172 </para>
2173
2174 @rc_string:
2175
2176 <!-- ##### FUNCTION gtk_item_factory_print_func ##### -->
2177 <para>
2178
2179 </para>
2180
2181 @FILE_pointer:
2182 @string:
2183
2184 <!-- ##### FUNCTION gtk_label_set_markup_with_accel ##### -->
2185 <para>
2186
2187 </para>
2188
2189 @label:
2190 @str:
2191 @Returns:
2192
2193 <!-- ##### FUNCTION gtk_list_store_new_with_types ##### -->
2194 <para>
2195
2196 </para>
2197
2198 @n_columns:
2199 @Varargs:
2200 @Returns:
2201
2202 <!-- ##### FUNCTION gtk_list_store_set_cell ##### -->
2203 <para>
2204
2205 </para>
2206
2207 @store:
2208 @iter:
2209 @column:
2210 @value:
2211
2212 <!-- ##### FUNCTION gtk_list_store_set_column_type ##### -->
2213 <para>
2214
2215 </para>
2216
2217 @store:
2218 @column:
2219 @type:
2220
2221 <!-- ##### FUNCTION gtk_list_store_set_n_columns ##### -->
2222 <para>
2223
2224 </para>
2225
2226 @store:
2227 @n_columns:
2228
2229 <!-- ##### FUNCTION gtk_menu_ensure_uline_accel_group ##### -->
2230 <para>
2231
2232 </para>
2233
2234 @menu:
2235 @Returns:
2236
2237 <!-- ##### FUNCTION gtk_menu_get_uline_accel_group ##### -->
2238 <para>
2239
2240 </para>
2241
2242 @menu:
2243 @Returns:
2244
2245 <!-- ##### FUNCTION gtk_menu_item_configure ##### -->
2246 <para>
2247 Sets whether the menu item should show a submenu indicator, which is a right
2248 arrow.
2249 </para>
2250
2251 @menu_item: the menu item
2252 @show_toggle_indicator: unused
2253 @show_submenu_indicator: whether to show the arrow or not
2254
2255 <!-- ##### FUNCTION gtk_menu_item_set_placement ##### -->
2256 <para>
2257 Specifies the placement of the submenu around the menu item. The placement
2258 is usually #GTK_LEFT_RIGHT for menu items in a popup menu and
2259 #GTK_TOP_BOTTOM in menu bars.
2260 </para>
2261 <para>
2262 This function is useless in usual applications.
2263 </para>
2264
2265 @menu_item: the menu item
2266 @placement: the submenu placement
2267
2268 <!-- ##### FUNCTION gtk_object_arg_get ##### -->
2269 <para>
2270 Private function to get an argument and argument info from an object.
2271 </para>
2272
2273 @object: the object whose argument should be retrieved.
2274 @arg: the argument, for the name on input, the rest is filled on output.
2275 @info: a #GtkArgInfo structure to optionally fill in.
2276
2277 <!-- ##### FUNCTION gtk_object_arg_get_info ##### -->
2278 <para>
2279 Query information about an argument type.
2280 </para>
2281
2282 @object_type: type of object to query about.
2283 @arg_name: name of the argument.
2284 @info_p: pointer to be filled in with a pointer to the GtkArgInfo.
2285 @Returns: an error message, or NULL on success.
2286 It is the caller's responsibility to call g_free() in the event of error.
2287
2288 <!-- ##### FUNCTION gtk_object_arg_set ##### -->
2289 <para>
2290 Private function to set an argument and argument info to an object.
2291 </para>
2292
2293 @object: the object whose argument should be set.
2294 @arg: the argument.
2295 @info: infomation about this type of argument in general.
2296
2297 <!-- ##### FUNCTION gtk_object_args_collect ##### -->
2298 <para>
2299 Private: Gets an array of #GtkArgs from a va_list C structure.
2300 </para>
2301
2302 @object_type: the type of object to collect arguments for.
2303 @arg_list_p: pointer to be filled in with a list of parsed arguments.
2304 @info_list_p: optional pointer for a returned list #GtkArgInfos.
2305 @first_arg_name: name of first argument.
2306 @var_args: value of first argument, followed by more key/value pairs,
2307 terminated by NULL.
2308 @Returns: an error message, or NULL on success.
2309 It is the caller's responsibility to call g_free() in the event of error.
2310
2311 <!-- ##### FUNCTION gtk_object_class_add_signals ##### -->
2312 <para>
2313 Add an array of signals to a #GtkObjectClass.
2314 Usually this is called when registering a new type of object.
2315 </para>
2316
2317 @klass: the object class to append signals to.
2318 @signals: the signals to append.
2319 @nsignals: the number of signals being appended.
2320
2321 <!-- ##### FUNCTION gtk_object_class_user_signal_new ##### -->
2322 <para>
2323 Define a signal-handler for a new signal on an already defined
2324 object.
2325 </para>
2326 <para>
2327 See the signal documentation for more general information.
2328 </para>
2329
2330 @klass: the object class to define the signal for.
2331 @name: the name of the signal.
2332 @signal_flags: the default emission behavior for the signal.
2333 See gtk_signal_new().
2334 @marshaller: a function that will take an array of GtkArgs
2335 and invoke the appropriate handler with the normal calling
2336 conventions.
2337 @return_val: specify the return-value type for the signal
2338 (or GTK_TYPE_NONE for no return-value).
2339 @nparams: specify the number of parameters the signal
2340 receives from the caller of gtk_signal_emit().
2341 @Varargs: list of nparams #GtkTypes to pass to the signal handlers.
2342 @Returns: the signal id.  (See #GtkSignals)
2343
2344 <!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### -->
2345 <para>
2346 Define a signal-handler for a new signal on an already defined
2347 object.
2348 </para>
2349
2350 @klass: the object class to define the signal for.
2351 @name: the name of the signal.
2352 @signal_flags: the default emission behavior for the signal.
2353 See gtk_signal_new().
2354 @marshaller: takes a GtkObject, a #GtkSignalFunc, and an array
2355 of arguments, and invokes the function using the appropriate
2356 calling conventions.  Usually just select a function
2357 out of gtkmarshal.h.
2358 @return_val: specify the return-value type for the signal (possibly
2359 #GTK_TYPE_NONE).
2360 @nparams: specify the number of parameters the signal
2361 receives from the caller of gtk_signal_emit().
2362 @params: array of #GtkTypes the signal handlers for this signal
2363 should have in their prototype (of length nparams).
2364 @Returns: the signal id.  (See #GtkSignals)
2365
2366 <!-- ##### FUNCTION gtk_object_constructed ##### -->
2367 <para>
2368 Mark an allocated object as constructed.
2369 This is used for situations
2370 that require precise control of the construction process.
2371 </para>
2372 <para>
2373 This is done when gtk_object_default_construct() is inadequate.
2374 In #GtkCList the need arises because #GtkCList does construction work that
2375 must happen <emphasis>after</emphasis> its derivers.  This work
2376 cannot be done in an initializer function, so an alternate
2377 constructor is mandatory.  It calls gtk_object_constructed() to
2378 indicate it has done its job, so that no other constructor will
2379 be invoked.
2380 </para>
2381 <para>
2382 Normally this function is just automatically run from
2383 gtk_object_default_construct().
2384 </para>
2385
2386 @object: object which has been constructed.  This is usually
2387 done automatically by gtk_object_new() and gtk_object_newv().
2388
2389 <!-- ##### FUNCTION gtk_object_default_construct ##### -->
2390 <para>
2391 This function is called to construct arguments that haven't been initialized
2392 but have the #GTK_ARG_CONSTRUCT flag set.
2393 </para>
2394 <para>
2395 All number arguments are set to 0.  All pointers and strings
2396 are set to NULL.
2397 </para>
2398 <para>
2399 Normally invoked by gtk_object_new() automatically; gtk_type_new() can
2400 be used to bypass it.
2401 </para>
2402
2403 @object: the object to initialize.
2404
2405 <!-- ##### FUNCTION gtk_object_getv ##### -->
2406 <para>
2407 Gets an array of argument values from an object.
2408 </para>
2409
2410 @object: the object to get arguments from.
2411 @n_args: the number of arguments to query.
2412 @args: the arguments to fill in.
2413
2414 <!-- ##### FUNCTION gtk_object_newv ##### -->
2415 <para>
2416 Construct an object with an array of arguments.
2417 </para>
2418
2419 @object_type: the type of the object to create.
2420 @n_args: the number of arguments to set.
2421 @args: an array of n_args arguments (which are name and value pairs).
2422 @Returns: the new GtkObject.
2423
2424 <!-- ##### FUNCTION gtk_object_query_args ##### -->
2425 <para>
2426 Get all the arguments that may be used for a given type.
2427 </para>
2428 <para>
2429 In Java, this type of mechanism is called
2430 <wordasword>introspection</wordasword>.  It is used by applications
2431 like Glade, that have to determine what can be done to an object
2432 at run-time.
2433 </para>
2434
2435 @class_type: the GtkType of the ObjectClass
2436 (returned from GTK_OBJECT_CLASS(class)-&gt;type for example).
2437 @arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to
2438 each argument.  You must g_free() this if you request it.
2439 @n_args: the number of arguments is returned in this field.
2440 @Returns: an array of arguments, that you must deallocate with g_free().
2441
2442 <!-- ##### FUNCTION gtk_object_setv ##### -->
2443 <para>
2444 Set an array of arguments.
2445 </para>
2446
2447 @object: the object whose arguments should be set.
2448 @n_args: the number of arguments to set.
2449 @args: the desired values, as an array of #GtkArgs (which contain
2450 the names, types, and values of the arguments).
2451
2452 <!-- ##### FUNCTION gtk_packer_add ##### -->
2453 <para>
2454
2455 </para>
2456
2457 @packer:
2458 @child:
2459 @side:
2460 @anchor:
2461 @options:
2462 @border_width:
2463 @pad_x:
2464 @pad_y:
2465 @i_pad_x:
2466 @i_pad_y:
2467
2468 <!-- ##### FUNCTION gtk_packer_add_defaults ##### -->
2469 <para>
2470
2471 </para>
2472
2473 @packer:
2474 @child:
2475 @side:
2476 @anchor:
2477 @options:
2478
2479 <!-- ##### MACRO gtk_packer_configure ##### -->
2480 <para>
2481
2482 </para>
2483
2484
2485 <!-- ##### FUNCTION gtk_packer_new ##### -->
2486 <para>
2487
2488 </para>
2489
2490 @Returns:
2491
2492 <!-- ##### FUNCTION gtk_packer_reorder_child ##### -->
2493 <para>
2494
2495 </para>
2496
2497 @packer:
2498 @child:
2499 @position:
2500
2501 <!-- ##### FUNCTION gtk_packer_set_child_packing ##### -->
2502 <para>
2503
2504 </para>
2505
2506 @packer:
2507 @child:
2508 @side:
2509 @anchor:
2510 @options:
2511 @border_width:
2512 @pad_x:
2513 @pad_y:
2514 @i_pad_x:
2515 @i_pad_y:
2516
2517 <!-- ##### FUNCTION gtk_packer_set_default_border_width ##### -->
2518 <para>
2519
2520 </para>
2521
2522 @packer:
2523 @border:
2524
2525 <!-- ##### FUNCTION gtk_packer_set_default_ipad ##### -->
2526 <para>
2527
2528 </para>
2529
2530 @packer:
2531 @i_pad_x:
2532 @i_pad_y:
2533
2534 <!-- ##### FUNCTION gtk_packer_set_default_pad ##### -->
2535 <para>
2536
2537 </para>
2538
2539 @packer:
2540 @pad_x:
2541 @pad_y:
2542
2543 <!-- ##### FUNCTION gtk_packer_set_spacing ##### -->
2544 <para>
2545
2546 </para>
2547
2548 @packer:
2549 @spacing:
2550
2551 <!-- ##### FUNCTION gtk_paned_compute_position ##### -->
2552 <para>
2553 Internal function used by #GtkHPaned and #GtkVPaned
2554 </para>
2555
2556 @paned:
2557 @allocation:
2558 @child1_req:
2559 @child2_req:
2560
2561 <!-- ##### MACRO gtk_paned_handle_size ##### -->
2562 <para>
2563 Old name for gtk_paned_set_handle_size().
2564 </para>
2565
2566
2567 <!-- ##### FUNCTION gtk_paned_set_handle_size ##### -->
2568 <para>
2569 Set the the handle size to @size x @size pixels.
2570 </para>
2571
2572 @paned: a paned widget
2573 @size: the size in pixels
2574
2575 <!-- ##### FUNCTION gtk_pattern_match ##### -->
2576 <para>
2577
2578 </para>
2579
2580 @pspec:
2581 @string_length:
2582 @string:
2583 @string_reversed:
2584 @Returns:
2585
2586 <!-- ##### FUNCTION gtk_pattern_match_simple ##### -->
2587 <para>
2588
2589 </para>
2590
2591 @pattern:
2592 @string:
2593 @Returns:
2594
2595 <!-- ##### FUNCTION gtk_pattern_match_string ##### -->
2596 <para>
2597
2598 </para>
2599
2600 @pspec:
2601 @string:
2602 @Returns:
2603
2604 <!-- ##### FUNCTION gtk_pattern_spec_free_segs ##### -->
2605 <para>
2606
2607 </para>
2608
2609 @pspec:
2610
2611 <!-- ##### FUNCTION gtk_pattern_spec_init ##### -->
2612 <para>
2613
2614 </para>
2615
2616 @pspec:
2617 @pattern:
2618
2619 <!-- ##### FUNCTION gtk_rc_init ##### -->
2620 <para>
2621 Internal function.
2622 </para>
2623
2624
2625 <!-- ##### FUNCTION gtk_rc_load_image ##### -->
2626 <para>
2627 Internal function. Loads an image using the current
2628 image loader.
2629 </para>
2630
2631 @colormap: the colormap to use for the image
2632 @transparent_color: the transparent color for the image
2633 @filename: the filename of the image file
2634 @Returns: a #GtkPixmap representing @filename
2635
2636 <!-- ##### FUNCTION gtk_rc_set_image_loader ##### -->
2637 <para>
2638 Sets the function that GTK+ will use to load images
2639 </para>
2640
2641 @loader: the #GtkImageLoader to use
2642
2643 <!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
2644 <para>
2645
2646 </para>
2647
2648 @ruler: the gtkruler
2649
2650 <!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
2651 <para>
2652
2653 </para>
2654
2655 @ruler: the gtkruler
2656
2657 <!-- ##### FUNCTION gtk_selection_clear ##### -->
2658 <para>
2659 Internal function.
2660 </para>
2661
2662 @widget:
2663 @event:
2664 @Returns:
2665
2666 <!-- ##### FUNCTION gtk_selection_incr_event ##### -->
2667 <para>
2668 Internal function.
2669 </para>
2670
2671 @window:
2672 @event:
2673 @Returns:
2674
2675 <!-- ##### FUNCTION gtk_selection_notify ##### -->
2676 <para>
2677 Internal function.
2678 </para>
2679
2680 @widget:
2681 @event:
2682 @Returns:
2683
2684 <!-- ##### FUNCTION gtk_selection_property_notify ##### -->
2685 <para>
2686 Internal function.
2687 </para>
2688
2689 @widget:
2690 @event:
2691 @Returns:
2692
2693 <!-- ##### FUNCTION gtk_selection_request ##### -->
2694 <para>
2695 Internal function.
2696 </para>
2697
2698 @widget:
2699 @event:
2700 @Returns:
2701
2702 <!-- ##### FUNCTION gtk_settings_get_global ##### -->
2703 <para>
2704
2705 </para>
2706
2707 @Returns:
2708
2709 <!-- ##### FUNCTION gtk_signal_add_emission_hook ##### -->
2710 <para>
2711 Add an emission hook for a type of signal, for any object.
2712 </para>
2713
2714 @signal_id: the type of signal to hook for.
2715 @hook_func: the function to invoke to handle the emission hook.
2716 @data: the user data passed in to hook_func.
2717 @Returns: the id (that you may pass as a parameter
2718 to gtk_signal_remove_emission_hook()).
2719 @i:
2720 @h:
2721 @d:
2722
2723 <!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
2724 <para>
2725 Add an emission hook for a type of signal, for any object.
2726 (with control of what happens when the hook is
2727 destroyed).
2728 </para>
2729
2730 @signal_id: the type of signal add the hook for.
2731 @hook_func: the function to invoke to handle the hook.
2732 @data: the user data passed in to hook_func.
2733 @destroy: a function to invoke when the hook is destroyed,
2734 to clean up any allocation done just for this
2735 signal handler.
2736 @Returns: the id (that you may pass as a parameter
2737 to gtk_signal_remove_emission_hook()).
2738
2739 <!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
2740 <para>
2741 Returns whether a connection id is valid (and optionally not blocked).
2742 </para>
2743
2744 @object: the object to search for the desired handler.
2745 @handler_id: the connection id.
2746 @may_be_blocked: whether it is acceptable to return a blocked
2747 handler.
2748 @Returns: TRUE if the signal exists and wasn't blocked,
2749 unless #may_be_blocked was specified.  FALSE otherwise.
2750
2751 <!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
2752 <para>
2753 Destroy all the signal handlers connected to an object.
2754 This is done automatically when the object is destroyed.
2755 </para>
2756 <para>
2757 This function is labeled private.
2758 </para>
2759
2760 @object: the object whose signal handlers should be destroyed.
2761
2762 <!-- ##### FUNCTION gtk_signal_init ##### -->
2763 <para>
2764
2765 </para>
2766
2767
2768 <!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
2769 <para>
2770 Find out the recursion depth of emissions for a particular type
2771 of signal and object.  (So it will
2772 always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
2773 This is a way to avoid recursion:  you can see if
2774 you are currently running in that signal handler and emit it only
2775 if you are.
2776 </para>
2777 <para>Another way to look at it is that this number increases
2778 by one when #gtk_signal_emit(), et al, are called,
2779 and decreases by one when #gtk_signal_emit() returns.
2780 </para>
2781
2782 @object: the object with the signal handler.
2783 @signal_id: the signal id.
2784 @Returns: the recursion depth of emissions of this signal for this
2785 object.
2786
2787 <!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
2788 <para>
2789 Find out the recursion depth of emissions for a particular type
2790 of signal and object.  Just like gtk_signal_n_emissions()
2791 except it will lookup the signal id for you.
2792 </para>
2793
2794 @object: the object with the signal handler.
2795 @name: the signal name.
2796 @Returns: the recursion depth of emissions of this signal for this
2797 object.
2798
2799 <!-- ##### FUNCTION gtk_signal_query ##### -->
2800 <para>
2801 Obtain information about a signal.
2802 </para>
2803
2804 @signal_id: the signal type identifier.
2805 @Returns: a pointer to a GtkSignalQuery structure
2806 which contains all the information, or NULL.
2807 The pointer is allocated just for you:  you must g_free() it.
2808
2809 <!-- ##### FUNCTION gtk_signal_remove_emission_hook ##### -->
2810 <para>
2811 Delete an emission hook. (see gtk_signal_add_emission_hook())
2812 </para>
2813
2814 @signal_id: the id of the signal type.
2815 @hook_id: the id of the emission handler, returned by add_emission_hook().
2816 @i:
2817 @h:
2818
2819 <!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
2820 <para>
2821 These set default functions to call when the user didn't
2822 supply a function when connecting.  (These are rarely
2823 used, and probably only for language bindings)
2824 </para>
2825 <para>
2826 By default, there are no such functions.
2827 </para>
2828
2829 @marshal_func: the function to invoke on every handlers for which there
2830 isn't a function pointer.  May be NULL.
2831 @destroy_func: the function to invoke when each hook is destroyed.
2832 May be NULL.
2833
2834 <!-- ##### FUNCTION gtk_spin_button_set_shadow_type ##### -->
2835 <para>
2836 Creates a border around the arrows of a #GtkSpinButton. The type of border is determined by @shadow_type.
2837 </para>
2838
2839 @spin_button: a #GtkSpinButton
2840 @shadow_type: the new border type.
2841
2842 <!-- ##### FUNCTION gtk_stock_list_items ##### -->
2843 <para>
2844
2845 </para>
2846
2847 @Returns:
2848
2849 <!-- ##### FUNCTION gtk_text_buffer_paste_primary ##### -->
2850 <para>
2851
2852 </para>
2853
2854 @buffer:
2855 @override_location:
2856 @default_editable:
2857
2858 <!-- ##### FUNCTION gtk_text_iter_reorder ##### -->
2859 <para>
2860
2861 </para>
2862
2863 @first:
2864 @second:
2865
2866 <!-- ##### FUNCTION gtk_text_iter_spew ##### -->
2867 <para>
2868
2869 </para>
2870
2871 @iter:
2872 @desc:
2873
2874 <!-- ##### FUNCTION gtk_text_view_set_text_window_size ##### -->
2875 <para>
2876
2877 </para>
2878
2879 @text_view:
2880 @width:
2881 @height:
2882
2883 <!-- ##### FUNCTION gtk_tips_query_get_type ##### -->
2884 <para>
2885
2886 </para>
2887
2888 @Returns:
2889
2890 <!-- ##### FUNCTION gtk_trace_referencing ##### -->
2891 <para>
2892 Private: print debugging information while doing a gtk_object_ref() or
2893 a gtk_object_unref().
2894 </para>
2895
2896 @object: object to reference or unreference.
2897 @func: name of caller's function to print (used within macros).
2898 @dummy: unused.
2899 @line: line number (used within macros).
2900 @do_ref: whether to reference or unreference.
2901
2902 <!-- ##### FUNCTION gtk_tree_model_ref_iter ##### -->
2903 <para>
2904
2905 </para>
2906
2907 @tree_model:
2908 @iter:
2909
2910 <!-- ##### FUNCTION gtk_tree_model_sort_convert_iter ##### -->
2911 <para>
2912
2913 </para>
2914
2915 @tree_model_sort:
2916 @sort_iter:
2917 @child_iter:
2918
2919 <!-- ##### FUNCTION gtk_tree_model_sort_convert_path ##### -->
2920 <para>
2921
2922 </para>
2923
2924 @tree_model_sort:
2925 @child_path:
2926 @Returns:
2927 @path:
2928
2929 <!-- ##### FUNCTION gtk_tree_model_sort_new ##### -->
2930 <para>
2931
2932 </para>
2933
2934 @Returns:
2935
2936 <!-- ##### FUNCTION gtk_tree_model_sort_set_compare ##### -->
2937 <para>
2938
2939 </para>
2940
2941 @tree_model_sort:
2942 @func:
2943
2944 <!-- ##### FUNCTION gtk_tree_model_sort_set_model ##### -->
2945 <para>
2946
2947 </para>
2948
2949 @tree_model_sort:
2950 @child_model:
2951 @model:
2952
2953 <!-- ##### FUNCTION gtk_tree_model_sort_set_sort_column ##### -->
2954 <para>
2955
2956 </para>
2957
2958 @tree_model_sort:
2959 @sort_col:
2960
2961 <!-- ##### FUNCTION gtk_tree_model_unref_iter ##### -->
2962 <para>
2963
2964 </para>
2965
2966 @tree_model:
2967 @iter:
2968
2969 <!-- ##### FUNCTION gtk_tree_store_new_with_types ##### -->
2970 <para>
2971
2972 </para>
2973
2974 @n_columns:
2975 @Varargs:
2976 @Returns:
2977
2978 <!-- ##### FUNCTION gtk_tree_store_set_cell ##### -->
2979 <para>
2980
2981 </para>
2982
2983 @tree_store:
2984 @iter:
2985 @column:
2986 @value:
2987
2988 <!-- ##### FUNCTION gtk_tree_store_set_column_type ##### -->
2989 <para>
2990
2991 </para>
2992
2993 @tree_store:
2994 @column:
2995 @type:
2996 @store:
2997
2998 <!-- ##### FUNCTION gtk_tree_store_set_n_columns ##### -->
2999 <para>
3000
3001 </para>
3002
3003 @tree_store:
3004 @n_columns:
3005
3006 <!-- ##### FUNCTION gtk_tree_view_column_cell_event ##### -->
3007 <para>
3008
3009 </para>
3010
3011 @tree_column:
3012 @event:
3013 @path_string:
3014 @background_area:
3015 @cell_area:
3016 @flags:
3017 @Returns:
3018
3019 <!-- ##### FUNCTION gtk_tree_view_column_set_cell_data ##### -->
3020 <para>
3021
3022 </para>
3023
3024 @tree_column:
3025 @tree_model:
3026 @iter:
3027
3028 <!-- ##### FUNCTION gtk_tree_view_column_set_cell_renderer ##### -->
3029 <para>
3030
3031 </para>
3032
3033 @tree_column:
3034 @cell:
3035
3036 <!-- ##### FUNCTION gtk_tree_view_column_set_width ##### -->
3037 <para>
3038
3039 </para>
3040
3041 @tree_column:
3042 @width:
3043 @size:
3044
3045 <!-- ##### FUNCTION gtk_tree_view_set_rows_drag_dest ##### -->
3046 <para>
3047
3048 </para>
3049
3050 @tree_view:
3051 @targets:
3052 @n_targets:
3053 @actions:
3054 @location_droppable_func:
3055 @user_data:
3056
3057 <!-- ##### FUNCTION gtk_tree_view_set_rows_drag_source ##### -->
3058 <para>
3059
3060 </para>
3061
3062 @tree_view:
3063 @start_button_mask:
3064 @targets:
3065 @n_targets:
3066 @actions:
3067 @row_draggable_func:
3068 @user_data:
3069
3070 <!-- ##### FUNCTION gtk_type_check_class_cast ##### -->
3071 <para>
3072 Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make
3073 sure that it's okay to cast something of that @klass into a @cast_type.
3074 </para>
3075
3076 @klass: GtkTypeClass*
3077 @cast_type: GtkType
3078 @Returns: Always return @klass.
3079
3080 <!-- ##### FUNCTION gtk_type_check_object_cast ##### -->
3081 <para>
3082 Given a pointer to a GtkTypeObject @type_object, and a GtkType @cast_type,
3083 make sure that it's okay to cast @type_object into a @cast_type.
3084 </para>
3085
3086 @type_object: GtkTypeObject*
3087 @cast_type: GtkType
3088 @Returns: the same GtkTypeObject* as @type_object
3089
3090 <!-- ##### FUNCTION gtk_type_children_types ##### -->
3091 <para>
3092 Return the pointer to the type's children's types.
3093 </para>
3094
3095 @type: GtkType
3096 @Returns: pointer to a GList
3097
3098 <!-- ##### FUNCTION gtk_type_describe_heritage ##### -->
3099 <para>
3100 Print the types @type inherits from.
3101 </para>
3102
3103 @type: GtkType
3104
3105 <!-- ##### FUNCTION gtk_type_describe_tree ##### -->
3106 <para>
3107 Given a @type, describe all of its children, and their children.  Only
3108 show the size if @show_size is true.
3109 </para>
3110
3111 @type: GtkType
3112 @show_size: gboolean
3113
3114 <!-- ##### FUNCTION gtk_type_free ##### -->
3115 <para>
3116 Given the type of an object and a pointer to it, the object is freed.
3117 </para>
3118
3119 @type: GtkType
3120 @mem: gpointer to the object
3121
3122 <!-- ##### FUNCTION gtk_type_get_varargs_type ##### -->
3123 <para>
3124 Get the varargs type associated with @foreign_type
3125 </para>
3126
3127 @foreign_type: GtkType
3128 @Returns: GtkType
3129
3130 <!-- ##### FUNCTION gtk_type_parent_class ##### -->
3131 <para>
3132 Return the class of the parent.  Initialize the class if necessary.
3133 Return NULL if anything goes wrong.
3134 </para>
3135
3136 @type: GtkType
3137 @Returns: gpointer to the klass.
3138
3139 <!-- ##### FUNCTION gtk_type_query ##### -->
3140 <para>
3141 Given a type, return various interesting parameters of the type.
3142 </para>
3143
3144 @type: GtkType
3145 @Returns: GtkTypeQuery*
3146
3147 <!-- ##### FUNCTION gtk_type_register_enum ##### -->
3148 <para>
3149 Register a new set of enum @values and give them the name in
3150 @type_name.
3151 </para>
3152
3153 @type_name: must not be null.
3154 @values: GtkEnumValue*
3155 @Returns:
3156
3157 <!-- ##### FUNCTION gtk_type_register_flags ##### -->
3158 <para>
3159 Register a new set of flags @values and give them the name in
3160 @type_name.
3161 </para>
3162
3163 @type_name: must not be null.
3164 @values: GtkFlagValue*
3165 @Returns:
3166
3167 <!-- ##### FUNCTION gtk_type_set_chunk_alloc ##### -->
3168 <para>
3169 Set the mem_chunk size so it will hold @n_chunks of the objects of that @type.
3170 </para>
3171
3172 @type: There must be an unlocked TypeNode associated with this type otherwise nothing happens.
3173 @n_chunks:
3174
3175 <!-- ##### FUNCTION gtk_type_set_varargs_type ##### -->
3176 <para>
3177 Set the varargs type for a fundamental type @foreign_type.
3178 </para>
3179
3180 @foreign_type: Must be a GtkType with a sequence number of zero.  Must not be a
3181 fundamental type.
3182 @varargs_type: Must be a GtkType which is either structured or flag, or NONE.
3183
3184 <!-- ##### FUNCTION gtk_widget_accelerator_signal ##### -->
3185 <para>
3186
3187 </para>
3188
3189 @widget:
3190 @accel_group:
3191 @accel_key:
3192 @accel_mods:
3193 @Returns:
3194
3195 <!-- ##### FUNCTION gtk_widget_accelerators_locked ##### -->
3196 <para>
3197
3198 </para>
3199
3200 @widget:
3201 @Returns:
3202
3203 <!-- ##### FUNCTION gtk_widget_activate_mnemonic ##### -->
3204 <para>
3205
3206 </para>
3207
3208 @widget:
3209 @group_cycling:
3210 @Returns:
3211
3212 <!-- ##### FUNCTION gtk_widget_get_usize ##### -->
3213 <para>
3214
3215 </para>
3216
3217 @widget:
3218 @width:
3219 @height:
3220
3221 <!-- ##### FUNCTION gtk_widget_lock_accelerators ##### -->
3222 <para>
3223
3224 </para>
3225
3226 @widget:
3227
3228 <!-- ##### FUNCTION gtk_widget_pop_style ##### -->
3229 <para>
3230
3231 </para>
3232
3233
3234 <!-- ##### FUNCTION gtk_widget_popup ##### -->
3235 <para>
3236
3237 </para>
3238
3239 @widget:
3240 @x:
3241 @y:
3242
3243 <!-- ##### FUNCTION gtk_widget_push_style ##### -->
3244 <para>
3245
3246 </para>
3247
3248 @style:
3249
3250 <!-- ##### FUNCTION gtk_widget_remove_accelerators ##### -->
3251 <para>
3252
3253 </para>
3254
3255 @widget:
3256 @accel_signal:
3257 @visible_only:
3258
3259 <!-- ##### FUNCTION gtk_widget_set_default_style ##### -->
3260 <para>
3261
3262 </para>
3263
3264 @style:
3265
3266 <!-- ##### FUNCTION gtk_widget_unlock_accelerators ##### -->
3267 <para>
3268
3269 </para>
3270
3271 @widget:
3272
3273 <!-- ##### FUNCTION gtk_window_activate_mnemonic ##### -->
3274 <para>
3275
3276 </para>
3277
3278 @window:
3279 @keyval:
3280 @modifier:
3281 @Returns:
3282
3283 <!-- ##### FUNCTION gtk_window_get_default_accel_group ##### -->
3284 <para>
3285
3286 </para>
3287
3288 @window:
3289 @Returns:
3290
3291 <!-- ##### FUNCTION gtk_window_get_resizeable ##### -->
3292 <para>
3293
3294 </para>
3295
3296 @window:
3297 @Returns:
3298
3299 <!-- ##### FUNCTION gtk_window_set_decorations_hint ##### -->
3300 <para>
3301
3302 </para>
3303
3304 @window:
3305 @decorations:
3306
3307 <!-- ##### FUNCTION gtk_window_set_functions_hint ##### -->
3308 <para>
3309
3310 </para>
3311
3312 @window:
3313 @functions:
3314
3315 <!-- ##### FUNCTION gtk_window_set_resizeable ##### -->
3316 <para>
3317
3318 </para>
3319
3320 @window:
3321 @setting:
3322 @resizeable:
3323