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

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