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 <!-- ##### ARG GtkPaned:handle-size ##### -->
1031 <para>
1032
1033 </para>
1034
1035
1036 <!-- ##### STRUCT GtkPatternSpec ##### -->
1037 <para>
1038
1039 </para>
1040
1041 @match_type:
1042 @pattern_length:
1043 @pattern:
1044 @pattern_reversed:
1045 @user_data:
1046 @seq_id:
1047
1048 <!-- ##### ENUM GtkPrivateFlags ##### -->
1049 <para>
1050
1051 </para>
1052
1053 @PRIVATE_GTK_USER_STYLE:
1054 @PRIVATE_GTK_RESIZE_PENDING:
1055 @PRIVATE_GTK_RESIZE_NEEDED:
1056 @PRIVATE_GTK_LEAVE_PENDING:
1057 @PRIVATE_GTK_HAS_SHAPE_MASK:
1058 @PRIVATE_GTK_IN_REPARENT:
1059 @PRIVATE_GTK_DIRECTION_SET:
1060 @PRIVATE_GTK_DIRECTION_LTR:
1061
1062 <!-- ##### STRUCT GtkRcStyleClass ##### -->
1063 <para>
1064
1065 </para>
1066
1067
1068 <!-- ##### ARG GtkScrolledWindow:shadow ##### -->
1069 <para>
1070
1071 </para>
1072
1073
1074 <!-- ##### STRUCT GtkSettingsClass ##### -->
1075 <para>
1076
1077 </para>
1078
1079
1080 <!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
1081 <para>
1082 A function which you can use to clean up when the
1083 signal handler is destroyed.
1084 </para>
1085 <para>
1086 For example, if your handler requires a few variables
1087 that you made into a struct and allocated (using g_new()
1088 or something), then you will probably want to free
1089 it as soon as the hook is destroyed.  This will
1090 allow you to do that. (For this in particular
1091 it is convenient to pass g_free() as a #GtkSignalDestroy
1092 function).
1093 </para>
1094
1095 @data: The user data associated with the hook that is being
1096 destroyed.
1097
1098 <!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
1099 <para>
1100 This is currently a hack left in for a scheme wrapper library.
1101 It may be removed.
1102 </para>
1103 <para>
1104 Don't use it.
1105 </para>
1106
1107 @object: The object which emits the signal.
1108 @data: The user data associated with the hook.
1109 @nparams: The number of parameters to the function.
1110 @args: The actual values of the arguments.
1111 @arg_types: The types of the arguments.
1112 @return_type: The type of the return value from the function
1113 or #GTK_TYPE_NONE for no return value.
1114
1115 <!-- ##### STRUCT GtkSignalQuery ##### -->
1116 <para>
1117 This structure contains all the information about a particular
1118 signal:  its name, the type it affects, the signature of the handlers,
1119 and its unique identifying integer.
1120 </para>
1121
1122 @object_type:
1123 @signal_id:
1124 @signal_name:
1125 @is_user_signal:
1126 @signal_flags:
1127 @return_val:
1128 @nparams:
1129 @params:
1130
1131 <!-- ##### ARG GtkSpinButton:shadow-type ##### -->
1132 <para>
1133 the type of border that surrounds the arrows of a spin button.
1134 </para>
1135
1136
1137 <!-- ##### STRUCT GtkStatusbarMsg ##### -->
1138 <para>
1139 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.
1140 </para>
1141
1142 @text:
1143 @context_id:
1144 @message_id:
1145
1146 <!-- ##### STRUCT GtkStyleClass ##### -->
1147 <para>
1148
1149 </para>
1150
1151 @parent_class:
1152 @realize:
1153 @unrealize:
1154 @copy:
1155 @clone:
1156 @init_from_rc:
1157 @set_background:
1158 @render_icon:
1159 @draw_hline:
1160 @draw_vline:
1161 @draw_shadow:
1162 @draw_polygon:
1163 @draw_arrow:
1164 @draw_diamond:
1165 @draw_string:
1166 @draw_box:
1167 @draw_flat_box:
1168 @draw_check:
1169 @draw_option:
1170 @draw_tab:
1171 @draw_shadow_gap:
1172 @draw_box_gap:
1173 @draw_extension:
1174 @draw_focus:
1175 @draw_slider:
1176 @draw_handle:
1177 @draw_expander:
1178 @draw_layout:
1179 @draw_resize_grip:
1180 @_gtk_reserved1:
1181 @_gtk_reserved2:
1182 @_gtk_reserved3:
1183 @_gtk_reserved4:
1184 @_gtk_reserved5:
1185 @_gtk_reserved6:
1186 @_gtk_reserved7:
1187 @_gtk_reserved8:
1188 @_gtk_reserved9:
1189 @_gtk_reserved10:
1190 @_gtk_reserved11:
1191 @_gtk_reserved12:
1192
1193 <!-- ##### STRUCT GtkTextBTreeNode ##### -->
1194 <para>
1195
1196 </para>
1197
1198
1199 <!-- ##### STRUCT GtkTextChildAnchorClass ##### -->
1200 <para>
1201
1202 </para>
1203
1204
1205 <!-- ##### ARG GtkTextTag:justify ##### -->
1206 <para>
1207 A #GtkJustification for the text. This is only used when the tag is
1208 applied to the first character in a paragraph.
1209 </para>
1210
1211
1212 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
1213 <para>
1214 Pixel width of the left margin of the text for lines after the first
1215 line in a wrapped paragraph.
1216 </para>
1217
1218
1219 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
1220 <para>
1221
1222 </para>
1223
1224
1225 <!-- ##### ARG GtkTextTag:offset ##### -->
1226 <para>
1227 Pixels to offset the text horizontally or vertically, useful to
1228 produce superscript and subscript.
1229 </para>
1230
1231
1232 <!-- ##### ARG GtkTextView:height-lines ##### -->
1233 <para>
1234
1235 </para>
1236
1237
1238 <!-- ##### ARG GtkTextView:justify ##### -->
1239 <para>
1240
1241 </para>
1242
1243
1244 <!-- ##### ARG GtkTextView:width-columns ##### -->
1245 <para>
1246
1247 </para>
1248
1249
1250 <!-- ##### STRUCT GtkTreeSelectionClass ##### -->
1251 <para>
1252
1253 </para>
1254
1255
1256 <!-- ##### ENUM GtkTreeSelectionMode ##### -->
1257 <para>
1258
1259 </para>
1260
1261 @GTK_TREE_SELECTION_SINGLE:
1262 @GTK_TREE_SELECTION_MULTI:
1263
1264 <!-- ##### SIGNAL GtkTreeView::focus-column-header ##### -->
1265 <para>
1266
1267 </para>
1268
1269 @treeview: the object which received the signal.
1270
1271 <!-- ##### USER_FUNCTION GtkTreeViewDraggableFunc ##### -->
1272 <para>
1273
1274 </para>
1275
1276 @tree_view:
1277 @context:
1278 @path:
1279 @user_data:
1280 @Returns:
1281
1282 <!-- ##### USER_FUNCTION GtkTreeViewDroppableFunc ##### -->
1283 <para>
1284
1285 </para>
1286
1287 @tree_view:
1288 @context:
1289 @path:
1290 @pos:
1291 @user_data:
1292 @Returns:
1293
1294 <!-- ##### ARG GtkVScale:adjustment ##### -->
1295 <para>
1296 the #GtkAdjustment which sets the range of the scale.
1297 </para>
1298
1299
1300 <!-- ##### ARG GtkVScrollbar:adjustment ##### -->
1301 <para>
1302
1303 </para>
1304
1305
1306 <!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
1307 <para>
1308
1309 </para>
1310
1311 @widget: the object which received the signal.
1312 @arg1:
1313 @Returns:
1314
1315 <!-- ##### SIGNAL GtkWidget::add-accelerator ##### -->
1316 <para>
1317
1318 </para>
1319
1320 @widget: the object which received the signal.
1321 @accel_signal_id:
1322 @accel_group:
1323 @accel_key:
1324 @accel_mods:
1325 @accel_flags:
1326
1327 <!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
1328 <para>
1329
1330 </para>
1331
1332 @widget: the object which received the signal.
1333 @message:
1334
1335 <!-- ##### SIGNAL GtkWidget::draw ##### -->
1336 <para>
1337
1338 </para>
1339
1340 @widget: the object which received the signal.
1341 @area:
1342
1343 <!-- ##### SIGNAL GtkWidget::draw-default ##### -->
1344 <para>
1345
1346 </para>
1347
1348 @widget: the object which received the signal.
1349
1350 <!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
1351 <para>
1352
1353 </para>
1354
1355 @widget: the object which received the signal.
1356
1357 <!-- ##### SIGNAL GtkWidget::remove-accelerator ##### -->
1358 <para>
1359
1360 </para>
1361
1362 @widget: the object which received the signal.
1363 @accel_group:
1364 @accel_key:
1365 @accel_mods:
1366
1367 <!-- ##### ARG GtkWidget:height ##### -->
1368 <para>
1369
1370 </para>
1371
1372
1373 <!-- ##### ARG GtkWidget:width ##### -->
1374 <para>
1375
1376 </para>
1377
1378
1379 <!-- ##### ARG GtkWidget:x ##### -->
1380 <para>
1381
1382 </para>
1383
1384
1385 <!-- ##### ARG GtkWidget:y ##### -->
1386 <para>
1387
1388 </para>
1389
1390
1391 <!-- ##### SIGNAL GtkWindow::accels-changed ##### -->
1392 <para>
1393
1394 </para>
1395
1396 @window: the object which received the signal.
1397
1398 <!-- ##### ARG GtkWindow:auto-shrink ##### -->
1399 <para>
1400 If the window shrinks automatically when widgets within it shrink.
1401 </para>
1402
1403
1404 <!-- ##### ARG GtkWindow:icon-list ##### -->
1405 <para>
1406
1407 </para>
1408
1409
1410 <!-- ##### FUNCTION gtk_accel_group_activate ##### -->
1411 <para>
1412
1413 </para>
1414
1415 @accel_group:
1416 @accel_key:
1417 @accel_mods:
1418 @Returns:
1419
1420 <!-- ##### FUNCTION gtk_accel_group_add ##### -->
1421 <para>
1422
1423 </para>
1424
1425 @accel_group:
1426 @path:
1427 @accel_key:
1428 @accel_mods:
1429 @accel_flags:
1430 @object:
1431 @accel_signal:
1432
1433 <!-- ##### FUNCTION gtk_accel_group_attach ##### -->
1434 <para>
1435
1436 </para>
1437
1438 @accel_group:
1439 @object:
1440
1441 <!-- ##### FUNCTION gtk_accel_group_create_add ##### -->
1442 <para>
1443
1444 </para>
1445
1446 @class_type:
1447 @signal_flags:
1448 @handler_offset:
1449 @Returns:
1450
1451 <!-- ##### FUNCTION gtk_accel_group_create_remove ##### -->
1452 <para>
1453
1454 </para>
1455
1456 @class_type:
1457 @signal_flags:
1458 @handler_offset:
1459 @Returns:
1460
1461 <!-- ##### FUNCTION gtk_accel_group_detach ##### -->
1462 <para>
1463
1464 </para>
1465
1466 @accel_group:
1467 @object:
1468
1469 <!-- ##### FUNCTION gtk_accel_group_entries_from_object ##### -->
1470 <para>
1471
1472 </para>
1473
1474 @object:
1475 @Returns:
1476
1477 <!-- ##### FUNCTION gtk_accel_group_get_default ##### -->
1478 <para>
1479
1480 </para>
1481
1482 @Returns:
1483
1484 <!-- ##### FUNCTION gtk_accel_group_get_entry ##### -->
1485 <para>
1486
1487 </para>
1488
1489 @accel_group:
1490 @accel_key:
1491 @accel_mods:
1492 @Returns:
1493
1494 <!-- ##### FUNCTION gtk_accel_group_get_type ##### -->
1495 <para>
1496
1497 </para>
1498
1499 @Returns:
1500
1501 <!-- ##### FUNCTION gtk_accel_group_handle_add ##### -->
1502 <para>
1503
1504 </para>
1505
1506 @object:
1507 @accel_signal_id:
1508 @accel_group:
1509 @accel_key:
1510 @accel_mods:
1511 @accel_flags:
1512
1513 <!-- ##### FUNCTION gtk_accel_group_handle_remove ##### -->
1514 <para>
1515
1516 </para>
1517
1518 @object:
1519 @accel_group:
1520 @accel_key:
1521 @accel_mods:
1522
1523 <!-- ##### FUNCTION gtk_accel_group_lock_entry ##### -->
1524 <para>
1525
1526 </para>
1527
1528 @accel_group:
1529 @accel_key:
1530 @accel_mods:
1531
1532 <!-- ##### FUNCTION gtk_accel_group_remove ##### -->
1533 <para>
1534
1535 </para>
1536
1537 @accel_group:
1538 @accel_key:
1539 @accel_mods:
1540 @object:
1541
1542 <!-- ##### FUNCTION gtk_accel_group_unlock_entry ##### -->
1543 <para>
1544
1545 </para>
1546
1547 @accel_group:
1548 @accel_key:
1549 @accel_mods:
1550
1551 <!-- ##### FUNCTION gtk_accel_label_get_accel_object ##### -->
1552 <para>
1553
1554 </para>
1555
1556 @accel_label:
1557 @Returns:
1558
1559 <!-- ##### FUNCTION gtk_accel_label_set_accel_object ##### -->
1560 <para>
1561
1562 </para>
1563
1564 @accel_label:
1565 @accel_object:
1566
1567 <!-- ##### FUNCTION gtk_accel_map_add_notifer ##### -->
1568 <para>
1569
1570 </para>
1571
1572 @accel_path:
1573 @notify_data:
1574 @notify_func:
1575 @accel_group:
1576
1577 <!-- ##### FUNCTION gtk_accel_map_remove_notifer ##### -->
1578 <para>
1579
1580 </para>
1581
1582 @accel_path:
1583 @notify_data:
1584 @notify_func:
1585
1586 <!-- ##### FUNCTION gtk_arg_copy ##### -->
1587 <para>
1588 It will either copy data into an existing argument or allocate a new argument
1589 and copy the data.  Strings are duplicated.  All other pointers and
1590 values are copied (shallowly-- that is the pointers themselves are
1591 copied, not the data they point to.)
1592 </para>
1593 <para>
1594 You should call gtk_arg_reset() on dest_arg before calling this
1595 if the argument may contain string data that you want freed.
1596 </para>
1597
1598 @src_arg: the argument to duplicate.
1599 @dest_arg: the argument to copy over (or NULL to create a new #GtkArg).
1600 @Returns: the new #GtkArg (or dest_arg, if it was not NULL).
1601
1602 <!-- ##### FUNCTION gtk_arg_free ##### -->
1603 <para>
1604 Frees the argument, and optionally its contents.
1605 </para>
1606
1607 @arg: the argument to free.
1608 @free_contents: whether to free the string, if it is a string.
1609
1610 <!-- ##### FUNCTION gtk_arg_get_info ##### -->
1611 <para>
1612 Private: get information about an argument.
1613 </para>
1614
1615 @object_type: the type of object.
1616 @arg_info_hash_table: the hashtable of #GtkArgInfos.
1617 @arg_name: the name of the argument to lookup.
1618 @info_p: the argument info.
1619 @Returns: an error message on failure, or NULL otherwise.
1620
1621 <!-- ##### FUNCTION gtk_arg_info_equal ##### -->
1622 <para>
1623 A #GCompareFunc for hashing #GtkArgInfos.
1624 </para>
1625
1626 @arg_info_1: a #GtkArgInfo.
1627 @arg_info_2: a #GtkArgInfo.
1628 @Returns: whether the arguments are the same.
1629
1630 <!-- ##### FUNCTION gtk_arg_info_hash ##### -->
1631 <para>
1632 A #GHashFunc for hashing #GtkArgInfos.
1633 </para>
1634
1635 @arg_info: a #GtkArgInfo.
1636 @Returns: a hash value for that #GtkArgInfo.
1637
1638 <!-- ##### FUNCTION gtk_arg_name_strip_type ##### -->
1639 <para>
1640 Given a fully qualified argument name (e.g. "GtkButton::label")
1641 it returns just the argument name (e.g. "label") unless
1642 the argument name was invalid, in which case it returns NULL.
1643 </para>
1644
1645 @arg_name: the fully-qualified argument name.
1646 @Returns: the base argument name.
1647
1648 <!-- ##### FUNCTION gtk_arg_new ##### -->
1649 <para>
1650 Creates a new argument of a certain type, set to 0 or NULL.
1651 </para>
1652
1653 @arg_type: the type of the argument.
1654 @Returns: the newly created #GtkArg.
1655
1656 <!-- ##### FUNCTION gtk_arg_reset ##### -->
1657 <para>
1658
1659 </para>
1660
1661 @arg:
1662
1663 <!-- ##### FUNCTION gtk_arg_to_valueloc ##### -->
1664 <para>
1665
1666 </para>
1667
1668 @arg:
1669 @value_pointer:
1670
1671 <!-- ##### FUNCTION gtk_arg_type_new_static ##### -->
1672 <para>
1673 Create a new argument registered with a class.
1674 </para>
1675
1676 @base_class_type: the basic type having the arguments, almost alway
1677 GTK_TYPE_OBJECT, except if your defining a different type argument
1678 that gets a different namespace.  #GtkContainer does this to define
1679 per-child arguments of the container.
1680 @arg_name: name of the argument to create.  (must be a static constant string)
1681 @class_n_args_offset: offset into the base class structure that tells
1682 the number of arguments.
1683 @arg_info_hash_table: hashtable of #GtkArgInfos.
1684 @arg_type: type of the argument.
1685 @arg_flags: flags of the argument.
1686 @arg_id: ???
1687 @Returns: the new #GtkArgInfo.
1688
1689 <!-- ##### FUNCTION gtk_arg_values_equal ##### -->
1690 <para>
1691
1692 </para>
1693
1694 @arg1:
1695 @arg2:
1696 @Returns:
1697
1698 <!-- ##### FUNCTION gtk_args_collect ##### -->
1699 <para>
1700 Private:  given a hashtable of argument information it takes a vararg
1701 list and parses it into arguments (in the form of lists of #GtkArgs
1702 and lists of #GtkArgInfos.
1703 </para>
1704 <para>
1705 The list of arguments starts with first_arg_name then the first argument's
1706 value.  Followed by any number of additional name/argument pairs,
1707 terminated with NULL.
1708 </para>
1709
1710 @object_type: the type of object we are collecting arguments for.
1711 @arg_info_hash_table: a hashtable mapping from names of arguments
1712 to their #GtkArgInfos.
1713 @arg_list_p: a returned list of arguments obtained from parsing the
1714 varargs.
1715 @info_list_p: a returned list of the #GtkArgInfos.
1716 @first_arg_name: the name of the first argument.
1717 @var_args: a va_list containing the value of the first argument,
1718 followed by name/value pairs, followed by NULL.
1719 @Returns: an error message on failure, or NULL otherwise.
1720
1721 <!-- ##### FUNCTION gtk_args_collect_cleanup ##### -->
1722 <para>
1723 Private: erase lists of arguments returned from gtk_args_collect().
1724 </para>
1725
1726 @arg_list: arg_list_p returned from gtk_args_collect().
1727 @info_list: info_list_p returned from gtk_args_collect().
1728
1729 <!-- ##### FUNCTION gtk_args_query ##### -->
1730 <para>
1731 Private: from a class type and its arginfo hashtable,
1732 get an array of #GtkArgs that this object accepts.
1733 </para>
1734
1735 @class_type: the class type.
1736 @arg_info_hash_table: the hashtable of #GtkArgInfos.
1737 @arg_flags: returned array of argument flags.
1738 @n_args_p: the number of arguments this object accepts.
1739 @Returns: the array of arguments (or NULL on error).
1740
1741 <!-- ##### FUNCTION gtk_button_box_child_requisition ##### -->
1742 <para>\r
1743 This is an internally used function and should never be called from an\r
1744 application.\r
1745 </para>
1746
1747 @widget:
1748 @nvis_children:
1749 @width:
1750 @height:
1751
1752 <!-- ##### FUNCTION gtk_button_box_get_child_ipadding_default ##### -->
1753 <para>\r
1754 The internal padding of a button is the amount of space between the outside\r
1755 of the button and the widget it contains. This function gets the default\r
1756 amount of horizontal and vertical padding, placing the results in @ipad_x\r
1757 and @ipad_y, respectively.\r
1758 </para>
1759
1760 @ipad_x: the default horizontal internal button padding.
1761 @ipad_y: the default vertical internal button padding.
1762
1763 <!-- ##### FUNCTION gtk_button_box_get_child_size_default ##### -->
1764 <para>\r
1765 Retrieves the default minimum width and height for all button boxes, and\r
1766 places the values in @min_width and @min_height, respectively.\r
1767 </para>
1768
1769 @min_width: the default minimum width of a child widget.
1770 @min_height: the default minimum height of a child widget.
1771
1772 <!-- ##### FUNCTION gtk_button_box_set_child_ipadding_default ##### -->
1773 <para>\r
1774 Sets the default number of pixels that pad each button in every button box.\r
1775 </para>
1776
1777 @ipad_x: new default horizontal padding.
1778 @ipad_y: new default vertical padding.
1779
1780 <!-- ##### FUNCTION gtk_button_box_set_child_size_default ##### -->
1781 <para>\r
1782 Sets the default size of child buttons.\r
1783 </para>
1784
1785 @min_width: minimum default width for child buttons.
1786 @min_height: minimum default height for child buttons.
1787
1788 <!-- ##### FUNCTION gtk_button_new_accel ##### -->
1789 <para>
1790
1791 </para>
1792
1793 @uline_label:
1794 @accel_group:
1795 @Returns:
1796
1797 <!-- ##### FUNCTION gtk_button_new_stock ##### -->
1798 <para>
1799
1800 </para>
1801
1802 @stock_id:
1803 @accel_group:
1804 @Returns:
1805
1806 <!-- ##### FUNCTION gtk_cell_renderer_event ##### -->
1807 <para>
1808
1809 </para>
1810
1811 @cell:
1812 @event:
1813 @widget:
1814 @path:
1815 @background_area:
1816 @cell_area:
1817 @flags:
1818 @Returns:
1819
1820 <!-- ##### FUNCTION gtk_cell_renderer_text_pixbuf_new ##### -->
1821 <para>
1822
1823 </para>
1824
1825 @Returns:
1826
1827 <!-- ##### FUNCTION gtk_clist_construct ##### -->
1828 <para>
1829 Initializes a previously allocated #GtkCList widget for use.  This should not
1830 normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
1831 </para>
1832
1833 @clist: A pointer to an uninitialized #GtkCList widget.
1834 @columns: The number of columns the #GtkCList should have.
1835 @titles: An array of strings that should be used as the titles i
1836 of the columns.  There should be enough strings in the array for
1837 the number of columns specified.
1838
1839 <!-- ##### FUNCTION gtk_color_selection_get_old_color ##### -->
1840 <para>
1841
1842 </para>
1843
1844 @colorsel:
1845 @color:
1846
1847 <!-- ##### FUNCTION gtk_color_selection_get_use_opacity ##### -->
1848 <para>
1849
1850 </para>
1851
1852 @colorsel:
1853 @Returns:
1854
1855 <!-- ##### FUNCTION gtk_color_selection_get_use_palette ##### -->
1856 <para>
1857
1858 </para>
1859
1860 @colorsel:
1861 @Returns:
1862
1863 <!-- ##### FUNCTION gtk_color_selection_set_old_color ##### -->
1864 <para>
1865
1866 </para>
1867
1868 @colorsel:
1869 @color:
1870
1871 <!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
1872 <para>
1873 Controls whether opacity can be set with the #GtkColorSelection.
1874 If this functionality is enabled, the necessary additional widgets
1875 are added to the #GtkColorSelection and the opacity value can be
1876 retrieved via the fourth value in the color array returned by
1877 the gtk_color_selection_get_color() function.
1878 </para>
1879
1880 @colorsel: a #GtkColorSelection.
1881 @use_opacity: a boolean indicating whether the opacity selection
1882 is enabled.
1883
1884 <!-- ##### FUNCTION gtk_color_selection_set_use_opacity ##### -->
1885 <para>
1886
1887 </para>
1888
1889 @colorsel:
1890 @use_opacity:
1891
1892 <!-- ##### FUNCTION gtk_color_selection_set_use_palette ##### -->
1893 <para>
1894
1895 </para>
1896
1897 @colorsel:
1898 @use_palette:
1899
1900 <!-- ##### FUNCTION gtk_container_add_child_arg_type ##### -->
1901 <para>
1902
1903 </para>
1904
1905 @arg_name:
1906 @arg_type:
1907 @arg_flags:
1908 @arg_id:
1909
1910 <!-- ##### FUNCTION gtk_container_add_with_args ##### -->
1911 <para>
1912
1913 </para>
1914
1915 @container:
1916 @widget:
1917 @first_arg_name:
1918 @Varargs:
1919
1920 <!-- ##### FUNCTION gtk_container_addv ##### -->
1921 <para>
1922
1923 </para>
1924
1925 @container:
1926 @widget:
1927 @n_args:
1928 @args:
1929
1930 <!-- ##### FUNCTION gtk_container_arg_get ##### -->
1931 <para>
1932
1933 </para>
1934
1935 @container:
1936 @child:
1937 @arg:
1938 @info:
1939
1940 <!-- ##### FUNCTION gtk_container_arg_set ##### -->
1941 <para>
1942
1943 </para>
1944
1945 @container:
1946 @child:
1947 @arg:
1948 @info:
1949
1950 <!-- ##### FUNCTION gtk_container_child_arg_get_info ##### -->
1951 <para>
1952
1953 </para>
1954
1955 @object_type:
1956 @arg_name:
1957 @info_p:
1958 @Returns:
1959
1960 <!-- ##### FUNCTION gtk_container_child_args_collect ##### -->
1961 <para>
1962
1963 </para>
1964
1965 @object_type:
1966 @arg_list_p:
1967 @info_list_p:
1968 @first_arg_name:
1969 @args:
1970 @Returns:
1971
1972 <!-- ##### FUNCTION gtk_container_child_getv ##### -->
1973 <para>
1974
1975 </para>
1976
1977 @container:
1978 @child:
1979 @n_args:
1980 @args:
1981
1982 <!-- ##### FUNCTION gtk_container_child_setv ##### -->
1983 <para>
1984
1985 </para>
1986
1987 @container:
1988 @child:
1989 @n_args:
1990 @args:
1991
1992 <!-- ##### FUNCTION gtk_container_dequeue_resize_handler ##### -->
1993 <para>
1994
1995 </para>
1996
1997 @container:
1998
1999 <!-- ##### FUNCTION gtk_container_focus ##### -->
2000 <para>
2001
2002 </para>
2003
2004 @container:
2005 @direction:
2006 @Returns:
2007
2008 <!-- ##### FUNCTION gtk_container_query_child_args ##### -->
2009 <para>
2010
2011 </para>
2012
2013 @class_type:
2014 @arg_flags:
2015 @nargs:
2016 @Returns:
2017
2018 <!-- ##### FUNCTION gtk_ctree_construct ##### -->
2019 <para>
2020 This function is not usually used by users.
2021 </para>
2022
2023 @ctree:
2024 @columns:
2025 @tree_column:
2026 @titles:
2027
2028 <!-- ##### FUNCTION gtk_drag_dest_handle_event ##### -->
2029 <para>
2030 Internal function.
2031 </para>
2032
2033 @toplevel:
2034 @event:
2035
2036 <!-- ##### FUNCTION gtk_drag_source_handle_event ##### -->
2037 <para>
2038 Internal function.
2039 </para>
2040
2041 @widget:
2042 @event:
2043
2044 <!-- ##### FUNCTION gtk_editable_changed ##### -->
2045 <para>
2046 Causes the "changed" signal to be emitted.
2047 </para>
2048
2049 @editable: a #GtkEditable widget.
2050
2051 <!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
2052 <para>
2053 Claim or disclaim ownership of the PRIMARY X selection.
2054 </para>
2055
2056 @editable: a #GtkEditable widget.
2057 @claim: if %TRUE, claim the selection, otherwise, disclaim it.
2058 @time: the timestamp for claiming the selection.
2059
2060 <!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
2061 <para>
2062 Sets one of the two font filters, to limit the fonts shown.
2063 </para>
2064
2065 @fsd: a #GtkFontSelectionDialog.
2066 @filter_type: which of the two font filters to set, either
2067 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
2068 can be changed by the user, but the base filter is permanent.
2069 @font_type: the types of font to be shown. This is a bitwise combination of
2070 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
2071 or #GTK_FONT_ALL to show all three font types.
2072 @foundries: a NULL-terminated array of strings containing foundry names which
2073 will be shown, or NULL to show all foundries.
2074 @weights: a NULL-terminated array of strings containing weight names which
2075 will be shown, or NULL to show all weights.
2076 @slants: a NULL-terminated array of strings containing slant names which
2077 will be shown, or NULL to show all slants.
2078 @setwidths: a NULL-terminated array of strings containing setwidth names which
2079 will be shown, or NULL to show all setwidths.
2080 @spacings: a NULL-terminated array of strings containing spacings which
2081 will be shown, or NULL to show all spacings.
2082 @charsets: a NULL-terminated array of strings containing charset names which
2083 will be shown, or NULL to show all charsets.
2084
2085 <!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
2086 <para>
2087 Sets one of the two font filters, to limit the fonts shown.
2088 </para>
2089
2090 @fontsel: a #GtkFontSelection.
2091 @filter_type: which of the two font filters to set, either
2092 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
2093 can be changed by the user, but the base filter is permanent.
2094 @font_type: the types of font to be shown. This is a bitwise combination of
2095 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
2096 or #GTK_FONT_ALL to show all three font types.
2097 @foundries: a NULL-terminated array of strings containing foundry names which
2098 will be shown, or NULL to show all foundries.
2099 @weights: a NULL-terminated array of strings containing weight names which
2100 will be shown, or NULL to show all weights.
2101 @slants: a NULL-terminated array of strings containing slant names which
2102 will be shown, or NULL to show all slants.
2103 @setwidths: a NULL-terminated array of strings containing setwidth names which
2104 will be shown, or NULL to show all setwidths.
2105 @spacings: a NULL-terminated array of strings containing spacings which
2106 will be shown, or NULL to show all spacings.
2107 @charsets: a NULL-terminated array of strings containing charset names which
2108 will be shown, or NULL to show all charsets.
2109
2110 <!-- ##### FUNCTION gtk_identifier_get_type ##### -->
2111 <para>
2112 Get the type of GtkIdentifier.
2113 </para>
2114
2115 @Returns: GtkType -- the enumerated type of something.
2116
2117 <!-- ##### FUNCTION gtk_image_menu_item_add_image ##### -->
2118 <para>
2119
2120 </para>
2121
2122 @image_menu_item:
2123 @child:
2124
2125 <!-- ##### FUNCTION gtk_image_menu_item_get_type ##### -->
2126 <para>
2127
2128 </para>
2129
2130 @Returns:
2131
2132 <!-- ##### FUNCTION gtk_item_factory_dump_items ##### -->
2133 <para>
2134
2135 </para>
2136
2137 @path_pspec:
2138 @modified_only:
2139 @print_func:
2140 @func_data:
2141
2142 <!-- ##### FUNCTION gtk_item_factory_dump_rc ##### -->
2143 <para>
2144
2145 </para>
2146
2147 @file_name:
2148 @path_pspec:
2149 @modified_only:
2150
2151 <!-- ##### FUNCTION gtk_item_factory_parse_rc ##### -->
2152 <para>
2153
2154 </para>
2155
2156 @file_name:
2157
2158 <!-- ##### FUNCTION gtk_item_factory_parse_rc_scanner ##### -->
2159 <para>
2160
2161 </para>
2162
2163 @scanner:
2164
2165 <!-- ##### FUNCTION gtk_item_factory_parse_rc_string ##### -->
2166 <para>
2167
2168 </para>
2169
2170 @rc_string:
2171
2172 <!-- ##### FUNCTION gtk_item_factory_print_func ##### -->
2173 <para>
2174
2175 </para>
2176
2177 @FILE_pointer:
2178 @string:
2179
2180 <!-- ##### FUNCTION gtk_label_set_markup_with_accel ##### -->
2181 <para>
2182
2183 </para>
2184
2185 @label:
2186 @str:
2187 @Returns:
2188
2189 <!-- ##### FUNCTION gtk_list_store_new_with_types ##### -->
2190 <para>
2191
2192 </para>
2193
2194 @n_columns:
2195 @Varargs:
2196 @Returns:
2197
2198 <!-- ##### FUNCTION gtk_list_store_set_cell ##### -->
2199 <para>
2200
2201 </para>
2202
2203 @store:
2204 @iter:
2205 @column:
2206 @value:
2207
2208 <!-- ##### FUNCTION gtk_list_store_set_column_type ##### -->
2209 <para>
2210
2211 </para>
2212
2213 @store:
2214 @column:
2215 @type:
2216
2217 <!-- ##### FUNCTION gtk_list_store_set_n_columns ##### -->
2218 <para>
2219
2220 </para>
2221
2222 @store:
2223 @n_columns:
2224
2225 <!-- ##### FUNCTION gtk_menu_ensure_uline_accel_group ##### -->
2226 <para>
2227
2228 </para>
2229
2230 @menu:
2231 @Returns:
2232
2233 <!-- ##### FUNCTION gtk_menu_get_uline_accel_group ##### -->
2234 <para>
2235
2236 </para>
2237
2238 @menu:
2239 @Returns:
2240
2241 <!-- ##### FUNCTION gtk_menu_item_configure ##### -->
2242 <para>
2243 Sets whether the menu item should show a submenu indicator, which is a right
2244 arrow.
2245 </para>
2246
2247 @menu_item: the menu item
2248 @show_toggle_indicator: unused
2249 @show_submenu_indicator: whether to show the arrow or not
2250
2251 <!-- ##### FUNCTION gtk_menu_item_set_placement ##### -->
2252 <para>
2253 Specifies the placement of the submenu around the menu item. The placement
2254 is usually #GTK_LEFT_RIGHT for menu items in a popup menu and
2255 #GTK_TOP_BOTTOM in menu bars.
2256 </para>
2257 <para>
2258 This function is useless in usual applications.
2259 </para>
2260
2261 @menu_item: the menu item
2262 @placement: the submenu placement
2263
2264 <!-- ##### FUNCTION gtk_object_arg_get ##### -->
2265 <para>
2266 Private function to get an argument and argument info from an object.
2267 </para>
2268
2269 @object: the object whose argument should be retrieved.
2270 @arg: the argument, for the name on input, the rest is filled on output.
2271 @info: a #GtkArgInfo structure to optionally fill in.
2272
2273 <!-- ##### FUNCTION gtk_object_arg_get_info ##### -->
2274 <para>
2275 Query information about an argument type.
2276 </para>
2277
2278 @object_type: type of object to query about.
2279 @arg_name: name of the argument.
2280 @info_p: pointer to be filled in with a pointer to the GtkArgInfo.
2281 @Returns: an error message, or NULL on success.
2282 It is the caller's responsibility to call g_free() in the event of error.
2283
2284 <!-- ##### FUNCTION gtk_object_arg_set ##### -->
2285 <para>
2286 Private function to set an argument and argument info to an object.
2287 </para>
2288
2289 @object: the object whose argument should be set.
2290 @arg: the argument.
2291 @info: infomation about this type of argument in general.
2292
2293 <!-- ##### FUNCTION gtk_object_args_collect ##### -->
2294 <para>
2295 Private: Gets an array of #GtkArgs from a va_list C structure.
2296 </para>
2297
2298 @object_type: the type of object to collect arguments for.
2299 @arg_list_p: pointer to be filled in with a list of parsed arguments.
2300 @info_list_p: optional pointer for a returned list #GtkArgInfos.
2301 @first_arg_name: name of first argument.
2302 @var_args: value of first argument, followed by more key/value pairs,
2303 terminated by NULL.
2304 @Returns: an error message, or NULL on success.
2305 It is the caller's responsibility to call g_free() in the event of error.
2306
2307 <!-- ##### FUNCTION gtk_object_class_add_signals ##### -->
2308 <para>
2309 Add an array of signals to a #GtkObjectClass.
2310 Usually this is called when registering a new type of object.
2311 </para>
2312
2313 @klass: the object class to append signals to.
2314 @signals: the signals to append.
2315 @nsignals: the number of signals being appended.
2316
2317 <!-- ##### FUNCTION gtk_object_class_user_signal_new ##### -->
2318 <para>
2319 Define a signal-handler for a new signal on an already defined
2320 object.
2321 </para>
2322 <para>
2323 See the signal documentation for more general information.
2324 </para>
2325
2326 @klass: the object class to define the signal for.
2327 @name: the name of the signal.
2328 @signal_flags: the default emission behavior for the signal.
2329 See gtk_signal_new().
2330 @marshaller: a function that will take an array of GtkArgs
2331 and invoke the appropriate handler with the normal calling
2332 conventions.
2333 @return_val: specify the return-value type for the signal
2334 (or GTK_TYPE_NONE for no return-value).
2335 @nparams: specify the number of parameters the signal
2336 receives from the caller of gtk_signal_emit().
2337 @Varargs: list of nparams #GtkTypes to pass to the signal handlers.
2338 @Returns: the signal id.  (See #GtkSignals)
2339
2340 <!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### -->
2341 <para>
2342 Define a signal-handler for a new signal on an already defined
2343 object.
2344 </para>
2345
2346 @klass: the object class to define the signal for.
2347 @name: the name of the signal.
2348 @signal_flags: the default emission behavior for the signal.
2349 See gtk_signal_new().
2350 @marshaller: takes a GtkObject, a #GtkSignalFunc, and an array
2351 of arguments, and invokes the function using the appropriate
2352 calling conventions.  Usually just select a function
2353 out of gtkmarshal.h.
2354 @return_val: specify the return-value type for the signal (possibly
2355 #GTK_TYPE_NONE).
2356 @nparams: specify the number of parameters the signal
2357 receives from the caller of gtk_signal_emit().
2358 @params: array of #GtkTypes the signal handlers for this signal
2359 should have in their prototype (of length nparams).
2360 @Returns: the signal id.  (See #GtkSignals)
2361
2362 <!-- ##### FUNCTION gtk_object_constructed ##### -->
2363 <para>
2364 Mark an allocated object as constructed.
2365 This is used for situations
2366 that require precise control of the construction process.
2367 </para>
2368 <para>
2369 This is done when gtk_object_default_construct() is inadequate.
2370 In #GtkCList the need arises because #GtkCList does construction work that
2371 must happen <emphasis>after</emphasis> its derivers.  This work
2372 cannot be done in an initializer function, so an alternate
2373 constructor is mandatory.  It calls gtk_object_constructed() to
2374 indicate it has done its job, so that no other constructor will
2375 be invoked.
2376 </para>
2377 <para>
2378 Normally this function is just automatically run from
2379 gtk_object_default_construct().
2380 </para>
2381
2382 @object: object which has been constructed.  This is usually
2383 done automatically by gtk_object_new() and gtk_object_newv().
2384
2385 <!-- ##### FUNCTION gtk_object_default_construct ##### -->
2386 <para>
2387 This function is called to construct arguments that haven't been initialized
2388 but have the #GTK_ARG_CONSTRUCT flag set.
2389 </para>
2390 <para>
2391 All number arguments are set to 0.  All pointers and strings
2392 are set to NULL.
2393 </para>
2394 <para>
2395 Normally invoked by gtk_object_new() automatically; gtk_type_new() can
2396 be used to bypass it.
2397 </para>
2398
2399 @object: the object to initialize.
2400
2401 <!-- ##### FUNCTION gtk_object_getv ##### -->
2402 <para>
2403 Gets an array of argument values from an object.
2404 </para>
2405
2406 @object: the object to get arguments from.
2407 @n_args: the number of arguments to query.
2408 @args: the arguments to fill in.
2409
2410 <!-- ##### FUNCTION gtk_object_newv ##### -->
2411 <para>
2412 Construct an object with an array of arguments.
2413 </para>
2414
2415 @object_type: the type of the object to create.
2416 @n_args: the number of arguments to set.
2417 @args: an array of n_args arguments (which are name and value pairs).
2418 @Returns: the new GtkObject.
2419
2420 <!-- ##### FUNCTION gtk_object_query_args ##### -->
2421 <para>
2422 Get all the arguments that may be used for a given type.
2423 </para>
2424 <para>
2425 In Java, this type of mechanism is called
2426 <wordasword>introspection</wordasword>.  It is used by applications
2427 like Glade, that have to determine what can be done to an object
2428 at run-time.
2429 </para>
2430
2431 @class_type: the GtkType of the ObjectClass
2432 (returned from GTK_OBJECT_CLASS(class)-&gt;type for example).
2433 @arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to
2434 each argument.  You must g_free() this if you request it.
2435 @n_args: the number of arguments is returned in this field.
2436 @Returns: an array of arguments, that you must deallocate with g_free().
2437
2438 <!-- ##### FUNCTION gtk_object_setv ##### -->
2439 <para>
2440 Set an array of arguments.
2441 </para>
2442
2443 @object: the object whose arguments should be set.
2444 @n_args: the number of arguments to set.
2445 @args: the desired values, as an array of #GtkArgs (which contain
2446 the names, types, and values of the arguments).
2447
2448 <!-- ##### FUNCTION gtk_packer_add ##### -->
2449 <para>
2450
2451 </para>
2452
2453 @packer:
2454 @child:
2455 @side:
2456 @anchor:
2457 @options:
2458 @border_width:
2459 @pad_x:
2460 @pad_y:
2461 @i_pad_x:
2462 @i_pad_y:
2463
2464 <!-- ##### FUNCTION gtk_packer_add_defaults ##### -->
2465 <para>
2466
2467 </para>
2468
2469 @packer:
2470 @child:
2471 @side:
2472 @anchor:
2473 @options:
2474
2475 <!-- ##### MACRO gtk_packer_configure ##### -->
2476 <para>
2477
2478 </para>
2479
2480
2481 <!-- ##### FUNCTION gtk_packer_new ##### -->
2482 <para>
2483
2484 </para>
2485
2486 @Returns:
2487
2488 <!-- ##### FUNCTION gtk_packer_reorder_child ##### -->
2489 <para>
2490
2491 </para>
2492
2493 @packer:
2494 @child:
2495 @position:
2496
2497 <!-- ##### FUNCTION gtk_packer_set_child_packing ##### -->
2498 <para>
2499
2500 </para>
2501
2502 @packer:
2503 @child:
2504 @side:
2505 @anchor:
2506 @options:
2507 @border_width:
2508 @pad_x:
2509 @pad_y:
2510 @i_pad_x:
2511 @i_pad_y:
2512
2513 <!-- ##### FUNCTION gtk_packer_set_default_border_width ##### -->
2514 <para>
2515
2516 </para>
2517
2518 @packer:
2519 @border:
2520
2521 <!-- ##### FUNCTION gtk_packer_set_default_ipad ##### -->
2522 <para>
2523
2524 </para>
2525
2526 @packer:
2527 @i_pad_x:
2528 @i_pad_y:
2529
2530 <!-- ##### FUNCTION gtk_packer_set_default_pad ##### -->
2531 <para>
2532
2533 </para>
2534
2535 @packer:
2536 @pad_x:
2537 @pad_y:
2538
2539 <!-- ##### FUNCTION gtk_packer_set_spacing ##### -->
2540 <para>
2541
2542 </para>
2543
2544 @packer:
2545 @spacing:
2546
2547 <!-- ##### FUNCTION gtk_paned_compute_position ##### -->
2548 <para>
2549 Internal function used by #GtkHPaned and #GtkVPaned
2550 </para>
2551
2552 @paned:
2553 @allocation:
2554 @child1_req:
2555 @child2_req:
2556
2557 <!-- ##### MACRO gtk_paned_handle_size ##### -->
2558 <para>
2559 Old name for gtk_paned_set_handle_size().
2560 </para>
2561
2562
2563 <!-- ##### FUNCTION gtk_paned_set_handle_size ##### -->
2564 <para>
2565 Set the the handle size to @size x @size pixels.
2566 </para>
2567
2568 @paned: a paned widget
2569 @size: the size in pixels
2570
2571 <!-- ##### FUNCTION gtk_pattern_match ##### -->
2572 <para>
2573
2574 </para>
2575
2576 @pspec:
2577 @string_length:
2578 @string:
2579 @string_reversed:
2580 @Returns:
2581
2582 <!-- ##### FUNCTION gtk_pattern_match_simple ##### -->
2583 <para>
2584
2585 </para>
2586
2587 @pattern:
2588 @string:
2589 @Returns:
2590
2591 <!-- ##### FUNCTION gtk_pattern_match_string ##### -->
2592 <para>
2593
2594 </para>
2595
2596 @pspec:
2597 @string:
2598 @Returns:
2599
2600 <!-- ##### FUNCTION gtk_pattern_spec_free_segs ##### -->
2601 <para>
2602
2603 </para>
2604
2605 @pspec:
2606
2607 <!-- ##### FUNCTION gtk_pattern_spec_init ##### -->
2608 <para>
2609
2610 </para>
2611
2612 @pspec:
2613 @pattern:
2614
2615 <!-- ##### FUNCTION gtk_rc_init ##### -->
2616 <para>
2617 Internal function.
2618 </para>
2619
2620
2621 <!-- ##### FUNCTION gtk_rc_load_image ##### -->
2622 <para>
2623 Internal function. Loads an image using the current
2624 image loader.
2625 </para>
2626
2627 @colormap: the colormap to use for the image
2628 @transparent_color: the transparent color for the image
2629 @filename: the filename of the image file
2630 @Returns: a #GtkPixmap representing @filename
2631
2632 <!-- ##### FUNCTION gtk_rc_set_image_loader ##### -->
2633 <para>
2634 Sets the function that GTK+ will use to load images
2635 </para>
2636
2637 @loader: the #GtkImageLoader to use
2638
2639 <!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
2640 <para>
2641
2642 </para>
2643
2644 @ruler: the gtkruler
2645
2646 <!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
2647 <para>
2648
2649 </para>
2650
2651 @ruler: the gtkruler
2652
2653 <!-- ##### FUNCTION gtk_selection_clear ##### -->
2654 <para>
2655 Internal function.
2656 </para>
2657
2658 @widget:
2659 @event:
2660 @Returns:
2661
2662 <!-- ##### FUNCTION gtk_selection_incr_event ##### -->
2663 <para>
2664 Internal function.
2665 </para>
2666
2667 @window:
2668 @event:
2669 @Returns:
2670
2671 <!-- ##### FUNCTION gtk_selection_notify ##### -->
2672 <para>
2673 Internal function.
2674 </para>
2675
2676 @widget:
2677 @event:
2678 @Returns:
2679
2680 <!-- ##### FUNCTION gtk_selection_property_notify ##### -->
2681 <para>
2682 Internal function.
2683 </para>
2684
2685 @widget:
2686 @event:
2687 @Returns:
2688
2689 <!-- ##### FUNCTION gtk_selection_request ##### -->
2690 <para>
2691 Internal function.
2692 </para>
2693
2694 @widget:
2695 @event:
2696 @Returns:
2697
2698 <!-- ##### FUNCTION gtk_settings_get_global ##### -->
2699 <para>
2700
2701 </para>
2702
2703 @Returns:
2704
2705 <!-- ##### FUNCTION gtk_signal_add_emission_hook ##### -->
2706 <para>
2707 Add an emission hook for a type of signal, for any object.
2708 </para>
2709
2710 @signal_id: the type of signal to hook for.
2711 @hook_func: the function to invoke to handle the emission hook.
2712 @data: the user data passed in to hook_func.
2713 @Returns: the id (that you may pass as a parameter
2714 to gtk_signal_remove_emission_hook()).
2715 @i:
2716 @h:
2717 @d:
2718
2719 <!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
2720 <para>
2721 Add an emission hook for a type of signal, for any object.
2722 (with control of what happens when the hook is
2723 destroyed).
2724 </para>
2725
2726 @signal_id: the type of signal add the hook for.
2727 @hook_func: the function to invoke to handle the hook.
2728 @data: the user data passed in to hook_func.
2729 @destroy: a function to invoke when the hook is destroyed,
2730 to clean up any allocation done just for this
2731 signal handler.
2732 @Returns: the id (that you may pass as a parameter
2733 to gtk_signal_remove_emission_hook()).
2734
2735 <!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
2736 <para>
2737 Returns whether a connection id is valid (and optionally not blocked).
2738 </para>
2739
2740 @object: the object to search for the desired handler.
2741 @handler_id: the connection id.
2742 @may_be_blocked: whether it is acceptable to return a blocked
2743 handler.
2744 @Returns: TRUE if the signal exists and wasn't blocked,
2745 unless #may_be_blocked was specified.  FALSE otherwise.
2746
2747 <!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
2748 <para>
2749 Destroy all the signal handlers connected to an object.
2750 This is done automatically when the object is destroyed.
2751 </para>
2752 <para>
2753 This function is labeled private.
2754 </para>
2755
2756 @object: the object whose signal handlers should be destroyed.
2757
2758 <!-- ##### FUNCTION gtk_signal_init ##### -->
2759 <para>
2760
2761 </para>
2762
2763
2764 <!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
2765 <para>
2766 Find out the recursion depth of emissions for a particular type
2767 of signal and object.  (So it will
2768 always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
2769 This is a way to avoid recursion:  you can see if
2770 you are currently running in that signal handler and emit it only
2771 if you are.
2772 </para>
2773 <para>Another way to look at it is that this number increases
2774 by one when #gtk_signal_emit(), et al, are called,
2775 and decreases by one when #gtk_signal_emit() returns.
2776 </para>
2777
2778 @object: the object with the signal handler.
2779 @signal_id: the signal id.
2780 @Returns: the recursion depth of emissions of this signal for this
2781 object.
2782
2783 <!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
2784 <para>
2785 Find out the recursion depth of emissions for a particular type
2786 of signal and object.  Just like gtk_signal_n_emissions()
2787 except it will lookup the signal id for you.
2788 </para>
2789
2790 @object: the object with the signal handler.
2791 @name: the signal name.
2792 @Returns: the recursion depth of emissions of this signal for this
2793 object.
2794
2795 <!-- ##### FUNCTION gtk_signal_query ##### -->
2796 <para>
2797 Obtain information about a signal.
2798 </para>
2799
2800 @signal_id: the signal type identifier.
2801 @Returns: a pointer to a GtkSignalQuery structure
2802 which contains all the information, or NULL.
2803 The pointer is allocated just for you:  you must g_free() it.
2804
2805 <!-- ##### FUNCTION gtk_signal_remove_emission_hook ##### -->
2806 <para>
2807 Delete an emission hook. (see gtk_signal_add_emission_hook())
2808 </para>
2809
2810 @signal_id: the id of the signal type.
2811 @hook_id: the id of the emission handler, returned by add_emission_hook().
2812 @i:
2813 @h:
2814
2815 <!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
2816 <para>
2817 These set default functions to call when the user didn't
2818 supply a function when connecting.  (These are rarely
2819 used, and probably only for language bindings)
2820 </para>
2821 <para>
2822 By default, there are no such functions.
2823 </para>
2824
2825 @marshal_func: the function to invoke on every handlers for which there
2826 isn't a function pointer.  May be NULL.
2827 @destroy_func: the function to invoke when each hook is destroyed.
2828 May be NULL.
2829
2830 <!-- ##### FUNCTION gtk_spin_button_set_shadow_type ##### -->
2831 <para>
2832 Creates a border around the arrows of a #GtkSpinButton. The type of border is determined by @shadow_type.
2833 </para>
2834
2835 @spin_button: a #GtkSpinButton
2836 @shadow_type: the new border type.
2837
2838 <!-- ##### FUNCTION gtk_stock_list_items ##### -->
2839 <para>
2840
2841 </para>
2842
2843 @Returns:
2844
2845 <!-- ##### FUNCTION gtk_text_buffer_paste_primary ##### -->
2846 <para>
2847
2848 </para>
2849
2850 @buffer:
2851 @override_location:
2852 @default_editable:
2853
2854 <!-- ##### FUNCTION gtk_text_iter_reorder ##### -->
2855 <para>
2856
2857 </para>
2858
2859 @first:
2860 @second:
2861
2862 <!-- ##### FUNCTION gtk_text_iter_spew ##### -->
2863 <para>
2864
2865 </para>
2866
2867 @iter:
2868 @desc:
2869
2870 <!-- ##### FUNCTION gtk_text_view_set_text_window_size ##### -->
2871 <para>
2872
2873 </para>
2874
2875 @text_view:
2876 @width:
2877 @height:
2878
2879 <!-- ##### FUNCTION gtk_tips_query_get_type ##### -->
2880 <para>
2881
2882 </para>
2883
2884 @Returns:
2885
2886 <!-- ##### FUNCTION gtk_trace_referencing ##### -->
2887 <para>
2888 Private: print debugging information while doing a gtk_object_ref() or
2889 a gtk_object_unref().
2890 </para>
2891
2892 @object: object to reference or unreference.
2893 @func: name of caller's function to print (used within macros).
2894 @dummy: unused.
2895 @line: line number (used within macros).
2896 @do_ref: whether to reference or unreference.
2897
2898 <!-- ##### FUNCTION gtk_tree_model_ref_iter ##### -->
2899 <para>
2900
2901 </para>
2902
2903 @tree_model:
2904 @iter:
2905
2906 <!-- ##### FUNCTION gtk_tree_model_sort_convert_iter ##### -->
2907 <para>
2908
2909 </para>
2910
2911 @tree_model_sort:
2912 @sort_iter:
2913 @child_iter:
2914
2915 <!-- ##### FUNCTION gtk_tree_model_sort_convert_path ##### -->
2916 <para>
2917
2918 </para>
2919
2920 @tree_model_sort:
2921 @child_path:
2922 @Returns:
2923 @path:
2924
2925 <!-- ##### FUNCTION gtk_tree_model_sort_new ##### -->
2926 <para>
2927
2928 </para>
2929
2930 @Returns:
2931
2932 <!-- ##### FUNCTION gtk_tree_model_sort_set_compare ##### -->
2933 <para>
2934
2935 </para>
2936
2937 @tree_model_sort:
2938 @func:
2939
2940 <!-- ##### FUNCTION gtk_tree_model_sort_set_model ##### -->
2941 <para>
2942
2943 </para>
2944
2945 @tree_model_sort:
2946 @child_model:
2947 @model:
2948
2949 <!-- ##### FUNCTION gtk_tree_model_sort_set_sort_column ##### -->
2950 <para>
2951
2952 </para>
2953
2954 @tree_model_sort:
2955 @sort_col:
2956
2957 <!-- ##### FUNCTION gtk_tree_model_unref_iter ##### -->
2958 <para>
2959
2960 </para>
2961
2962 @tree_model:
2963 @iter:
2964
2965 <!-- ##### FUNCTION gtk_tree_store_new_with_types ##### -->
2966 <para>
2967
2968 </para>
2969
2970 @n_columns:
2971 @Varargs:
2972 @Returns:
2973
2974 <!-- ##### FUNCTION gtk_tree_store_set_cell ##### -->
2975 <para>
2976
2977 </para>
2978
2979 @tree_store:
2980 @iter:
2981 @column:
2982 @value:
2983
2984 <!-- ##### FUNCTION gtk_tree_store_set_column_type ##### -->
2985 <para>
2986
2987 </para>
2988
2989 @tree_store:
2990 @column:
2991 @type:
2992 @store:
2993
2994 <!-- ##### FUNCTION gtk_tree_store_set_n_columns ##### -->
2995 <para>
2996
2997 </para>
2998
2999 @tree_store:
3000 @n_columns:
3001
3002 <!-- ##### FUNCTION gtk_tree_view_column_cell_event ##### -->
3003 <para>
3004
3005 </para>
3006
3007 @tree_column:
3008 @event:
3009 @path_string:
3010 @background_area:
3011 @cell_area:
3012 @flags:
3013 @Returns:
3014
3015 <!-- ##### FUNCTION gtk_tree_view_column_set_cell_data ##### -->
3016 <para>
3017
3018 </para>
3019
3020 @tree_column:
3021 @tree_model:
3022 @iter:
3023
3024 <!-- ##### FUNCTION gtk_tree_view_column_set_cell_renderer ##### -->
3025 <para>
3026
3027 </para>
3028
3029 @tree_column:
3030 @cell:
3031
3032 <!-- ##### FUNCTION gtk_tree_view_column_set_width ##### -->
3033 <para>
3034
3035 </para>
3036
3037 @tree_column:
3038 @width:
3039 @size:
3040
3041 <!-- ##### FUNCTION gtk_tree_view_set_rows_drag_dest ##### -->
3042 <para>
3043
3044 </para>
3045
3046 @tree_view:
3047 @targets:
3048 @n_targets:
3049 @actions:
3050 @location_droppable_func:
3051 @user_data:
3052
3053 <!-- ##### FUNCTION gtk_tree_view_set_rows_drag_source ##### -->
3054 <para>
3055
3056 </para>
3057
3058 @tree_view:
3059 @start_button_mask:
3060 @targets:
3061 @n_targets:
3062 @actions:
3063 @row_draggable_func:
3064 @user_data:
3065
3066 <!-- ##### FUNCTION gtk_type_check_class_cast ##### -->
3067 <para>
3068 Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make
3069 sure that it's okay to cast something of that @klass into a @cast_type.
3070 </para>
3071
3072 @klass: GtkTypeClass*
3073 @cast_type: GtkType
3074 @Returns: Always return @klass.
3075
3076 <!-- ##### FUNCTION gtk_type_check_object_cast ##### -->
3077 <para>
3078 Given a pointer to a GtkTypeObject @type_object, and a GtkType @cast_type,
3079 make sure that it's okay to cast @type_object into a @cast_type.
3080 </para>
3081
3082 @type_object: GtkTypeObject*
3083 @cast_type: GtkType
3084 @Returns: the same GtkTypeObject* as @type_object
3085
3086 <!-- ##### FUNCTION gtk_type_children_types ##### -->
3087 <para>
3088 Return the pointer to the type's children's types.
3089 </para>
3090
3091 @type: GtkType
3092 @Returns: pointer to a GList
3093
3094 <!-- ##### FUNCTION gtk_type_describe_heritage ##### -->
3095 <para>
3096 Print the types @type inherits from.
3097 </para>
3098
3099 @type: GtkType
3100
3101 <!-- ##### FUNCTION gtk_type_describe_tree ##### -->
3102 <para>
3103 Given a @type, describe all of its children, and their children.  Only
3104 show the size if @show_size is true.
3105 </para>
3106
3107 @type: GtkType
3108 @show_size: gboolean
3109
3110 <!-- ##### FUNCTION gtk_type_free ##### -->
3111 <para>
3112 Given the type of an object and a pointer to it, the object is freed.
3113 </para>
3114
3115 @type: GtkType
3116 @mem: gpointer to the object
3117
3118 <!-- ##### FUNCTION gtk_type_get_varargs_type ##### -->
3119 <para>
3120 Get the varargs type associated with @foreign_type
3121 </para>
3122
3123 @foreign_type: GtkType
3124 @Returns: GtkType
3125
3126 <!-- ##### FUNCTION gtk_type_parent_class ##### -->
3127 <para>
3128 Return the class of the parent.  Initialize the class if necessary.
3129 Return NULL if anything goes wrong.
3130 </para>
3131
3132 @type: GtkType
3133 @Returns: gpointer to the klass.
3134
3135 <!-- ##### FUNCTION gtk_type_query ##### -->
3136 <para>
3137 Given a type, return various interesting parameters of the type.
3138 </para>
3139
3140 @type: GtkType
3141 @Returns: GtkTypeQuery*
3142
3143 <!-- ##### FUNCTION gtk_type_register_enum ##### -->
3144 <para>
3145 Register a new set of enum @values and give them the name in
3146 @type_name.
3147 </para>
3148
3149 @type_name: must not be null.
3150 @values: GtkEnumValue*
3151 @Returns:
3152
3153 <!-- ##### FUNCTION gtk_type_register_flags ##### -->
3154 <para>
3155 Register a new set of flags @values and give them the name in
3156 @type_name.
3157 </para>
3158
3159 @type_name: must not be null.
3160 @values: GtkFlagValue*
3161 @Returns:
3162
3163 <!-- ##### FUNCTION gtk_type_set_chunk_alloc ##### -->
3164 <para>
3165 Set the mem_chunk size so it will hold @n_chunks of the objects of that @type.
3166 </para>
3167
3168 @type: There must be an unlocked TypeNode associated with this type otherwise nothing happens.
3169 @n_chunks:
3170
3171 <!-- ##### FUNCTION gtk_type_set_varargs_type ##### -->
3172 <para>
3173 Set the varargs type for a fundamental type @foreign_type.
3174 </para>
3175
3176 @foreign_type: Must be a GtkType with a sequence number of zero.  Must not be a
3177 fundamental type.
3178 @varargs_type: Must be a GtkType which is either structured or flag, or NONE.
3179
3180 <!-- ##### FUNCTION gtk_widget_accelerator_signal ##### -->
3181 <para>
3182
3183 </para>
3184
3185 @widget:
3186 @accel_group:
3187 @accel_key:
3188 @accel_mods:
3189 @Returns:
3190
3191 <!-- ##### FUNCTION gtk_widget_accelerators_locked ##### -->
3192 <para>
3193
3194 </para>
3195
3196 @widget:
3197 @Returns:
3198
3199 <!-- ##### FUNCTION gtk_widget_activate_mnemonic ##### -->
3200 <para>
3201
3202 </para>
3203
3204 @widget:
3205 @group_cycling:
3206 @Returns:
3207
3208 <!-- ##### FUNCTION gtk_widget_get_usize ##### -->
3209 <para>
3210
3211 </para>
3212
3213 @widget:
3214 @width:
3215 @height:
3216
3217 <!-- ##### FUNCTION gtk_widget_lock_accelerators ##### -->
3218 <para>
3219
3220 </para>
3221
3222 @widget:
3223
3224 <!-- ##### FUNCTION gtk_widget_pop_style ##### -->
3225 <para>
3226
3227 </para>
3228
3229
3230 <!-- ##### FUNCTION gtk_widget_popup ##### -->
3231 <para>
3232
3233 </para>
3234
3235 @widget:
3236 @x:
3237 @y:
3238
3239 <!-- ##### FUNCTION gtk_widget_push_style ##### -->
3240 <para>
3241
3242 </para>
3243
3244 @style:
3245
3246 <!-- ##### FUNCTION gtk_widget_remove_accelerators ##### -->
3247 <para>
3248
3249 </para>
3250
3251 @widget:
3252 @accel_signal:
3253 @visible_only:
3254
3255 <!-- ##### FUNCTION gtk_widget_set_default_style ##### -->
3256 <para>
3257
3258 </para>
3259
3260 @style:
3261
3262 <!-- ##### FUNCTION gtk_widget_unlock_accelerators ##### -->
3263 <para>
3264
3265 </para>
3266
3267 @widget:
3268
3269 <!-- ##### FUNCTION gtk_window_activate_mnemonic ##### -->
3270 <para>
3271
3272 </para>
3273
3274 @window:
3275 @keyval:
3276 @modifier:
3277 @Returns:
3278
3279 <!-- ##### FUNCTION gtk_window_get_default_accel_group ##### -->
3280 <para>
3281
3282 </para>
3283
3284 @window:
3285 @Returns:
3286
3287 <!-- ##### FUNCTION gtk_window_get_resizeable ##### -->
3288 <para>
3289
3290 </para>
3291
3292 @window:
3293 @Returns:
3294
3295 <!-- ##### FUNCTION gtk_window_set_decorations_hint ##### -->
3296 <para>
3297
3298 </para>
3299
3300 @window:
3301 @decorations:
3302
3303 <!-- ##### FUNCTION gtk_window_set_functions_hint ##### -->
3304 <para>
3305
3306 </para>
3307
3308 @window:
3309 @functions:
3310
3311 <!-- ##### FUNCTION gtk_window_set_resizeable ##### -->
3312 <para>
3313
3314 </para>
3315
3316 @window:
3317 @setting:
3318 @resizeable:
3319