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