gtk-unused.sgml 39.2 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
<!-- ##### MACRO GTK_TREE_SELECTION ##### -->
213
<para>
214
A macro that returns a GList that contains the selection of the root tree of @obj.
215 216
</para>

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

219
<!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
220
<para>
221
The first "flat" (no struct) enumerated type value.
222 223 224
</para>


225
<!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
226
<para>
227
The last "flat" (no struct) enumerated type value.
Havoc Pennington's avatar
Havoc Pennington committed
228 229 230
</para>


231
<!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
232
<para>
233
Hide the name of gtk_identifier_get_type
Havoc Pennington's avatar
Havoc Pennington committed
234 235 236
</para>


237
<!-- ##### MACRO GTK_TYPE_MAKE ##### -->
238
<para>
239
Combine a fundemantal type and a sequence number to create a gtk type.
240 241
</para>

242 243
@parent_t: 
@seqno: 
244

245
<!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
246
<para>
247
No idea.
248 249 250
</para>


251
<!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
252
<para>
253
Convert a gtk type into its sequence number
254 255
</para>

256
@type: 
257

258
<!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
259
<para>
260
The first structured enumerated type value.
261
</para>
262 263


264
<!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
265
<para>
266
The last structured enumerated type value.
267 268 269
</para>


270 271 272 273 274 275
<!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
<para>

</para>


276
<!-- ##### MACRO GTK_VALUE_ARGS ##### -->
277
<para>
278
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
279 280
</para>

281
@a: 
282

283
<!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
284
<para>
285
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
286
</para>
Havoc Pennington's avatar
Havoc Pennington committed
287

288
@a: 
289

290
<!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
291
<para>
292
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
293 294
</para>

295
@a: 
296

297
<!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
298
<para>
299
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
Havoc Pennington's avatar
Havoc Pennington committed
300 301
</para>

302
@a: 
Havoc Pennington's avatar
Havoc Pennington committed
303

Havoc Pennington's avatar
Delete.  
Havoc Pennington committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317
<!-- ##### 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.

318
<!-- ##### SIGNAL GtkEditable::activate ##### -->
319
<para>
320 321 322 323 324
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.)
325 326
</para>

327
@editable: the object which received the signal.
328

329
<!-- ##### SIGNAL GtkEditable::changed ##### -->
330
<para>
331 332
Indicates that the user has changed the contents
of the widget.
333
</para>
334

335
@editable: the object which received the signal.
336

337
<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
338
<para>
339 340
An action signal. Causes the characters in the current selection to
be copied to the clipboard.
341 342
</para>

343
@editable: the object which received the signal.
344

345
<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
346
<para>
347 348 349
An action signal. Causes the characters in the current
selection to be copied to the clipboard and then deleted from
the widget.
350 351
</para>

352
@editable: the object which received the signal.
353

354
<!-- ##### SIGNAL GtkEditable::delete-text ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
355
<para>
356 357 358 359 360 361 362 363 364
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
365 366
</para>

367 368 369
@editable: the object which received the signal.
@start_pos: the starting position.
@end_pos: the end position.
Havoc Pennington's avatar
Havoc Pennington committed
370

371
<!-- ##### SIGNAL GtkEditable::insert-text ##### -->
Owen Taylor's avatar
Owen Taylor committed
372
<para>
373 374 375 376 377 378 379
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.
380 381
</para>

382 383 384 385 386 387 388
@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.
389

390
<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
391
<para>
392
An action signal. Delete a single character.
393
</para>
394 395 396 397 398 399

@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 ##### -->
400
<para>
401
An action signal. Delete a single line.
402
</para>
403 404 405 406 407 408

@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 ##### -->
409
<para>
410
An action signal. Delete a single word.
411 412
</para>

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

417
<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
418
<para>
419
An action signal. Move the cursor position.
420 421
</para>

422 423 424
@editable: the object which received the signal.
@x: horizontal distance to move the cursor.
@y: vertical distance to move the cursor.
425

426
<!-- ##### SIGNAL GtkEditable::move-page ##### -->
427
<para>
428
An action signal. Move the cursor by pages.
429 430
</para>

431 432 433
@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.
434

435
<!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
436
<para>
437
An action signal. Move the cursor to the given column.
438
</para>
439 440 441 442 443 444

@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 ##### -->
445
<para>
446
An action signal. Move the cursor to the given row.
447 448
</para>

449 450 451
@editable: the object which received the signal.
@row: the row to move to. (A negative value indicates 
      the last row)
452

453
<!-- ##### SIGNAL GtkEditable::move-word ##### -->
454
<para>
455
An action signal. Move the cursor by words.
456 457
</para>

458 459 460
@editable: the object which received the signal.
@num_words: The number of words to move the
cursor. (Can be negative).
461

462
<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
463
<para>
464 465 466
An action signal. Causes the contents of the clipboard to
be pasted into the editable widget at the current cursor
position.
467 468
</para>

469
@editable: the object which received the signal.
470

471 472 473 474 475 476
<!-- ##### 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.
477 478
</para>

479 480 481
@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
482

483 484 485 486
<!-- ##### ARG GtkEditable:editable ##### -->
<para>
A boolean indicating whether the widget is editable by
the user.
Owen Taylor's avatar
Owen Taylor committed
487 488 489
</para>


490
<!-- ##### ARG GtkEditable:text-position ##### -->
491
<para>
492
The position of the cursor.
493 494 495
</para>


Havoc Pennington's avatar
Havoc Pennington committed
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
<!-- ##### 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: 

514
<!-- ##### ENUM GtkFontFilterType ##### -->
515
<para>
516 517 518
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().
519 520
</para>

521 522 523
@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.
524

525
<!-- ##### ENUM GtkFontType ##### -->
526
<para>
527 528 529
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().
530 531
</para>

532 533 534 535
@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.
536

537 538 539 540 541 542
<!-- ##### ARG GtkFrame:shadow-type ##### -->
<para>

</para>


543
<!-- ##### STRUCT GtkIMContextSimple ##### -->
544 545 546 547
<para>

</para>

548 549 550 551 552
@object: 
@tables: 
@compose_buffer: 
@tentative_match: 
@tentative_match_len: 
553

554 555 556 557 558 559
<!-- ##### ARG GtkLabel:accel-keyval ##### -->
<para>

</para>


560
<!-- ##### ARG GtkObject:object-signal ##### -->
561
<para>
562 563 564
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.
565 566
</para>
<para>
567 568 569 570
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.
571 572 573
</para>


574
<!-- ##### ARG GtkObject:object-signal-after ##### -->
575
<para>
576 577 578 579
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.
580 581
</para>
<para>
582
See gtk_signal_connect_object_after() for more details.
583 584 585
</para>


586
<!-- ##### ARG GtkObject:signal ##### -->
587
<para>
588 589
Setting this with a GtkType of GTK_TYPE_SIGNAL connects
the signal to the object.
590 591 592
</para>


593
<!-- ##### ARG GtkObject:signal-after ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
594
<para>
595 596 597
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
598 599
</para>

600

601
<!-- ##### ENUM GtkPrivateFlags ##### -->
602
<para>
603

604 605
</para>

606 607 608 609 610 611 612 613
@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: 
614

615
<!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
616
<para>
617 618 619 620 621 622 623 624 625 626 627
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).
628 629
</para>

630 631
@data: The user data associated with the hook that is being
destroyed.
632

633
<!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
634
<para>
635 636
This is currently a hack left in for a scheme wrapper library.
It may be removed.
637 638
</para>
<para>
639
Don't use it.
640 641
</para>

642 643 644 645 646 647 648
@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.
649

650
<!-- ##### STRUCT GtkSignalQuery ##### -->
651
<para>
652 653 654
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.
655 656
</para>

657 658 659 660 661 662 663 664
@object_type: 
@signal_id: 
@signal_name: 
@is_user_signal: 
@signal_flags: 
@return_val: 
@nparams: 
@params: 
665

666 667 668 669 670 671
<!-- ##### ARG GtkSpinButton:shadow-type ##### -->
<para>
the type of border that surrounds the arrows of a spin button.
</para>


672
<!-- ##### STRUCT GtkStatusbarMsg ##### -->
673
<para>
674
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.
675 676
</para>

677 678 679
@text: 
@context_id: 
@message_id: 
680

681
<!-- ##### ARG GtkTextTag:justify ##### -->
682
<para>
683 684
A #GtkJustification for the text. This is only used when the tag is
applied to the first character in a paragraph.
685 686 687
</para>


688
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
689
<para>
690 691
Pixel width of the left margin of the text for lines after the first
line in a wrapped paragraph.
692 693 694
</para>


695
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
696 697 698 699 700
<para>

</para>


701
<!-- ##### ARG GtkTextTag:offset ##### -->
702
<para>
703 704
Pixels to offset the text horizontally or vertically, useful to
produce superscript and subscript.
705 706 707
</para>


708 709 710 711 712 713 714 715 716 717 718 719
<!-- ##### ARG GtkTextView:justify ##### -->
<para>

</para>


<!-- ##### ARG GtkTextView:wrap-mode ##### -->
<para>

</para>


720 721 722 723 724 725 726 727 728
<!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
<para>

</para>

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

729 730 731 732 733 734 735 736
<!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
<para>

</para>

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

737
<!-- ##### SIGNAL GtkWidget::draw ##### -->
738 739 740 741
<para>

</para>

742 743
@widget: the object which received the signal.
@area: 
744

745
<!-- ##### SIGNAL GtkWidget::draw-default ##### -->
746 747 748 749
<para>

</para>

750
@widget: the object which received the signal.
751

752
<!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
753 754 755 756
<para>

</para>

757
@widget: the object which received the signal.
Havoc Pennington's avatar
Havoc Pennington committed
758

759 760 761 762 763 764 765 766
<!-- ##### SIGNAL GtkWidget::size-request ##### -->
<para>

</para>

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

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 801 802 803 804 805 806 807 808 809 810 811 812 813
<!-- ##### 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.

814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
<!-- ##### FUNCTION gtk_button_new_accel ##### -->
<para>

</para>

@uline_label: 
@accel_group: 
@Returns: 

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

</para>

@stock_id: 
@accel_group: 
@Returns: 

832
<!-- ##### FUNCTION gtk_clist_construct ##### -->
833
<para>
834 835
Initializes a previously allocated #GtkCList widget for use.  This should not
normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
836 837
</para>

838 839 840 841 842
@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.
843

844
<!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
845
<para>
846 847 848 849 850
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.
851 852
</para>

853 854 855
@colorsel: a #GtkColorSelection.
@use_opacity: a boolean indicating whether the opacity selection
is enabled.
856

857
<!-- ##### FUNCTION gtk_ctree_construct ##### -->
858
<para>
859
This function is not usually used by users.
860 861
</para>

862 863 864 865
@ctree: 
@columns: 
@tree_column: 
@titles: 
866

867
<!-- ##### FUNCTION gtk_editable_changed ##### -->
868
<para>
869
Causes the "changed" signal to be emitted.
870 871
</para>

872
@editable: a #GtkEditable widget.
873

874
<!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
875
<para>
876
Claim or disclaim ownership of the PRIMARY X selection.
877 878
</para>

879 880 881
@editable: a #GtkEditable widget.
@claim: if %TRUE, claim the selection, otherwise, disclaim it.
@time: the timestamp for claiming the selection.
882

883
<!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
884
<para>
885
Sets one of the two font filters, to limit the fonts shown.
886 887
</para>

888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
@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.
907

908
<!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
909
<para>
910
Sets one of the two font filters, to limit the fonts shown.
911 912
</para>

913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
@fontsel: a #GtkFontSelection.
@filter_type: which of the two font filters to set, either
#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
can be changed by the user, but the base filter is permanent.
@font_type: the types of font to be shown. This is a bitwise combination of
#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
or #GTK_FONT_ALL to show all three font types.
@foundries: a NULL-terminated array of strings containing foundry names which
will be shown, or NULL to show all foundries.
@weights: a NULL-terminated array of strings containing weight names which
will be shown, or NULL to show all weights.
@slants: a NULL-terminated array of strings containing slant names which
will be shown, or NULL to show all slants.
@setwidths: a NULL-terminated array of strings containing setwidth names which
will be shown, or NULL to show all setwidths.
@spacings: a NULL-terminated array of strings containing spacings which
will be shown, or NULL to show all spacings.
@charsets: a NULL-terminated array of strings containing charset names which
will be shown, or NULL to show all charsets.
932

933
<!-- ##### FUNCTION gtk_identifier_get_type ##### -->
934
<para>
935
Get the type of GtkIdentifier.
936
</para>
937

938
@Returns: GtkType -- the enumerated type of something.
939

940 941 942 943 944 945 946 947 948
<!-- ##### FUNCTION gtk_label_set_markup_with_accel ##### -->
<para>

</para>

@label: 
@str: 
@Returns: 

Havoc Pennington's avatar
Havoc Pennington committed
949 950 951 952 953 954 955 956 957 958
<!-- ##### FUNCTION gtk_list_store_set_cell ##### -->
<para>

</para>

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

959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
<!-- ##### FUNCTION gtk_menu_ensure_uline_accel_group ##### -->
<para>

</para>

@menu: 
@Returns: 

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

</para>

@menu: 
@Returns: 

975
<!-- ##### FUNCTION gtk_object_arg_get ##### -->
976
<para>
977
Private function to get an argument and argument info from an object.
978 979
</para>

980 981 982
@object: the object whose argument should be retrieved.
@arg: the argument, for the name on input, the rest is filled on output.
@info: a #GtkArgInfo structure to optionally fill in.
983

984
<!-- ##### FUNCTION gtk_object_arg_get_info ##### -->
Owen Taylor's avatar
Owen Taylor committed
985
<para>
986
Query information about an argument type.
Owen Taylor's avatar
Owen Taylor committed
987 988
</para>

989 990 991 992 993
@object_type: type of object to query about.
@arg_name: name of the argument.
@info_p: pointer to be filled in with a pointer to the GtkArgInfo.
@Returns: an error message, or NULL on success.
It is the caller's responsibility to call g_free() in the event of error.
Owen Taylor's avatar
Owen Taylor committed
994

995
<!-- ##### FUNCTION gtk_object_arg_set ##### -->
Owen Taylor's avatar
Owen Taylor committed