gtk-unused.sgml 51.2 KB
Newer Older
1 2
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
Debugging
3 4


5 6 7 8 9 10 11 12 13
<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
<para>
An action signal. Causes the characters in the current
selection to be copied to the clipboard and then deleted from
the widget.
</para>

@editable: the object which received the signal.

14
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:Short_Description ##### -->
15 16 17



18
<!-- ##### MACRO gtk_marshal_NONE__BOXED ##### -->
19 20 21
<para>

</para>
22 23


Owen Taylor's avatar
Owen Taylor committed
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
<!-- ##### FUNCTION gtk_model_simple_node_inserted ##### -->
<para>

</para>

@simple: 
@path: 
@iter: 

<!-- ##### FUNCTION gtk_widget_newv ##### -->
<para>

</para>

@type: 
@nargs: 
@args: 
@Returns: 

<!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
<para>
A macro to check whether a child widget of the CList
has the focus.
</para>

@clist: The #GtkCList widget to check.

51 52 53
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
<refsect2>
<title>What are Signal Marshallers?</title>
54
<para>
55 56 57 58
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....
59 60
</para>
<para>
61 62 63 64 65 66 67
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.
68 69
</para>
<para>
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
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>
</para>
</refsect2>
<refsect2>
<title>Writing Custom Marshals</title>
<para>
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.
</para>
<para>
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
);
95

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
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>
113
</para>
114
</refsect2>
115 116


117
<!-- ##### SECTION ./tmpl/gtkmenufactory.sgml:Short_Description ##### -->
118 119 120



Owen Taylor's avatar
Owen Taylor committed
121 122 123 124 125 126 127 128 129 130
<!-- ##### FUNCTION gtk_object_class_add_signals ##### -->
<para>
Add an array of signals to a #GtkObjectClass.
Usually this is called when registering a new type of object.
</para>

@klass: the object class to append signals to.
@signals: the signals to append.
@nsignals: the number of signals being appended.

131
<!-- ##### MACRO gtk_marshal_NONE__UINT_STRING ##### -->
Jonathan Blandford's avatar
Jonathan Blandford committed
132 133 134 135 136
<para>

</para>


137
<!-- ##### MACRO GTK_PRIVATE_UNSET_FLAG ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
138 139 140 141
<para>

</para>

142 143
@wid: 
@flag: 
Havoc Pennington's avatar
Havoc Pennington committed
144

145
<!-- ##### MACRO GTK_WIDGET_REDRAW_PENDING ##### -->
146 147 148 149
<para>

</para>

150
@obj: 
151

152
<!-- ##### FUNCTION gtk_icon_factory_get_type ##### -->
153 154 155 156
<para>

</para>

157
@Returns: 
158

Owen Taylor's avatar
Owen Taylor committed
159 160 161 162 163 164
<!-- ##### ARG GtkTextTag:offset-set ##### -->
<para>

</para>


165 166 167 168 169 170 171 172
<!-- ##### FUNCTION gtk_theme_engine_create_rc_style ##### -->
<para>

</para>

@engine: 
@Returns: 

Owen Taylor's avatar
Owen Taylor committed
173 174 175 176 177 178 179 180
<!-- ##### FUNCTION gtk_tree_selection_set_type ##### -->
<para>

</para>

@selection: 
@type: 

181
<!-- ##### MACRO gtk_marshal_NONE__ENUM_FLOAT ##### -->
182 183 184 185 186
<para>

</para>


187 188 189 190 191 192 193 194 195
<!-- ##### FUNCTION gtk_tree_store_new_with_values ##### -->
<para>

</para>

@n_columns: 
@Varargs: 
@Returns: 

196
<!-- ##### SIGNAL GtkTextView::insert ##### -->
197 198 199 200
<para>

</para>

201 202
@textview: the object which received the signal.
@arg1: 
203

204
<!-- ##### MACRO gtk_widget_set_default_visual ##### -->
205 206 207 208
<para>

</para>

209 210
@v: 
@visual: 
211

212
<!-- ##### FUNCTION gtk_window_set_focus ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
213 214 215 216
<para>

</para>

217 218
@window: 
@focus: 
Havoc Pennington's avatar
Havoc Pennington committed
219

220
<!-- ##### SECTION ./tmpl/gtkprivate.sgml:See_Also ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
221 222 223 224 225
<para>

</para>


Owen Taylor's avatar
Owen Taylor committed
226
<!-- ##### FUNCTION gtk_widget_get ##### -->
227 228 229 230
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
231 232
@widget: 
@arg: 
233

234
<!-- ##### MACRO gtk_marshal_NONE__POINTER_UINT_ENUM ##### -->
235 236 237 238 239
<para>

</para>


240 241 242 243 244 245 246
<!-- ##### ARG GtkEditable:editable ##### -->
<para>
A boolean indicating whether the widget is editable by
the user.
</para>


247
<!-- ##### SECTION ./tmpl/gtkmenufactory.sgml:See_Also ##### -->
248
<para>
249

250
</para>
251 252


253
<!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
254
<para>
255
Sets one of the two font filters, to limit the fonts shown.
256 257
</para>

258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
@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.
277

278
<!-- ##### FUNCTION gtk_container_unregister_toplevel ##### -->
279
<para>
280

281 282
</para>

283
@container: 
284

285 286
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
Signal Marshallers
Havoc Pennington's avatar
Havoc Pennington committed
287 288


289 290
<!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Long_Description ##### -->
<para>
291

292
</para>
Havoc Pennington's avatar
Havoc Pennington committed
293

294

295
<!-- ##### STRUCT GtkTypeQuery ##### -->
296
<para>
297
A structure used to return values from @gtk_type_query.
298 299
</para>

300 301 302 303
@type: 
@type_name: 
@object_size: 
@class_size: 
304

Owen Taylor's avatar
Owen Taylor committed
305
<!-- ##### MACRO gtk_widget_pop_visual ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
306 307 308 309
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
310
@v: 
Havoc Pennington's avatar
Havoc Pennington committed
311

Owen Taylor's avatar
Owen Taylor committed
312
<!-- ##### FUNCTION gtk_text_buffer_get_clipboard_contents ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
313 314 315 316
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
317 318
@buffer: 
@Returns: 
Havoc Pennington's avatar
Havoc Pennington committed
319

320
<!-- ##### FUNCTION gtk_marshal_NONE__C_CALLBACK ##### -->
321
<para>
322

323 324
</para>

325 326 327 328
@object: 
@func: 
@func_data: 
@args: 
329

330
<!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
331
<para>
332 333 334 335 336
This is currently a hack left in for a scheme wrapper library.
It may be removed.
</para>
<para>
Don't use it.
337 338
</para>

339 340 341 342 343 344 345
@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.
346

347
<!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
348
<para>
349 350 351
Add an emission hook for a type of signal, for any object.
(with control of what happens when the hook is
destroyed).
352 353
</para>

354 355 356 357 358 359 360 361
@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()).
362

363
<!-- ##### FUNCTION gtk_text_buffer_paste_primary_selection ##### -->
364 365 366 367
<para>

</para>

368 369 370 371 372
@buffer: 
@override_location: 
@time: 
@interactive: 
@default_editable: 
373

374
<!-- ##### FUNCTION gtk_marshal_BOOL__POINTER_INT_INT ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
375 376 377 378
<para>

</para>

379 380 381 382
@object: 
@func: 
@func_data: 
@args: 
Havoc Pennington's avatar
Havoc Pennington committed
383

Owen Taylor's avatar
Owen Taylor committed
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
<!-- ##### FUNCTION gtk_model_simple_node_changed ##### -->
<para>

</para>

@simple: 
@path: 
@iter: 

<!-- ##### FUNCTION gtk_tree_view_column_set_size ##### -->
<para>

</para>

@tree_column: 
@size: 
@width: 

402
<!-- ##### SIGNAL GtkTextView::copy-text ##### -->
403 404 405 406
<para>

</para>

407
@textview: the object which received the signal.
408

409
<!-- ##### FUNCTION gtk_text_view_get_iter_at_pixel ##### -->
410 411 412 413
<para>

</para>

414 415 416 417
@text_view: 
@iter: 
@x: 
@y: 
418

Owen Taylor's avatar
Owen Taylor committed
419 420 421 422 423 424 425 426 427
<!-- ##### FUNCTION gtk_object_getv ##### -->
<para>
Gets an array of argument values from an object.
</para>

@object: the object to get arguments from.
@n_args: the number of arguments to query.
@args: the arguments to fill in.

428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
<!-- ##### STRUCT GtkThemeEngine ##### -->
<para>

</para>


<!-- ##### FUNCTION gtk_text_buffer_get_tags ##### -->
<para>

</para>

@buffer: 
@iter: 
@Returns: 

443
<!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Short_Description ##### -->
444 445


Havoc Pennington's avatar
Havoc Pennington committed
446

447 448 449
<!-- ##### FUNCTION gtk_identifier_get_type ##### -->
<para>
Get the type of GtkIdentifier.
Havoc Pennington's avatar
Havoc Pennington committed
450 451
</para>

452
@Returns: GtkType -- the enumerated type of something.
Havoc Pennington's avatar
Havoc Pennington committed
453

454 455 456 457 458 459 460 461
<!-- ##### FUNCTION gtk_theme_engine_get ##### -->
<para>

</para>

@name: 
@Returns: 

Owen Taylor's avatar
Owen Taylor committed
462 463 464 465 466 467 468 469
<!-- ##### STRUCT GtkModelSimple ##### -->
<para>

</para>

@parent: 
@stamp: 

470
<!-- ##### MACRO gtk_marshal_BOOL__POINTER_INT_INT_UINT ##### -->
471
<para>
472

473 474 475
</para>


Owen Taylor's avatar
Owen Taylor committed
476 477 478 479 480 481 482 483 484
<!-- ##### FUNCTION gtk_model_simple_node_child_toggled ##### -->
<para>

</para>

@simple: 
@path: 
@iter: 

485
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER_POINTER ##### -->
486
<para>
487

488 489
</para>

490 491 492 493
@object: 
@func: 
@func_data: 
@args: 
494

495 496 497 498 499 500 501
<!-- ##### FUNCTION gtk_theme_engine_ref ##### -->
<para>

</para>

@engine: 

502 503
<!-- ##### FUNCTION gtk_marshal_NONE__INT_INT ##### -->
<para>
504

505
</para>
506

507 508 509 510 511
@object: 
@func: 
@func_data: 
@args: 

Owen Taylor's avatar
Owen Taylor committed
512 513 514 515 516 517 518 519 520
<!-- ##### ENUM GtkCellRendererType ##### -->
<para>

</para>

@GTK_CELL_RENDERER_SELECTED: 
@GTK_CELL_RENDERER_PRELIT: 
@GTK_CELL_RENDERER_INSENSITIVE: 

521
<!-- ##### FUNCTION gtk_marshal_NONE__NONE ##### -->
522 523 524 525
<para>

</para>

526 527 528 529
@object: 
@func: 
@func_data: 
@args: 
530

531
<!-- ##### FUNCTION gtk_text_mark_deleted ##### -->
532
<para>
533

534 535
</para>

536 537
@mark: 
@Returns: 
538

539
<!-- ##### MACRO gtk_marshal_BOOL__POINTER_STRING_STRING_POINTER ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
540 541 542 543 544
<para>

</para>


545 546 547 548 549 550 551 552 553 554 555 556
<!-- ##### 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.
</para>

@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 562 563 564 565
<!-- ##### FUNCTION gtk_model_simple_node_deleted ##### -->
<para>

</para>

@simple: 
@path: 
@iter: 

566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
<!-- ##### SIGNAL GtkEditable::delete-text ##### -->
<para>
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()
</para>

@editable: the object which received the signal.
@start_pos: the starting position.
@end_pos: the end position.

583
<!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
584 585 586 587
<para>

</para>

588
@ruler: the gtkruler
589

590
<!-- ##### SIGNAL GtkEditable::kill-line ##### -->
591
<para>
592
An action signal. Delete a single line.
593 594
</para>

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

599
<!-- ##### FUNCTION gtk_themes_init ##### -->
600 601 602 603
<para>

</para>

604 605
@argc: 
@argv: 
606

607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
<!-- ##### FUNCTION gtk_type_register_enum ##### -->
<para>
Register a new set of enum @values and give them the name in
@type_name.
</para>

@type_name: must not be null.
@values: GtkEnumValue*
@Returns: 

<!-- ##### SECTION ./tmpl/gtkmenufactory.sgml:Title ##### -->
Menu Factory


<!-- ##### VARIABLE gtk_debug_flags ##### -->
622 623 624 625 626
<para>

</para>


627
<!-- ##### MACRO gtk_widget_set_visual ##### -->
628
<para>
629

630 631
</para>

632 633 634 635
@w: 
@v: 
@widget: 
@visual: 
636

Owen Taylor's avatar
Owen Taylor committed
637 638 639 640 641 642 643 644 645
<!-- ##### FUNCTION gtk_widget_setv ##### -->
<para>

</para>

@widget: 
@nargs: 
@args: 

646 647 648 649 650 651 652 653 654 655 656 657 658 659
<!-- ##### MACRO gtk_marshal_NONE__UINT_POINTER_UINT_ENUM_ENUM_POINTER ##### -->
<para>

</para>


<!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
<para>
Convert a gtk type into its sequence number
</para>

@type: 

<!-- ##### SECTION ./tmpl/gtkimcontextsimple.sgml:See_Also ##### -->
660 661 662 663 664
<para>

</para>


665
<!-- ##### ENUM GtkMenuFactoryType ##### -->
666
<para>
667

668 669
</para>

670 671 672
@GTK_MENU_FACTORY_MENU: 
@GTK_MENU_FACTORY_MENU_BAR: 
@GTK_MENU_FACTORY_OPTION_MENU: 
673

674
<!-- ##### MACRO gtk_marshal_NONE__STRING ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
675 676 677 678 679
<para>

</para>


680
<!-- ##### MACRO gtk_marshal_NONE__POINTER_POINTER_UINT_UINT ##### -->
681 682 683 684 685
<para>

</para>


686
<!-- ##### MACRO GTK_WIDGET_IS_OFFSCREEN ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
687 688 689 690
<para>

</para>

691
@obj: 
Havoc Pennington's avatar
Havoc Pennington committed
692

693
<!-- ##### MACRO GTK_MAX_COMPOSE_LEN ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
694 695 696 697 698
<para>

</para>


Owen Taylor's avatar
Owen Taylor committed
699 700 701 702 703 704 705 706
<!-- ##### FUNCTION gtk_text_iter_prev_char ##### -->
<para>

</para>

@iter: 
@Returns: 

707 708 709 710 711
<!-- ##### SECTION ./tmpl/gtkprivate.sgml:Short_Description ##### -->



<!-- ##### SIGNAL GtkTextView::cut-text ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
712 713 714 715
<para>

</para>

716
@textview: the object which received the signal.
Havoc Pennington's avatar
Havoc Pennington committed
717

718 719 720 721 722 723 724
<!-- ##### FUNCTION gtk_theme_engine_unref ##### -->
<para>

</para>

@engine: 

Owen Taylor's avatar
Owen Taylor committed
725 726 727 728 729 730
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
<para>

</para>


731 732 733 734 735 736 737
<!-- ##### STRUCT GtkDialogButton ##### -->
<para>
Deprecated.
</para>


<!-- ##### FUNCTION gtk_marshal_BOOL__POINTER ##### -->
738 739 740 741
<para>

</para>

742 743 744 745
@object: 
@func: 
@func_data: 
@args: 
746

747
<!-- ##### FUNCTION gtk_text_buffer_cut ##### -->
748 749 750 751
<para>

</para>

752 753 754 755
@buffer: 
@time: 
@interactive: 
@default_editable: 
756

757 758 759 760 761 762 763 764 765 766 767
<!-- ##### SIGNAL GtkEditable::activate ##### -->
<para>
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.)
</para>

@editable: the object which received the signal.

768 769
<!-- ##### ENUM GtkTextViewMovementStep ##### -->
<para>
770

771
</para>
772

773 774 775 776 777 778 779
@GTK_TEXT_MOVEMENT_CHAR: 
@GTK_TEXT_MOVEMENT_POSITIONS: 
@GTK_TEXT_MOVEMENT_WORD: 
@GTK_TEXT_MOVEMENT_WRAPPED_LINE: 
@GTK_TEXT_MOVEMENT_LINE: 
@GTK_TEXT_MOVEMENT_LINE_ENDS: 
@GTK_TEXT_MOVEMENT_BUFFER_ENDS: 
780

781
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER_POINTER_INT_INT ##### -->
782
<para>
783

784 785
</para>

786 787 788 789
@object: 
@func: 
@func_data: 
@args: 
790

Owen Taylor's avatar
Owen Taylor committed
791 792 793 794 795 796 797
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
<para>
Pixel width of the left margin of the text for lines after the first
line in a wrapped paragraph.
</para>


798
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:See_Also ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
799 800 801 802 803
<para>

</para>


Owen Taylor's avatar
Owen Taylor committed
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
<!-- ##### FUNCTION gtk_paint_oval ##### -->
<para>

</para>

@style: 
@window: 
@state_type: 
@shadow_type: 
@area: 
@widget: 
@detail: 
@x: 
@y: 
@width: 
@height: 

821
<!-- ##### MACRO GTK_CONTAINER_RESIZE_PENDING ##### -->
822
<para>
823

824 825
</para>

826
@obj: 
827

828 829 830 831 832 833 834 835
<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
<para>
An action signal. Causes the characters in the current selection to
be copied to the clipboard.
</para>

@editable: the object which received the signal.

Owen Taylor's avatar
Owen Taylor committed
836 837 838 839 840 841 842 843 844 845 846 847
<!-- ##### FUNCTION gtk_clist_construct ##### -->
<para>
Initializes a previously allocated #GtkCList widget for use.  This should not
normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
</para>

@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.

848
<!-- ##### FUNCTION gtk_menu_factory_remove_entries ##### -->
849 850 851 852
<para>

</para>

853 854 855
@factory: 
@entries: 
@nentries: 
856

857 858 859 860 861 862 863 864 865 866 867 868 869
<!-- ##### FUNCTION gtk_text_buffer_find_string ##### -->
<para>

</para>

@buffer: 
@iter: 
@str: 
@start: 
@end: 
@Returns: 

<!-- ##### FUNCTION gtk_marshal_NONE__INT_POINTER_INT_INT_INT_POINTER ##### -->
870 871 872 873 874 875 876 877 878
<para>

</para>

@object: 
@func: 
@func_data: 
@args: 

879
<!-- ##### FUNCTION gtk_marshal_INT__INT ##### -->
880 881 882 883 884 885 886 887 888
<para>

</para>

@object: 
@func: 
@func_data: 
@args: 

889
<!-- ##### FUNCTION gtk_marshal_NONE__INT_FLOAT_BOOL ##### -->
890 891 892 893
<para>

</para>

894 895 896 897
@object: 
@func: 
@func_data: 
@args: 
898

899 900 901 902 903 904 905 906 907 908
<!-- ##### FUNCTION gtk_paned_compute_position ##### -->
<para>
Internal function used by #GtkHPaned and #GtkVPaned
</para>

@paned: 
@allocation: 
@child1_req: 
@child2_req: 

909
<!-- ##### MACRO gtk_marshal_NONE__POINTER_STRING_STRING ##### -->
910 911 912 913 914
<para>

</para>


915
<!-- ##### FUNCTION gtk_trace_referencing ##### -->
916
<para>
917 918
Private: print debugging information while doing a gtk_object_ref() or 
a gtk_object_unref().
919 920
</para>

921 922 923 924 925
@object: object to reference or unreference.
@func: name of caller's function to print (used within macros).
@dummy: unused.
@line: line number (used within macros).
@do_ref: whether to reference or unreference.
926

927
<!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
928
<para>
929
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
930 931
</para>

932
@a: 
933

934
<!-- ##### MACRO gtk_marshal_NONE__ENUM_FLOAT_BOOL ##### -->
935
<para>
936

937 938 939
</para>


Owen Taylor's avatar
Owen Taylor committed
940 941 942 943 944 945 946 947 948 949 950 951 952 953
<!-- ##### FUNCTION gtk_object_args_collect ##### -->
<para>
Private: Gets an array of #GtkArgs from a va_list C structure.
</para>

@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.

954
<!-- ##### ENUM GtkFontType ##### -->
955
<para>
956 957 958
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().
959 960
</para>

961 962 963 964
@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.
965

966
<!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
967
<para>
968
The last structured enumerated type value.
969 970
</para>

971

972
<!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
973
<para>
974
Get the number of signals defined by this object.
975 976
</para>

977
@obj: the object to query.
978

Owen Taylor's avatar
Owen Taylor committed
979 980 981 982 983 984 985 986 987
<!-- ##### FUNCTION gtk_object_arg_get ##### -->
<para>
Private function to get an argument and argument info from an object.
</para>

@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.

988
<!-- ##### FUNCTION gtk_menu_factory_remove_subfactory ##### -->
989
<para>
990

991 992
</para>

993 994 995
@factory: 
@subfactory: 
@path: 
996

997
<!-- ##### FUNCTION gtk_type_children_types ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
998
<para>
999
Return the pointer to the type's children's types.
Havoc Pennington's avatar
Havoc Pennington committed
1000 1001
</para>

1002 1003
@type: GtkType
@Returns: pointer to a GList
Havoc Pennington's avatar
Havoc Pennington committed
1004

1005 1006 1007 1008 1009 1010 1011 1012 1013
<!-- ##### SIGNAL GtkEditable::move-page ##### -->
<para>
An action signal. Move the cursor by pages.
</para>

@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.

1014
<!-- ##### FUNCTION gtk_type_register_flags ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
1015
<para>
1016 1017
Register a new set of flags @values and give them the name in
@type_name.
Havoc Pennington's avatar
Havoc Pennington committed
1018 1019
</para>

1020 1021 1022
@type_name: must not be null.
@values: GtkFlagValue*
@Returns: 
Havoc Pennington's avatar
Havoc Pennington committed
1023

1024
<!-- ##### SIGNAL GtkTextView::scroll-text ##### -->
1025
<para>
1026

1027
</para>
1028

1029 1030
@textview: the object which received the signal.
@arg1: 
1031

1032
<!-- ##### ENUM GtkPrivateFlags ##### -->
1033
<para>
1034

1035
</para>
1036

1037 1038 1039 1040 1041 1042 1043 1044
@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: 
1045

1046
<!-- ##### FUNCTION gtk_type_set_chunk_alloc ##### -->
1047
<para>
1048
Set the mem_chunk size so it will hold @n_chunks of the objects of that @type.
1049 1050
</para>

1051 1052
@type: There must be an unlocked TypeNode associated with this type otherwise nothing happens.
@n_chunks: 
1053

Owen Taylor's avatar
Owen Taylor committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
<!-- ##### FUNCTION gtk_draw_oval ##### -->
<para>

</para>

@style: 
@window: 
@state_type: 
@shadow_type: 
@x: 
@y: 
@width: 
@height: 

1068
<!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
1069
<para>
1070
The first structured enumerated type value.
1071 1072 1073
</para>


1074
<!-- ##### STRUCT GtkSignalQuery ##### -->
1075
<para>
1076 1077 1078
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.
1079 1080
</para>

1081 1082 1083 1084 1085 1086 1087 1088
@object_type: 
@signal_id: 
@signal_name: 
@is_user_signal: 
@signal_flags: 
@return_val: 
@nparams: 
@params: 
1089

1090
<!-- ##### FUNCTION gtk_type_describe_tree ##### -->
1091
<para>
1092 1093
Given a @type, describe all of its children, and their children.  Only
show the size if @show_size is true.
1094 1095
</para>

1096 1097
@type: GtkType
@show_size: gboolean
1098

1099 1100 1101 1102 1103 1104 1105 1106
<!-- ##### FUNCTION gtk_text_mark_is_visible ##### -->
<para>

</para>

@mark: 
@Returns: 

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

</para>

@object: 
@func: 
@func_data: 
@args: 

1117 1118 1119 1120 1121 1122 1123 1124 1125
<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
<para>
An action signal. Delete a single character.
</para>

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

1126
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:Long_Description ##### -->
1127 1128 1129 1130 1131
<para>

</para>


1132
<!-- ##### FUNCTION gtk_window_remove_embedded_xid ##### -->
1133 1134 1135 1136
<para>

</para>