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