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