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

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