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


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

</para>


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


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


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


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


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


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

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


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

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

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


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

124

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

128

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


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

</para>


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

</para>


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



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


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

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

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

</para>


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

</para>


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

</para>


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

</para>


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

</para>


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

196
@obj: the object to examine.
197

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

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

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

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

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

</para>


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

</para>


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

</para>


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

</para>


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

</para>


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

</para>


248
<!-- ##### MACRO GTK_TREE_SELECTION ##### -->
249
<para>
250
A macro that returns a GList that contains the selection of the root tree of @obj.
251 252
</para>

253
@obj: A pointer to the #GtkTree. @obj will accept any pointer, but it the pointer does not point to a #GtkTree, the results are undefined.
254

255
<!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
256
<para>
257
The first "flat" (no struct) enumerated type value.
258 259 260
</para>


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


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


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

278 279
@parent_t: 
@seqno: 
280

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


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

292
@type: 
293

294
<!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
295
<para>
296
The first structured enumerated type value.
297
</para>
298 299


300
<!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
301
<para>
302
The last structured enumerated type value.
303 304 305
</para>


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

</para>


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

317
@a: 
318

319
<!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
320
<para>
321
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
322
</para>
Havoc Pennington's avatar
Havoc Pennington committed
323

324
@a: 
325

326
<!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
327
<para>
328
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
329 330
</para>

331
@a: 
332

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

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

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

</para>


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

@object: 
@arg: 
@arg_id: 

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

@object: 
@arg: 
@arg_id: 

364 365 366 367 368 369
<!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
<para>

</para>


Havoc Pennington's avatar
Delete.  
Havoc Pennington committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383
<!-- ##### 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.

384
<!-- ##### SIGNAL GtkEditable::activate ##### -->
385
<para>
386 387 388 389 390
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.)
391 392
</para>

393
@editable: the object which received the signal.
394

395
<!-- ##### SIGNAL GtkEditable::changed ##### -->
396
<para>
397 398
Indicates that the user has changed the contents
of the widget.
399
</para>
400

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

403
<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
404
<para>
405 406
An action signal. Causes the characters in the current selection to
be copied to the clipboard.
407 408
</para>

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

411
<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
412
<para>
413 414 415
An action signal. Causes the characters in the current
selection to be copied to the clipboard and then deleted from
the widget.
416 417
</para>

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

420
<!-- ##### SIGNAL GtkEditable::delete-text ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
421
<para>
422 423 424 425 426 427 428 429 430
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
431 432
</para>

433 434 435
@editable: the object which received the signal.
@start_pos: the starting position.
@end_pos: the end position.
Havoc Pennington's avatar
Havoc Pennington committed
436

437
<!-- ##### SIGNAL GtkEditable::insert-text ##### -->
Owen Taylor's avatar
Owen Taylor committed
438
<para>
439 440 441 442 443 444 445
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.
446 447
</para>

448 449 450 451 452 453 454
@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.
455

456
<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
457
<para>
458
An action signal. Delete a single character.
459
</para>
460 461 462 463 464 465

@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 ##### -->
466
<para>
467
An action signal. Delete a single line.
468
</para>
469 470 471 472 473 474

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

<!-- ##### SIGNAL GtkEditable::kill-word ##### -->
475
<para>
476
An action signal. Delete a single word.
477 478
</para>

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

483
<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
484
<para>
485
An action signal. Move the cursor position.
486 487
</para>

488 489 490
@editable: the object which received the signal.
@x: horizontal distance to move the cursor.
@y: vertical distance to move the cursor.
491

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

497 498 499
@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.
500

501
<!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
502
<para>
503
An action signal. Move the cursor to the given column.
504
</para>
505 506 507 508 509 510

@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 ##### -->
511
<para>
512
An action signal. Move the cursor to the given row.
513 514
</para>

515 516 517
@editable: the object which received the signal.
@row: the row to move to. (A negative value indicates 
      the last row)
518

519
<!-- ##### SIGNAL GtkEditable::move-word ##### -->
520
<para>
521
An action signal. Move the cursor by words.
522 523
</para>

524 525 526
@editable: the object which received the signal.
@num_words: The number of words to move the
cursor. (Can be negative).
527

528
<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
529
<para>
530 531 532
An action signal. Causes the contents of the clipboard to
be pasted into the editable widget at the current cursor
position.
533 534
</para>

535
@editable: the object which received the signal.
536

537 538 539 540 541 542
<!-- ##### 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.
543 544
</para>

545 546 547
@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
548

549 550 551 552
<!-- ##### ARG GtkEditable:editable ##### -->
<para>
A boolean indicating whether the widget is editable by
the user.
Owen Taylor's avatar
Owen Taylor committed
553 554 555
</para>


556
<!-- ##### ARG GtkEditable:text-position ##### -->
557
<para>
558
The position of the cursor.
559 560 561
</para>


Havoc Pennington's avatar
Havoc Pennington committed
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
<!-- ##### 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: 

580
<!-- ##### ENUM GtkFontFilterType ##### -->
581
<para>
582 583 584
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().
585 586
</para>

587 588 589
@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.
590

591
<!-- ##### ENUM GtkFontType ##### -->
592
<para>
593 594 595
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().
596 597
</para>

598 599 600 601
@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.
602

603 604 605 606 607 608
<!-- ##### ARG GtkFrame:shadow-type ##### -->
<para>

</para>


609 610 611 612 613 614 615 616 617 618 619 620
<!-- ##### ARG GtkHScale:adjustment ##### -->
<para>
the #GtkAdjustment which sets the range of the scale.
</para>


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

</para>


621
<!-- ##### STRUCT GtkIMContextSimple ##### -->
622 623 624 625
<para>

</para>

626 627 628 629 630
@object: 
@tables: 
@compose_buffer: 
@tentative_match: 
@tentative_match_len: 
631

632 633 634 635 636 637
<!-- ##### ARG GtkLabel:accel-keyval ##### -->
<para>

</para>


638
<!-- ##### ARG GtkObject:object-signal ##### -->
639
<para>
640 641 642
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.
643 644
</para>
<para>
645 646 647 648
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.
649 650 651
</para>


652
<!-- ##### ARG GtkObject:object-signal-after ##### -->
653
<para>
654 655 656 657
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.
658 659
</para>
<para>
660
See gtk_signal_connect_object_after() for more details.
661 662 663
</para>


664
<!-- ##### ARG GtkObject:signal ##### -->
665
<para>
666 667
Setting this with a GtkType of GTK_TYPE_SIGNAL connects
the signal to the object.
668 669 670
</para>


671
<!-- ##### ARG GtkObject:signal-after ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
672
<para>
673 674 675
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
676 677
</para>

678

Tim Janik's avatar
Tim Janik committed
679 680 681 682 683 684
<!-- ##### ARG GtkPaned:handle-size ##### -->
<para>

</para>


685 686 687 688 689 690 691 692 693 694 695 696
<!-- ##### STRUCT GtkPatternSpec ##### -->
<para>

</para>

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

697
<!-- ##### ENUM GtkPrivateFlags ##### -->
698
<para>
699

700 701
</para>

702 703 704 705 706 707 708 709
@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: 
710

711
<!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
712
<para>
713 714 715 716 717 718 719 720 721 722 723
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).
724 725
</para>

726 727
@data: The user data associated with the hook that is being
destroyed.
728

729
<!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
730
<para>
731 732
This is currently a hack left in for a scheme wrapper library.
It may be removed.
733 734
</para>
<para>
735
Don't use it.
736 737
</para>

738 739 740 741 742 743 744
@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.
745

746
<!-- ##### STRUCT GtkSignalQuery ##### -->
747
<para>
748 749 750
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.
751 752
</para>

753 754 755 756 757 758 759 760
@object_type: 
@signal_id: 
@signal_name: 
@is_user_signal: 
@signal_flags: 
@return_val: 
@nparams: 
@params: 
761

762 763 764 765 766 767
<!-- ##### ARG GtkSpinButton:shadow-type ##### -->
<para>
the type of border that surrounds the arrows of a spin button.
</para>


768
<!-- ##### STRUCT GtkStatusbarMsg ##### -->
769
<para>
770
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.
771 772
</para>

773 774 775
@text: 
@context_id: 
@message_id: 
776

777
<!-- ##### ARG GtkTextTag:justify ##### -->
778
<para>
779 780
A #GtkJustification for the text. This is only used when the tag is
applied to the first character in a paragraph.
781 782 783
</para>


784
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
785
<para>
786 787
Pixel width of the left margin of the text for lines after the first
line in a wrapped paragraph.
788 789 790
</para>


791
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
792 793 794 795 796
<para>

</para>


797
<!-- ##### ARG GtkTextTag:offset ##### -->
798
<para>
799 800
Pixels to offset the text horizontally or vertically, useful to
produce superscript and subscript.
801 802 803
</para>


Havoc Pennington's avatar
Havoc Pennington committed
804 805 806 807 808 809
<!-- ##### ARG GtkTextView:justify ##### -->
<para>

</para>


810 811 812 813 814 815 816 817 818 819 820 821
<!-- ##### ARG GtkVScale:adjustment ##### -->
<para>
the #GtkAdjustment which sets the range of the scale.
</para>


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

</para>


822 823 824 825 826 827 828 829 830
<!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
<para>

</para>

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

831 832 833 834 835 836 837 838
<!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
<para>

</para>

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

839
<!-- ##### SIGNAL GtkWidget::draw ##### -->
840 841 842 843
<para>

</para>

844 845
@widget: the object which received the signal.
@area: 
846

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

</para>

852
@widget: the object which received the signal.
853

854
<!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
855 856 857 858
<para>

</para>

859
@widget: the object which received the signal.
Havoc Pennington's avatar
Havoc Pennington committed
860

861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
<!-- ##### 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.

908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
<!-- ##### FUNCTION gtk_button_new_accel ##### -->
<para>

</para>

@uline_label: 
@accel_group: 
@Returns: 

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

</para>

@stock_id: 
@accel_group: 
@Returns: 

926
<!-- ##### FUNCTION gtk_clist_construct ##### -->
927
<para>
928 929
Initializes a previously allocated #GtkCList widget for use.  This should not
normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
930 931
</para>

932 933 934 935 936
@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.
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
<!-- ##### 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: 

970
<!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
971
<para>
972 973 974 975 976
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.
977 978
</para>

979 980 981
@colorsel: a #GtkColorSelection.
@use_opacity: a boolean indicating whether the opacity selection
is enabled.
982

983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
<!-- ##### FUNCTION gtk_color_selection_set_use_opacity ##### -->
<para>

</para>

@colorsel: 
@use_opacity: 

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

</para>

@colorsel: 
@use_palette: 

999
<!-- ##### FUNCTION gtk_ctree_construct ##### -->
1000
<para>
1001
This function is not usually used by users.
1002 1003
</para>

1004 1005 1006 1007
@ctree: 
@columns: 
@tree_column: 
@titles: 
1008

1009
<!-- ##### FUNCTION gtk_editable_changed ##### -->
1010
<para>
1011
Causes the "changed" signal to be emitted.
1012 1013
</para>

1014
@editable: a #GtkEditable widget.
1015

1016
<!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
1017
<para>
1018
Claim or disclaim ownership of the PRIMARY X selection.
1019 1020
</para>

1021 1022 1023
@editable: a #GtkEditable widget.
@claim: if %TRUE, claim the selection, otherwise, disclaim it.
@time: the timestamp for claiming the selection.
1024

1025
<!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
1026
<para>
1027
Sets one of the two font filters, to limit the fonts shown.
1028 1029
</para>

1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
@fsd: a #GtkFontSelectionDialog.
@filter_type: which of the two font filters to set, either
#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
can be changed by the user, but the base filter is permanent.
@font_type: the types of font to be shown. This is a bitwise combination of
#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
or #GTK_FONT_ALL to show all three font types.
@foundries: a NULL-terminated array of strings containing foundry names which
will be shown, or NULL to show all foundries.
@weights: a NULL-terminated array of strings containing weight names which
will be shown, or NULL to show all weights.
@slants: a NULL-terminated array of strings containing slant names which
will be shown, or NULL to show all slants.
@setwidths: a NULL-terminated array of strings containing setwidth names which
will be shown, or NULL to show all setwidths.
@spacings: a NULL-terminated array of strings containing spacings which
will be shown, or NULL to show all spacings.
@charsets: a NULL-terminated array of strings containing charset names which
will be shown, or NULL to show all charsets.
1049

1050
<!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
1051
<para>
1052
Sets one of the two font filters, to limit the fonts shown.
1053 1054
</para>

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066