gtk-unused.sgml 63.4 KB
Newer Older
Owen Taylor's avatar
Owen Taylor 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 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
<!-- ##### SECTION ./tmpl/gtkarg.sgml:Long_Description ##### -->
<para>
All the functions in here are marked a Non-public.
We describe it anyway because it is occasionally useful
to understand how the work is done.
</para>
<para>
Arguments are a way of describing a named parameter to a function.
They have two important roles within gtk+:
<itemizedlist>
<listitem>
<para>
they describe <wordasword>object properties</wordasword>.
This means that they present an interface to get and set a named-type
for any type of object in a consistent way.
(All the relevant functions to do this start with gtk_object_set
or gtk_object_get).
</para>
</listitem>
<listitem>
<para>
they describe <wordasword>signal arguments</wordasword>.
This is a lot less often needed but still useful.
Usually if you are just emitting or creating a particular signal
it is more convenient to just use gtk_signal_emit() or gtk_signal_new().
However if you are writing a function to emit or create an arbitrary
signal, you must use gtk_signal_emitv() or gtk_signal_newv().
</para>
</listitem>
</itemizedlist>
</para>


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


<!-- ##### SECTION ./tmpl/gtkarg.sgml:Short_Description ##### -->
Utility function to manipulate lists of named, typed arguments.


<!-- ##### SECTION ./tmpl/gtkarg.sgml:Title ##### -->
Implementation of Object Properties


Jonathan Blandford's avatar
Jonathan Blandford committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
<!-- ##### SECTION ./tmpl/gtkcellrenderertextpixbuf.sgml:Long_Description ##### -->
<para>

</para>


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

</para>


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



<!-- ##### SECTION ./tmpl/gtkcellrenderertextpixbuf.sgml:Title ##### -->
GtkCellRendererTextPixbuf


Havoc Pennington's avatar
Havoc Pennington committed
68 69 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 95
<!-- ##### 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


96 97
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
Debugging
Owen Taylor's avatar
Owen Taylor committed
98 99


100 101
<!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Title ##### -->
gtkenums.sgml
Owen Taylor's avatar
Owen Taylor committed
102 103


104 105 106
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
<refsect2>
<title>What are Signal Marshallers?</title>
107
<para>
108 109 110 111
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....
112 113
</para>
<para>
114 115 116 117 118 119 120
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.
121 122
</para>
<para>
123 124 125 126 127 128 129 130
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>
131
</para>
132 133 134
</refsect2>
<refsect2>
<title>Writing Custom Marshals</title>
135
<para>
136 137 138
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.
139
</para>
Owen Taylor's avatar
Owen Taylor committed
140
<para>
141 142 143 144 145 146 147
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
);
148

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
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
166
</para>
167
</refsect2>
Owen Taylor's avatar
Owen Taylor committed
168 169


170
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
Jonathan Blandford's avatar
Jonathan Blandford committed
171
<para>
172
<variablelist>
Jonathan Blandford's avatar
Jonathan Blandford committed
173

174 175 176 177 178
<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
179

180 181
</variablelist>
</para>
Havoc Pennington's avatar
Havoc Pennington committed
182 183


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

187

188 189
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
Signal Marshallers
190

191

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
<!-- ##### SECTION ./tmpl/gtkpacker.sgml:Long_Description ##### -->
<para>

</para>


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

</para>


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



<!-- ##### SECTION ./tmpl/gtkpacker.sgml:Title ##### -->
GtkPacker


212 213
<!-- ##### SECTION ./tmpl/gtkprivate.sgml:Title ##### -->
Private Information
214 215


Havoc Pennington's avatar
Havoc Pennington committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
<!-- ##### 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


236
<!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
237
<para>
238 239
A macro to check whether a child widget of the CList
has the focus.
240 241
</para>

242
@clist: The #GtkCList widget to check.
243

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
<!-- ##### 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>


274 275 276 277 278 279 280 281 282 283 284 285 286 287
<!-- ##### MACRO GTK_IS_TIPS_QUERY ##### -->
<para>

</para>

@obj: 

<!-- ##### MACRO GTK_IS_TIPS_QUERY_CLASS ##### -->
<para>

</para>

@klass: 

288
<!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
289
<para>
290
Test whether a GtkObject's arguments have been prepared.
291 292
</para>

293
@obj: the object to examine.
294

295
<!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
Owen Taylor's avatar
Owen Taylor committed
296
<para>
297
Get the number of signals defined by this object.
Owen Taylor's avatar
Owen Taylor committed
298 299
</para>

300
@obj: the object to query.
Owen Taylor's avatar
Owen Taylor committed
301

302
<!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
303
<para>
304
Get the array of signals defined for this object.
305 306
</para>

307
@obj: the object to fetch the signals from.
308

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
<!-- ##### 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>


345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
<!-- ##### MACRO GTK_TIPS_QUERY ##### -->
<para>

</para>

@obj: 

<!-- ##### MACRO GTK_TIPS_QUERY_CLASS ##### -->
<para>

</para>

@klass: 

<!-- ##### MACRO GTK_TIPS_QUERY_GET_CLASS ##### -->
<para>

</para>

@obj: 

Jonathan Blandford's avatar
docs  
Jonathan Blandford committed
366 367 368 369 370 371 372
<!-- ##### MACRO GTK_TREE_MODEL_GET_IFACE ##### -->
<para>

</para>

@obj: 

373
<!-- ##### MACRO GTK_TREE_SELECTION ##### -->
374
<para>
375
A macro that returns a GList that contains the selection of the root tree of @obj.
376 377
</para>

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

380
<!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
381
<para>
382
The first "flat" (no struct) enumerated type value.
383 384 385
</para>


386
<!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
387
<para>
388
The last "flat" (no struct) enumerated type value.
Havoc Pennington's avatar
Havoc Pennington committed
389 390 391
</para>


392
<!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
393
<para>
394
Hide the name of gtk_identifier_get_type
Havoc Pennington's avatar
Havoc Pennington committed
395 396 397
</para>


398
<!-- ##### MACRO GTK_TYPE_MAKE ##### -->
399
<para>
400
Combine a fundemantal type and a sequence number to create a gtk type.
401 402
</para>

403 404
@parent_t: 
@seqno: 
405

406
<!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
407
<para>
408
No idea.
409 410 411
</para>


412
<!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
413
<para>
414
Convert a gtk type into its sequence number
415 416
</para>

417
@type: 
418

419
<!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
420
<para>
421
The first structured enumerated type value.
422
</para>
423 424


425
<!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
426
<para>
427
The last structured enumerated type value.
428 429 430
</para>


431 432 433 434 435 436
<!-- ##### MACRO GTK_TYPE_TIPS_QUERY ##### -->
<para>

</para>


437 438 439 440 441 442
<!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
<para>

</para>


Havoc Pennington's avatar
docs  
Havoc Pennington committed
443 444 445 446 447 448
<!-- ##### MACRO GTK_TYPE_TREE_VIEW_COLUMN ##### -->
<para>

</para>


449
<!-- ##### MACRO GTK_VALUE_ARGS ##### -->
450
<para>
451
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
452 453
</para>

454
@a: 
455

456
<!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
457
<para>
458
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
459
</para>
Havoc Pennington's avatar
Havoc Pennington committed
460

461
@a: 
462

463
<!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
464
<para>
465
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
466 467
</para>

468
@a: 
469

470
<!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
471
<para>
472
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
Havoc Pennington's avatar
Havoc Pennington committed
473 474
</para>

475
@a: 
Havoc Pennington's avatar
Havoc Pennington committed
476

Tim Janik's avatar
Tim Janik committed
477 478 479 480 481 482 483 484 485
<!-- ##### USER_FUNCTION GValueCompareFunc ##### -->
<para>

</para>

@a: 
@b: 
@Returns: 

486 487 488 489 490 491 492 493 494 495 496 497
<!-- ##### STRUCT GtkAccelEntry ##### -->
<para>
This is a private struct used by GTK+ internally, don't worry about it.
</para>

@accel_group: 
@accelerator_key: 
@accelerator_mods: 
@accel_flags: 
@object: 
@signal_id: 

498
<!-- ##### ARG GtkAccelLabel:accel-object ##### -->
499
<para>
500

501 502 503
</para>


504 505 506 507 508 509
<!-- ##### ARG GtkAccelLabel:accel-width ##### -->
<para>

</para>


510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
<!-- ##### ENUM GtkAnchorType ##### -->
<para>

</para>

@GTK_ANCHOR_CENTER: 
@GTK_ANCHOR_NORTH: 
@GTK_ANCHOR_NORTH_WEST: 
@GTK_ANCHOR_NORTH_EAST: 
@GTK_ANCHOR_SOUTH: 
@GTK_ANCHOR_SOUTH_WEST: 
@GTK_ANCHOR_SOUTH_EAST: 
@GTK_ANCHOR_WEST: 
@GTK_ANCHOR_EAST: 
@GTK_ANCHOR_N: 
@GTK_ANCHOR_NW: 
@GTK_ANCHOR_NE: 
@GTK_ANCHOR_S: 
@GTK_ANCHOR_SW: 
@GTK_ANCHOR_SE: 
@GTK_ANCHOR_W: 
@GTK_ANCHOR_E: 

533 534 535 536 537 538 539 540 541
<!-- ##### USER_FUNCTION GtkArgGetFunc ##### -->
<para>
Define a function pointer.  Deprecated.
</para>

@object: 
@arg: 
@arg_id: 

Owen Taylor's avatar
Owen Taylor committed
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
<!-- ##### STRUCT GtkArgInfo ##### -->
<para>
A structure containing information about the argument.
Returned by gtk_arg_get_info().
</para>

@class_type: if the argument is an object, this is the object class type.
@name: the name of the argument.
@type: the type of the argument; it may be an object's type
or a fundamental type.
@arg_flags: flags applicable to the argument (i.e. readable, writable,
and whether it needs to be constructed).
@full_name: the object name and argument name separated by ::,
e.g. "GtkObject::user_data" or "GtkButton::label".
@arg_id: the unique argument identified.
@seq_id: ???

559 560 561 562 563 564 565 566 567
<!-- ##### USER_FUNCTION GtkArgSetFunc ##### -->
<para>
Define a function pointer.  Deprecated.
</para>

@object: 
@arg: 
@arg_id: 

568 569 570 571 572 573 574
<!-- ##### STRUCT GtkCellRendererTextPixbuf ##### -->
<para>

</para>

@parent: 

Owen Taylor's avatar
Owen Taylor committed
575 576 577 578 579 580 581 582 583 584 585 586
<!-- ##### ARG GtkColorSelection:previous-alpha ##### -->
<para>

</para>


<!-- ##### ARG GtkColorSelection:previous-color ##### -->
<para>

</para>


587 588 589 590 591 592 593 594 595
<!-- ##### SIGNAL GtkContainer::focus ##### -->
<para>

</para>

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

596 597 598 599 600 601
<!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
<para>

</para>


Havoc Pennington's avatar
Delete.  
Havoc Pennington committed
602 603 604 605 606 607 608 609 610 611 612 613 614 615
<!-- ##### 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.

616
<!-- ##### SIGNAL GtkEditable::activate ##### -->
617
<para>
618 619 620 621 622
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.)
623 624
</para>

625
@editable: the object which received the signal.
626

627
<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
628
<para>
629 630
An action signal. Causes the characters in the current selection to
be copied to the clipboard.
631 632
</para>

633
@editable: the object which received the signal.
634

635
<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
636
<para>
637 638 639
An action signal. Causes the characters in the current
selection to be copied to the clipboard and then deleted from
the widget.
640 641
</para>

642
@editable: the object which received the signal.
643

644
<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
645
<para>
646
An action signal. Delete a single character.
647
</para>
648 649 650 651 652 653

@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 ##### -->
654
<para>
655
An action signal. Delete a single line.
656
</para>
657 658 659 660 661 662

@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 ##### -->
663
<para>
664
An action signal. Delete a single word.
665 666
</para>

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

671
<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
672
<para>
673
An action signal. Move the cursor position.
674 675
</para>

676 677 678
@editable: the object which received the signal.
@x: horizontal distance to move the cursor.
@y: vertical distance to move the cursor.
679

680
<!-- ##### SIGNAL GtkEditable::move-page ##### -->
681
<para>
682
An action signal. Move the cursor by pages.
683 684
</para>

685 686 687
@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.
688

689
<!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
690
<para>
691
An action signal. Move the cursor to the given column.
692
</para>
693 694 695 696 697 698

@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 ##### -->
699
<para>
700
An action signal. Move the cursor to the given row.
701 702
</para>

703 704 705
@editable: the object which received the signal.
@row: the row to move to. (A negative value indicates 
      the last row)
706

707
<!-- ##### SIGNAL GtkEditable::move-word ##### -->
708
<para>
709
An action signal. Move the cursor by words.
710 711
</para>

712 713 714
@editable: the object which received the signal.
@num_words: The number of words to move the
cursor. (Can be negative).
715

716
<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
717
<para>
718 719 720
An action signal. Causes the contents of the clipboard to
be pasted into the editable widget at the current cursor
position.
721 722
</para>

723
@editable: the object which received the signal.
724

725 726 727 728 729 730
<!-- ##### 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.
731 732
</para>

733 734 735
@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
736

737 738 739 740
<!-- ##### ARG GtkEditable:editable ##### -->
<para>
A boolean indicating whether the widget is editable by
the user.
Owen Taylor's avatar
Owen Taylor committed
741 742 743
</para>


744
<!-- ##### ARG GtkEditable:text-position ##### -->
745
<para>
746
The position of the cursor.
747 748 749
</para>


Havoc Pennington's avatar
Havoc Pennington committed
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
<!-- ##### 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: 

768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
<!-- ##### SIGNAL GtkEntry::changed ##### -->
<para>

</para>

@entry: the object which received the signal.

<!-- ##### SIGNAL GtkEntry::delete-text ##### -->
<para>

</para>

@entry: the object which received the signal.
@arg1: 
@arg2: 

<!-- ##### SIGNAL GtkEntry::insert-text ##### -->
<para>

</para>

@entry: the object which received the signal.
@arg1: 
@arg2: 
@arg3: 

794 795 796 797 798 799
<!-- ##### ARG GtkEntry:text-position ##### -->
<para>

</para>


800
<!-- ##### ENUM GtkFontFilterType ##### -->
801
<para>
802 803 804
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().
805 806
</para>

807 808 809
@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.
810

811
<!-- ##### ENUM GtkFontType ##### -->
812
<para>
813 814 815
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().
816 817
</para>

818 819 820 821
@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.
822

823 824 825 826 827 828 829 830 831 832 833 834
<!-- ##### ARG GtkHScale:adjustment ##### -->
<para>
the #GtkAdjustment which sets the range of the scale.
</para>


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

</para>


Owen Taylor's avatar
Owen Taylor committed
835 836 837 838 839 840 841 842 843 844 845 846 847
<!-- ##### USER_FUNCTION GtkImageLoader ##### -->
<para>
A GtkImageLoader is used to load a filename found in
a RC file.
</para>

@window: the window for creating image
@colormap: the colormap for this image
@mask: a pointer to the location to store the mask
@transparent_color: the transparent color for the image
@filename: filename to load
@Returns: a #GtkPixmap representing @filename

848 849 850 851 852 853
<!-- ##### ARG GtkLabel:accel-keyval ##### -->
<para>

</para>


854
<!-- ##### ARG GtkObject:object-signal ##### -->
855
<para>
856 857 858
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.
859 860
</para>
<para>
861 862 863 864
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.
865 866 867
</para>


868
<!-- ##### ARG GtkObject:object-signal-after ##### -->
869
<para>
870 871 872 873
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.
874 875
</para>
<para>
876
See gtk_signal_connect_object_after() for more details.
877 878 879
</para>


880
<!-- ##### ARG GtkObject:signal ##### -->
881
<para>
882 883
Setting this with a GtkType of GTK_TYPE_SIGNAL connects
the signal to the object.
884 885 886
</para>


887
<!-- ##### ARG GtkObject:signal-after ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
888
<para>
889 890 891
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
892 893
</para>

894

895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
<!-- ##### SIGNAL GtkOldEditable::changed ##### -->
<para>

</para>

@oldeditable: the object which received the signal.

<!-- ##### SIGNAL GtkOldEditable::delete-text ##### -->
<para>

</para>

@oldeditable: the object which received the signal.
@arg1: 
@arg2: 

<!-- ##### SIGNAL GtkOldEditable::insert-text ##### -->
<para>

</para>

@oldeditable: the object which received the signal.
@arg1: 
@arg2: 
@arg3: 

921 922 923 924 925 926 927 928 929 930 931 932 933 934
<!-- ##### STRUCT GtkPacker ##### -->
<para>

</para>

@parent: 
@children: 
@spacing: 
@default_border_width: 
@default_pad_x: 
@default_pad_y: 
@default_i_pad_x: 
@default_i_pad_y: 

Owen Taylor's avatar
Owen Taylor committed
935 936 937 938 939 940 941 942 943 944 945 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
<!-- ##### ARG GtkPacker:default-border-width ##### -->
<para>

</para>


<!-- ##### ARG GtkPacker:default-ipad-x ##### -->
<para>

</para>


<!-- ##### ARG GtkPacker:default-ipad-y ##### -->
<para>

</para>


<!-- ##### ARG GtkPacker:default-pad-x ##### -->
<para>

</para>


<!-- ##### ARG GtkPacker:default-pad-y ##### -->
<para>

</para>


<!-- ##### ARG GtkPacker:spacing ##### -->
<para>

</para>


971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
<!-- ##### STRUCT GtkPackerChild ##### -->
<para>

</para>

@widget: 
@anchor: 
@side: 
@options: 
@use_default: 
@border_width: 
@pad_x: 
@pad_y: 
@i_pad_x: 
@i_pad_y: 

<!-- ##### ENUM GtkPackerOptions ##### -->
<para>

</para>

@GTK_PACK_EXPAND: 
@GTK_FILL_X: 
@GTK_FILL_Y: 

Tim Janik's avatar
Tim Janik committed
996 997 998 999 1000 1001
<!-- ##### ARG GtkPaned:handle-size ##### -->
<para>

</para>


1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
<!-- ##### STRUCT GtkPatternSpec ##### -->
<para>

</para>

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

1014
<!-- ##### ENUM GtkPrivateFlags ##### -->
1015
<para>
1016

1017 1018
</para>

1019 1020 1021 1022 1023 1024 1025 1026
@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: 
1027

Owen Taylor's avatar
Owen Taylor committed
1028 1029 1030 1031 1032 1033
<!-- ##### ARG GtkScrolledWindow:shadow ##### -->
<para>

</para>


1034 1035 1036 1037 1038 1039
<!-- ##### ARG GtkSettings:gtk-dnd-drag-threshold ##### -->
<para>

</para>


1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
<!-- ##### ENUM GtkSideType ##### -->
<para>

</para>

@GTK_SIDE_TOP: 
@GTK_SIDE_BOTTOM: 
@GTK_SIDE_LEFT: 
@GTK_SIDE_RIGHT: 

1050
<!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
1051
<para>
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
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).
1063 1064
</para>

1065 1066
@data: The user data associated with the hook that is being
destroyed.
1067

1068
<!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
1069
<para>
1070 1071
This is currently a hack left in for a scheme wrapper library.
It may be removed.
1072 1073
</para>
<para>
1074
Don't use it.
1075 1076
</para>

1077 1078 1079 1080 1081 1082 1083
@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.
1084

1085
<!-- ##### STRUCT GtkSignalQuery ##### -->
1086
<para>
1087 1088 1089
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.
1090 1091
</para>

1092 1093 1094 1095 1096 1097 1098 1099
@object_type: 
@signal_id: 
@signal_name: 
@is_user_signal: 
@signal_flags: 
@return_val: 
@nparams: 
@params: 
1100

1101 1102 1103 1104 1105 1106
<!-- ##### ARG GtkSpinButton:shadow-type ##### -->
<para>
the type of border that surrounds the arrows of a spin button.
</para>


1107
<!-- ##### STRUCT GtkStatusbarMsg ##### -->
1108
<para>
1109
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.
1110 1111
</para>

1112 1113 1114
@text: 
@context_id: 
@message_id: 
1115

1116
<!-- ##### ARG GtkTextTag:justify ##### -->
1117
<para>
1118 1119
A #GtkJustification for the text. This is only used when the tag is
applied to the first character in a paragraph.
1120 1121 1122
</para>


1123
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
1124
<para>
1125 1126
Pixel width of the left margin of the text for lines after the first
line in a wrapped paragraph.
1127 1128 1129
</para>


1130
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
1131 1132 1133 1134 1135
<para>

</para>


1136
<!-- ##### ARG GtkTextTag:offset ##### -->
1137
<para>
1138 1139
Pixels to offset the text horizontally or vertically, useful to
produce superscript and subscript.
1140 1141 1142
</para>


1143 1144 1145 1146 1147 1148
<!-- ##### ARG GtkTextView:height-lines ##### -->
<para>

</para>


Havoc Pennington's avatar
Havoc Pennington committed
1149 1150 1151 1152 1153 1154
<!-- ##### ARG GtkTextView:justify ##### -->
<para>

</para>


1155 1156 1157 1158 1159 1160
<!-- ##### ARG GtkTextView:width-columns ##### -->
<para>

</para>


Havoc Pennington's avatar
docs  
Havoc Pennington committed
1161 1162 1163 1164 1165 1166
<!-- ##### STRUCT GtkTreeSelectionClass ##### -->
<para>

</para>


Havoc Pennington's avatar
Havoc Pennington committed
1167 1168 1169 1170 1171 1172 1173 1174
<!-- ##### ENUM GtkTreeSelectionMode ##### -->
<para>

</para>

@GTK_TREE_SELECTION_SINGLE: 
@GTK_TREE_SELECTION_MULTI: 

1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
<!-- ##### USER_FUNCTION GtkTreeViewDraggableFunc ##### -->
<para>

</para>

@tree_view: 
@context: 
@path: 
@user_data: 
@Returns: 

<!-- ##### USER_FUNCTION GtkTreeViewDroppableFunc ##### -->
<para>

</para>

@tree_view: 
@context: 
@path: 
@pos: 
@user_data: 
@Returns: 

1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209
<!-- ##### ARG GtkVScale:adjustment ##### -->
<para>
the #GtkAdjustment which sets the range of the scale.
</para>


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

</para>


1210 1211 1212 1213 1214 1215 1216 1217 1218
<!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
<para>

</para>

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

1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
<!-- ##### SIGNAL GtkWidget::add-accelerator ##### -->
<para>

</para>

@widget: the object which received the signal.
@accel_signal_id: 
@accel_group: 
@accel_key: 
@accel_mods: 
@accel_flags: 

1231 1232 1233 1234 1235 1236 1237 1238
<!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
<para>

</para>

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

1239
<!-- ##### SIGNAL GtkWidget::draw ##### -->
1240 1241 1242 1243
<para>

</para>

1244 1245
@widget: the object which received the signal.
@area: 
1246

1247
<!-- ##### SIGNAL GtkWidget::draw-default ##### -->
1248 1249 1250 1251
<para>

</para>

1252
@widget: the object which received the signal.
1253

1254
<!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
1255 1256 1257 1258
<para>

</para>

1259
@widget: the object which received the signal.
Havoc Pennington's avatar
Havoc Pennington committed
1260

1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
<!-- ##### SIGNAL GtkWidget::remove-accelerator ##### -->
<para>

</para>

@widget: the object which received the signal.
@accel_group: 
@accel_key: 
@accel_mods: 

Havoc Pennington's avatar
Havoc Pennington committed
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
<!-- ##### ARG GtkWidget:height ##### -->
<para>

</para>


<!-- ##### ARG GtkWidget:width ##### -->
<para>

</para>


<!-- ##### ARG GtkWidget:x ##### -->
<para>

</para>


<!-- ##### ARG GtkWidget:y ##### -->
<para>

</para>


<!-- ##### ARG GtkWindow:auto-shrink ##### -->
<para>
If the window shrinks automatically when widgets within it shrink.
</para>


Havoc Pennington's avatar
Havoc Pennington committed
1301 1302 1303 1304 1305 1306
<!-- ##### ARG GtkWindow:icon-list ##### -->
<para>

</para>


1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
<!-- ##### FUNCTION gtk_accel_group_activate ##### -->
<para>

</para>

@accel_group: 
@accel_key: 
@accel_mods: 
@Returns: 

<!-- ##### FUNCTION gtk_accel_group_add ##### -->
<para>

</para>

@accel_group: 
@path: 
@accel_key: 
@accel_mods: 
@accel_flags: 
@object: 
@accel_signal: 

<!-- ##### FUNCTION gtk_accel_group_attach ##### -->
<para>

</para>

@accel_group: 
@object: 

1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
<!-- ##### FUNCTION gtk_accel_group_create_add ##### -->
<para>

</para>

@class_type: 
@signal_flags: 
@handler_offset: 
@Returns: 

<!-- ##### FUNCTION gtk_accel_group_create_remove ##### -->
<para>

</para>

@class_type: 
@signal_flags: 
@handler_offset: 
@Returns: 

1358 1359 1360 1361 1362 1363 1364 1365
<!-- ##### FUNCTION gtk_accel_group_detach ##### -->
<para>

</para>

@accel_group: 
@object: 

1366 1367 1368 1369 1370 1371 1372 1373
<!-- ##### FUNCTION gtk_accel_group_entries_from_object ##### -->
<para>

</para>

@object: 
@Returns: 

1374 1375 1376 1377 1378 1379 1380
<!-- ##### FUNCTION gtk_accel_group_get_default ##### -->
<para>

</para>

@Returns: 

1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
<!-- ##### FUNCTION gtk_accel_group_get_entry ##### -->
<para>

</para>

@accel_group: 
@accel_key: 
@accel_mods: 
@Returns: 

<!-- ##### FUNCTION gtk_accel_group_handle_add ##### -->
<para>

</para>

@object: 
@accel_signal_id: 
@accel_group: 
@accel_key: 
@accel_mods: 
@accel_flags: 

<!-- ##### FUNCTION gtk_accel_group_handle_remove ##### -->
<para>

</para>

@object: 
@accel_group: 
@accel_key: 
@accel_mods: 

<!-- ##### FUNCTION gtk_accel_group_lock_entry ##### -->
<para>

</para>

@accel_group: 
@accel_key: 
@accel_mods: 

1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
<!-- ##### MACRO gtk_accel_group_ref ##### -->
<para>

</para>

@Returns: 
@accel_group: 

<!-- ##### FUNCTION gtk_accel_group_remove ##### -->
<para>

</para>

@accel_group: 
@accel_key: 
@accel_mods: 
@object: 

1440 1441 1442 1443 1444 1445 1446 1447 1448
<!-- ##### FUNCTION gtk_accel_group_unlock_entry ##### -->
<para>

</para>

@accel_group: 
@accel_key: 
@accel_mods: 

1449 1450 1451 1452 1453 1454 1455
<!-- ##### MACRO gtk_accel_group_unref ##### -->
<para>

</para>

@accel_group: 

1456 1457 1458 1459 1460 1461 1462 1463
<!-- ##### FUNCTION gtk_accel_groups_from_object ##### -->
<para>

</para>

@object: 
@Returns: 

1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
<!-- ##### FUNCTION gtk_accel_label_get_accel_object ##### -->
<para>

</para>

@accel_label: 
@Returns: 

<!-- ##### FUNCTION gtk_accel_label_set_accel_object ##### -->
<para>

</para>

@accel_label: 
@accel_object: 

Owen Taylor's avatar
Owen Taylor committed
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
<!-- ##### FUNCTION gtk_arg_copy ##### -->
<para>
It will either copy data into an existing argument or allocate a new argument
and copy the data.  Strings are duplicated.  All other pointers and
values are copied (shallowly-- that is the pointers themselves are
copied, not the data they point to.)
</para>
<para>
You should call gtk_arg_reset() on dest_arg before calling this
if the argument may contain string data that you want freed.
</para>

@src_arg: the argument to duplicate.
@dest_arg: the argument to copy over (or NULL to create a new #GtkArg).
@Returns: the new #GtkArg (or dest_arg, if it was not NULL).

<!-- ##### FUNCTION gtk_arg_free ##### -->
<para>
Frees the argument, and optionally its contents.
</para>

@arg: the argument to free.
@free_contents: whether to free the string, if it is a string.

<!-- ##### FUNCTION gtk_arg_get_info ##### -->
<para>
Private: get information about an argument.
</para>

@object_type: the type of object.
@arg_info_hash_table: the hashtable of #GtkArgInfos.
@arg_name: the name of the argument to lookup.
@info_p: the argument info.
@Returns: an error message on failure, or NULL otherwise.

<!-- ##### FUNCTION gtk_arg_info_equal ##### -->
<para>
A #GCompareFunc for hashing #GtkArgInfos.
</para>

@arg_info_1: a #GtkArgInfo.
@arg_info_2: a #GtkArgInfo.
@Returns: whether the arguments are the same.

<!-- ##### FUNCTION gtk_arg_info_hash ##### -->
<para>
A #GHashFunc for hashing #GtkArgInfos.
</para>

@arg_info: a #GtkArgInfo.
@Returns: a hash value for that #GtkArgInfo.

<!-- ##### FUNCTION gtk_arg_name_strip_type ##### -->
<para>
Given a fully qualified argument name (e.g. "GtkButton::label")
it returns just the argument name (e.g. "label") unless
the argument name was invalid, in which case it returns NULL.
</para>

@arg_name: the fully-qualified argument name.
@Returns: the base argument name.

<!-- ##### FUNCTION gtk_arg_new ##### -->
<para>
Creates a new argument of a certain type, set to 0 or NULL.
</para>

@arg_type: the type of the argument.
@Returns: the newly created #GtkArg.

<!-- ##### FUNCTION gtk_arg_reset ##### -->
<para>

</para>

@arg: 

<!-- ##### FUNCTION gtk_arg_to_valueloc ##### -->
<para>

</para>

@arg: 
@value_pointer: 

<!-- ##### FUNCTION gtk_arg_type_new_static ##### -->
<para>
Create a new argument registered with a class.
</para>

@base_class_type: the basic type having the arguments, almost alway
GTK_TYPE_OBJECT, except if your defining a different type argument
that gets a different namespace.  #GtkContainer does this to define
per-child arguments of the container.
@arg_name: name of the argument to create.  (must be a static constant string)
@class_n_args_offset: offset into the base class structure that tells
the number of arguments.
@arg_info_hash_table: hashtable of #GtkArgInfos.
@arg_type: type of the argument.
@arg_flags: flags of the argument.
@arg_id: ???
@Returns: the new #GtkArgInfo.

<!-- ##### FUNCTION gtk_arg_values_equal ##### -->
<para>

</para>

@arg1: 
@arg2: 
@Returns: 

<!-- ##### FUNCTION gtk_args_collect ##### -->
<para>
Private:  given a hashtable of argument information it takes a vararg
list and parses it into arguments (in the form of lists of #GtkArgs
and lists of #GtkArgInfos.
</para>
<para>
The list of arguments starts with first_arg_name then the first argument's
value.  Followed by any number of additional name/argument pairs,
terminated with NULL.
</para>

@object_type: the type of object we are collecting arguments for.
@arg_info_hash_table: a hashtable mapping from names of arguments
to their #GtkArgInfos.
@arg_list_p: a returned list of arguments obtained from parsing the
varargs.
@info_list_p: a returned list of the #GtkArgInfos.
@first_arg_name: the name of the first argument.
@var_args: a va_list containing the value of the first argument,
followed by name/value pairs, followed by NULL.
@Returns: an error message on failure, or NULL otherwise.

<!-- ##### FUNCTION gtk_args_collect_cleanup ##### -->
<para>
Private: erase lists of arguments returned from gtk_args_collect().
</para>

@arg_list: arg_list_p returned from gtk_args_collect().
@info_list: info_list_p returned from gtk_args_collect().

<!-- ##### FUNCTION gtk_args_query ##### -->
<para>
Private: from a class type and its arginfo hashtable,
get an array of #GtkArgs that this object accepts.
</para>

@class_type: the class type.
@arg_info_hash_table: the hashtable of #GtkArgInfos.
@arg_flags: returned array of argument flags.
@n_args_p: the number of arguments this object accepts.
@Returns: the array of arguments (or NULL on error).

1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
<!-- ##### 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.

1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
<!-- ##### FUNCTION gtk_button_new_accel ##### -->
<para>

</para>

@uline_label: 
@accel_group: 
@Returns: 

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

</para>

@stock_id: 
@accel_group: 
@Returns: 

1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713
<!-- ##### FUNCTION gtk_cell_renderer_event ##### -->
<para>

</para>

@cell: 
@event: 
@widget: 
@path: 
@background_area: 
@cell_area: 
@flags: 
@Returns: 

1714 1715 1716 1717 1718 1719 1720
<!-- ##### FUNCTION gtk_cell_renderer_text_pixbuf_new ##### -->
<para>

</para>

@Returns: 

1721
<!-- ##### FUNCTION gtk_clist_construct ##### -->
1722
<para>
1723 1724
Initializes a previously allocated #GtkCList widget for use.  This should not
normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
1725 1726
</para>

1727 1728 1729 1730 1731
@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.
1732

1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764
<!-- ##### 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: 

1765
<!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
1766
<para>
1767 1768 1769 1770 1771
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.
1772 1773
</para>

1774 1775 1776
@colorsel: a #GtkColorSelection.
@use_opacity: a boolean indicating whether the opacity selection
is enabled.
1777

1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793
<!-- ##### FUNCTION gtk_color_selection_set_use_opacity ##### -->
<para>

</para>

@colorsel: 
@use_opacity: 

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

</para>

@colorsel: 
@use_palette: 

Owen Taylor's avatar
Owen Taylor committed
1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885
<!-- ##### FUNCTION gtk_container_add_child_arg_type ##### -->
<para>

</para>

@arg_name: 
@arg_type: 
@arg_flags: 
@arg_id: 

<!-- ##### FUNCTION gtk_container_add_with_args ##### -->
<para>

</para>

@container: 
@widget: 
@first_arg_name: 
@Varargs: 

<!-- ##### FUNCTION gtk_container_addv ##### -->
<para>

</para>

@container: 
@widget: 
@n_args: 
@args: 

<!-- ##### FUNCTION gtk_container_arg_get ##### -->
<para>

</para>

@container: 
@child: 
@arg: 
@info: 

<!-- ##### FUNCTION gtk_container_arg_set ##### -->
<para>

</para>

@container: 
@child: 
@arg: 
@info: 

<!-- ##### FUNCTION gtk_container_child_arg_get_info ##### -->
<para>

</para>

@object_type: 
@arg_name: 
@info_p: 
@Returns: 

<!-- ##### FUNCTION gtk_container_child_args_collect ##### -->
<para>

</para>

@object_type: 
@arg_list_p: 
@info_list_p: 
@first_arg_name: 
@args: 
@Returns: 

<!-- ##### FUNCTION gtk_container_child_getv ##### -->
<para>

</para>

@container: 
@child: 
@n_args: 
@args: 

<!-- ##### FUNCTION gtk_container_child_setv ##### -->
<para>

</para>

@container: 
@child: 
@n_args: 
@args: 

Tim Janik's avatar
Tim Janik committed
1886 1887 1888 1889 1890 1891 1892
<!-- ##### FUNCTION gtk_container_dequeue_resize_handler ##### -->
<para>

</para>

@container: 

Havoc Pennington's avatar
Havoc Pennington committed
1893 1894 1895 1896 1897 1898 1899 1900 1901
<!-- ##### FUNCTION gtk_container_focus ##### -->
<para>

</para>

@container: 
@direction: 
@Returns: 

Owen Taylor's avatar
Owen Taylor committed
1902 1903 1904 1905 1906 1907 1908 1909 1910 1911
<!-- ##### FUNCTION gtk_container_query_child_args ##### -->
<para>

</para>

@class_type: 
@arg_flags: 
@nargs: 
@Returns: 

1912
<!-- ##### FUNCTION gtk_ctree_construct ##### -->
1913
<para>
1914
This function is not usually used by users.