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 GtkFrame:shadow-type ##### -->
 743 <para>
 744
 745 </para>
 746
 747
 748 <!-- ##### ARG GtkHScale:adjustment ##### -->
 749 <para>
 750 the #GtkAdjustment which sets the range of the scale.
 751 </para>
 752
 753
 754 <!-- ##### ARG GtkHScrollbar:adjustment ##### -->
 755 <para>
 756
 757 </para>
 758
 759
 760 <!-- ##### STRUCT GtkIMContextSimple ##### -->
 761 <para>
 762
 763 </para>
 764
 765 @object:
 766 @tables:
 767 @compose_buffer:
 768 @tentative_match:
 769 @tentative_match_len:
 770
 771 <!-- ##### USER_FUNCTION GtkImageLoader ##### -->
 772 <para>
 773 A GtkImageLoader is used to load a filename found in
 774 a RC file.
 775 </para>
 776
 777 @window: the window for creating image
 778 @colormap: the colormap for this image
 779 @mask: a pointer to the location to store the mask
 780 @transparent_color: the transparent color for the image
 781 @filename: filename to load
 782 @Returns: a #GtkPixmap representing @filename
 783
 784 <!-- ##### ARG GtkLabel:accel-keyval ##### -->
 785 <para>
 786
 787 </para>
 788
 789
 790 <!-- ##### ARG GtkObject:object-signal ##### -->
 791 <para>
 792 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 793 the signal to the object, so that the user data and objects
 794 and swapped when the signal handler is invoked.
 795 </para>
 796 <para>
 797 This is useful for handlers that are primarily notifying
 798 other objects and could just invoke an already existing function
 799 if the parameters were swapped.
 800 See gtk_signal_connect_object() for more details.
 801 </para>
 802
 803
 804 <!-- ##### ARG GtkObject:object-signal-after ##### -->
 805 <para>
 806 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 807 the signal to the object, so that the user data and objects
 808 and swapped when the signal handler is invoked,
 809 and so that the handler is invoked after all others.
 810 </para>
 811 <para>
 812 See gtk_signal_connect_object_after() for more details.
 813 </para>
 814
 815
 816 <!-- ##### ARG GtkObject:signal ##### -->
 817 <para>
 818 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 819 the signal to the object.
 820 </para>
 821
 822
 823 <!-- ##### ARG GtkObject:signal-after ##### -->
 824 <para>
 825 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 826 the signal to the object, so that the signal is always run
 827 after other user handlers and the default handler.
 828 </para>
 829
 830
 831 <!-- ##### ARG GtkPacker:default-border-width ##### -->
 832 <para>
 833
 834 </para>
 835
 836
 837 <!-- ##### ARG GtkPacker:default-ipad-x ##### -->
 838 <para>
 839
 840 </para>
 841
 842
 843 <!-- ##### ARG GtkPacker:default-ipad-y ##### -->
 844 <para>
 845
 846 </para>
 847
 848
 849 <!-- ##### ARG GtkPacker:default-pad-x ##### -->
 850 <para>
 851
 852 </para>
 853
 854
 855 <!-- ##### ARG GtkPacker:default-pad-y ##### -->
 856 <para>
 857
 858 </para>
 859
 860
 861 <!-- ##### ARG GtkPacker:spacing ##### -->
 862 <para>
 863
 864 </para>
 865
 866
 867 <!-- ##### ARG GtkPaned:handle-size ##### -->
 868 <para>
 869
 870 </para>
 871
 872
 873 <!-- ##### STRUCT GtkPatternSpec ##### -->
 874 <para>
 875
 876 </para>
 877
 878 @match_type:
 879 @pattern_length:
 880 @pattern:
 881 @pattern_reversed:
 882 @user_data:
 883 @seq_id:
 884
 885 <!-- ##### ENUM GtkPrivateFlags ##### -->
 886 <para>
 887
 888 </para>
 889
 890 @PRIVATE_GTK_USER_STYLE:
 891 @PRIVATE_GTK_RESIZE_PENDING:
 892 @PRIVATE_GTK_RESIZE_NEEDED:
 893 @PRIVATE_GTK_LEAVE_PENDING:
 894 @PRIVATE_GTK_HAS_SHAPE_MASK:
 895 @PRIVATE_GTK_IN_REPARENT:
 896 @PRIVATE_GTK_DIRECTION_SET:
 897 @PRIVATE_GTK_DIRECTION_LTR:
 898
 899 <!-- ##### ARG GtkScrolledWindow:shadow ##### -->
 900 <para>
 901
 902 </para>
 903
 904
 905 <!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
 906 <para>
 907 A function which you can use to clean up when the
 908 signal handler is destroyed.
 909 </para>
 910 <para>
 911 For example, if your handler requires a few variables
 912 that you made into a struct and allocated (using g_new()
 913 or something), then you will probably want to free
 914 it as soon as the hook is destroyed.  This will
 915 allow you to do that. (For this in particular
 916 it is convenient to pass g_free() as a #GtkSignalDestroy
 917 function).
 918 </para>
 919
 920 @data: The user data associated with the hook that is being
 921 destroyed.
 922
 923 <!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
 924 <para>
 925 This is currently a hack left in for a scheme wrapper library.
 926 It may be removed.
 927 </para>
 928 <para>
 929 Don't use it.
 930 </para>
 931
 932 @object: The object which emits the signal.
 933 @data: The user data associated with the hook.
 934 @nparams: The number of parameters to the function.
 935 @args: The actual values of the arguments.
 936 @arg_types: The types of the arguments.
 937 @return_type: The type of the return value from the function
 938 or #GTK_TYPE_NONE for no return value.
 939
 940 <!-- ##### STRUCT GtkSignalQuery ##### -->
 941 <para>
 942 This structure contains all the information about a particular
 943 signal:  its name, the type it affects, the signature of the handlers,
 944 and its unique identifying integer.
 945 </para>
 946
 947 @object_type:
 948 @signal_id:
 949 @signal_name:
 950 @is_user_signal:
 951 @signal_flags:
 952 @return_val:
 953 @nparams:
 954 @params:
 955
 956 <!-- ##### ARG GtkSpinButton:shadow-type ##### -->
 957 <para>
 958 the type of border that surrounds the arrows of a spin button.
 959 </para>
 960
 961
 962 <!-- ##### STRUCT GtkStatusbarMsg ##### -->
 963 <para>
 964 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.
 965 </para>
 966
 967 @text:
 968 @context_id:
 969 @message_id:
 970
 971 <!-- ##### ARG GtkTextTag:justify ##### -->
 972 <para>
 973 A #GtkJustification for the text. This is only used when the tag is
 974 applied to the first character in a paragraph.
 975 </para>
 976
 977
 978 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
 979 <para>
 980 Pixel width of the left margin of the text for lines after the first
 981 line in a wrapped paragraph.
 982 </para>
 983
 984
 985 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
 986 <para>
 987
 988 </para>
 989
 990
 991 <!-- ##### ARG GtkTextTag:offset ##### -->
 992 <para>
 993 Pixels to offset the text horizontally or vertically, useful to
 994 produce superscript and subscript.
 995 </para>
 996
 997
 998 <!-- ##### ARG GtkTextView:justify ##### -->
 999 <para>
1000
1001 </para>
1002
1003
1004 <!-- ##### ENUM GtkTreeSelectionMode ##### -->
1005 <para>
1006
1007 </para>
1008
1009 @GTK_TREE_SELECTION_SINGLE:
1010 @GTK_TREE_SELECTION_MULTI:
1011
1012 <!-- ##### ARG GtkVScale:adjustment ##### -->
1013 <para>
1014 the #GtkAdjustment which sets the range of the scale.
1015 </para>
1016
1017
1018 <!-- ##### ARG GtkVScrollbar:adjustment ##### -->
1019 <para>
1020
1021 </para>
1022
1023
1024 <!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
1025 <para>
1026
1027 </para>
1028
1029 @widget: the object which received the signal.
1030 @arg1:
1031 @Returns:
1032
1033 <!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
1034 <para>
1035
1036 </para>
1037
1038 @widget: the object which received the signal.
1039 @message:
1040
1041 <!-- ##### SIGNAL GtkWidget::draw ##### -->
1042 <para>
1043
1044 </para>
1045
1046 @widget: the object which received the signal.
1047 @area:
1048
1049 <!-- ##### SIGNAL GtkWidget::draw-default ##### -->
1050 <para>
1051
1052 </para>
1053
1054 @widget: the object which received the signal.
1055
1056 <!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
1057 <para>
1058
1059 </para>
1060
1061 @widget: the object which received the signal.
1062
1063 <!-- ##### ARG GtkWidget:height ##### -->
1064 <para>
1065
1066 </para>
1067
1068
1069 <!-- ##### ARG GtkWidget:width ##### -->
1070 <para>
1071
1072 </para>
1073
1074
1075 <!-- ##### ARG GtkWidget:x ##### -->
1076 <para>
1077
1078 </para>
1079
1080
1081 <!-- ##### ARG GtkWidget:y ##### -->
1082 <para>
1083
1084 </para>
1085
1086
1087 <!-- ##### ARG GtkWindow:auto-shrink ##### -->
1088 <para>
1089 If the window shrinks automatically when widgets within it shrink.
1090 </para>
1091
1092
1093 <!-- ##### ARG GtkWindow:icon-list ##### -->
1094 <para>
1095
1096 </para>
1097
1098
1099 <!-- ##### FUNCTION gtk_accel_group_create_add ##### -->
1100 <para>
1101
1102 </para>
1103
1104 @class_type:
1105 @signal_flags:
1106 @handler_offset:
1107 @Returns:
1108
1109 <!-- ##### FUNCTION gtk_accel_group_create_remove ##### -->
1110 <para>
1111
1112 </para>
1113
1114 @class_type:
1115 @signal_flags:
1116 @handler_offset:
1117 @Returns:
1118
1119 <!-- ##### FUNCTION gtk_accel_group_entries_from_object ##### -->
1120 <para>
1121
1122 </para>
1123
1124 @object:
1125 @Returns:
1126
1127 <!-- ##### FUNCTION gtk_accel_group_get_entry ##### -->
1128 <para>
1129
1130 </para>
1131
1132 @accel_group:
1133 @accel_key:
1134 @accel_mods:
1135 @Returns:
1136
1137 <!-- ##### FUNCTION gtk_accel_group_handle_add ##### -->
1138 <para>
1139
1140 </para>
1141
1142 @object:
1143 @accel_signal_id:
1144 @accel_group:
1145 @accel_key:
1146 @accel_mods:
1147 @accel_flags:
1148
1149 <!-- ##### FUNCTION gtk_accel_group_handle_remove ##### -->
1150 <para>
1151
1152 </para>
1153
1154 @object:
1155 @accel_group:
1156 @accel_key:
1157 @accel_mods:
1158
1159 <!-- ##### FUNCTION gtk_accel_group_lock_entry ##### -->
1160 <para>
1161
1162 </para>
1163
1164 @accel_group:
1165 @accel_key:
1166 @accel_mods:
1167
1168 <!-- ##### FUNCTION gtk_accel_group_unlock_entry ##### -->
1169 <para>
1170
1171 </para>
1172
1173 @accel_group:
1174 @accel_key:
1175 @accel_mods:
1176
1177 <!-- ##### FUNCTION gtk_accel_groups_from_object ##### -->
1178 <para>
1179
1180 </para>
1181
1182 @object:
1183 @Returns:
1184
1185 <!-- ##### FUNCTION gtk_arg_copy ##### -->
1186 <para>
1187 It will either copy data into an existing argument or allocate a new argument
1188 and copy the data.  Strings are duplicated.  All other pointers and
1189 values are copied (shallowly-- that is the pointers themselves are
1190 copied, not the data they point to.)
1191 </para>
1192 <para>
1193 You should call gtk_arg_reset() on dest_arg before calling this
1194 if the argument may contain string data that you want freed.
1195 </para>
1196
1197 @src_arg: the argument to duplicate.
1198 @dest_arg: the argument to copy over (or NULL to create a new #GtkArg).
1199 @Returns: the new #GtkArg (or dest_arg, if it was not NULL).
1200
1201 <!-- ##### FUNCTION gtk_arg_free ##### -->
1202 <para>
1203 Frees the argument, and optionally its contents.
1204 </para>
1205
1206 @arg: the argument to free.
1207 @free_contents: whether to free the string, if it is a string.
1208
1209 <!-- ##### FUNCTION gtk_arg_get_info ##### -->
1210 <para>
1211 Private: get information about an argument.
1212 </para>
1213
1214 @object_type: the type of object.
1215 @arg_info_hash_table: the hashtable of #GtkArgInfos.
1216 @arg_name: the name of the argument to lookup.
1217 @info_p: the argument info.
1218 @Returns: an error message on failure, or NULL otherwise.
1219
1220 <!-- ##### FUNCTION gtk_arg_info_equal ##### -->
1221 <para>
1222 A #GCompareFunc for hashing #GtkArgInfos.
1223 </para>
1224
1225 @arg_info_1: a #GtkArgInfo.
1226 @arg_info_2: a #GtkArgInfo.
1227 @Returns: whether the arguments are the same.
1228
1229 <!-- ##### FUNCTION gtk_arg_info_hash ##### -->
1230 <para>
1231 A #GHashFunc for hashing #GtkArgInfos.
1232 </para>
1233
1234 @arg_info: a #GtkArgInfo.
1235 @Returns: a hash value for that #GtkArgInfo.
1236
1237 <!-- ##### FUNCTION gtk_arg_name_strip_type ##### -->
1238 <para>
1239 Given a fully qualified argument name (e.g. "GtkButton::label")
1240 it returns just the argument name (e.g. "label") unless
1241 the argument name was invalid, in which case it returns NULL.
1242 </para>
1243
1244 @arg_name: the fully-qualified argument name.
1245 @Returns: the base argument name.
1246
1247 <!-- ##### FUNCTION gtk_arg_new ##### -->
1248 <para>
1249 Creates a new argument of a certain type, set to 0 or NULL.
1250 </para>
1251
1252 @arg_type: the type of the argument.
1253 @Returns: the newly created #GtkArg.
1254
1255 <!-- ##### FUNCTION gtk_arg_reset ##### -->
1256 <para>
1257
1258 </para>
1259
1260 @arg:
1261
1262 <!-- ##### FUNCTION gtk_arg_to_valueloc ##### -->
1263 <para>
1264
1265 </para>
1266
1267 @arg:
1268 @value_pointer:
1269
1270 <!-- ##### FUNCTION gtk_arg_type_new_static ##### -->
1271 <para>
1272 Create a new argument registered with a class.
1273 </para>
1274
1275 @base_class_type: the basic type having the arguments, almost alway
1276 GTK_TYPE_OBJECT, except if your defining a different type argument
1277 that gets a different namespace.  #GtkContainer does this to define
1278 per-child arguments of the container.
1279 @arg_name: name of the argument to create.  (must be a static constant string)
1280 @class_n_args_offset: offset into the base class structure that tells
1281 the number of arguments.
1282 @arg_info_hash_table: hashtable of #GtkArgInfos.
1283 @arg_type: type of the argument.
1284 @arg_flags: flags of the argument.
1285 @arg_id: ???
1286 @Returns: the new #GtkArgInfo.
1287
1288 <!-- ##### FUNCTION gtk_arg_values_equal ##### -->
1289 <para>
1290
1291 </para>
1292
1293 @arg1:
1294 @arg2:
1295 @Returns:
1296
1297 <!-- ##### FUNCTION gtk_args_collect ##### -->
1298 <para>
1299 Private:  given a hashtable of argument information it takes a vararg
1300 list and parses it into arguments (in the form of lists of #GtkArgs
1301 and lists of #GtkArgInfos.
1302 </para>
1303 <para>
1304 The list of arguments starts with first_arg_name then the first argument's
1305 value.  Followed by any number of additional name/argument pairs,
1306 terminated with NULL.
1307 </para>
1308
1309 @object_type: the type of object we are collecting arguments for.
1310 @arg_info_hash_table: a hashtable mapping from names of arguments
1311 to their #GtkArgInfos.
1312 @arg_list_p: a returned list of arguments obtained from parsing the
1313 varargs.
1314 @info_list_p: a returned list of the #GtkArgInfos.
1315 @first_arg_name: the name of the first argument.
1316 @var_args: a va_list containing the value of the first argument,
1317 followed by name/value pairs, followed by NULL.
1318 @Returns: an error message on failure, or NULL otherwise.
1319
1320 <!-- ##### FUNCTION gtk_args_collect_cleanup ##### -->
1321 <para>
1322 Private: erase lists of arguments returned from gtk_args_collect().
1323 </para>
1324
1325 @arg_list: arg_list_p returned from gtk_args_collect().
1326 @info_list: info_list_p returned from gtk_args_collect().
1327
1328 <!-- ##### FUNCTION gtk_args_query ##### -->
1329 <para>
1330 Private: from a class type and its arginfo hashtable,
1331 get an array of #GtkArgs that this object accepts.
1332 </para>
1333
1334 @class_type: the class type.
1335 @arg_info_hash_table: the hashtable of #GtkArgInfos.
1336 @arg_flags: returned array of argument flags.
1337 @n_args_p: the number of arguments this object accepts.
1338 @Returns: the array of arguments (or NULL on error).
1339
1340 <!-- ##### FUNCTION gtk_button_box_child_requisition ##### -->
1341 <para>\r
1342 This is an internally used function and should never be called from an\r
1343 application.\r
1344 </para>
1345
1346 @widget:
1347 @nvis_children:
1348 @width:
1349 @height:
1350
1351 <!-- ##### FUNCTION gtk_button_box_get_child_ipadding_default ##### -->
1352 <para>\r
1353 The internal padding of a button is the amount of space between the outside\r
1354 of the button and the widget it contains. This function gets the default\r
1355 amount of horizontal and vertical padding, placing the results in @ipad_x\r
1356 and @ipad_y, respectively.\r
1357 </para>
1358
1359 @ipad_x: the default horizontal internal button padding.
1360 @ipad_y: the default vertical internal button padding.
1361
1362 <!-- ##### FUNCTION gtk_button_box_get_child_size_default ##### -->
1363 <para>\r
1364 Retrieves the default minimum width and height for all button boxes, and\r
1365 places the values in @min_width and @min_height, respectively.\r
1366 </para>
1367
1368 @min_width: the default minimum width of a child widget.
1369 @min_height: the default minimum height of a child widget.
1370
1371 <!-- ##### FUNCTION gtk_button_box_set_child_ipadding_default ##### -->
1372 <para>\r
1373 Sets the default number of pixels that pad each button in every button box.\r
1374 </para>
1375
1376 @ipad_x: new default horizontal padding.
1377 @ipad_y: new default vertical padding.
1378
1379 <!-- ##### FUNCTION gtk_button_box_set_child_size_default ##### -->
1380 <para>\r
1381 Sets the default size of child buttons.\r
1382 </para>
1383
1384 @min_width: minimum default width for child buttons.
1385 @min_height: minimum default height for child buttons.
1386
1387 <!-- ##### FUNCTION gtk_button_new_accel ##### -->
1388 <para>
1389
1390 </para>
1391
1392 @uline_label:
1393 @accel_group:
1394 @Returns:
1395
1396 <!-- ##### FUNCTION gtk_button_new_stock ##### -->
1397 <para>
1398
1399 </para>
1400
1401 @stock_id:
1402 @accel_group:
1403 @Returns:
1404
1405 <!-- ##### FUNCTION gtk_cell_renderer_text_pixbuf_new ##### -->
1406 <para>
1407
1408 </para>
1409
1410 @Returns:
1411
1412 <!-- ##### FUNCTION gtk_clist_construct ##### -->
1413 <para>
1414 Initializes a previously allocated #GtkCList widget for use.  This should not
1415 normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
1416 </para>
1417
1418 @clist: A pointer to an uninitialized #GtkCList widget.
1419 @columns: The number of columns the #GtkCList should have.
1420 @titles: An array of strings that should be used as the titles i
1421 of the columns.  There should be enough strings in the array for
1422 the number of columns specified.
1423
1424 <!-- ##### FUNCTION gtk_color_selection_get_old_color ##### -->
1425 <para>
1426
1427 </para>
1428
1429 @colorsel:
1430 @color:
1431
1432 <!-- ##### FUNCTION gtk_color_selection_get_use_opacity ##### -->
1433 <para>
1434
1435 </para>
1436
1437 @colorsel:
1438 @Returns:
1439
1440 <!-- ##### FUNCTION gtk_color_selection_get_use_palette ##### -->
1441 <para>
1442
1443 </para>
1444
1445 @colorsel:
1446 @Returns:
1447
1448 <!-- ##### FUNCTION gtk_color_selection_set_old_color ##### -->
1449 <para>
1450
1451 </para>
1452
1453 @colorsel:
1454 @color:
1455
1456 <!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
1457 <para>
1458 Controls whether opacity can be set with the #GtkColorSelection.
1459 If this functionality is enabled, the necessary additional widgets
1460 are added to the #GtkColorSelection and the opacity value can be
1461 retrieved via the fourth value in the color array returned by
1462 the gtk_color_selection_get_color() function.
1463 </para>
1464
1465 @colorsel: a #GtkColorSelection.
1466 @use_opacity: a boolean indicating whether the opacity selection
1467 is enabled.
1468
1469 <!-- ##### FUNCTION gtk_color_selection_set_use_opacity ##### -->
1470 <para>
1471
1472 </para>
1473
1474 @colorsel:
1475 @use_opacity:
1476
1477 <!-- ##### FUNCTION gtk_color_selection_set_use_palette ##### -->
1478 <para>
1479
1480 </para>
1481
1482 @colorsel:
1483 @use_palette:
1484
1485 <!-- ##### FUNCTION gtk_container_add_child_arg_type ##### -->
1486 <para>
1487
1488 </para>
1489
1490 @arg_name:
1491 @arg_type:
1492 @arg_flags:
1493 @arg_id:
1494
1495 <!-- ##### FUNCTION gtk_container_add_with_args ##### -->
1496 <para>
1497
1498 </para>
1499
1500 @container:
1501 @widget:
1502 @first_arg_name:
1503 @Varargs:
1504
1505 <!-- ##### FUNCTION gtk_container_addv ##### -->
1506 <para>
1507
1508 </para>
1509
1510 @container:
1511 @widget:
1512 @n_args:
1513 @args:
1514
1515 <!-- ##### FUNCTION gtk_container_arg_get ##### -->
1516 <para>
1517
1518 </para>
1519
1520 @container:
1521 @child:
1522 @arg:
1523 @info:
1524
1525 <!-- ##### FUNCTION gtk_container_arg_set ##### -->
1526 <para>
1527
1528 </para>
1529
1530 @container:
1531 @child:
1532 @arg:
1533 @info:
1534
1535 <!-- ##### FUNCTION gtk_container_child_arg_get_info ##### -->
1536 <para>
1537
1538 </para>
1539
1540 @object_type:
1541 @arg_name:
1542 @info_p:
1543 @Returns:
1544
1545 <!-- ##### FUNCTION gtk_container_child_args_collect ##### -->
1546 <para>
1547
1548 </para>
1549
1550 @object_type:
1551 @arg_list_p:
1552 @info_list_p:
1553 @first_arg_name:
1554 @args:
1555 @Returns:
1556
1557 <!-- ##### FUNCTION gtk_container_child_getv ##### -->
1558 <para>
1559
1560 </para>
1561
1562 @container:
1563 @child:
1564 @n_args:
1565 @args:
1566
1567 <!-- ##### FUNCTION gtk_container_child_setv ##### -->
1568 <para>
1569
1570 </para>
1571
1572 @container:
1573 @child:
1574 @n_args:
1575 @args:
1576
1577 <!-- ##### FUNCTION gtk_container_dequeue_resize_handler ##### -->
1578 <para>
1579
1580 </para>
1581
1582 @container:
1583
1584 <!-- ##### FUNCTION gtk_container_focus ##### -->
1585 <para>
1586
1587 </para>
1588
1589 @container:
1590 @direction:
1591 @Returns:
1592
1593 <!-- ##### FUNCTION gtk_container_query_child_args ##### -->
1594 <para>
1595
1596 </para>
1597
1598 @class_type:
1599 @arg_flags:
1600 @nargs:
1601 @Returns:
1602
1603 <!-- ##### FUNCTION gtk_ctree_construct ##### -->
1604 <para>
1605 This function is not usually used by users.
1606 </para>
1607
1608 @ctree:
1609 @columns:
1610 @tree_column:
1611 @titles:
1612
1613 <!-- ##### FUNCTION gtk_drag_dest_handle_event ##### -->
1614 <para>
1615 Internal function.
1616 </para>
1617
1618 @toplevel:
1619 @event:
1620
1621 <!-- ##### FUNCTION gtk_drag_source_handle_event ##### -->
1622 <para>
1623 Internal function.
1624 </para>
1625
1626 @widget:
1627 @event:
1628
1629 <!-- ##### FUNCTION gtk_editable_changed ##### -->
1630 <para>
1631 Causes the "changed" signal to be emitted.
1632 </para>
1633
1634 @editable: a #GtkEditable widget.
1635
1636 <!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
1637 <para>
1638 Claim or disclaim ownership of the PRIMARY X selection.
1639 </para>
1640
1641 @editable: a #GtkEditable widget.
1642 @claim: if %TRUE, claim the selection, otherwise, disclaim it.
1643 @time: the timestamp for claiming the selection.
1644
1645 <!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
1646 <para>
1647 Sets one of the two font filters, to limit the fonts shown.
1648 </para>
1649
1650 @fsd: a #GtkFontSelectionDialog.
1651 @filter_type: which of the two font filters to set, either
1652 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
1653 can be changed by the user, but the base filter is permanent.
1654 @font_type: the types of font to be shown. This is a bitwise combination of
1655 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
1656 or #GTK_FONT_ALL to show all three font types.
1657 @foundries: a NULL-terminated array of strings containing foundry names which
1658 will be shown, or NULL to show all foundries.
1659 @weights: a NULL-terminated array of strings containing weight names which
1660 will be shown, or NULL to show all weights.
1661 @slants: a NULL-terminated array of strings containing slant names which
1662 will be shown, or NULL to show all slants.
1663 @setwidths: a NULL-terminated array of strings containing setwidth names which
1664 will be shown, or NULL to show all setwidths.
1665 @spacings: a NULL-terminated array of strings containing spacings which
1666 will be shown, or NULL to show all spacings.
1667 @charsets: a NULL-terminated array of strings containing charset names which
1668 will be shown, or NULL to show all charsets.
1669
1670 <!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
1671 <para>
1672 Sets one of the two font filters, to limit the fonts shown.
1673 </para>
1674
1675 @fontsel: a #GtkFontSelection.
1676 @filter_type: which of the two font filters to set, either
1677 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
1678 can be changed by the user, but the base filter is permanent.
1679 @font_type: the types of font to be shown. This is a bitwise combination of
1680 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
1681 or #GTK_FONT_ALL to show all three font types.
1682 @foundries: a NULL-terminated array of strings containing foundry names which
1683 will be shown, or NULL to show all foundries.
1684 @weights: a NULL-terminated array of strings containing weight names which
1685 will be shown, or NULL to show all weights.
1686 @slants: a NULL-terminated array of strings containing slant names which
1687 will be shown, or NULL to show all slants.
1688 @setwidths: a NULL-terminated array of strings containing setwidth names which
1689 will be shown, or NULL to show all setwidths.
1690 @spacings: a NULL-terminated array of strings containing spacings which
1691 will be shown, or NULL to show all spacings.
1692 @charsets: a NULL-terminated array of strings containing charset names which
1693 will be shown, or NULL to show all charsets.
1694
1695 <!-- ##### FUNCTION gtk_identifier_get_type ##### -->
1696 <para>
1697 Get the type of GtkIdentifier.
1698 </para>
1699
1700 @Returns: GtkType -- the enumerated type of something.
1701
1702 <!-- ##### FUNCTION gtk_image_menu_item_add_image ##### -->
1703 <para>
1704
1705 </para>
1706
1707 @image_menu_item:
1708 @child:
1709
1710 <!-- ##### FUNCTION gtk_image_menu_item_get_type ##### -->
1711 <para>
1712
1713 </para>
1714
1715 @Returns:
1716
1717 <!-- ##### FUNCTION gtk_label_set_markup_with_accel ##### -->
1718 <para>
1719
1720 </para>
1721
1722 @label:
1723 @str:
1724 @Returns:
1725
1726 <!-- ##### FUNCTION gtk_list_store_new_with_types ##### -->
1727 <para>
1728
1729 </para>
1730
1731 @n_columns:
1732 @Varargs:
1733 @Returns:
1734
1735 <!-- ##### FUNCTION gtk_list_store_set_cell ##### -->
1736 <para>
1737
1738 </para>
1739
1740 @store:
1741 @iter:
1742 @column:
1743 @value:
1744
1745 <!-- ##### FUNCTION gtk_list_store_set_column_type ##### -->
1746 <para>
1747
1748 </para>
1749
1750 @store:
1751 @column:
1752 @type:
1753
1754 <!-- ##### FUNCTION gtk_list_store_set_n_columns ##### -->
1755 <para>
1756
1757 </para>
1758
1759 @store:
1760 @n_columns:
1761
1762 <!-- ##### FUNCTION gtk_menu_ensure_uline_accel_group ##### -->
1763 <para>
1764
1765 </para>
1766
1767 @menu:
1768 @Returns:
1769
1770 <!-- ##### FUNCTION gtk_menu_get_uline_accel_group ##### -->
1771 <para>
1772
1773 </para>
1774
1775 @menu:
1776 @Returns:
1777
1778 <!-- ##### FUNCTION gtk_menu_item_configure ##### -->
1779 <para>
1780 Sets whether the menu item should show a submenu indicator, which is a right
1781 arrow.
1782 </para>
1783
1784 @menu_item: the menu item
1785 @show_toggle_indicator: unused
1786 @show_submenu_indicator: whether to show the arrow or not
1787
1788 <!-- ##### FUNCTION gtk_object_arg_get ##### -->
1789 <para>
1790 Private function to get an argument and argument info from an object.
1791 </para>
1792
1793 @object: the object whose argument should be retrieved.
1794 @arg: the argument, for the name on input, the rest is filled on output.
1795 @info: a #GtkArgInfo structure to optionally fill in.
1796
1797 <!-- ##### FUNCTION gtk_object_arg_get_info ##### -->
1798 <para>
1799 Query information about an argument type.
1800 </para>
1801
1802 @object_type: type of object to query about.
1803 @arg_name: name of the argument.
1804 @info_p: pointer to be filled in with a pointer to the GtkArgInfo.
1805 @Returns: an error message, or NULL on success.
1806 It is the caller's responsibility to call g_free() in the event of error.
1807
1808 <!-- ##### FUNCTION gtk_object_arg_set ##### -->
1809 <para>
1810 Private function to set an argument and argument info to an object.
1811 </para>
1812
1813 @object: the object whose argument should be set.
1814 @arg: the argument.
1815 @info: infomation about this type of argument in general.
1816
1817 <!-- ##### FUNCTION gtk_object_args_collect ##### -->
1818 <para>
1819 Private: Gets an array of #GtkArgs from a va_list C structure.
1820 </para>
1821
1822 @object_type: the type of object to collect arguments for.
1823 @arg_list_p: pointer to be filled in with a list of parsed arguments.
1824 @info_list_p: optional pointer for a returned list #GtkArgInfos.
1825 @first_arg_name: name of first argument.
1826 @var_args: value of first argument, followed by more key/value pairs,
1827 terminated by NULL.
1828 @Returns: an error message, or NULL on success.
1829 It is the caller's responsibility to call g_free() in the event of error.
1830
1831 <!-- ##### FUNCTION gtk_object_class_add_signals ##### -->
1832 <para>
1833 Add an array of signals to a #GtkObjectClass.
1834 Usually this is called when registering a new type of object.
1835 </para>
1836
1837 @klass: the object class to append signals to.
1838 @signals: the signals to append.
1839 @nsignals: the number of signals being appended.
1840
1841 <!-- ##### FUNCTION gtk_object_class_user_signal_new ##### -->
1842 <para>
1843 Define a signal-handler for a new signal on an already defined
1844 object.
1845 </para>
1846 <para>
1847 See the signal documentation for more general information.
1848 </para>
1849
1850 @klass: the object class to define the signal for.
1851 @name: the name of the signal.
1852 @signal_flags: the default emission behavior for the signal.
1853 See gtk_signal_new().
1854 @marshaller: a function that will take an array of GtkArgs
1855 and invoke the appropriate handler with the normal calling
1856 conventions.
1857 @return_val: specify the return-value type for the signal
1858 (or GTK_TYPE_NONE for no return-value).
1859 @nparams: specify the number of parameters the signal
1860 receives from the caller of gtk_signal_emit().
1861 @Varargs: list of nparams #GtkTypes to pass to the signal handlers.
1862 @Returns: the signal id.  (See #GtkSignals)
1863
1864 <!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### -->
1865 <para>
1866 Define a signal-handler for a new signal on an already defined
1867 object.
1868 </para>
1869
1870 @klass: the object class to define the signal for.
1871 @name: the name of the signal.
1872 @signal_flags: the default emission behavior for the signal.
1873 See gtk_signal_new().
1874 @marshaller: takes a GtkObject, a #GtkSignalFunc, and an array
1875 of arguments, and invokes the function using the appropriate
1876 calling conventions.  Usually just select a function
1877 out of gtkmarshal.h.
1878 @return_val: specify the return-value type for the signal (possibly
1879 #GTK_TYPE_NONE).
1880 @nparams: specify the number of parameters the signal
1881 receives from the caller of gtk_signal_emit().
1882 @params: array of #GtkTypes the signal handlers for this signal
1883 should have in their prototype (of length nparams).
1884 @Returns: the signal id.  (See #GtkSignals)
1885
1886 <!-- ##### FUNCTION gtk_object_constructed ##### -->
1887 <para>
1888 Mark an allocated object as constructed.
1889 This is used for situations
1890 that require precise control of the construction process.
1891 </para>
1892 <para>
1893 This is done when gtk_object_default_construct() is inadequate.
1894 In #GtkCList the need arises because #GtkCList does construction work that
1895 must happen <emphasis>after</emphasis> its derivers.  This work
1896 cannot be done in an initializer function, so an alternate
1897 constructor is mandatory.  It calls gtk_object_constructed() to
1898 indicate it has done its job, so that no other constructor will
1899 be invoked.
1900 </para>
1901 <para>
1902 Normally this function is just automatically run from
1903 gtk_object_default_construct().
1904 </para>
1905
1906 @object: object which has been constructed.  This is usually
1907 done automatically by gtk_object_new() and gtk_object_newv().
1908
1909 <!-- ##### FUNCTION gtk_object_default_construct ##### -->
1910 <para>
1911 This function is called to construct arguments that haven't been initialized
1912 but have the #GTK_ARG_CONSTRUCT flag set.
1913 </para>
1914 <para>
1915 All number arguments are set to 0.  All pointers and strings
1916 are set to NULL.
1917 </para>
1918 <para>
1919 Normally invoked by gtk_object_new() automatically; gtk_type_new() can
1920 be used to bypass it.
1921 </para>
1922
1923 @object: the object to initialize.
1924
1925 <!-- ##### FUNCTION gtk_object_getv ##### -->
1926 <para>
1927 Gets an array of argument values from an object.
1928 </para>
1929
1930 @object: the object to get arguments from.
1931 @n_args: the number of arguments to query.
1932 @args: the arguments to fill in.
1933
1934 <!-- ##### FUNCTION gtk_object_newv ##### -->
1935 <para>
1936 Construct an object with an array of arguments.
1937 </para>
1938
1939 @object_type: the type of the object to create.
1940 @n_args: the number of arguments to set.
1941 @args: an array of n_args arguments (which are name and value pairs).
1942 @Returns: the new GtkObject.
1943
1944 <!-- ##### FUNCTION gtk_object_query_args ##### -->
1945 <para>
1946 Get all the arguments that may be used for a given type.
1947 </para>
1948 <para>
1949 In Java, this type of mechanism is called
1950 <wordasword>introspection</wordasword>.  It is used by applications
1951 like Glade, that have to determine what can be done to an object
1952 at run-time.
1953 </para>
1954
1955 @class_type: the GtkType of the ObjectClass
1956 (returned from GTK_OBJECT_CLASS(class)-&gt;type for example).
1957 @arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to
1958 each argument.  You must g_free() this if you request it.
1959 @n_args: the number of arguments is returned in this field.
1960 @Returns: an array of arguments, that you must deallocate with g_free().
1961
1962 <!-- ##### FUNCTION gtk_object_setv ##### -->
1963 <para>
1964 Set an array of arguments.
1965 </para>
1966
1967 @object: the object whose arguments should be set.
1968 @n_args: the number of arguments to set.
1969 @args: the desired values, as an array of #GtkArgs (which contain
1970 the names, types, and values of the arguments).
1971
1972 <!-- ##### FUNCTION gtk_paned_compute_position ##### -->
1973 <para>
1974 Internal function used by #GtkHPaned and #GtkVPaned
1975 </para>
1976
1977 @paned:
1978 @allocation:
1979 @child1_req:
1980 @child2_req:
1981
1982 <!-- ##### FUNCTION gtk_paned_set_handle_size ##### -->
1983 <para>
1984 Set the the handle size to @size x @size pixels.
1985 </para>
1986
1987 @paned: a paned widget
1988 @size: the size in pixels
1989
1990 <!-- ##### FUNCTION gtk_pattern_match ##### -->
1991 <para>
1992
1993 </para>
1994
1995 @pspec:
1996 @string_length:
1997 @string:
1998 @string_reversed:
1999 @Returns:
2000
2001 <!-- ##### FUNCTION gtk_pattern_match_simple ##### -->
2002 <para>
2003
2004 </para>
2005
2006 @pattern:
2007 @string:
2008 @Returns:
2009
2010 <!-- ##### FUNCTION gtk_pattern_match_string ##### -->
2011 <para>
2012
2013 </para>
2014
2015 @pspec:
2016 @string:
2017 @Returns:
2018
2019 <!-- ##### FUNCTION gtk_pattern_spec_free_segs ##### -->
2020 <para>
2021
2022 </para>
2023
2024 @pspec:
2025
2026 <!-- ##### FUNCTION gtk_pattern_spec_init ##### -->
2027 <para>
2028
2029 </para>
2030
2031 @pspec:
2032 @pattern:
2033
2034 <!-- ##### FUNCTION gtk_rc_init ##### -->
2035 <para>
2036 Internal function.
2037 </para>
2038
2039
2040 <!-- ##### FUNCTION gtk_rc_load_image ##### -->
2041 <para>
2042 Internal function. Loads an image using the current
2043 image loader.
2044 </para>
2045
2046 @colormap: the colormap to use for the image
2047 @transparent_color: the transparent color for the image
2048 @filename: the filename of the image file
2049 @Returns: a #GtkPixmap representing @filename
2050
2051 <!-- ##### FUNCTION gtk_rc_set_image_loader ##### -->
2052 <para>
2053 Sets the function that GTK+ will use to load images
2054 </para>
2055
2056 @loader: the #GtkImageLoader to use
2057
2058 <!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
2059 <para>
2060
2061 </para>
2062
2063 @ruler: the gtkruler
2064
2065 <!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
2066 <para>
2067
2068 </para>
2069
2070 @ruler: the gtkruler
2071
2072 <!-- ##### FUNCTION gtk_settings_get_global ##### -->
2073 <para>
2074
2075 </para>
2076
2077 @Returns:
2078
2079 <!-- ##### FUNCTION gtk_signal_add_emission_hook ##### -->
2080 <para>
2081 Add an emission hook for a type of signal, for any object.
2082 </para>
2083
2084 @signal_id: the type of signal to hook for.
2085 @hook_func: the function to invoke to handle the emission hook.
2086 @data: the user data passed in to hook_func.
2087 @Returns: the id (that you may pass as a parameter
2088 to gtk_signal_remove_emission_hook()).
2089 @i:
2090 @h:
2091 @d:
2092
2093 <!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
2094 <para>
2095 Add an emission hook for a type of signal, for any object.
2096 (with control of what happens when the hook is
2097 destroyed).
2098 </para>
2099
2100 @signal_id: the type of signal add the hook for.
2101 @hook_func: the function to invoke to handle the hook.
2102 @data: the user data passed in to hook_func.
2103 @destroy: a function to invoke when the hook is destroyed,
2104 to clean up any allocation done just for this
2105 signal handler.
2106 @Returns: the id (that you may pass as a parameter
2107 to gtk_signal_remove_emission_hook()).
2108
2109 <!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
2110 <para>
2111 Returns whether a connection id is valid (and optionally not blocked).
2112 </para>
2113
2114 @object: the object to search for the desired handler.
2115 @handler_id: the connection id.
2116 @may_be_blocked: whether it is acceptable to return a blocked
2117 handler.
2118 @Returns: TRUE if the signal exists and wasn't blocked,
2119 unless #may_be_blocked was specified.  FALSE otherwise.
2120
2121 <!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
2122 <para>
2123 Destroy all the signal handlers connected to an object.
2124 This is done automatically when the object is destroyed.
2125 </para>
2126 <para>
2127 This function is labeled private.
2128 </para>
2129
2130 @object: the object whose signal handlers should be destroyed.
2131
2132 <!-- ##### FUNCTION gtk_signal_init ##### -->
2133 <para>
2134
2135 </para>
2136
2137
2138 <!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
2139 <para>
2140 Find out the recursion depth of emissions for a particular type
2141 of signal and object.  (So it will
2142 always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
2143 This is a way to avoid recursion:  you can see if
2144 you are currently running in that signal handler and emit it only
2145 if you are.
2146 </para>
2147 <para>Another way to look at it is that this number increases
2148 by one when #gtk_signal_emit(), et al, are called,
2149 and decreases by one when #gtk_signal_emit() returns.
2150 </para>
2151
2152 @object: the object with the signal handler.
2153 @signal_id: the signal id.
2154 @Returns: the recursion depth of emissions of this signal for this
2155 object.
2156
2157 <!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
2158 <para>
2159 Find out the recursion depth of emissions for a particular type
2160 of signal and object.  Just like gtk_signal_n_emissions()
2161 except it will lookup the signal id for you.
2162 </para>
2163
2164 @object: the object with the signal handler.
2165 @name: the signal name.
2166 @Returns: the recursion depth of emissions of this signal for this
2167 object.
2168
2169 <!-- ##### FUNCTION gtk_signal_query ##### -->
2170 <para>
2171 Obtain information about a signal.
2172 </para>
2173
2174 @signal_id: the signal type identifier.
2175 @Returns: a pointer to a GtkSignalQuery structure
2176 which contains all the information, or NULL.
2177 The pointer is allocated just for you:  you must g_free() it.
2178
2179 <!-- ##### FUNCTION gtk_signal_remove_emission_hook ##### -->
2180 <para>
2181 Delete an emission hook. (see gtk_signal_add_emission_hook())
2182 </para>
2183
2184 @signal_id: the id of the signal type.
2185 @hook_id: the id of the emission handler, returned by add_emission_hook().
2186 @i:
2187 @h:
2188
2189 <!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
2190 <para>
2191 These set default functions to call when the user didn't
2192 supply a function when connecting.  (These are rarely
2193 used, and probably only for language bindings)
2194 </para>
2195 <para>
2196 By default, there are no such functions.
2197 </para>
2198
2199 @marshal_func: the function to invoke on every handlers for which there
2200 isn't a function pointer.  May be NULL.
2201 @destroy_func: the function to invoke when each hook is destroyed.
2202 May be NULL.
2203
2204 <!-- ##### FUNCTION gtk_spin_button_set_shadow_type ##### -->
2205 <para>
2206 Creates a border around the arrows of a #GtkSpinButton. The type of border is determined by @shadow_type.
2207 </para>
2208
2209 @spin_button: a #GtkSpinButton
2210 @shadow_type: the new border type.
2211
2212 <!-- ##### FUNCTION gtk_stock_list_items ##### -->
2213 <para>
2214
2215 </para>
2216
2217 @Returns:
2218
2219 <!-- ##### FUNCTION gtk_text_buffer_paste_primary ##### -->
2220 <para>
2221
2222 </para>
2223
2224 @buffer:
2225 @override_location:
2226 @default_editable:
2227
2228 <!-- ##### FUNCTION gtk_text_iter_reorder ##### -->
2229 <para>
2230
2231 </para>
2232
2233 @first:
2234 @second:
2235
2236 <!-- ##### FUNCTION gtk_text_iter_spew ##### -->
2237 <para>
2238
2239 </para>
2240
2241 @iter:
2242 @desc:
2243
2244 <!-- ##### FUNCTION gtk_text_view_set_text_window_size ##### -->
2245 <para>
2246
2247 </para>
2248
2249 @text_view:
2250 @width:
2251 @height:
2252
2253 <!-- ##### FUNCTION gtk_trace_referencing ##### -->
2254 <para>
2255 Private: print debugging information while doing a gtk_object_ref() or
2256 a gtk_object_unref().
2257 </para>
2258
2259 @object: object to reference or unreference.
2260 @func: name of caller's function to print (used within macros).
2261 @dummy: unused.
2262 @line: line number (used within macros).
2263 @do_ref: whether to reference or unreference.
2264
2265 <!-- ##### FUNCTION gtk_tree_model_ref_iter ##### -->
2266 <para>
2267
2268 </para>
2269
2270 @tree_model:
2271 @iter:
2272
2273 <!-- ##### FUNCTION gtk_tree_model_sort_set_compare ##### -->
2274 <para>
2275
2276 </para>
2277
2278 @tree_model_sort:
2279 @func:
2280
2281 <!-- ##### FUNCTION gtk_tree_model_sort_set_sort_column ##### -->
2282 <para>
2283
2284 </para>
2285
2286 @tree_model_sort:
2287 @sort_col:
2288
2289 <!-- ##### FUNCTION gtk_tree_model_unref_iter ##### -->
2290 <para>
2291
2292 </para>
2293
2294 @tree_model:
2295 @iter:
2296
2297 <!-- ##### FUNCTION gtk_tree_store_new_with_types ##### -->
2298 <para>
2299
2300 </para>
2301
2302 @n_columns:
2303 @Varargs:
2304 @Returns:
2305
2306 <!-- ##### FUNCTION gtk_tree_store_set_cell ##### -->
2307 <para>
2308
2309 </para>
2310
2311 @tree_store:
2312 @iter:
2313 @column:
2314 @value:
2315
2316 <!-- ##### FUNCTION gtk_tree_store_set_column_type ##### -->
2317 <para>
2318
2319 </para>
2320
2321 @tree_store:
2322 @column:
2323 @type:
2324 @store:
2325
2326 <!-- ##### FUNCTION gtk_tree_store_set_n_columns ##### -->
2327 <para>
2328
2329 </para>
2330
2331 @tree_store:
2332 @n_columns:
2333
2334 <!-- ##### FUNCTION gtk_tree_view_column_set_cell_data ##### -->
2335 <para>
2336
2337 </para>
2338
2339 @tree_column:
2340 @tree_model:
2341 @iter:
2342
2343 <!-- ##### FUNCTION gtk_tree_view_column_set_width ##### -->
2344 <para>
2345
2346 </para>
2347
2348 @tree_column:
2349 @width:
2350 @size:
2351
2352 <!-- ##### FUNCTION gtk_type_check_class_cast ##### -->
2353 <para>
2354 Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make
2355 sure that it's okay to cast something of that @klass into a @cast_type.
2356 </para>
2357
2358 @klass: GtkTypeClass*
2359 @cast_type: GtkType
2360 @Returns: Always return @klass.
2361
2362 <!-- ##### FUNCTION gtk_type_check_object_cast ##### -->
2363 <para>
2364 Given a pointer to a GtkTypeObject @type_object, and a GtkType @cast_type,
2365 make sure that it's okay to cast @type_object into a @cast_type.
2366 </para>
2367
2368 @type_object: GtkTypeObject*
2369 @cast_type: GtkType
2370 @Returns: the same GtkTypeObject* as @type_object
2371
2372 <!-- ##### FUNCTION gtk_type_children_types ##### -->
2373 <para>
2374 Return the pointer to the type's children's types.
2375 </para>
2376
2377 @type: GtkType
2378 @Returns: pointer to a GList
2379
2380 <!-- ##### FUNCTION gtk_type_describe_heritage ##### -->
2381 <para>
2382 Print the types @type inherits from.
2383 </para>
2384
2385 @type: GtkType
2386
2387 <!-- ##### FUNCTION gtk_type_describe_tree ##### -->
2388 <para>
2389 Given a @type, describe all of its children, and their children.  Only
2390 show the size if @show_size is true.
2391 </para>
2392
2393 @type: GtkType
2394 @show_size: gboolean
2395
2396 <!-- ##### FUNCTION gtk_type_free ##### -->
2397 <para>
2398 Given the type of an object and a pointer to it, the object is freed.
2399 </para>
2400
2401 @type: GtkType
2402 @mem: gpointer to the object
2403
2404 <!-- ##### FUNCTION gtk_type_get_varargs_type ##### -->
2405 <para>
2406 Get the varargs type associated with @foreign_type
2407 </para>
2408
2409 @foreign_type: GtkType
2410 @Returns: GtkType
2411
2412 <!-- ##### FUNCTION gtk_type_parent_class ##### -->
2413 <para>
2414 Return the class of the parent.  Initialize the class if necessary.
2415 Return NULL if anything goes wrong.
2416 </para>
2417
2418 @type: GtkType
2419 @Returns: gpointer to the klass.
2420
2421 <!-- ##### FUNCTION gtk_type_query ##### -->
2422 <para>
2423 Given a type, return various interesting parameters of the type.
2424 </para>
2425
2426 @type: GtkType
2427 @Returns: GtkTypeQuery*
2428
2429 <!-- ##### FUNCTION gtk_type_register_enum ##### -->
2430 <para>
2431 Register a new set of enum @values and give them the name in
2432 @type_name.
2433 </para>
2434
2435 @type_name: must not be null.
2436 @values: GtkEnumValue*
2437 @Returns:
2438
2439 <!-- ##### FUNCTION gtk_type_register_flags ##### -->
2440 <para>
2441 Register a new set of flags @values and give them the name in
2442 @type_name.
2443 </para>
2444
2445 @type_name: must not be null.
2446 @values: GtkFlagValue*
2447 @Returns:
2448
2449 <!-- ##### FUNCTION gtk_type_set_chunk_alloc ##### -->
2450 <para>
2451 Set the mem_chunk size so it will hold @n_chunks of the objects of that @type.
2452 </para>
2453
2454 @type: There must be an unlocked TypeNode associated with this type otherwise nothing happens.
2455 @n_chunks:
2456
2457 <!-- ##### FUNCTION gtk_type_set_varargs_type ##### -->
2458 <para>
2459 Set the varargs type for a fundamental type @foreign_type.
2460 </para>
2461
2462 @foreign_type: Must be a GtkType with a sequence number of zero.  Must not be a
2463 fundamental type.
2464 @varargs_type: Must be a GtkType which is either structured or flag, or NONE.
2465
2466 <!-- ##### FUNCTION gtk_widget_activate_mnemonic ##### -->
2467 <para>
2468
2469 </para>
2470
2471 @widget:
2472 @group_cycling:
2473 @Returns:
2474
2475 <!-- ##### FUNCTION gtk_widget_pop_style ##### -->
2476 <para>
2477
2478 </para>
2479
2480
2481 <!-- ##### FUNCTION gtk_widget_popup ##### -->
2482 <para>
2483
2484 </para>
2485
2486 @widget:
2487 @x:
2488 @y:
2489
2490 <!-- ##### FUNCTION gtk_widget_push_style ##### -->
2491 <para>
2492
2493 </para>
2494
2495 @style:
2496
2497 <!-- ##### FUNCTION gtk_widget_set_default_style ##### -->
2498 <para>
2499
2500 </para>
2501
2502 @style:
2503
2504 <!-- ##### FUNCTION gtk_window_activate_mnemonic ##### -->
2505 <para>
2506
2507 </para>
2508
2509 @window:
2510 @keyval:
2511 @modifier:
2512 @Returns:
2513
2514 <!-- ##### FUNCTION gtk_window_get_default_accel_group ##### -->
2515 <para>
2516
2517 </para>
2518
2519 @window:
2520 @Returns:
2521
2522 <!-- ##### FUNCTION gtk_window_get_resizeable ##### -->
2523 <para>
2524
2525 </para>
2526
2527 @window:
2528 @Returns:
2529
2530 <!-- ##### FUNCTION gtk_window_set_decorations_hint ##### -->
2531 <para>
2532
2533 </para>
2534
2535 @window:
2536 @decorations:
2537
2538 <!-- ##### FUNCTION gtk_window_set_functions_hint ##### -->
2539 <para>
2540
2541 </para>
2542
2543 @window:
2544 @functions:
2545
2546 <!-- ##### FUNCTION gtk_window_set_resizeable ##### -->
2547 <para>
2548
2549 </para>
2550
2551 @window:
2552 @setting:
2553 @resizeable:
2554