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