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