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

   1 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Long_Description ##### -->
   2 <para>
   3 The #GtkData object is a very simple object intended to be used as a base
   4 class for objects which contain data (i.e. the 'Model' in the object-oriented
   5 Model/View/Controller framework).
   6 </para>
   7 <para>
   8 Currently it is not very useful since all it provides is a "disconnect" signal.
   9 This signal could be emitted by a #GtkData subclass to notify any 'Views'
  10 that they should disconnect from the #GtkData (the 'Model'), possibly just
  11 before the #GtkData is destroyed.
  12 </para>
  13
  14
  15 <!-- ##### SECTION ./tmpl/gtkdata.sgml:See_Also ##### -->
  16 <para>
  17
  18 </para>
  19
  20
  21 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Short_Description ##### -->
  22 abstract base class for objects containing data.
  23
  24
  25 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Title ##### -->
  26 GtkData
  27
  28
  29 <!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
  30 Debugging
  31
  32
  33 <!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Title ##### -->
  34 gtkenums.sgml
  35
  36
  37 <!-- ##### SECTION ./tmpl/gtkimcontextsimple.sgml:Title ##### -->
  38 GtkIMContextSimple
  39
  40
  41 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
  42 <refsect2>
  43 <title>What are Signal Marshallers?</title>
  44 <para>
  45 Marshals are functions which all have the same prototype:
  46 they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
  47 and an array of argument values.
  48 The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
  49 </para>
  50 <para>
  51 They then call a native function:  the GtkObject is the first
  52 parameter passed in.  The arguments are passed in the native
  53 calling convention:  chars, shorts, ints, longs may be packed
  54 on the stack, or tucked in registers:  it doesn't matter
  55 because the same calling convention will be generated
  56 inside the gtkmarshal code as is expected where you define
  57 your handlers.
  58 </para>
  59 <para>
  60 So the function named:
  61 <programlisting>
  62 gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
  63 </programlisting>
  64 will call the #GtkSignalFunc assuming it was a function with signature:
  65 <programlisting>
  66 gboolean sigfunc(gpointer,gint,gint,guint);
  67 </programlisting>
  68 </para>
  69 </refsect2>
  70 <refsect2>
  71 <title>Writing Custom Marshals</title>
  72 <para>
  73 Marshals are primarily used as arguments to gtk_signal_new().
  74 Sometimes, you may find that a marshaller you need isn't available
  75 in the standard list.  Then you have to write your own.
  76 </para>
  77 <para>
  78 If you wish to define a signal with a new type of argument list.
  79 Suppose you want 2 pointers and 2 integers.
  80 You would write:
  81 <programlisting>
  82 typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
  83                         gpointer, gpointer, gint, gint
  84 );
  85
  86 void marshal_INT__POINTER_POINTER_INT_INT(GtkObject*    object,
  87                                            GtkSignalFunc func,
  88                                            gpointer      func_data,
  89                                            GtkArg*       args)
  90 {
  91         GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
  92         gint* return_val;
  93         return_val = GTK_RETLOC_INT(args[4]);
  94         rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
  95         *return_val = (*rfunc)(object,
  96                                GTK_VALUE_POINTER(args[0]),
  97                                GTK_VALUE_POINTER(args[1]),
  98                                GTK_VALUE_INT(args[2]),
  99                                GTK_VALUE_INT(args[3]),
 100                                func_data);
 101 }
 102 </programlisting>
 103 </para>
 104 </refsect2>
 105
 106
 107 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
 108 <para>
 109 <variablelist>
 110
 111 <varlistentry>
 112 <term>#GtkSignal</term>
 113 <listitem><para>The signal handling functions (of which marshallers are
 114 really an implementation detail).</para></listitem>
 115 </varlistentry>
 116
 117 </variablelist>
 118 </para>
 119
 120
 121 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Short_Description ##### -->
 122 Functions to adapt C structures to native calling convention.
 123
 124
 125 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
 126 Signal Marshallers
 127
 128
 129 <!-- ##### SECTION ./tmpl/gtkprivate.sgml:Title ##### -->
 130 Private Information
 131
 132
 133 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Long_Description ##### -->
 134 <para>
 135
 136 </para>
 137
 138
 139 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:See_Also ##### -->
 140 <para>
 141
 142 </para>
 143
 144
 145 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Short_Description ##### -->
 146
 147
 148
 149 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Title ##### -->
 150 GtkModelSimple
 151
 152
 153 <!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
 154 <para>
 155 A macro to check whether a child widget of the CList
 156 has the focus.
 157 </para>
 158
 159 @clist: The #GtkCList widget to check.
 160
 161 <!-- ##### MACRO GTK_ICON_SIZE_BUTTON ##### -->
 162 <para>
 163
 164 </para>
 165
 166
 167 <!-- ##### MACRO GTK_ICON_SIZE_DIALOG ##### -->
 168 <para>
 169
 170 </para>
 171
 172
 173 <!-- ##### MACRO GTK_ICON_SIZE_LARGE_TOOLBAR ##### -->
 174 <para>
 175
 176 </para>
 177
 178
 179 <!-- ##### MACRO GTK_ICON_SIZE_MENU ##### -->
 180 <para>
 181
 182 </para>
 183
 184
 185 <!-- ##### MACRO GTK_ICON_SIZE_SMALL_TOOLBAR ##### -->
 186 <para>
 187
 188 </para>
 189
 190
 191 <!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
 192 <para>
 193 Test whether a GtkObject's arguments have been prepared.
 194 </para>
 195
 196 @obj: the object to examine.
 197
 198 <!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
 199 <para>
 200 Get the number of signals defined by this object.
 201 </para>
 202
 203 @obj: the object to query.
 204
 205 <!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
 206 <para>
 207 Get the array of signals defined for this object.
 208 </para>
 209
 210 @obj: the object to fetch the signals from.
 211
 212 <!-- ##### MACRO GTK_STOCK_BUTTON_APPLY ##### -->
 213 <para>
 214
 215 </para>
 216
 217
 218 <!-- ##### MACRO GTK_STOCK_BUTTON_CANCEL ##### -->
 219 <para>
 220
 221 </para>
 222
 223
 224 <!-- ##### MACRO GTK_STOCK_BUTTON_CLOSE ##### -->
 225 <para>
 226
 227 </para>
 228
 229
 230 <!-- ##### MACRO GTK_STOCK_BUTTON_NO ##### -->
 231 <para>
 232
 233 </para>
 234
 235
 236 <!-- ##### MACRO GTK_STOCK_BUTTON_OK ##### -->
 237 <para>
 238
 239 </para>
 240
 241
 242 <!-- ##### MACRO GTK_STOCK_BUTTON_YES ##### -->
 243 <para>
 244
 245 </para>
 246
 247
 248 <!-- ##### MACRO GTK_TREE_SELECTION ##### -->
 249 <para>
 250 A macro that returns a GList that contains the selection of the root tree of @obj.
 251 </para>
 252
 253 @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.
 254
 255 <!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
 256 <para>
 257 The first "flat" (no struct) enumerated type value.
 258 </para>
 259
 260
 261 <!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
 262 <para>
 263 The last "flat" (no struct) enumerated type value.
 264 </para>
 265
 266
 267 <!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
 268 <para>
 269 Hide the name of gtk_identifier_get_type
 270 </para>
 271
 272
 273 <!-- ##### MACRO GTK_TYPE_MAKE ##### -->
 274 <para>
 275 Combine a fundemantal type and a sequence number to create a gtk type.
 276 </para>
 277
 278 @parent_t:
 279 @seqno:
 280
 281 <!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
 282 <para>
 283 No idea.
 284 </para>
 285
 286
 287 <!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
 288 <para>
 289 Convert a gtk type into its sequence number
 290 </para>
 291
 292 @type:
 293
 294 <!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
 295 <para>
 296 The first structured enumerated type value.
 297 </para>
 298
 299
 300 <!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
 301 <para>
 302 The last structured enumerated type value.
 303 </para>
 304
 305
 306 <!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
 307 <para>
 308
 309 </para>
 310
 311
 312 <!-- ##### MACRO GTK_VALUE_ARGS ##### -->
 313 <para>
 314 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
 315 </para>
 316
 317 @a:
 318
 319 <!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
 320 <para>
 321 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
 322 </para>
 323
 324 @a:
 325
 326 <!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
 327 <para>
 328 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
 329 </para>
 330
 331 @a:
 332
 333 <!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
 334 <para>
 335 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
 336 </para>
 337
 338 @a:
 339
 340 <!-- ##### ARG GtkAccelLabel:accel-width ##### -->
 341 <para>
 342
 343 </para>
 344
 345
 346 <!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
 347 <para>
 348
 349 </para>
 350
 351
 352 <!-- ##### STRUCT GtkData ##### -->
 353 <para>
 354 The #GtkData-struct struct contains no public fields.
 355 </para>
 356
 357
 358 <!-- ##### SIGNAL GtkData::disconnect ##### -->
 359 <para>
 360 Emitted to notify any views on the #GtkData object to disconnect from it,
 361 possibly because the #GtkData object is about to be destroyed.
 362 </para>
 363
 364 @data: the object which received the signal.
 365
 366 <!-- ##### SIGNAL GtkEditable::activate ##### -->
 367 <para>
 368 Indicates that the user has activated the widget
 369 in some fashion. Generally, this will be done
 370 with a keystroke. (The default binding for this
 371 action is Return for #GtkEntry and
 372 Control-Return for #GtkText.)
 373 </para>
 374
 375 @editable: the object which received the signal.
 376
 377 <!-- ##### SIGNAL GtkEditable::changed ##### -->
 378 <para>
 379 Indicates that the user has changed the contents
 380 of the widget.
 381 </para>
 382
 383 @editable: the object which received the signal.
 384
 385 <!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
 386 <para>
 387 An action signal. Causes the characters in the current selection to
 388 be copied to the clipboard.
 389 </para>
 390
 391 @editable: the object which received the signal.
 392
 393 <!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
 394 <para>
 395 An action signal. Causes the characters in the current
 396 selection to be copied to the clipboard and then deleted from
 397 the widget.
 398 </para>
 399
 400 @editable: the object which received the signal.
 401
 402 <!-- ##### SIGNAL GtkEditable::delete-text ##### -->
 403 <para>
 404 This signal is emitted when text is deleted from
 405 the widget by the user. The default handler for
 406 this signal will normally be responsible for inserting
 407 the text, so by connecting to this signal and then
 408 stopping the signal with gtk_signal_emit_stop(), it
 409 is possible to modify the inserted text, or prevent
 410 it from being inserted entirely. The @start_pos
 411 and @end_pos parameters are interpreted as for
 412 gtk_editable_delete_text()
 413 </para>
 414
 415 @editable: the object which received the signal.
 416 @start_pos: the starting position.
 417 @end_pos: the end position.
 418
 419 <!-- ##### SIGNAL GtkEditable::insert-text ##### -->
 420 <para>
 421 This signal is emitted when text is inserted into
 422 the widget by the user. The default handler for
 423 this signal will normally be responsible for inserting
 424 the text, so by connecting to this signal and then
 425 stopping the signal with gtk_signal_emit_stop(), it
 426 is possible to modify the inserted text, or prevent
 427 it from being inserted entirely.
 428 </para>
 429
 430 @editable: the object which received the signal.
 431 @new_text: the new text to insert.
 432 @new_text_length: the length of the new text.
 433 @position: the position at which to insert the new text.
 434            this is an in-out paramter. After the signal
 435            emission is finished, it should point after
 436            the newly inserted text.
 437
 438 <!-- ##### SIGNAL GtkEditable::kill-char ##### -->
 439 <para>
 440 An action signal. Delete a single character.
 441 </para>
 442
 443 @editable: the object which received the signal.
 444 @direction: the direction in which to delete. Positive
 445    indicates forward deletion, negative, backwards deletion.
 446
 447 <!-- ##### SIGNAL GtkEditable::kill-line ##### -->
 448 <para>
 449 An action signal. Delete a single line.
 450 </para>
 451
 452 @editable: the object which received the signal.
 453 @direction: the direction in which to delete. Positive
 454    indicates forward deletion, negative, backwards deletion.
 455
 456 <!-- ##### SIGNAL GtkEditable::kill-word ##### -->
 457 <para>
 458 An action signal. Delete a single word.
 459 </para>
 460
 461 @editable: the object which received the signal.
 462 @direction: the direction in which to delete. Positive
 463    indicates forward deletion, negative, backwards deletion.
 464
 465 <!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
 466 <para>
 467 An action signal. Move the cursor position.
 468 </para>
 469
 470 @editable: the object which received the signal.
 471 @x: horizontal distance to move the cursor.
 472 @y: vertical distance to move the cursor.
 473
 474 <!-- ##### SIGNAL GtkEditable::move-page ##### -->
 475 <para>
 476 An action signal. Move the cursor by pages.
 477 </para>
 478
 479 @editable: the object which received the signal.
 480 @x: Number of pages to move the cursor horizontally.
 481 @y: Number of pages to move the cursor vertically.
 482
 483 <!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
 484 <para>
 485 An action signal. Move the cursor to the given column.
 486 </para>
 487
 488 @editable: the object which received the signal.
 489 @column: the column to move to. (A negative value indicates
 490          the last column)
 491
 492 <!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
 493 <para>
 494 An action signal. Move the cursor to the given row.
 495 </para>
 496
 497 @editable: the object which received the signal.
 498 @row: the row to move to. (A negative value indicates
 499       the last row)
 500
 501 <!-- ##### SIGNAL GtkEditable::move-word ##### -->
 502 <para>
 503 An action signal. Move the cursor by words.
 504 </para>
 505
 506 @editable: the object which received the signal.
 507 @num_words: The number of words to move the
 508 cursor. (Can be negative).
 509
 510 <!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
 511 <para>
 512 An action signal. Causes the contents of the clipboard to
 513 be pasted into the editable widget at the current cursor
 514 position.
 515 </para>
 516
 517 @editable: the object which received the signal.
 518
 519 <!-- ##### SIGNAL GtkEditable::set-editable ##### -->
 520 <para>
 521 Determines if the user can edit the text in the editable
 522 widget or not. This is meant to be overriden by
 523 child classes and should not generally useful to
 524 applications.
 525 </para>
 526
 527 @editable: the object which received the signal.
 528 @is_editable: %TRUE if the user is allowed to edit the text
 529   in the widget.
 530
 531 <!-- ##### ARG GtkEditable:editable ##### -->
 532 <para>
 533 A boolean indicating whether the widget is editable by
 534 the user.
 535 </para>
 536
 537
 538 <!-- ##### ARG GtkEditable:text-position ##### -->
 539 <para>
 540 The position of the cursor.
 541 </para>
 542
 543
 544 <!-- ##### USER_FUNCTION GtkEmissionHook ##### -->
 545 <para>
 546 A simple function pointer to get invoked when the
 547 signal is emitted.  This allows you tie a hook to the signal type,
 548 so that it will trap all emissions of that signal, from any object.
 549 </para>
 550 <para>
 551 You may not attach these to signals created with the
 552 #GTK_RUN_NO_HOOKS flag.
 553 </para>
 554
 555 @object:
 556 @signal_id:
 557 @n_params:
 558 @params:
 559 @data:
 560 @Returns:
 561
 562 <!-- ##### ENUM GtkFontFilterType ##### -->
 563 <para>
 564 A set of bit flags used to specify the filter being set
 565 when calling gtk_font_selection_dialog_set_filter() or
 566 gtk_font_selection_set_filter().
 567 </para>
 568
 569 @GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user.
 570 @GTK_FONT_FILTER_USER: the user filter, which can be changed from within the
 571 'Filter' page of the #GtkFontSelection widget.
 572
 573 <!-- ##### ENUM GtkFontType ##### -->
 574 <para>
 575 A set of bit flags used to specify the type of fonts shown
 576 when calling gtk_font_selection_dialog_set_filter() or
 577 gtk_font_selection_set_filter().
 578 </para>
 579
 580 @GTK_FONT_BITMAP: bitmap fonts.
 581 @GTK_FONT_SCALABLE: scalable fonts.
 582 @GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts.
 583 @GTK_FONT_ALL: a bitwise combination of all of the above.
 584
 585 <!-- ##### ARG GtkFrame:shadow-type ##### -->
 586 <para>
 587
 588 </para>
 589
 590
 591 <!-- ##### ARG GtkHScale:adjustment ##### -->
 592 <para>
 593 the #GtkAdjustment which sets the range of the scale.
 594 </para>
 595
 596
 597 <!-- ##### ARG GtkHScrollbar:adjustment ##### -->
 598 <para>
 599
 600 </para>
 601
 602
 603 <!-- ##### STRUCT GtkIMContextSimple ##### -->
 604 <para>
 605
 606 </para>
 607
 608 @object:
 609 @tables:
 610 @compose_buffer:
 611 @tentative_match:
 612 @tentative_match_len:
 613
 614 <!-- ##### ARG GtkLabel:accel-keyval ##### -->
 615 <para>
 616
 617 </para>
 618
 619
 620 <!-- ##### ARG GtkObject:object-signal ##### -->
 621 <para>
 622 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 623 the signal to the object, so that the user data and objects
 624 and swapped when the signal handler is invoked.
 625 </para>
 626 <para>
 627 This is useful for handlers that are primarily notifying
 628 other objects and could just invoke an already existing function
 629 if the parameters were swapped.
 630 See gtk_signal_connect_object() for more details.
 631 </para>
 632
 633
 634 <!-- ##### ARG GtkObject:object-signal-after ##### -->
 635 <para>
 636 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 637 the signal to the object, so that the user data and objects
 638 and swapped when the signal handler is invoked,
 639 and so that the handler is invoked after all others.
 640 </para>
 641 <para>
 642 See gtk_signal_connect_object_after() for more details.
 643 </para>
 644
 645
 646 <!-- ##### ARG GtkObject:signal ##### -->
 647 <para>
 648 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 649 the signal to the object.
 650 </para>
 651
 652
 653 <!-- ##### ARG GtkObject:signal-after ##### -->
 654 <para>
 655 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
 656 the signal to the object, so that the signal is always run
 657 after other user handlers and the default handler.
 658 </para>
 659
 660
 661 <!-- ##### ARG GtkPaned:handle-size ##### -->
 662 <para>
 663
 664 </para>
 665
 666
 667 <!-- ##### STRUCT GtkPatternSpec ##### -->
 668 <para>
 669
 670 </para>
 671
 672 @match_type:
 673 @pattern_length:
 674 @pattern:
 675 @pattern_reversed:
 676 @user_data:
 677 @seq_id:
 678
 679 <!-- ##### ENUM GtkPrivateFlags ##### -->
 680 <para>
 681
 682 </para>
 683
 684 @PRIVATE_GTK_USER_STYLE:
 685 @PRIVATE_GTK_RESIZE_PENDING:
 686 @PRIVATE_GTK_RESIZE_NEEDED:
 687 @PRIVATE_GTK_LEAVE_PENDING:
 688 @PRIVATE_GTK_HAS_SHAPE_MASK:
 689 @PRIVATE_GTK_IN_REPARENT:
 690 @PRIVATE_GTK_DIRECTION_SET:
 691 @PRIVATE_GTK_DIRECTION_LTR:
 692
 693 <!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
 694 <para>
 695 A function which you can use to clean up when the
 696 signal handler is destroyed.
 697 </para>
 698 <para>
 699 For example, if your handler requires a few variables
 700 that you made into a struct and allocated (using g_new()
 701 or something), then you will probably want to free
 702 it as soon as the hook is destroyed.  This will
 703 allow you to do that. (For this in particular
 704 it is convenient to pass g_free() as a #GtkSignalDestroy
 705 function).
 706 </para>
 707
 708 @data: The user data associated with the hook that is being
 709 destroyed.
 710
 711 <!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
 712 <para>
 713 This is currently a hack left in for a scheme wrapper library.
 714 It may be removed.
 715 </para>
 716 <para>
 717 Don't use it.
 718 </para>
 719
 720 @object: The object which emits the signal.
 721 @data: The user data associated with the hook.
 722 @nparams: The number of parameters to the function.
 723 @args: The actual values of the arguments.
 724 @arg_types: The types of the arguments.
 725 @return_type: The type of the return value from the function
 726 or #GTK_TYPE_NONE for no return value.
 727
 728 <!-- ##### STRUCT GtkSignalQuery ##### -->
 729 <para>
 730 This structure contains all the information about a particular
 731 signal:  its name, the type it affects, the signature of the handlers,
 732 and its unique identifying integer.
 733 </para>
 734
 735 @object_type:
 736 @signal_id:
 737 @signal_name:
 738 @is_user_signal:
 739 @signal_flags:
 740 @return_val:
 741 @nparams:
 742 @params:
 743
 744 <!-- ##### ARG GtkSpinButton:shadow-type ##### -->
 745 <para>
 746 the type of border that surrounds the arrows of a spin button.
 747 </para>
 748
 749
 750 <!-- ##### STRUCT GtkStatusbarMsg ##### -->
 751 <para>
 752 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.
 753 </para>
 754
 755 @text:
 756 @context_id:
 757 @message_id:
 758
 759 <!-- ##### ARG GtkTextTag:justify ##### -->
 760 <para>
 761 A #GtkJustification for the text. This is only used when the tag is
 762 applied to the first character in a paragraph.
 763 </para>
 764
 765
 766 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
 767 <para>
 768 Pixel width of the left margin of the text for lines after the first
 769 line in a wrapped paragraph.
 770 </para>
 771
 772
 773 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
 774 <para>
 775
 776 </para>
 777
 778
 779 <!-- ##### ARG GtkTextTag:offset ##### -->
 780 <para>
 781 Pixels to offset the text horizontally or vertically, useful to
 782 produce superscript and subscript.
 783 </para>
 784
 785
 786 <!-- ##### ARG GtkTextView:justify ##### -->
 787 <para>
 788
 789 </para>
 790
 791
 792 <!-- ##### ARG GtkVScale:adjustment ##### -->
 793 <para>
 794 the #GtkAdjustment which sets the range of the scale.
 795 </para>
 796
 797
 798 <!-- ##### ARG GtkVScrollbar:adjustment ##### -->
 799 <para>
 800
 801 </para>
 802
 803
 804 <!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
 805 <para>
 806
 807 </para>
 808
 809 @widget: the object which received the signal.
 810 @arg1:
 811 @Returns:
 812
 813 <!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
 814 <para>
 815
 816 </para>
 817
 818 @widget: the object which received the signal.
 819 @message:
 820
 821 <!-- ##### SIGNAL GtkWidget::draw ##### -->
 822 <para>
 823
 824 </para>
 825
 826 @widget: the object which received the signal.
 827 @area:
 828
 829 <!-- ##### SIGNAL GtkWidget::draw-default ##### -->
 830 <para>
 831
 832 </para>
 833
 834 @widget: the object which received the signal.
 835
 836 <!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
 837 <para>
 838
 839 </para>
 840
 841 @widget: the object which received the signal.
 842
 843 <!-- ##### FUNCTION gtk_button_box_child_requisition ##### -->
 844 <para>\r
 845 This is an internally used function and should never be called from an\r
 846 application.\r
 847 </para>
 848
 849 @widget:
 850 @nvis_children:
 851 @width:
 852 @height:
 853
 854 <!-- ##### FUNCTION gtk_button_box_get_child_ipadding_default ##### -->
 855 <para>\r
 856 The internal padding of a button is the amount of space between the outside\r
 857 of the button and the widget it contains. This function gets the default\r
 858 amount of horizontal and vertical padding, placing the results in @ipad_x\r
 859 and @ipad_y, respectively.\r
 860 </para>
 861
 862 @ipad_x: the default horizontal internal button padding.
 863 @ipad_y: the default vertical internal button padding.
 864
 865 <!-- ##### FUNCTION gtk_button_box_get_child_size_default ##### -->
 866 <para>\r
 867 Retrieves the default minimum width and height for all button boxes, and\r
 868 places the values in @min_width and @min_height, respectively.\r
 869 </para>
 870
 871 @min_width: the default minimum width of a child widget.
 872 @min_height: the default minimum height of a child widget.
 873
 874 <!-- ##### FUNCTION gtk_button_box_set_child_ipadding_default ##### -->
 875 <para>\r
 876 Sets the default number of pixels that pad each button in every button box.\r
 877 </para>
 878
 879 @ipad_x: new default horizontal padding.
 880 @ipad_y: new default vertical padding.
 881
 882 <!-- ##### FUNCTION gtk_button_box_set_child_size_default ##### -->
 883 <para>\r
 884 Sets the default size of child buttons.\r
 885 </para>
 886
 887 @min_width: minimum default width for child buttons.
 888 @min_height: minimum default height for child buttons.
 889
 890 <!-- ##### FUNCTION gtk_button_new_accel ##### -->
 891 <para>
 892
 893 </para>
 894
 895 @uline_label:
 896 @accel_group:
 897 @Returns:
 898
 899 <!-- ##### FUNCTION gtk_button_new_stock ##### -->
 900 <para>
 901
 902 </para>
 903
 904 @stock_id:
 905 @accel_group:
 906 @Returns:
 907
 908 <!-- ##### FUNCTION gtk_clist_construct ##### -->
 909 <para>
 910 Initializes a previously allocated #GtkCList widget for use.  This should not
 911 normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
 912 </para>
 913
 914 @clist: A pointer to an uninitialized #GtkCList widget.
 915 @columns: The number of columns the #GtkCList should have.
 916 @titles: An array of strings that should be used as the titles i
 917 of the columns.  There should be enough strings in the array for
 918 the number of columns specified.
 919
 920 <!-- ##### FUNCTION gtk_color_selection_get_old_color ##### -->
 921 <para>
 922
 923 </para>
 924
 925 @colorsel:
 926 @color:
 927
 928 <!-- ##### FUNCTION gtk_color_selection_get_use_opacity ##### -->
 929 <para>
 930
 931 </para>
 932
 933 @colorsel:
 934 @Returns:
 935
 936 <!-- ##### FUNCTION gtk_color_selection_get_use_palette ##### -->
 937 <para>
 938
 939 </para>
 940
 941 @colorsel:
 942 @Returns:
 943
 944 <!-- ##### FUNCTION gtk_color_selection_set_old_color ##### -->
 945 <para>
 946
 947 </para>
 948
 949 @colorsel:
 950 @color:
 951
 952 <!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
 953 <para>
 954 Controls whether opacity can be set with the #GtkColorSelection.
 955 If this functionality is enabled, the necessary additional widgets
 956 are added to the #GtkColorSelection and the opacity value can be
 957 retrieved via the fourth value in the color array returned by
 958 the gtk_color_selection_get_color() function.
 959 </para>
 960
 961 @colorsel: a #GtkColorSelection.
 962 @use_opacity: a boolean indicating whether the opacity selection
 963 is enabled.
 964
 965 <!-- ##### FUNCTION gtk_color_selection_set_use_opacity ##### -->
 966 <para>
 967
 968 </para>
 969
 970 @colorsel:
 971 @use_opacity:
 972
 973 <!-- ##### FUNCTION gtk_color_selection_set_use_palette ##### -->
 974 <para>
 975
 976 </para>
 977
 978 @colorsel:
 979 @use_palette:
 980
 981 <!-- ##### FUNCTION gtk_ctree_construct ##### -->
 982 <para>
 983 This function is not usually used by users.
 984 </para>
 985
 986 @ctree:
 987 @columns:
 988 @tree_column:
 989 @titles:
 990
 991 <!-- ##### FUNCTION gtk_editable_changed ##### -->
 992 <para>
 993 Causes the "changed" signal to be emitted.
 994 </para>
 995
 996 @editable: a #GtkEditable widget.
 997
 998 <!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
 999 <para>
1000 Claim or disclaim ownership of the PRIMARY X selection.
1001 </para>
1002
1003 @editable: a #GtkEditable widget.
1004 @claim: if %TRUE, claim the selection, otherwise, disclaim it.
1005 @time: the timestamp for claiming the selection.
1006
1007 <!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
1008 <para>
1009 Sets one of the two font filters, to limit the fonts shown.
1010 </para>
1011
1012 @fsd: a #GtkFontSelectionDialog.
1013 @filter_type: which of the two font filters to set, either
1014 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
1015 can be changed by the user, but the base filter is permanent.
1016 @font_type: the types of font to be shown. This is a bitwise combination of
1017 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
1018 or #GTK_FONT_ALL to show all three font types.
1019 @foundries: a NULL-terminated array of strings containing foundry names which
1020 will be shown, or NULL to show all foundries.
1021 @weights: a NULL-terminated array of strings containing weight names which
1022 will be shown, or NULL to show all weights.
1023 @slants: a NULL-terminated array of strings containing slant names which
1024 will be shown, or NULL to show all slants.
1025 @setwidths: a NULL-terminated array of strings containing setwidth names which
1026 will be shown, or NULL to show all setwidths.
1027 @spacings: a NULL-terminated array of strings containing spacings which
1028 will be shown, or NULL to show all spacings.
1029 @charsets: a NULL-terminated array of strings containing charset names which
1030 will be shown, or NULL to show all charsets.
1031
1032 <!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
1033 <para>
1034 Sets one of the two font filters, to limit the fonts shown.
1035 </para>
1036
1037 @fontsel: a #GtkFontSelection.
1038 @filter_type: which of the two font filters to set, either
1039 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
1040 can be changed by the user, but the base filter is permanent.
1041 @font_type: the types of font to be shown. This is a bitwise combination of
1042 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
1043 or #GTK_FONT_ALL to show all three font types.
1044 @foundries: a NULL-terminated array of strings containing foundry names which
1045 will be shown, or NULL to show all foundries.
1046 @weights: a NULL-terminated array of strings containing weight names which
1047 will be shown, or NULL to show all weights.
1048 @slants: a NULL-terminated array of strings containing slant names which
1049 will be shown, or NULL to show all slants.
1050 @setwidths: a NULL-terminated array of strings containing setwidth names which
1051 will be shown, or NULL to show all setwidths.
1052 @spacings: a NULL-terminated array of strings containing spacings which
1053 will be shown, or NULL to show all spacings.
1054 @charsets: a NULL-terminated array of strings containing charset names which
1055 will be shown, or NULL to show all charsets.
1056
1057 <!-- ##### FUNCTION gtk_identifier_get_type ##### -->
1058 <para>
1059 Get the type of GtkIdentifier.
1060 </para>
1061
1062 @Returns: GtkType -- the enumerated type of something.
1063
1064 <!-- ##### FUNCTION gtk_image_menu_item_add_image ##### -->
1065 <para>
1066
1067 </para>
1068
1069 @image_menu_item:
1070 @child:
1071
1072 <!-- ##### FUNCTION gtk_label_set_markup_with_accel ##### -->
1073 <para>
1074
1075 </para>
1076
1077 @label:
1078 @str:
1079 @Returns:
1080
1081 <!-- ##### FUNCTION gtk_list_store_set_cell ##### -->
1082 <para>
1083
1084 </para>
1085
1086 @store:
1087 @iter:
1088 @column:
1089 @value:
1090
1091 <!-- ##### FUNCTION gtk_menu_ensure_uline_accel_group ##### -->
1092 <para>
1093
1094 </para>
1095
1096 @menu:
1097 @Returns:
1098
1099 <!-- ##### FUNCTION gtk_menu_get_uline_accel_group ##### -->
1100 <para>
1101
1102 </para>
1103
1104 @menu:
1105 @Returns:
1106
1107 <!-- ##### FUNCTION gtk_object_arg_get ##### -->
1108 <para>
1109 Private function to get an argument and argument info from an object.
1110 </para>
1111
1112 @object: the object whose argument should be retrieved.
1113 @arg: the argument, for the name on input, the rest is filled on output.
1114 @info: a #GtkArgInfo structure to optionally fill in.
1115
1116 <!-- ##### FUNCTION gtk_object_arg_get_info ##### -->
1117 <para>
1118 Query information about an argument type.
1119 </para>
1120
1121 @object_type: type of object to query about.
1122 @arg_name: name of the argument.
1123 @info_p: pointer to be filled in with a pointer to the GtkArgInfo.
1124 @Returns: an error message, or NULL on success.
1125 It is the caller's responsibility to call g_free() in the event of error.
1126
1127 <!-- ##### FUNCTION gtk_object_arg_set ##### -->
1128 <para>
1129 Private function to set an argument and argument info to an object.
1130 </para>
1131
1132 @object: the object whose argument should be set.
1133 @arg: the argument.
1134 @info: infomation about this type of argument in general.
1135
1136 <!-- ##### FUNCTION gtk_object_args_collect ##### -->
1137 <para>
1138 Private: Gets an array of #GtkArgs from a va_list C structure.
1139 </para>
1140
1141 @object_type: the type of object to collect arguments for.
1142 @arg_list_p: pointer to be filled in with a list of parsed arguments.
1143 @info_list_p: optional pointer for a returned list #GtkArgInfos.
1144 @first_arg_name: name of first argument.
1145 @var_args: value of first argument, followed by more key/value pairs,
1146 terminated by NULL.
1147 @Returns: an error message, or NULL on success.
1148 It is the caller's responsibility to call g_free() in the event of error.
1149
1150 <!-- ##### FUNCTION gtk_object_class_add_signals ##### -->
1151 <para>
1152 Add an array of signals to a #GtkObjectClass.
1153 Usually this is called when registering a new type of object.
1154 </para>
1155
1156 @klass: the object class to append signals to.
1157 @signals: the signals to append.
1158 @nsignals: the number of signals being appended.
1159
1160 <!-- ##### FUNCTION gtk_object_class_user_signal_new ##### -->
1161 <para>
1162 Define a signal-handler for a new signal on an already defined
1163 object.
1164 </para>
1165 <para>
1166 See the signal documentation for more general information.
1167 </para>
1168
1169 @klass: the object class to define the signal for.
1170 @name: the name of the signal.
1171 @signal_flags: the default emission behavior for the signal.
1172 See gtk_signal_new().
1173 @marshaller: a function that will take an array of GtkArgs
1174 and invoke the appropriate handler with the normal calling
1175 conventions.
1176 @return_val: specify the return-value type for the signal
1177 (or GTK_TYPE_NONE for no return-value).
1178 @nparams: specify the number of parameters the signal
1179 receives from the caller of gtk_signal_emit().
1180 @Varargs: list of nparams #GtkTypes to pass to the signal handlers.
1181 @Returns: the signal id.  (See #GtkSignals)
1182
1183 <!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### -->
1184 <para>
1185 Define a signal-handler for a new signal on an already defined
1186 object.
1187 </para>
1188
1189 @klass: the object class to define the signal for.
1190 @name: the name of the signal.
1191 @signal_flags: the default emission behavior for the signal.
1192 See gtk_signal_new().
1193 @marshaller: takes a GtkObject, a #GtkSignalFunc, and an array
1194 of arguments, and invokes the function using the appropriate
1195 calling conventions.  Usually just select a function
1196 out of gtkmarshal.h.
1197 @return_val: specify the return-value type for the signal (possibly
1198 #GTK_TYPE_NONE).
1199 @nparams: specify the number of parameters the signal
1200 receives from the caller of gtk_signal_emit().
1201 @params: array of #GtkTypes the signal handlers for this signal
1202 should have in their prototype (of length nparams).
1203 @Returns: the signal id.  (See #GtkSignals)
1204
1205 <!-- ##### FUNCTION gtk_object_constructed ##### -->
1206 <para>
1207 Mark an allocated object as constructed.
1208 This is used for situations
1209 that require precise control of the construction process.
1210 </para>
1211 <para>
1212 This is done when gtk_object_default_construct() is inadequate.
1213 In #GtkCList the need arises because #GtkCList does construction work that
1214 must happen <emphasis>after</emphasis> its derivers.  This work
1215 cannot be done in an initializer function, so an alternate
1216 constructor is mandatory.  It calls gtk_object_constructed() to
1217 indicate it has done its job, so that no other constructor will
1218 be invoked.
1219 </para>
1220 <para>
1221 Normally this function is just automatically run from
1222 gtk_object_default_construct().
1223 </para>
1224
1225 @object: object which has been constructed.  This is usually
1226 done automatically by gtk_object_new() and gtk_object_newv().
1227
1228 <!-- ##### FUNCTION gtk_object_default_construct ##### -->
1229 <para>
1230 This function is called to construct arguments that haven't been initialized
1231 but have the #GTK_ARG_CONSTRUCT flag set.
1232 </para>
1233 <para>
1234 All number arguments are set to 0.  All pointers and strings
1235 are set to NULL.
1236 </para>
1237 <para>
1238 Normally invoked by gtk_object_new() automatically; gtk_type_new() can
1239 be used to bypass it.
1240 </para>
1241
1242 @object: the object to initialize.
1243
1244 <!-- ##### FUNCTION gtk_object_getv ##### -->
1245 <para>
1246 Gets an array of argument values from an object.
1247 </para>
1248
1249 @object: the object to get arguments from.
1250 @n_args: the number of arguments to query.
1251 @args: the arguments to fill in.
1252
1253 <!-- ##### FUNCTION gtk_object_newv ##### -->
1254 <para>
1255 Construct an object with an array of arguments.
1256 </para>
1257
1258 @object_type: the type of the object to create.
1259 @n_args: the number of arguments to set.
1260 @args: an array of n_args arguments (which are name and value pairs).
1261 @Returns: the new GtkObject.
1262
1263 <!-- ##### FUNCTION gtk_object_query_args ##### -->
1264 <para>
1265 Get all the arguments that may be used for a given type.
1266 </para>
1267 <para>
1268 In Java, this type of mechanism is called
1269 <wordasword>introspection</wordasword>.  It is used by applications
1270 like Glade, that have to determine what can be done to an object
1271 at run-time.
1272 </para>
1273
1274 @class_type: the GtkType of the ObjectClass
1275 (returned from GTK_OBJECT_CLASS(class)-&gt;type for example).
1276 @arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to
1277 each argument.  You must g_free() this if you request it.
1278 @n_args: the number of arguments is returned in this field.
1279 @Returns: an array of arguments, that you must deallocate with g_free().
1280
1281 <!-- ##### FUNCTION gtk_object_setv ##### -->
1282 <para>
1283 Set an array of arguments.
1284 </para>
1285
1286 @object: the object whose arguments should be set.
1287 @n_args: the number of arguments to set.
1288 @args: the desired values, as an array of #GtkArgs (which contain
1289 the names, types, and values of the arguments).
1290
1291 <!-- ##### FUNCTION gtk_paned_compute_position ##### -->
1292 <para>
1293 Internal function used by #GtkHPaned and #GtkVPaned
1294 </para>
1295
1296 @paned:
1297 @allocation:
1298 @child1_req:
1299 @child2_req:
1300
1301 <!-- ##### FUNCTION gtk_paned_set_handle_size ##### -->
1302 <para>
1303 Set the the handle size to @size x @size pixels.
1304 </para>
1305
1306 @paned: a paned widget
1307 @size: the size in pixels
1308
1309 <!-- ##### FUNCTION gtk_pattern_match ##### -->
1310 <para>
1311
1312 </para>
1313
1314 @pspec:
1315 @string_length:
1316 @string:
1317 @string_reversed:
1318 @Returns:
1319
1320 <!-- ##### FUNCTION gtk_pattern_match_simple ##### -->
1321 <para>
1322
1323 </para>
1324
1325 @pattern:
1326 @string:
1327 @Returns:
1328
1329 <!-- ##### FUNCTION gtk_pattern_match_string ##### -->
1330 <para>
1331
1332 </para>
1333
1334 @pspec:
1335 @string:
1336 @Returns:
1337
1338 <!-- ##### FUNCTION gtk_pattern_spec_free_segs ##### -->
1339 <para>
1340
1341 </para>
1342
1343 @pspec:
1344
1345 <!-- ##### FUNCTION gtk_pattern_spec_init ##### -->
1346 <para>
1347
1348 </para>
1349
1350 @pspec:
1351 @pattern:
1352
1353 <!-- ##### FUNCTION gtk_rc_init ##### -->
1354 <para>
1355 Internal function.
1356 </para>
1357
1358
1359 <!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
1360 <para>
1361
1362 </para>
1363
1364 @ruler: the gtkruler
1365
1366 <!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
1367 <para>
1368
1369 </para>
1370
1371 @ruler: the gtkruler
1372
1373 <!-- ##### FUNCTION gtk_signal_add_emission_hook ##### -->
1374 <para>
1375 Add an emission hook for a type of signal, for any object.
1376 </para>
1377
1378 @signal_id: the type of signal to hook for.
1379 @hook_func: the function to invoke to handle the emission hook.
1380 @data: the user data passed in to hook_func.
1381 @Returns: the id (that you may pass as a parameter
1382 to gtk_signal_remove_emission_hook()).
1383 @i:
1384 @h:
1385 @d:
1386
1387 <!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
1388 <para>
1389 Add an emission hook for a type of signal, for any object.
1390 (with control of what happens when the hook is
1391 destroyed).
1392 </para>
1393
1394 @signal_id: the type of signal add the hook for.
1395 @hook_func: the function to invoke to handle the hook.
1396 @data: the user data passed in to hook_func.
1397 @destroy: a function to invoke when the hook is destroyed,
1398 to clean up any allocation done just for this
1399 signal handler.
1400 @Returns: the id (that you may pass as a parameter
1401 to gtk_signal_remove_emission_hook()).
1402
1403 <!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
1404 <para>
1405 Returns whether a connection id is valid (and optionally not blocked).
1406 </para>
1407
1408 @object: the object to search for the desired handler.
1409 @handler_id: the connection id.
1410 @may_be_blocked: whether it is acceptable to return a blocked
1411 handler.
1412 @Returns: TRUE if the signal exists and wasn't blocked,
1413 unless #may_be_blocked was specified.  FALSE otherwise.
1414
1415 <!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
1416 <para>
1417 Destroy all the signal handlers connected to an object.
1418 This is done automatically when the object is destroyed.
1419 </para>
1420 <para>
1421 This function is labeled private.
1422 </para>
1423
1424 @object: the object whose signal handlers should be destroyed.
1425
1426 <!-- ##### FUNCTION gtk_signal_init ##### -->
1427 <para>
1428
1429 </para>
1430
1431
1432 <!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
1433 <para>
1434 Find out the recursion depth of emissions for a particular type
1435 of signal and object.  (So it will
1436 always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
1437 This is a way to avoid recursion:  you can see if
1438 you are currently running in that signal handler and emit it only
1439 if you are.
1440 </para>
1441 <para>Another way to look at it is that this number increases
1442 by one when #gtk_signal_emit(), et al, are called,
1443 and decreases by one when #gtk_signal_emit() returns.
1444 </para>
1445
1446 @object: the object with the signal handler.
1447 @signal_id: the signal id.
1448 @Returns: the recursion depth of emissions of this signal for this
1449 object.
1450
1451 <!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
1452 <para>
1453 Find out the recursion depth of emissions for a particular type
1454 of signal and object.  Just like gtk_signal_n_emissions()
1455 except it will lookup the signal id for you.
1456 </para>
1457
1458 @object: the object with the signal handler.
1459 @name: the signal name.
1460 @Returns: the recursion depth of emissions of this signal for this
1461 object.
1462
1463 <!-- ##### FUNCTION gtk_signal_query ##### -->
1464 <para>
1465 Obtain information about a signal.
1466 </para>
1467
1468 @signal_id: the signal type identifier.
1469 @Returns: a pointer to a GtkSignalQuery structure
1470 which contains all the information, or NULL.
1471 The pointer is allocated just for you:  you must g_free() it.
1472
1473 <!-- ##### FUNCTION gtk_signal_remove_emission_hook ##### -->
1474 <para>
1475 Delete an emission hook. (see gtk_signal_add_emission_hook())
1476 </para>
1477
1478 @signal_id: the id of the signal type.
1479 @hook_id: the id of the emission handler, returned by add_emission_hook().
1480 @i:
1481 @h:
1482
1483 <!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
1484 <para>
1485 These set default functions to call when the user didn't
1486 supply a function when connecting.  (These are rarely
1487 used, and probably only for language bindings)
1488 </para>
1489 <para>
1490 By default, there are no such functions.
1491 </para>
1492
1493 @marshal_func: the function to invoke on every handlers for which there
1494 isn't a function pointer.  May be NULL.
1495 @destroy_func: the function to invoke when each hook is destroyed.
1496 May be NULL.
1497
1498 <!-- ##### FUNCTION gtk_spin_button_set_shadow_type ##### -->
1499 <para>
1500 Creates a border around the arrows of a #GtkSpinButton. The type of border is determined by @shadow_type.
1501 </para>
1502
1503 @spin_button: a #GtkSpinButton
1504 @shadow_type: the new border type.
1505
1506 <!-- ##### FUNCTION gtk_stock_list_items ##### -->
1507 <para>
1508
1509 </para>
1510
1511 @Returns:
1512
1513 <!-- ##### FUNCTION gtk_trace_referencing ##### -->
1514 <para>
1515 Private: print debugging information while doing a gtk_object_ref() or
1516 a gtk_object_unref().
1517 </para>
1518
1519 @object: object to reference or unreference.
1520 @func: name of caller's function to print (used within macros).
1521 @dummy: unused.
1522 @line: line number (used within macros).
1523 @do_ref: whether to reference or unreference.
1524
1525 <!-- ##### FUNCTION gtk_tree_model_ref_iter ##### -->
1526 <para>
1527
1528 </para>
1529
1530 @tree_model:
1531 @iter:
1532
1533 <!-- ##### FUNCTION gtk_tree_model_sort_set_compare ##### -->
1534 <para>
1535
1536 </para>
1537
1538 @tree_model_sort:
1539 @func:
1540
1541 <!-- ##### FUNCTION gtk_tree_model_sort_set_sort_column ##### -->
1542 <para>
1543
1544 </para>
1545
1546 @tree_model_sort:
1547 @sort_col:
1548
1549 <!-- ##### FUNCTION gtk_tree_model_unref_iter ##### -->
1550 <para>
1551
1552 </para>
1553
1554 @tree_model:
1555 @iter:
1556
1557 <!-- ##### FUNCTION gtk_tree_store_set_cell ##### -->
1558 <para>
1559
1560 </para>
1561
1562 @tree_store:
1563 @iter:
1564 @column:
1565 @value:
1566
1567 <!-- ##### FUNCTION gtk_type_check_class_cast ##### -->
1568 <para>
1569 Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make
1570 sure that it's okay to cast something of that @klass into a @cast_type.
1571 </para>
1572
1573 @klass: GtkTypeClass*
1574 @cast_type: GtkType
1575 @Returns: Always return @klass.
1576
1577 <!-- ##### FUNCTION gtk_type_check_object_cast ##### -->
1578 <para>
1579 Given a pointer to a GtkTypeObject @type_object, and a GtkType @cast_type,
1580 make sure that it's okay to cast @type_object into a @cast_type.
1581 </para>
1582
1583 @type_object: GtkTypeObject*
1584 @cast_type: GtkType
1585 @Returns: the same GtkTypeObject* as @type_object
1586
1587 <!-- ##### FUNCTION gtk_type_children_types ##### -->
1588 <para>
1589 Return the pointer to the type's children's types.
1590 </para>
1591
1592 @type: GtkType
1593 @Returns: pointer to a GList
1594
1595 <!-- ##### FUNCTION gtk_type_describe_heritage ##### -->
1596 <para>
1597 Print the types @type inherits from.
1598 </para>
1599
1600 @type: GtkType
1601
1602 <!-- ##### FUNCTION gtk_type_describe_tree ##### -->
1603 <para>
1604 Given a @type, describe all of its children, and their children.  Only
1605 show the size if @show_size is true.
1606 </para>
1607
1608 @type: GtkType
1609 @show_size: gboolean
1610
1611 <!-- ##### FUNCTION gtk_type_free ##### -->
1612 <para>
1613 Given the type of an object and a pointer to it, the object is freed.
1614 </para>
1615
1616 @type: GtkType
1617 @mem: gpointer to the object
1618
1619 <!-- ##### FUNCTION gtk_type_get_varargs_type ##### -->
1620 <para>
1621 Get the varargs type associated with @foreign_type
1622 </para>
1623
1624 @foreign_type: GtkType
1625 @Returns: GtkType
1626
1627 <!-- ##### FUNCTION gtk_type_parent_class ##### -->
1628 <para>
1629 Return the class of the parent.  Initialize the class if necessary.
1630 Return NULL if anything goes wrong.
1631 </para>
1632
1633 @type: GtkType
1634 @Returns: gpointer to the klass.
1635
1636 <!-- ##### FUNCTION gtk_type_query ##### -->
1637 <para>
1638 Given a type, return various interesting parameters of the type.
1639 </para>
1640
1641 @type: GtkType
1642 @Returns: GtkTypeQuery*
1643
1644 <!-- ##### FUNCTION gtk_type_register_enum ##### -->
1645 <para>
1646 Register a new set of enum @values and give them the name in
1647 @type_name.
1648 </para>
1649
1650 @type_name: must not be null.
1651 @values: GtkEnumValue*
1652 @Returns:
1653
1654 <!-- ##### FUNCTION gtk_type_register_flags ##### -->
1655 <para>
1656 Register a new set of flags @values and give them the name in
1657 @type_name.
1658 </para>
1659
1660 @type_name: must not be null.
1661 @values: GtkFlagValue*
1662 @Returns:
1663
1664 <!-- ##### FUNCTION gtk_type_set_chunk_alloc ##### -->
1665 <para>
1666 Set the mem_chunk size so it will hold @n_chunks of the objects of that @type.
1667 </para>
1668
1669 @type: There must be an unlocked TypeNode associated with this type otherwise nothing happens.
1670 @n_chunks:
1671
1672 <!-- ##### FUNCTION gtk_type_set_varargs_type ##### -->
1673 <para>
1674 Set the varargs type for a fundamental type @foreign_type.
1675 </para>
1676
1677 @foreign_type: Must be a GtkType with a sequence number of zero.  Must not be a
1678 fundamental type.
1679 @varargs_type: Must be a GtkType which is either structured or flag, or NONE.
1680
1681 <!-- ##### FUNCTION gtk_widget_activate_mnemonic ##### -->
1682 <para>
1683
1684 </para>
1685
1686 @widget:
1687 @group_cycling:
1688 @Returns:
1689
1690 <!-- ##### FUNCTION gtk_widget_popup ##### -->
1691 <para>
1692
1693 </para>
1694
1695 @widget:
1696 @x:
1697 @y:
1698
1699 <!-- ##### FUNCTION gtk_window_activate_mnemonic ##### -->
1700 <para>
1701
1702 </para>
1703
1704 @window:
1705 @keyval:
1706 @modifier:
1707 @Returns:
1708
1709 <!-- ##### FUNCTION gtk_window_get_default_accel_group ##### -->
1710 <para>
1711
1712 </para>
1713
1714 @window:
1715 @Returns:
1716
1717 <!-- ##### FUNCTION gtk_window_set_decorations_hint ##### -->
1718 <para>
1719
1720 </para>
1721
1722 @window:
1723 @decorations:
1724
1725 <!-- ##### FUNCTION gtk_window_set_functions_hint ##### -->
1726 <para>
1727
1728 </para>
1729
1730 @window:
1731 @functions:
1732