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