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