gtk-unused.sgml 52.1 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


Havoc Pennington's avatar
Havoc Pennington committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
<!-- ##### 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


76 77
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
Debugging
Owen Taylor's avatar
Owen Taylor committed
78 79


80 81
<!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Title ##### -->
gtkenums.sgml
Owen Taylor's avatar
Owen Taylor committed
82 83


84 85
<!-- ##### SECTION ./tmpl/gtkimcontextsimple.sgml:Title ##### -->
GtkIMContextSimple
Owen Taylor's avatar
Owen Taylor committed
86 87


88 89 90
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
<refsect2>
<title>What are Signal Marshallers?</title>
91
<para>
92 93 94 95
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....
96 97
</para>
<para>
98 99 100 101 102 103 104
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.
105 106
</para>
<para>
107 108 109 110 111 112 113 114
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>
115
</para>
116 117 118
</refsect2>
<refsect2>
<title>Writing Custom Marshals</title>
119
<para>
120 121 122
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.
123
</para>
Owen Taylor's avatar
Owen Taylor committed
124
<para>
125 126 127 128 129 130 131
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
);
132

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
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
150
</para>
151
</refsect2>
Owen Taylor's avatar
Owen Taylor committed
152 153


154
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
Jonathan Blandford's avatar
Jonathan Blandford committed
155
<para>
156
<variablelist>
Jonathan Blandford's avatar
Jonathan Blandford committed
157

158 159 160 161 162
<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
163

164 165
</variablelist>
</para>
Havoc Pennington's avatar
Havoc Pennington committed
166 167


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

171

172 173
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
Signal Marshallers
174

175

176 177
<!-- ##### SECTION ./tmpl/gtkprivate.sgml:Title ##### -->
Private Information
178 179


Havoc Pennington's avatar
Havoc Pennington committed
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
<!-- ##### 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


200
<!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
201
<para>
202 203
A macro to check whether a child widget of the CList
has the focus.
204 205
</para>

206
@clist: The #GtkCList widget to check.
207

208 209 210 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
<!-- ##### 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>


238
<!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
239
<para>
240
Test whether a GtkObject's arguments have been prepared.
241 242
</para>

243
@obj: the object to examine.
244

245
<!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
Owen Taylor's avatar
Owen Taylor committed
246
<para>
247
Get the number of signals defined by this object.
Owen Taylor's avatar
Owen Taylor committed
248 249
</para>

250
@obj: the object to query.
Owen Taylor's avatar
Owen Taylor committed
251

252
<!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
253
<para>
254
Get the array of signals defined for this object.
255 256
</para>

257
@obj: the object to fetch the signals from.
258

259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
<!-- ##### 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>


295
<!-- ##### MACRO GTK_TREE_SELECTION ##### -->
296
<para>
297
A macro that returns a GList that contains the selection of the root tree of @obj.
298 299
</para>

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

302
<!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
303
<para>
304
The first "flat" (no struct) enumerated type value.
305 306 307
</para>


308
<!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
309
<para>
310
The last "flat" (no struct) enumerated type value.
Havoc Pennington's avatar
Havoc Pennington committed
311 312 313
</para>


314
<!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
315
<para>
316
Hide the name of gtk_identifier_get_type
Havoc Pennington's avatar
Havoc Pennington committed
317 318 319
</para>


320
<!-- ##### MACRO GTK_TYPE_MAKE ##### -->
321
<para>
322
Combine a fundemantal type and a sequence number to create a gtk type.
323 324
</para>

325 326
@parent_t: 
@seqno: 
327

328
<!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
329
<para>
330
No idea.
331 332 333
</para>


334
<!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
335
<para>
336
Convert a gtk type into its sequence number
337 338
</para>

339
@type: 
340

341
<!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
342
<para>
343
The first structured enumerated type value.
344
</para>
345 346


347
<!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
348
<para>
349
The last structured enumerated type value.
350 351 352
</para>


353 354 355 356 357 358
<!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
<para>

</para>


359
<!-- ##### MACRO GTK_VALUE_ARGS ##### -->
360
<para>
361
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
362 363
</para>

364
@a: 
365

366
<!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
367
<para>
368
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
369
</para>
Havoc Pennington's avatar
Havoc Pennington committed
370

371
@a: 
372

373
<!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
374
<para>
375
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
376 377
</para>

378
@a: 
379

380
<!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
381
<para>
382
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
Havoc Pennington's avatar
Havoc Pennington committed
383 384
</para>

385
@a: 
Havoc Pennington's avatar
Havoc Pennington committed
386

387 388 389 390 391 392
<!-- ##### ARG GtkAccelLabel:accel-width ##### -->
<para>

</para>


393 394 395 396 397 398 399 400 401
<!-- ##### USER_FUNCTION GtkArgGetFunc ##### -->
<para>
Define a function pointer.  Deprecated.
</para>

@object: 
@arg: 
@arg_id: 

Owen Taylor's avatar
Owen Taylor committed
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
<!-- ##### 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: ???

419 420 421 422 423 424 425 426 427
<!-- ##### USER_FUNCTION GtkArgSetFunc ##### -->
<para>
Define a function pointer.  Deprecated.
</para>

@object: 
@arg: 
@arg_id: 

428 429 430 431 432 433 434 435 436
<!-- ##### SIGNAL GtkContainer::focus ##### -->
<para>

</para>

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

437 438 439 440 441 442
<!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
<para>

</para>


Havoc Pennington's avatar
Delete.  
Havoc Pennington committed
443 444 445 446 447 448 449 450 451 452 453 454 455 456
<!-- ##### 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.

457
<!-- ##### SIGNAL GtkEditable::activate ##### -->
458
<para>
459 460 461 462 463
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.)
464 465
</para>

466
@editable: the object which received the signal.
467

468
<!-- ##### SIGNAL GtkEditable::changed ##### -->
469
<para>
470 471
Indicates that the user has changed the contents
of the widget.
472
</para>
473

474
@editable: the object which received the signal.
475

476
<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
477
<para>
478 479
An action signal. Causes the characters in the current selection to
be copied to the clipboard.
480 481
</para>

482
@editable: the object which received the signal.
483

484
<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
485
<para>
486 487 488
An action signal. Causes the characters in the current
selection to be copied to the clipboard and then deleted from
the widget.
489 490
</para>

491
@editable: the object which received the signal.
492

493
<!-- ##### SIGNAL GtkEditable::delete-text ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
494
<para>
495 496 497 498 499 500 501 502 503
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
504 505
</para>

506 507 508
@editable: the object which received the signal.
@start_pos: the starting position.
@end_pos: the end position.
Havoc Pennington's avatar
Havoc Pennington committed
509

510
<!-- ##### SIGNAL GtkEditable::insert-text ##### -->
Owen Taylor's avatar
Owen Taylor committed
511
<para>
512 513 514 515 516 517 518
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.
519 520
</para>

521 522 523 524 525 526 527
@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.
528

529
<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
530
<para>
531
An action signal. Delete a single character.
532
</para>
533 534 535 536 537 538

@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 ##### -->
539
<para>
540
An action signal. Delete a single line.
541
</para>
542 543 544 545 546 547

@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 ##### -->
548
<para>
549
An action signal. Delete a single word.
550 551
</para>

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

556
<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
557
<para>
558
An action signal. Move the cursor position.
559 560
</para>

561 562 563
@editable: the object which received the signal.
@x: horizontal distance to move the cursor.
@y: vertical distance to move the cursor.
564

565
<!-- ##### SIGNAL GtkEditable::move-page ##### -->
566
<para>
567
An action signal. Move the cursor by pages.
568 569
</para>

570 571 572
@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.
573

574
<!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
575
<para>
576
An action signal. Move the cursor to the given column.
577
</para>
578 579 580 581 582 583

@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 ##### -->
584
<para>
585
An action signal. Move the cursor to the given row.
586 587
</para>

588 589 590
@editable: the object which received the signal.
@row: the row to move to. (A negative value indicates 
      the last row)
591

592
<!-- ##### SIGNAL GtkEditable::move-word ##### -->
593
<para>
594
An action signal. Move the cursor by words.
595 596
</para>

597 598 599
@editable: the object which received the signal.
@num_words: The number of words to move the
cursor. (Can be negative).
600

601
<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
602
<para>
603 604 605
An action signal. Causes the contents of the clipboard to
be pasted into the editable widget at the current cursor
position.
606 607
</para>

608
@editable: the object which received the signal.
609

610 611 612 613 614 615
<!-- ##### 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.
616 617
</para>

618 619 620
@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
621

622 623 624 625
<!-- ##### ARG GtkEditable:editable ##### -->
<para>
A boolean indicating whether the widget is editable by
the user.
Owen Taylor's avatar
Owen Taylor committed
626 627 628
</para>


629
<!-- ##### ARG GtkEditable:text-position ##### -->
630
<para>
631
The position of the cursor.
632 633 634
</para>


Havoc Pennington's avatar
Havoc Pennington committed
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
<!-- ##### 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: 

653
<!-- ##### ENUM GtkFontFilterType ##### -->
654
<para>
655 656 657
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().
658 659
</para>

660 661 662
@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.
663

664
<!-- ##### ENUM GtkFontType ##### -->
665
<para>
666 667 668
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().
669 670
</para>

671 672 673 674
@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.
675

676 677 678 679 680 681
<!-- ##### ARG GtkFrame:shadow-type ##### -->
<para>

</para>


682 683 684 685 686 687 688 689 690 691 692 693
<!-- ##### ARG GtkHScale:adjustment ##### -->
<para>
the #GtkAdjustment which sets the range of the scale.
</para>


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

</para>


694
<!-- ##### STRUCT GtkIMContextSimple ##### -->
695 696 697 698
<para>

</para>

699 700 701 702 703
@object: 
@tables: 
@compose_buffer: 
@tentative_match: 
@tentative_match_len: 
704

Owen Taylor's avatar
Owen Taylor committed
705 706 707 708 709 710 711 712 713 714 715 716 717
<!-- ##### 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

718 719 720 721 722 723
<!-- ##### ARG GtkLabel:accel-keyval ##### -->
<para>

</para>


724
<!-- ##### ARG GtkObject:object-signal ##### -->
725
<para>
726 727 728
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.
729 730
</para>
<para>
731 732 733 734
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.
735 736 737
</para>


738
<!-- ##### ARG GtkObject:object-signal-after ##### -->
739
<para>
740 741 742 743
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.
744 745
</para>
<para>
746
See gtk_signal_connect_object_after() for more details.
747 748 749
</para>


750
<!-- ##### ARG GtkObject:signal ##### -->
751
<para>
752 753
Setting this with a GtkType of GTK_TYPE_SIGNAL connects
the signal to the object.
754 755 756
</para>


757
<!-- ##### ARG GtkObject:signal-after ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
758
<para>
759 760 761
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
762 763
</para>

764

Owen Taylor's avatar
Owen Taylor committed
765 766 767 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 794 795 796 797 798 799 800
<!-- ##### 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>


Tim Janik's avatar
Tim Janik committed
801 802 803 804 805 806
<!-- ##### ARG GtkPaned:handle-size ##### -->
<para>

</para>


807 808 809 810 811 812 813 814 815 816 817 818
<!-- ##### STRUCT GtkPatternSpec ##### -->
<para>

</para>

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

819
<!-- ##### ENUM GtkPrivateFlags ##### -->
820
<para>
821

822 823
</para>

824 825 826 827 828 829 830 831
@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: 
832

833
<!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
834
<para>
835 836 837 838 839 840 841 842 843 844 845
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).
846 847
</para>

848 849
@data: The user data associated with the hook that is being
destroyed.
850

851
<!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
852
<para>
853 854
This is currently a hack left in for a scheme wrapper library.
It may be removed.
855 856
</para>
<para>
857
Don't use it.
858 859
</para>

860 861 862 863 864 865 866
@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.
867

868
<!-- ##### STRUCT GtkSignalQuery ##### -->
869
<para>
870 871 872
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.
873 874
</para>

875 876 877 878 879 880 881 882
@object_type: 
@signal_id: 
@signal_name: 
@is_user_signal: 
@signal_flags: 
@return_val: 
@nparams: 
@params: 
883

884 885 886 887 888 889
<!-- ##### ARG GtkSpinButton:shadow-type ##### -->
<para>
the type of border that surrounds the arrows of a spin button.
</para>


890
<!-- ##### STRUCT GtkStatusbarMsg ##### -->
891
<para>
892
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.
893 894
</para>

895 896 897
@text: 
@context_id: 
@message_id: 
898

899
<!-- ##### ARG GtkTextTag:justify ##### -->
900
<para>
901 902
A #GtkJustification for the text. This is only used when the tag is
applied to the first character in a paragraph.
903 904 905
</para>


906
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
907
<para>
908 909
Pixel width of the left margin of the text for lines after the first
line in a wrapped paragraph.
910 911 912
</para>


913
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
914 915 916 917 918
<para>

</para>


919
<!-- ##### ARG GtkTextTag:offset ##### -->
920
<para>
921 922
Pixels to offset the text horizontally or vertically, useful to
produce superscript and subscript.
923 924 925
</para>


Havoc Pennington's avatar
Havoc Pennington committed
926 927 928 929 930 931
<!-- ##### ARG GtkTextView:justify ##### -->
<para>

</para>


932 933 934 935 936 937 938 939 940 941 942 943
<!-- ##### ARG GtkVScale:adjustment ##### -->
<para>
the #GtkAdjustment which sets the range of the scale.
</para>


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

</para>


944 945 946 947 948 949 950 951 952
<!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
<para>

</para>

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

953 954 955 956 957 958 959 960
<!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
<para>

</para>

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

961
<!-- ##### SIGNAL GtkWidget::draw ##### -->
962 963 964 965
<para>

</para>

966 967
@widget: the object which received the signal.
@area: 
968

969
<!-- ##### SIGNAL GtkWidget::draw-default ##### -->
970 971 972 973
<para>

</para>

974
@widget: the object which received the signal.
975

976
<!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
977 978 979 980
<para>

</para>

981
@widget: the object which received the signal.
Havoc Pennington's avatar
Havoc Pennington committed
982

Owen Taylor's avatar
Owen Taylor committed
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
<!-- ##### 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).

1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
<!-- ##### 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.

1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
<!-- ##### FUNCTION gtk_button_new_accel ##### -->
<para>

</para>

@uline_label: 
@accel_group: 
@Returns: 

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

</para>

@stock_id: 
@accel_group: 
@Returns: 

1203
<!-- ##### FUNCTION gtk_clist_construct ##### -->
1204
<para>
1205 1206
Initializes a previously allocated #GtkCList widget for use.  This should not
normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
Damon Chaplin's avatar