gtk-unused.sgml 42.7 KB
Newer Older
Havoc Pennington's avatar
Havoc Pennington committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
<!-- ##### SECTION ./tmpl/gtkdata.sgml:Long_Description ##### -->
<para>
The #GtkData object is a very simple object intended to be used as a base
class for objects which contain data (i.e. the 'Model' in the object-oriented
Model/View/Controller framework).
</para>
<para>
Currently it is not very useful since all it provides is a "disconnect" signal.
This signal could be emitted by a #GtkData subclass to notify any 'Views'
that they should disconnect from the #GtkData (the 'Model'), possibly just
before the #GtkData is destroyed.
</para>


<!-- ##### SECTION ./tmpl/gtkdata.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gtkdata.sgml:Short_Description ##### -->
abstract base class for objects containing data.


<!-- ##### SECTION ./tmpl/gtkdata.sgml:Title ##### -->
GtkData


29 30
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
Debugging
Owen Taylor's avatar
Owen Taylor committed
31 32


33 34
<!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Title ##### -->
gtkenums.sgml
Owen Taylor's avatar
Owen Taylor committed
35 36


37 38
<!-- ##### SECTION ./tmpl/gtkimcontextsimple.sgml:Title ##### -->
GtkIMContextSimple
Owen Taylor's avatar
Owen Taylor committed
39 40


41 42 43
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
<refsect2>
<title>What are Signal Marshallers?</title>
44
<para>
45 46 47 48
Marshals are functions which all have the same prototype:
they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
and an array of argument values.
The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
49 50
</para>
<para>
51 52 53 54 55 56 57
They then call a native function:  the GtkObject is the first
parameter passed in.  The arguments are passed in the native
calling convention:  chars, shorts, ints, longs may be packed
on the stack, or tucked in registers:  it doesn't matter
because the same calling convention will be generated
inside the gtkmarshal code as is expected where you define
your handlers.
58 59
</para>
<para>
60 61 62 63 64 65 66 67
So the function named:
<programlisting>
gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
</programlisting>
will call the #GtkSignalFunc assuming it was a function with signature:
<programlisting>
gboolean sigfunc(gpointer,gint,gint,guint);
</programlisting>
68
</para>
69 70 71
</refsect2>
<refsect2>
<title>Writing Custom Marshals</title>
72
<para>
73 74 75
Marshals are primarily used as arguments to gtk_signal_new().
Sometimes, you may find that a marshaller you need isn't available
in the standard list.  Then you have to write your own.
76
</para>
Owen Taylor's avatar
Owen Taylor committed
77
<para>
78 79 80 81 82 83 84
If you wish to define a signal with a new type of argument list.
Suppose you want 2 pointers and 2 integers.
You would write:
<programlisting>
typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
			gpointer, gpointer, gint, gint
);
85

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
void marshal_INT__POINTER_POINTER_INT_INT(GtkObject*    object,
					   GtkSignalFunc func,
					   gpointer      func_data,
                                           GtkArg*       args)
{
	GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
	gint* return_val;
	return_val = GTK_RETLOC_INT(args[4]);
	rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
	*return_val = (*rfunc)(object,
                               GTK_VALUE_POINTER(args[0]),
                               GTK_VALUE_POINTER(args[1]),
                               GTK_VALUE_INT(args[2]),
                               GTK_VALUE_INT(args[3]),
                               func_data);
}
</programlisting>
Owen Taylor's avatar
Owen Taylor committed
103
</para>
104
</refsect2>
Owen Taylor's avatar
Owen Taylor committed
105 106


107
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
Jonathan Blandford's avatar
Jonathan Blandford committed
108
<para>
109
<variablelist>
Jonathan Blandford's avatar
Jonathan Blandford committed
110

111 112 113 114 115
<varlistentry>
<term>#GtkSignal</term>
<listitem><para>The signal handling functions (of which marshallers are 
really an implementation detail).</para></listitem>
</varlistentry>
Jonathan Blandford's avatar
Jonathan Blandford committed
116

117 118
</variablelist>
</para>
Havoc Pennington's avatar
Havoc Pennington committed
119 120


121 122
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Short_Description ##### -->
Functions to adapt C structures to native calling convention.
Havoc Pennington's avatar
Havoc Pennington committed
123

124

125 126
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
Signal Marshallers
127

128

129 130
<!-- ##### SECTION ./tmpl/gtkprivate.sgml:Title ##### -->
Private Information
131 132


Havoc Pennington's avatar
Havoc Pennington committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
<!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Long_Description ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:See_Also ##### -->
<para>

</para>


<!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Short_Description ##### -->



<!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Title ##### -->
GtkModelSimple


153
<!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
154
<para>
155 156
A macro to check whether a child widget of the CList
has the focus.
157 158
</para>

159
@clist: The #GtkCList widget to check.
160

161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
<!-- ##### MACRO GTK_ICON_SIZE_BUTTON ##### -->
<para>

</para>


<!-- ##### MACRO GTK_ICON_SIZE_DIALOG ##### -->
<para>

</para>


<!-- ##### MACRO GTK_ICON_SIZE_LARGE_TOOLBAR ##### -->
<para>

</para>


<!-- ##### MACRO GTK_ICON_SIZE_MENU ##### -->
<para>

</para>


<!-- ##### MACRO GTK_ICON_SIZE_SMALL_TOOLBAR ##### -->
<para>

</para>


191
<!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
192
<para>
193
Test whether a GtkObject's arguments have been prepared.
194 195
</para>

196
@obj: the object to examine.
197

198
<!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
Owen Taylor's avatar
Owen Taylor committed
199
<para>
200
Get the number of signals defined by this object.
Owen Taylor's avatar
Owen Taylor committed
201 202
</para>

203
@obj: the object to query.
Owen Taylor's avatar
Owen Taylor committed
204

205
<!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
206
<para>
207
Get the array of signals defined for this object.
208 209
</para>

210
@obj: the object to fetch the signals from.
211

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
<!-- ##### MACRO GTK_STOCK_BUTTON_APPLY ##### -->
<para>

</para>


<!-- ##### MACRO GTK_STOCK_BUTTON_CANCEL ##### -->
<para>

</para>


<!-- ##### MACRO GTK_STOCK_BUTTON_CLOSE ##### -->
<para>

</para>


<!-- ##### MACRO GTK_STOCK_BUTTON_NO ##### -->
<para>

</para>


<!-- ##### MACRO GTK_STOCK_BUTTON_OK ##### -->
<para>

</para>


<!-- ##### MACRO GTK_STOCK_BUTTON_YES ##### -->
<para>

</para>


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 252
</para>

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 259 260
</para>


261
<!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
262
<para>
263
The last "flat" (no struct) enumerated type value.
Havoc Pennington's avatar
Havoc Pennington committed
264 265 266
</para>


267
<!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
268
<para>
269
Hide the name of gtk_identifier_get_type
Havoc Pennington's avatar
Havoc Pennington committed
270 271 272
</para>


273
<!-- ##### MACRO GTK_TYPE_MAKE ##### -->
274
<para>
275
Combine a fundemantal type and a sequence number to create a gtk type.
276 277
</para>

278 279
@parent_t: 
@seqno: 
280

281
<!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
282
<para>
283
No idea.
284 285 286
</para>


287
<!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
288
<para>
289
Convert a gtk type into its sequence number
290 291
</para>

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 304 305
</para>


306 307 308 309 310 311
<!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
<para>

</para>


312
<!-- ##### MACRO GTK_VALUE_ARGS ##### -->
313
<para>
314
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
315 316
</para>

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>
Havoc Pennington's avatar
Havoc Pennington committed
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 330
</para>

331
@a: 
332

333
<!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
334
<para>
335
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
Havoc Pennington's avatar
Havoc Pennington committed
336 337
</para>

338
@a: 
Havoc Pennington's avatar
Havoc Pennington committed
339

340 341 342 343 344 345
<!-- ##### ARG GtkAccelLabel:accel-width ##### -->
<para>

</para>


346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
<!-- ##### USER_FUNCTION GtkArgGetFunc ##### -->
<para>
Define a function pointer.  Deprecated.
</para>

@object: 
@arg: 
@arg_id: 

<!-- ##### USER_FUNCTION GtkArgSetFunc ##### -->
<para>
Define a function pointer.  Deprecated.
</para>

@object: 
@arg: 
@arg_id: 

364 365 366 367 368 369 370 371 372
<!-- ##### SIGNAL GtkContainer::focus ##### -->
<para>

</para>

@container: the object which received the signal.
@direction: 
@Returns: 

373 374 375 376 377 378
<!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
<para>

</para>


Havoc Pennington's avatar
Havoc Pennington committed
379 380 381 382 383 384 385 386 387 388 389 390 391 392
<!-- ##### STRUCT GtkData ##### -->
<para>
The #GtkData-struct struct contains no public fields.
</para>


<!-- ##### SIGNAL GtkData::disconnect ##### -->
<para>
Emitted to notify any views on the #GtkData object to disconnect from it,
possibly because the #GtkData object is about to be destroyed.
</para>

@data: the object which received the signal.

393
<!-- ##### SIGNAL GtkEditable::activate ##### -->
394
<para>
395 396 397 398 399
Indicates that the user has activated the widget
in some fashion. Generally, this will be done
with a keystroke. (The default binding for this
action is Return for #GtkEntry and
Control-Return for #GtkText.)
400 401
</para>

402
@editable: the object which received the signal.
403

404
<!-- ##### SIGNAL GtkEditable::changed ##### -->
405
<para>
406 407
Indicates that the user has changed the contents
of the widget.
408
</para>
409

410
@editable: the object which received the signal.
411

412
<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
413
<para>
414 415
An action signal. Causes the characters in the current selection to
be copied to the clipboard.
416 417
</para>

418
@editable: the object which received the signal.
419

420
<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
421
<para>
422 423 424
An action signal. Causes the characters in the current
selection to be copied to the clipboard and then deleted from
the widget.
425 426
</para>

427
@editable: the object which received the signal.
428

429
<!-- ##### SIGNAL GtkEditable::delete-text ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
430
<para>
431 432 433 434 435 436 437 438 439
This signal is emitted when text is deleted from
the widget by the user. The default handler for
this signal will normally be responsible for inserting
the text, so by connecting to this signal and then
stopping the signal with gtk_signal_emit_stop(), it
is possible to modify the inserted text, or prevent
it from being inserted entirely. The @start_pos
and @end_pos parameters are interpreted as for
gtk_editable_delete_text()
Havoc Pennington's avatar
Havoc Pennington committed
440 441
</para>

442 443 444
@editable: the object which received the signal.
@start_pos: the starting position.
@end_pos: the end position.
Havoc Pennington's avatar
Havoc Pennington committed
445

446
<!-- ##### SIGNAL GtkEditable::insert-text ##### -->
Owen Taylor's avatar
Owen Taylor committed
447
<para>
448 449 450 451 452 453 454
This signal is emitted when text is inserted into
the widget by the user. The default handler for
this signal will normally be responsible for inserting
the text, so by connecting to this signal and then
stopping the signal with gtk_signal_emit_stop(), it
is possible to modify the inserted text, or prevent
it from being inserted entirely.
455 456
</para>

457 458 459 460 461 462 463
@editable: the object which received the signal.
@new_text: the new text to insert.
@new_text_length: the length of the new text.
@position: the position at which to insert the new text.
           this is an in-out paramter. After the signal
           emission is finished, it should point after   
           the newly inserted text.
464

465
<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
466
<para>
467
An action signal. Delete a single character.
468
</para>
469 470 471 472 473 474

@editable: the object which received the signal.
@direction: the direction in which to delete. Positive
   indicates forward deletion, negative, backwards deletion.

<!-- ##### SIGNAL GtkEditable::kill-line ##### -->
475
<para>
476
An action signal. Delete a single line.
477
</para>
478 479 480 481 482 483

@editable: the object which received the signal.
@direction: the direction in which to delete. Positive
   indicates forward deletion, negative, backwards deletion.

<!-- ##### SIGNAL GtkEditable::kill-word ##### -->
484
<para>
485
An action signal. Delete a single word.
486 487
</para>

488 489 490
@editable: the object which received the signal.
@direction: the direction in which to delete. Positive
   indicates forward deletion, negative, backwards deletion.
491

492
<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
493
<para>
494
An action signal. Move the cursor position.
495 496
</para>

497 498 499
@editable: the object which received the signal.
@x: horizontal distance to move the cursor.
@y: vertical distance to move the cursor.
500

501
<!-- ##### SIGNAL GtkEditable::move-page ##### -->
502
<para>
503
An action signal. Move the cursor by pages.
504 505
</para>

506 507 508
@editable: the object which received the signal.
@x: Number of pages to move the cursor horizontally.
@y: Number of pages to move the cursor vertically.
509

510
<!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
511
<para>
512
An action signal. Move the cursor to the given column.
513
</para>
514 515 516 517 518 519

@editable: the object which received the signal.
@column: the column to move to. (A negative value indicates
         the last column)

<!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
520
<para>
521
An action signal. Move the cursor to the given row.
522 523
</para>

524 525 526
@editable: the object which received the signal.
@row: the row to move to. (A negative value indicates 
      the last row)
527

528
<!-- ##### SIGNAL GtkEditable::move-word ##### -->
529
<para>
530
An action signal. Move the cursor by words.
531 532
</para>

533 534 535
@editable: the object which received the signal.
@num_words: The number of words to move the
cursor. (Can be negative).
536

537
<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
538
<para>
539 540 541
An action signal. Causes the contents of the clipboard to
be pasted into the editable widget at the current cursor
position.
542 543
</para>

544
@editable: the object which received the signal.
545

546 547 548 549 550 551
<!-- ##### SIGNAL GtkEditable::set-editable ##### -->
<para>
Determines if the user can edit the text in the editable
widget or not. This is meant to be overriden by 
child classes and should not generally useful to
applications.
552 553
</para>

554 555 556
@editable: the object which received the signal.
@is_editable: %TRUE if the user is allowed to edit the text
  in the widget.
Owen Taylor's avatar
Owen Taylor committed
557

558 559 560 561
<!-- ##### ARG GtkEditable:editable ##### -->
<para>
A boolean indicating whether the widget is editable by
the user.
Owen Taylor's avatar
Owen Taylor committed
562 563 564
</para>


565
<!-- ##### ARG GtkEditable:text-position ##### -->
566
<para>
567
The position of the cursor.
568 569 570
</para>


Havoc Pennington's avatar
Havoc Pennington committed
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
<!-- ##### USER_FUNCTION GtkEmissionHook ##### -->
<para>
A simple function pointer to get invoked when the
signal is emitted.  This allows you tie a hook to the signal type,
so that it will trap all emissions of that signal, from any object.
</para>
<para>
You may not attach these to signals created with the
#GTK_RUN_NO_HOOKS flag.
</para>

@object: 
@signal_id: 
@n_params: 
@params: 
@data: 
@Returns: 

589
<!-- ##### ENUM GtkFontFilterType ##### -->
590
<para>
591 592 593
A set of bit flags used to specify the filter being set
when calling gtk_font_selection_dialog_set_filter() or
gtk_font_selection_set_filter().
594 595
</para>

596 597 598
@GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user.
@GTK_FONT_FILTER_USER: the user filter, which can be changed from within the
'Filter' page of the #GtkFontSelection widget.
599

600
<!-- ##### ENUM GtkFontType ##### -->
601
<para>
602 603 604
A set of bit flags used to specify the type of fonts shown
when calling gtk_font_selection_dialog_set_filter() or
gtk_font_selection_set_filter().
605 606
</para>

607 608 609 610
@GTK_FONT_BITMAP: bitmap fonts.
@GTK_FONT_SCALABLE: scalable fonts.
@GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts.
@GTK_FONT_ALL: a bitwise combination of all of the above.
611

612 613 614 615 616 617
<!-- ##### ARG GtkFrame:shadow-type ##### -->
<para>

</para>


618 619 620 621 622 623 624 625 626 627 628 629
<!-- ##### ARG GtkHScale:adjustment ##### -->
<para>
the #GtkAdjustment which sets the range of the scale.
</para>


<!-- ##### ARG GtkHScrollbar:adjustment ##### -->
<para>

</para>


630
<!-- ##### STRUCT GtkIMContextSimple ##### -->
631 632 633 634
<para>

</para>

635 636 637 638 639
@object: 
@tables: 
@compose_buffer: 
@tentative_match: 
@tentative_match_len: 
640

641 642 643 644 645 646
<!-- ##### ARG GtkLabel:accel-keyval ##### -->
<para>

</para>


647
<!-- ##### ARG GtkObject:object-signal ##### -->
648
<para>
649 650 651
Setting this with a GtkType of GTK_TYPE_SIGNAL connects
the signal to the object, so that the user data and objects
and swapped when the signal handler is invoked.
652 653
</para>
<para>
654 655 656 657
This is useful for handlers that are primarily notifying
other objects and could just invoke an already existing function
if the parameters were swapped.
See gtk_signal_connect_object() for more details.
658 659 660
</para>


661
<!-- ##### ARG GtkObject:object-signal-after ##### -->
662
<para>
663 664 665 666
Setting this with a GtkType of GTK_TYPE_SIGNAL connects
the signal to the object, so that the user data and objects
and swapped when the signal handler is invoked,
and so that the handler is invoked after all others.
667 668
</para>
<para>
669
See gtk_signal_connect_object_after() for more details.
670 671 672
</para>


673
<!-- ##### ARG GtkObject:signal ##### -->
674
<para>
675 676
Setting this with a GtkType of GTK_TYPE_SIGNAL connects
the signal to the object.
677 678 679
</para>


680
<!-- ##### ARG GtkObject:signal-after ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
681
<para>
682 683 684
Setting this with a GtkType of GTK_TYPE_SIGNAL connects
the signal to the object, so that the signal is always run
after other user handlers and the default handler.
Havoc Pennington's avatar
Havoc Pennington committed
685 686
</para>

687

688 689 690 691 692 693
<!-- ##### ARG GtkPaned:handle-size ##### -->
<para>

</para>


694 695 696 697 698 699 700 701 702 703 704 705
<!-- ##### STRUCT GtkPatternSpec ##### -->
<para>

</para>

@match_type: 
@pattern_length: 
@pattern: 
@pattern_reversed: 
@user_data: 
@seq_id: 

706
<!-- ##### ENUM GtkPrivateFlags ##### -->
707
<para>
708

709 710
</para>

711 712 713 714 715 716 717 718
@PRIVATE_GTK_USER_STYLE: 
@PRIVATE_GTK_RESIZE_PENDING: 
@PRIVATE_GTK_RESIZE_NEEDED: 
@PRIVATE_GTK_LEAVE_PENDING: 
@PRIVATE_GTK_HAS_SHAPE_MASK: 
@PRIVATE_GTK_IN_REPARENT: 
@PRIVATE_GTK_DIRECTION_SET: 
@PRIVATE_GTK_DIRECTION_LTR: 
719

720
<!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
721
<para>
722 723 724 725 726 727 728 729 730 731 732
A function which you can use to clean up when the
signal handler is destroyed.
</para>
<para>
For example, if your handler requires a few variables
that you made into a struct and allocated (using g_new()
or something), then you will probably want to free
it as soon as the hook is destroyed.  This will
allow you to do that. (For this in particular
it is convenient to pass g_free() as a #GtkSignalDestroy
function).
733 734
</para>

735 736
@data: The user data associated with the hook that is being
destroyed.
737

738
<!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
739
<para>
740 741
This is currently a hack left in for a scheme wrapper library.
It may be removed.
742 743
</para>
<para>
744
Don't use it.
745 746
</para>

747 748 749 750 751 752 753
@object: The object which emits the signal.
@data: The user data associated with the hook.
@nparams: The number of parameters to the function.
@args: The actual values of the arguments.
@arg_types: The types of the arguments.
@return_type: The type of the return value from the function
or #GTK_TYPE_NONE for no return value.
754

755
<!-- ##### STRUCT GtkSignalQuery ##### -->
756
<para>
757 758 759
This structure contains all the information about a particular
signal:  its name, the type it affects, the signature of the handlers,
and its unique identifying integer.
760 761
</para>

762 763 764 765 766 767 768 769
@object_type: 
@signal_id: 
@signal_name: 
@is_user_signal: 
@signal_flags: 
@return_val: 
@nparams: 
@params: 
770

771 772 773 774 775 776
<!-- ##### ARG GtkSpinButton:shadow-type ##### -->
<para>
the type of border that surrounds the arrows of a spin button.
</para>


777
<!-- ##### STRUCT GtkStatusbarMsg ##### -->
778
<para>
779
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.
780 781
</para>

782 783 784
@text: 
@context_id: 
@message_id: 
785

786
<!-- ##### ARG GtkTextTag:justify ##### -->
787
<para>
788 789
A #GtkJustification for the text. This is only used when the tag is
applied to the first character in a paragraph.
790 791 792
</para>


793
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
794
<para>
795 796
Pixel width of the left margin of the text for lines after the first
line in a wrapped paragraph.
797 798 799
</para>


800
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
801 802 803 804 805
<para>

</para>


806
<!-- ##### ARG GtkTextTag:offset ##### -->
807
<para>
808 809
Pixels to offset the text horizontally or vertically, useful to
produce superscript and subscript.
810 811 812
</para>


Havoc Pennington's avatar
Havoc Pennington committed
813 814 815 816 817 818
<!-- ##### ARG GtkTextView:justify ##### -->
<para>

</para>


819 820 821 822 823 824 825 826 827 828 829 830
<!-- ##### ARG GtkVScale:adjustment ##### -->
<para>
the #GtkAdjustment which sets the range of the scale.
</para>


<!-- ##### ARG GtkVScrollbar:adjustment ##### -->
<para>

</para>


831 832 833 834 835 836 837 838 839
<!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
<para>

</para>

@widget: the object which received the signal.
@arg1: 
@Returns: 

840 841 842 843 844 845 846 847
<!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
<para>

</para>

@widget: the object which received the signal.
@message: 

848
<!-- ##### SIGNAL GtkWidget::draw ##### -->
849 850 851 852
<para>

</para>

853 854
@widget: the object which received the signal.
@area: 
855

856
<!-- ##### SIGNAL GtkWidget::draw-default ##### -->
857 858 859 860
<para>

</para>

861
@widget: the object which received the signal.
862

863
<!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
864 865 866 867
<para>

</para>

868
@widget: the object which received the signal.
Havoc Pennington's avatar
Havoc Pennington committed
869

870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
<!-- ##### FUNCTION gtk_button_box_child_requisition ##### -->
<para>
This is an internally used function and should never be called from an
application.
</para>

@widget: 
@nvis_children: 
@width: 
@height: 

<!-- ##### FUNCTION gtk_button_box_get_child_ipadding_default ##### -->
<para>
The internal padding of a button is the amount of space between the outside
of the button and the widget it contains. This function gets the default
amount of horizontal and vertical padding, placing the results in @ipad_x
and @ipad_y, respectively.
</para>

@ipad_x: the default horizontal internal button padding.
@ipad_y: the default vertical internal button padding.

<!-- ##### FUNCTION gtk_button_box_get_child_size_default ##### -->
<para>
Retrieves the default minimum width and height for all button boxes, and
places the values in @min_width and @min_height, respectively.
</para>

@min_width: the default minimum width of a child widget.
@min_height: the default minimum height of a child widget.

<!-- ##### FUNCTION gtk_button_box_set_child_ipadding_default ##### -->
<para>
Sets the default number of pixels that pad each button in every button box.
</para>

@ipad_x: new default horizontal padding.
@ipad_y: new default vertical padding.

<!-- ##### FUNCTION gtk_button_box_set_child_size_default ##### -->
<para>
Sets the default size of child buttons.
</para>

@min_width: minimum default width for child buttons.
@min_height: minimum default height for child buttons.

917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
<!-- ##### FUNCTION gtk_button_new_accel ##### -->
<para>

</para>

@uline_label: 
@accel_group: 
@Returns: 

<!-- ##### FUNCTION gtk_button_new_stock ##### -->
<para>

</para>

@stock_id: 
@accel_group: 
@Returns: 

935
<!-- ##### FUNCTION gtk_clist_construct ##### -->
936
<para>
937 938
Initializes a previously allocated #GtkCList widget for use.  This should not
normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
939 940
</para>

941 942 943 944 945
@clist: A pointer to an uninitialized #GtkCList widget.
@columns: The number of columns the #GtkCList should have.
@titles: An array of strings that should be used as the titles i
of the columns.  There should be enough strings in the array for
the number of columns specified.
946

947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
<!-- ##### FUNCTION gtk_color_selection_get_old_color ##### -->
<para>

</para>

@colorsel: 
@color: 

<!-- ##### FUNCTION gtk_color_selection_get_use_opacity ##### -->
<para>

</para>

@colorsel: 
@Returns: 

<!-- ##### FUNCTION gtk_color_selection_get_use_palette ##### -->
<para>

</para>

@colorsel: 
@Returns: 

<!-- ##### FUNCTION gtk_color_selection_set_old_color ##### -->
<para>

</para>

@colorsel: 
@color: 

979
<!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
980
<para>
981 982 983 984 985
Controls whether opacity can be set with the #GtkColorSelection.
If this functionality is enabled, the necessary additional widgets
are added to the #GtkColorSelection and the opacity value can be
retrieved via the fourth value in the color array returned by
the gtk_color_selection_get_color() function.
986 987
</para>

988 989 990
@colorsel: a #GtkColorSelection.
@use_opacity: a boolean indicating whether the opacity selection
is enabled.
991

992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
<!-- ##### FUNCTION gtk_color_selection_set_use_opacity ##### -->
<para>

</para>

@colorsel: 
@use_opacity: 

<!-- ##### FUNCTION gtk_color_selection_set_use_palette ##### -->
<para>

</para>

@colorsel: 
@use_palette: 

Havoc Pennington's avatar
Havoc Pennington committed
1008 1009 1010 1011 1012 1013 1014 1015 1016
<!-- ##### FUNCTION gtk_container_focus ##### -->
<para>

</para>

@container: 
@direction: 
@Returns: 

1017
<!-- ##### FUNCTION gtk_ctree_construct ##### -->
1018
<para>
1019
This function is not usually used by users.
1020 1021
</para>

1022 1023 1024 1025
@ctree: 
@columns: 
@tree_column: 
@titles: 
1026

1027
<!-- ##### FUNCTION gtk_editable_changed ##### -->
1028
<para>
1029
Causes the "changed" signal to be emitted.
1030 1031
</para>

1032
@editable: a #GtkEditable widget.
1033

1034
<!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
1035
<para>
1036
Claim or disclaim ownership of the PRIMARY X selection.
1037 1038
</para>

1039 1040 1041
@editable: a #GtkEditable widget.
@claim: if %TRUE, claim the selection, otherwise, disclaim it.
@time: the timestamp for claiming the selection.
1042

1043
<!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
1044
<para>
1045
Sets one of the two font filters, to limit the fonts shown.
1046 1047
</para>

1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
@fsd: a #GtkFontSelectionDialog.
@filter_type: which of the two font filters to set, either
#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
can be changed by the user, but the base filter is permanent.
@font_type: the types of font to be shown. This is a bitwise combination of
#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
or #GTK_FONT_ALL to show all three font types.
@foundries: a NULL-terminated array of strings containing foundry names which
will be shown, or NULL to show all foundries.
@weights: a NULL-terminated array of strings containing weight names which
will be shown, or NULL to show all weights.
@slants: a NULL-terminated array of strings containing slant names which
will be shown, or NULL to show all slants.
@setwidths: a NULL-terminated array of strings containing setwidth names which
will be shown, or NULL to show all setwidths.
@spacings: a NULL-terminated array of strings containing spacings which
will be shown, or NULL to show all spacings.
@charsets: a NULL-terminated array of strings containing charset names which
will be shown, or NULL to show all charsets.
1067

1068
<!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
1069
<para>
1070
Sets one of the two font filters, to limit the fonts shown.
1071 1072
</para>

1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
@fontsel: a #GtkFontSelection.
@filter_type: which of the two font filters to set, either
#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
can be changed by the user, but the base filter is permanent.
@font_type: the types of font to be shown. This is a bitwise combination of
#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
or #GTK_FONT_ALL to show all three font types.
@foundries: a NULL-terminated array of strings containing foundry names which
will be shown, or NULL to show all foundries.
@weights: a NULL-terminated array of strings containing weight names which
will be shown, or NULL to show all weights.
@slants: a NULL-terminated array of strings containing slant names which
will be shown, or NULL to show all slants.
@setwidths: a NULL-terminated array of strings containing setwidth names which
will be shown, or NULL to show all setwidths.
@spacings: a NULL-terminated array of strings containing spacings which
will be shown, or NULL to show all spacings.
@charsets: a NULL-terminated array of strings containing charset names which
will be shown, or NULL to show all charsets.
1092

1093
<!-- ##### FUNCTION gtk_identifier_get_type ##### -->
1094
<para>
1095
Get the type of GtkIdentifier.
1096
</para>
1097

1098
@Returns: GtkType -- the enumerated type of something.
1099

1100 1101 1102 1103 1104 1105 1106 1107
<!-- ##### FUNCTION gtk_image_menu_item_add_image ##### -->
<para>

</para>

@image_menu_item: 
@child: 

1108 1109 1110 1111 1112 1113 1114 1115 1116
<!-- ##### FUNCTION gtk_label_set_markup_with_accel ##### -->
<para>

</para>

@label: 
@str: 
@Returns: 

Havoc Pennington's avatar
Havoc Pennington committed
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
<!-- ##### FUNCTION gtk_list_store_set_cell ##### -->
<para>

</para>

@store: 
@iter: 
@column: 
@value: 

1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
<!-- ##### FUNCTION gtk_menu_ensure_uline_accel_group ##### -->
<para>

</para>

@menu: 
@Returns: 

<!-- ##### FUNCTION gtk_menu_get_uline_accel_group ##### -->
<para>

</para>

@menu: 
@Returns: 

1143
<!-- ##### FUNCTION gtk_object_arg_get ##### -->
1144
<para>
1145
Private function to get an argument and argument info from an object.
1146 1147
</para>

1148 1149 1150
@object: the object whose argument should be retrieved.
@arg: the argument, for the name on input, the rest is filled on output.
@info: a #GtkArgInfo structure to optionally fill in.
1151

1152
<!-- ##### FUNCTION gtk_object_arg_get_info ##### -->
Owen Taylor's avatar
Owen Taylor committed
1153
<para>
1154
Query information about an argument type.
Owen Taylor's avatar
Owen Taylor committed
1155 1156
</para>

1157 1158 1159 1160 1161
@object_type: type of object to query about.
@arg_name: name of the argument.
@info_p: pointer to be filled in with a pointer to the GtkArgInfo.
@Returns: an error message, or NULL on success.
It is the caller's responsibility to call g_free() in the event of error.
Owen Taylor's avatar
Owen Taylor committed
1162

1163
<!-- ##### FUNCTION gtk_object_arg_set ##### -->
Owen Taylor's avatar
Owen Taylor committed
1164
<para>
1165
Private function to set an argument and argument info to an object.
Owen Taylor's avatar
Owen Taylor committed
1166 1167
</para>

1168 1169 1170
@object: the object whose argument should be set.
@arg: the argument.
@info: infomation about this type of argument in general.
Owen Taylor's avatar
Owen Taylor committed
1171

1172
<!-- ##### FUNCTION gtk_object_args_collect ##### -->
Owen Taylor's avatar
Owen Taylor committed
1173
<para>
1174
Private: Gets an array of #GtkArgs from a va_list C structure.
Owen Taylor's avatar
Owen Taylor committed
1175 1176
</para>

1177 1178 1179 1180 1181 1182 1183 1184
@object_type: the type of object to collect arguments for.
@arg_list_p: pointer to be filled in with a list of parsed arguments.
@info_list_p: optional pointer for a returned list #GtkArgInfos.
@first_arg_name: name of first argument.
@var_args: value of first argument, followed by more key/value pairs,
terminated by NULL.
@Returns: an error message, or NULL on success.
It is the caller's responsibility to call g_free() in the event of error.
Owen Taylor's avatar
Owen Taylor committed
1185

1186
<!-- ##### FUNCTION gtk_object_class_add_signals ##### -->
1187
<para>
1188 1189
Add an array of signals to a #GtkObjectClass.
Usually this is called when registering a new type of object.
1190
</para>
Havoc Pennington's avatar
Havoc Pennington committed
1191

1192 1193 1194
@klass: the object class to append signals to.
@signals: the signals to append.
@nsignals: the number of signals being appended.
Havoc Pennington's avatar
Havoc Pennington committed
1195

1196
<!-- ##### FUNCTION gtk_object_class_user_signal_new ##### -->
1197
<para>
1198 1199 1200 1201 1202
Define a signal-handler for a new signal on an already defined
object.
</para>
<para>
See the signal documentation for more general information.
1203 1204
</para>

1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
@klass: the object class to define the signal for.
@name: the name of the signal.
@signal_flags: the default emission behavior for the signal.
See gtk_signal_new().
@marshaller: a function that will take an array of GtkArgs
and invoke the appropriate handler with the normal calling
conventions.
@return_val: specify the return-value type for the signal
(or GTK_TYPE_NONE for no return-value).
@nparams: specify the number of parameters the signal
receives from the caller of gtk_signal_emit().
@Varargs: list of nparams #GtkTypes to pass to the signal handlers.
@Returns: the signal id.  (See #GtkSignals)
1218

1219
<!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### -->
1220
<para>
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
Define a signal-handler for a new signal on an already defined
object.
</para>

@klass: the object class to define the signal for.
@name: the name of the signal.
@signal_flags: the default emission behavior for the signal.
See gtk_signal_new().
@marshaller: takes a GtkObject, a #GtkSignalFunc, and an array
of arguments, and invokes the function using the appropriate
calling conventions.  Usually just select a function
out of gtkmarshal.h.
@return_val: specify the return-value type for the signal (possibly
#GTK_TYPE_NONE).
@nparams: specify the number of parameters the signal
receives from the caller of gtk_signal_emit().
@params: array of #GtkTypes the signal handlers for this signal
should have in their prototype (of length nparams).
@Returns: the signal id.  (See #GtkSignals)
1240

1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
<!-- ##### FUNCTION gtk_object_constructed ##### -->
<para>
Mark an allocated object as constructed.
This is used for situations
that require precise control of the construction process.
</para>
<para>
This is done when gtk_object_default_construct() is inadequate.
In #GtkCList the need arises because #GtkCList does construction work that
must happen <emphasis>after</emphasis> its derivers.  This work
cannot be done in an initializer function, so an alternate
constructor is mandatory.  It calls gtk_object_constructed() to
indicate it has done its job, so that no other constructor will
be invoked.
1255
</para>
1256
<para>
1257 1258
Normally this function is just automatically run from
gtk_object_default_construct().
1259 1260
</para>

1261 1262
@object: object which has been constructed.  This is usually
done automatically by gtk_object_new() and gtk_object_newv().
1263

1264
<!-- ##### FUNCTION gtk_object_default_construct ##### -->
1265
<para>
1266 1267
This function is called to construct arguments that haven't been initialized
but have the #GTK_ARG_CONSTRUCT flag set.
1268
</para>
1269
<para>
1270 1271
All number arguments are set to 0.  All pointers and strings
are set to NULL.
1272 1273
</para>
<para>
1274 1275
Normally invoked by gtk_object_new() automatically; gtk_type_new() can
be used to bypass it.
1276
</para>
1277

1278
@object: the object to initialize.
1279

1280
<!-- ##### FUNCTION gtk_object_getv ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
1281
<para>
1282
Gets an array of argument values from an object.
Havoc Pennington's avatar
Havoc Pennington committed
1283 1284
</para>

1285 1286 1287
@object: the object to get arguments from.
@n_args: the number of arguments to query.
@args: the arguments to fill in.
Havoc Pennington's avatar
Havoc Pennington committed
1288

1289
<!-- ##### FUNCTION gtk_object_newv ##### -->
1290
<para>
1291
Construct an object with an array of arguments.
1292 1293
</para>

1294 1295 1296 1297
@object_type: the type of the object to create.
@n_args: the number of arguments to set.
@args: an array of n_args arguments (which are name and value pairs).
@Returns: the new GtkObject.
1298

1299
<!-- ##### FUNCTION gtk_object_query_args ##### -->
Owen Taylor's avatar
Owen Taylor committed
1300
<para>
1301
Get all the arguments that may be used for a given type.
Owen Taylor's avatar
Owen Taylor committed
1302 1303
</para>
<para>
1304 1305 1306 1307
In Java, this type of mechanism is called 
<wordasword>introspection</wordasword>.  It is used by applications
like Glade, that have to determine what can be done to an object
at run-time.
Owen Taylor's avatar
Owen Taylor committed
1308 1309
</para>

1310 1311 1312 1313 1314 1315
@class_type: the GtkType of the ObjectClass
(returned from GTK_OBJECT_CLASS(class)-&gt;type for example).
@arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to
each argument.  You must g_free() this if you request it.
@n_args: the number of arguments is returned in this field.
@Returns: an array of arguments, that you must deallocate with g_free().
Owen Taylor's avatar
Owen Taylor committed
1316

1317
<!-- ##### FUNCTION gtk_object_setv ##### -->
1318
<para>
1319
Set an array of arguments.
1320 1321
</para>

1322 1323 1324 1325
@object: the object whose arguments should be set.
@n_args: the number of arguments to set.
@args: the desired values, as an array of #GtkArgs (which contain 
the names, types, and values of the arguments).
1326

1327
<!-- ##### FUNCTION gtk_paned_compute_position ##### -->
Owen Taylor's avatar
Owen Taylor committed
1328
<para>
1329
Internal function used by #GtkHPaned and #GtkVPaned
Owen Taylor's avatar
Owen Taylor committed
1330
</para>
1331

1332 1333 1334 1335
@paned: 
@allocation: 
@child1_req: 
@child2_req: 
1336

1337 1338 1339 1340 1341 1342 1343 1344
<!-- ##### FUNCTION gtk_paned_set_handle_size ##### -->
<para>
Set the the handle size to @size x @size pixels.
</para>

@paned: a paned widget
@size: the size in pixels

1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
<!-- ##### FUNCTION gtk_pattern_match ##### -->
<para>

</para>

@pspec: 
@string_length: 
@string: 
@string_reversed: 
@Returns: 

<!-- ##### FUNCTION gtk_pattern_match_simple ##### -->
<para>

</para>

@pattern: 
@string: 
@Returns: 

<!-- ##### FUNCTION gtk_pattern_match_string ##### -->
<para>

</para>

@pspec: 
@string: 
@Returns: 

<!-- ##### FUNCTION gtk_pattern_spec_free_segs ##### -->
<para>

</para>

@pspec: 

<!-- ##### FUNCTION gtk_pattern_spec_init ##### -->
<para>

</para>

@pspec: 
@pattern: 

1389
<!-- ##### FUNCTION gtk_rc_init ##### -->
Owen Taylor's avatar
Owen Taylor committed
1390
<para>
1391
Internal function.
Owen Taylor's avatar
Owen Taylor committed
1392 1393 1394
</para>


1395
<!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
Owen Taylor's avatar
Owen Taylor committed
1396 1397 1398 1399
<para>

</para>

1400
@ruler: the gtkruler
Owen Taylor's avatar
Owen Taylor committed
1401

1402
<!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
1403
<para>
1404

1405
</para>
1406

1407
@ruler: the gtkruler
1408

Havoc Pennington's avatar
Havoc Pennington committed
1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
<!-- ##### FUNCTION gtk_signal_add_emission_hook ##### -->
<para>
Add an emission hook for a type of signal, for any object.
</para>

@signal_id: the type of signal to hook for.
@hook_func: the function to invoke to handle the emission hook.
@data: the user data passed in to hook_func.
@Returns: the id (that you may pass as a parameter
to gtk_signal_remove_emission_hook()).
@i: 
@h: 
@d: 

1423
<!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
1424
<para>
1425 1426 1427
Add an emission hook for a type of signal, for any object.
(with control of what happens when the hook is
destroyed).
1428 1429
</para>

1430 1431 1432 1433 1434 1435 1436 1437
@signal_id: the type of signal add the hook for.
@hook_func: the function to invoke to handle the hook.
@data: the user data passed in to hook_func.
@destroy: a function to invoke when the hook is destroyed,
to clean up any allocation done just for this
signal handler.
@Returns: the id (that you may pass as a parameter
to gtk_signal_remove_emission_hook()).
1438

1439
<!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
1440
<para>
1441
Returns whether a connection id is valid (and optionally not blocked).
1442 1443
</para>

1444 1445 1446 1447 1448 1449
@object: the object to search for the desired handler.
@handler_id: the connection id.
@may_be_blocked: whether it is acceptable to return a blocked
handler.
@Returns: TRUE if the signal exists and wasn't blocked,
unless #may_be_blocked was specified.  FALSE otherwise.
1450

1451
<!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
1452
<para>
1453 1454
Destroy all the signal handlers connected to an object.
This is done automatically when the object is destroyed.
1455
</para>
1456
<para>
1457
This function is labeled private.
1458 1459
</para>

1460
@object: the object whose signal handlers should be destroyed.
1461

Havoc Pennington's avatar
Havoc Pennington committed
1462 1463 1464 1465 1466 1467
<!-- ##### FUNCTION gtk_signal_init ##### -->
<para>

</para>


1468
<!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
Owen Taylor's avatar
Owen Taylor committed
1469
<para>
1470 1471 1472 1473 1474 1475
Find out the recursion depth of emissions for a particular type
of signal and object.  (So it will
always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
This is a way to avoid recursion:  you can see if
you are currently running in that signal handler and emit it only
if you are.
Owen Taylor's avatar
Owen Taylor committed
1476
</para>
1477 1478 1479
<para>Another way to look at it is that this number increases
by one when #gtk_signal_emit(), et al, are called,
and decreases by one when #gtk_signal_emit() returns.
Owen Taylor's avatar
Owen Taylor committed
1480 1481
</para>

1482 1483 1484 1485
@object: the object with the signal handler.
@signal_id: the signal id.
@Returns: the recursion depth of emissions of this signal for this
object.
Owen Taylor's avatar
Owen Taylor committed
1486

1487
<!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
1488
<para>
1489 1490 1491
Find out the recursion depth of emissions for a particular type
of signal and object.  Just like gtk_signal_n_emissions()
except it will lookup the signal id for you.
1492 1493
</para>

1494 1495 1496 1497
@object: the object with the signal handler.
@name: the signal name.
@Returns: the recursion depth of emissions of this signal for this
object.
1498

1499
<!-- ##### FUNCTION gtk_signal_query ##### -->
1500
<para>
1501
Obtain information about a signal.
1502 1503
</para>

1504 1505 1506 1507
@signal_id: the signal type identifier.
@Returns: a pointer to a GtkSignalQuery structure
which contains all the information, or NULL.
The pointer is allocated just for you:  you must g_free() it.
1508

Havoc Pennington's avatar
Havoc Pennington committed
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
<!-- ##### FUNCTION gtk_signal_remove_emission_hook ##### -->
<para>
Delete an emission hook. (see gtk_signal_add_emission_hook())
</para>

@signal_id: the id of the signal type.
@hook_id: the id of the emission handler, returned by add_emission_hook().
@i: 
@h: 

1519
<!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
1520
<para>
1521 1522 1523
These set default functions to call when the user didn't
supply a function when connecting.  (These are rarely
used, and probably only for language bindings)
1524
</para>
Owen Taylor's avatar
Owen Taylor committed
1525
<para>
1526
By default, there are no such functions.
Owen Taylor's avatar
Owen Taylor committed
1527 1528
</para>

1529 1530 1531 1532
@marshal_func: the function to invoke on every handlers for which there
isn't a function pointer.  May be NULL.
@destroy_func: the function to invoke when each hook is destroyed.
May be NULL.
Owen Taylor's avatar
Owen Taylor committed
1533

1534 1535 1536 1537 1538 1539 1540 1541
<!-- ##### FUNCTION gtk_spin_button_set_shadow_type ##### -->
<para>
Creates a border around the arrows of a #GtkSpinButton. The type of border is determined by @shadow_type.
</para>

@spin_button: a #GtkSpinButton
@shadow_type: the new border type.

1542 1543 1544 1545 1546 1547 1548
<!-- ##### FUNCTION gtk_stock_list_items ##### -->
<para>

</para>

@Returns: 

1549 1550 1551 1552 1553 1554 1555 1556
<!-- ##### FUNCTION gtk_text_iter_reorder ##### -->
<para>

</para>

@first: 
@second: 

</