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

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