gtk-unused.sgml 36.1 KB
Newer Older
1 2
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
Debugging
Owen Taylor's avatar
Owen Taylor committed
3 4


5 6
<!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Title ##### -->
gtkenums.sgml
Owen Taylor's avatar
Owen Taylor committed
7 8


9 10
<!-- ##### SECTION ./tmpl/gtkimcontextsimple.sgml:Title ##### -->
GtkIMContextSimple
Owen Taylor's avatar
Owen Taylor committed
11 12


13 14 15
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
<refsect2>
<title>What are Signal Marshallers?</title>
16
<para>
17 18 19 20
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....
21 22
</para>
<para>
23 24 25 26 27 28 29
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.
30 31
</para>
<para>
32 33 34 35 36 37 38 39
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>
40
</para>
41 42 43
</refsect2>
<refsect2>
<title>Writing Custom Marshals</title>
44
<para>
45 46 47
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.
48
</para>
Owen Taylor's avatar
Owen Taylor committed
49
<para>
50 51 52 53 54 55 56
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
);
57

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
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
75
</para>
76
</refsect2>
Owen Taylor's avatar
Owen Taylor committed
77 78


79
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
Jonathan Blandford's avatar
Jonathan Blandford committed
80
<para>
81
<variablelist>
Jonathan Blandford's avatar
Jonathan Blandford committed
82

83 84 85 86 87
<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
88

89 90
</variablelist>
</para>
Havoc Pennington's avatar
Havoc Pennington committed
91 92


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

96

97 98
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
Signal Marshallers
99

100

101 102
<!-- ##### SECTION ./tmpl/gtkprivate.sgml:Title ##### -->
Private Information
103 104


105
<!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
106
<para>
107 108
A macro to check whether a child widget of the CList
has the focus.
109 110
</para>

111
@clist: The #GtkCList widget to check.
112

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
<!-- ##### 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>


143
<!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
144
<para>
145
Test whether a GtkObject's arguments have been prepared.
146 147
</para>

148
@obj: the object to examine.
149

150
<!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
Owen Taylor's avatar
Owen Taylor committed
151
<para>
152
Get the number of signals defined by this object.
Owen Taylor's avatar
Owen Taylor committed
153 154
</para>

155
@obj: the object to query.
Owen Taylor's avatar
Owen Taylor committed
156

157
<!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
158
<para>
159
Get the array of signals defined for this object.
160 161
</para>

162
@obj: the object to fetch the signals from.
163

164
<!-- ##### MACRO GTK_TREE_SELECTION ##### -->
165
<para>
166
A macro that returns a GList that contains the selection of the root tree of @obj.
167 168
</para>

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

171
<!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
172
<para>
173
The first "flat" (no struct) enumerated type value.
174 175 176
</para>


177
<!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
178
<para>
179
The last "flat" (no struct) enumerated type value.
Havoc Pennington's avatar
Havoc Pennington committed
180 181 182
</para>


183
<!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
184
<para>
185
Hide the name of gtk_identifier_get_type
Havoc Pennington's avatar
Havoc Pennington committed
186 187 188
</para>


189
<!-- ##### MACRO GTK_TYPE_MAKE ##### -->
190
<para>
191
Combine a fundemantal type and a sequence number to create a gtk type.
192 193
</para>

194 195
@parent_t: 
@seqno: 
196

197
<!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
198
<para>
199
No idea.
200 201 202
</para>


203
<!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
204
<para>
205
Convert a gtk type into its sequence number
206 207
</para>

208
@type: 
209

210
<!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
211
<para>
212
The first structured enumerated type value.
213
</para>
214 215


216
<!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
217
<para>
218
The last structured enumerated type value.
219 220 221
</para>


222 223 224 225 226 227
<!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
<para>

</para>


228
<!-- ##### MACRO GTK_VALUE_ARGS ##### -->
229
<para>
230
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
231 232
</para>

233
@a: 
234

235
<!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
236
<para>
237
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
238
</para>
Havoc Pennington's avatar
Havoc Pennington committed
239

240
@a: 
241

242
<!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
243
<para>
244
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
245 246
</para>

247
@a: 
248

249
<!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
250
<para>
251
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
Havoc Pennington's avatar
Havoc Pennington committed
252 253
</para>

254
@a: 
Havoc Pennington's avatar
Havoc Pennington committed
255

Havoc Pennington's avatar
Delete.  
Havoc Pennington committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269
<!-- ##### 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.

270
<!-- ##### SIGNAL GtkEditable::activate ##### -->
271
<para>
272 273 274 275 276
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.)
277 278
</para>

279
@editable: the object which received the signal.
280

281
<!-- ##### SIGNAL GtkEditable::changed ##### -->
282
<para>
283 284
Indicates that the user has changed the contents
of the widget.
285
</para>
286

287
@editable: the object which received the signal.
288

289
<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
290
<para>
291 292
An action signal. Causes the characters in the current selection to
be copied to the clipboard.
293 294
</para>

295
@editable: the object which received the signal.
296

297
<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
298
<para>
299 300 301
An action signal. Causes the characters in the current
selection to be copied to the clipboard and then deleted from
the widget.
302 303
</para>

304
@editable: the object which received the signal.
305

306
<!-- ##### SIGNAL GtkEditable::delete-text ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
307
<para>
308 309 310 311 312 313 314 315 316
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
317 318
</para>

319 320 321
@editable: the object which received the signal.
@start_pos: the starting position.
@end_pos: the end position.
Havoc Pennington's avatar
Havoc Pennington committed
322

323
<!-- ##### SIGNAL GtkEditable::insert-text ##### -->
Owen Taylor's avatar
Owen Taylor committed
324
<para>
325 326 327 328 329 330 331
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.
332 333
</para>

334 335 336 337 338 339 340
@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.
341

342
<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
343
<para>
344
An action signal. Delete a single character.
345
</para>
346 347 348 349 350 351

@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 ##### -->
352
<para>
353
An action signal. Delete a single line.
354
</para>
355 356 357 358 359 360

@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 ##### -->
361
<para>
362
An action signal. Delete a single word.
363 364
</para>

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

369
<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
370
<para>
371
An action signal. Move the cursor position.
372 373
</para>

374 375 376
@editable: the object which received the signal.
@x: horizontal distance to move the cursor.
@y: vertical distance to move the cursor.
377

378
<!-- ##### SIGNAL GtkEditable::move-page ##### -->
379
<para>
380
An action signal. Move the cursor by pages.
381 382
</para>

383 384 385
@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.
386

387
<!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
388
<para>
389
An action signal. Move the cursor to the given column.
390
</para>
391 392 393 394 395 396

@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 ##### -->
397
<para>
398
An action signal. Move the cursor to the given row.
399 400
</para>

401 402 403
@editable: the object which received the signal.
@row: the row to move to. (A negative value indicates 
      the last row)
404

405
<!-- ##### SIGNAL GtkEditable::move-word ##### -->
406
<para>
407
An action signal. Move the cursor by words.
408 409
</para>

410 411 412
@editable: the object which received the signal.
@num_words: The number of words to move the
cursor. (Can be negative).
413

414
<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
415
<para>
416 417 418
An action signal. Causes the contents of the clipboard to
be pasted into the editable widget at the current cursor
position.
419 420
</para>

421
@editable: the object which received the signal.
422

423 424 425 426 427 428
<!-- ##### 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.
429 430
</para>

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

435 436 437 438
<!-- ##### ARG GtkEditable:editable ##### -->
<para>
A boolean indicating whether the widget is editable by
the user.
Owen Taylor's avatar
Owen Taylor committed
439 440 441
</para>


442
<!-- ##### ARG GtkEditable:text-position ##### -->
443
<para>
444
The position of the cursor.
445 446 447
</para>


448
<!-- ##### ENUM GtkFontFilterType ##### -->
449
<para>
450 451 452
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().
453 454
</para>

455 456 457
@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.
458

459
<!-- ##### ENUM GtkFontType ##### -->
460
<para>
461 462 463
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().
464 465
</para>

466 467 468 469
@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.
470

471
<!-- ##### STRUCT GtkIMContextSimple ##### -->
472 473 474 475
<para>

</para>

476 477 478 479 480
@object: 
@tables: 
@compose_buffer: 
@tentative_match: 
@tentative_match_len: 
481

482 483 484 485 486 487
<!-- ##### ARG GtkLabel:accel-keyval ##### -->
<para>

</para>


488
<!-- ##### ARG GtkObject:object-signal ##### -->
489
<para>
490 491 492
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.
493 494
</para>
<para>
495 496 497 498
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.
499 500 501
</para>


502
<!-- ##### ARG GtkObject:object-signal-after ##### -->
503
<para>
504 505 506 507
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.
508 509
</para>
<para>
510
See gtk_signal_connect_object_after() for more details.
511 512 513
</para>


514
<!-- ##### ARG GtkObject:signal ##### -->
515
<para>
516 517
Setting this with a GtkType of GTK_TYPE_SIGNAL connects
the signal to the object.
518 519 520
</para>


521
<!-- ##### ARG GtkObject:signal-after ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
522
<para>
523 524 525
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
526 527
</para>

528

529
<!-- ##### ENUM GtkPrivateFlags ##### -->
530
<para>
531

532 533
</para>

534 535 536 537 538 539 540 541
@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: 
542

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

558 559
@data: The user data associated with the hook that is being
destroyed.
560

561
<!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
562
<para>
563 564
This is currently a hack left in for a scheme wrapper library.
It may be removed.
565 566
</para>
<para>
567
Don't use it.
568 569
</para>

570 571 572 573 574 575 576
@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.
577

578
<!-- ##### STRUCT GtkSignalQuery ##### -->
579
<para>
580 581 582
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.
583 584
</para>

585 586 587 588 589 590 591 592
@object_type: 
@signal_id: 
@signal_name: 
@is_user_signal: 
@signal_flags: 
@return_val: 
@nparams: 
@params: 
593

594 595 596 597 598 599
<!-- ##### ARG GtkSpinButton:shadow-type ##### -->
<para>
the type of border that surrounds the arrows of a spin button.
</para>


600
<!-- ##### STRUCT GtkStatusbarMsg ##### -->
601
<para>
602
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.
603 604
</para>

605 606 607
@text: 
@context_id: 
@message_id: 
608

609
<!-- ##### ARG GtkTextTag:justify ##### -->
610
<para>
611 612
A #GtkJustification for the text. This is only used when the tag is
applied to the first character in a paragraph.
613 614 615
</para>


616
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
617
<para>
618 619
Pixel width of the left margin of the text for lines after the first
line in a wrapped paragraph.
620 621 622
</para>


623
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
624 625 626 627 628
<para>

</para>


629
<!-- ##### ARG GtkTextTag:offset ##### -->
630
<para>
631 632
Pixels to offset the text horizontally or vertically, useful to
produce superscript and subscript.
633 634 635
</para>


636 637 638 639 640 641 642 643 644 645 646 647
<!-- ##### ARG GtkTextView:justify ##### -->
<para>

</para>


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

</para>


648 649 650 651 652 653 654 655
<!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
<para>

</para>

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

656
<!-- ##### SIGNAL GtkWidget::draw ##### -->
657 658 659 660
<para>

</para>

661 662
@widget: the object which received the signal.
@area: 
663

664
<!-- ##### SIGNAL GtkWidget::draw-default ##### -->
665 666 667 668
<para>

</para>

669
@widget: the object which received the signal.
670

671
<!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
672 673 674 675
<para>

</para>

676
@widget: the object which received the signal.
Havoc Pennington's avatar
Havoc Pennington committed
677

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
<!-- ##### 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.

725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
<!-- ##### FUNCTION gtk_button_new_accel ##### -->
<para>

</para>

@uline_label: 
@accel_group: 
@Returns: 

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

</para>

@stock_id: 
@accel_group: 
@Returns: 

743
<!-- ##### FUNCTION gtk_clist_construct ##### -->
744
<para>
745 746
Initializes a previously allocated #GtkCList widget for use.  This should not
normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
747 748
</para>

749 750 751 752 753
@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.
754

755
<!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
756
<para>
757 758 759 760 761
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.
762 763
</para>

764 765 766
@colorsel: a #GtkColorSelection.
@use_opacity: a boolean indicating whether the opacity selection
is enabled.
767

768
<!-- ##### FUNCTION gtk_ctree_construct ##### -->
769
<para>
770
This function is not usually used by users.
771 772
</para>

773 774 775 776
@ctree: 
@columns: 
@tree_column: 
@titles: 
777

778
<!-- ##### FUNCTION gtk_editable_changed ##### -->
779
<para>
780
Causes the "changed" signal to be emitted.
781 782
</para>

783
@editable: a #GtkEditable widget.
784

785
<!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
786
<para>
787
Claim or disclaim ownership of the PRIMARY X selection.
788 789
</para>

790 791 792
@editable: a #GtkEditable widget.
@claim: if %TRUE, claim the selection, otherwise, disclaim it.
@time: the timestamp for claiming the selection.
793

794
<!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
795
<para>
796
Sets one of the two font filters, to limit the fonts shown.
797 798
</para>

799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
@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.
818

819
<!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
820
<para>
821
Sets one of the two font filters, to limit the fonts shown.
822 823
</para>

824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
@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.
843

844
<!-- ##### FUNCTION gtk_identifier_get_type ##### -->
845
<para>
846
Get the type of GtkIdentifier.
847
</para>
848

849
@Returns: GtkType -- the enumerated type of something.
850

851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
<!-- ##### FUNCTION gtk_label_set_markup_with_accel ##### -->
<para>

</para>

@label: 
@str: 
@Returns: 

<!-- ##### FUNCTION gtk_menu_ensure_uline_accel_group ##### -->
<para>

</para>

@menu: 
@Returns: 

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

</para>

@menu: 
@Returns: 

876
<!-- ##### FUNCTION gtk_object_arg_get ##### -->
877
<para>
878
Private function to get an argument and argument info from an object.
879 880
</para>

881 882 883
@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.
884

885
<!-- ##### FUNCTION gtk_object_arg_get_info ##### -->
Owen Taylor's avatar
Owen Taylor committed
886
<para>
887
Query information about an argument type.
Owen Taylor's avatar
Owen Taylor committed
888 889
</para>

890 891 892 893 894
@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
895

896
<!-- ##### FUNCTION gtk_object_arg_set ##### -->
Owen Taylor's avatar
Owen Taylor committed
897
<para>
898
Private function to set an argument and argument info to an object.
Owen Taylor's avatar
Owen Taylor committed
899 900
</para>

901 902 903
@object: the object whose argument should be set.
@arg: the argument.
@info: infomation about this type of argument in general.
Owen Taylor's avatar
Owen Taylor committed
904

905
<!-- ##### FUNCTION gtk_object_args_collect ##### -->
Owen Taylor's avatar
Owen Taylor committed
906
<para>
907
Private: Gets an array of #GtkArgs from a va_list C structure.
Owen Taylor's avatar
Owen Taylor committed
908 909
</para>

910 911 912 913 914 915 916 917
@object_type: the type of object to collect arguments for.
@arg_list_p: pointer to be filled in with a list of parsed arguments.
@info_list_p: optional pointer for a returned list #GtkArgInfos.
@first_arg_name: name of first argument.
@var_args: value of first argument, followed by more key/value pairs,
terminated by NULL.
@Returns: an error message, or NULL on success.
It is the caller's responsibility to call g_free() in the event of error.
Owen Taylor's avatar
Owen Taylor committed
918

919
<!-- ##### FUNCTION gtk_object_class_add_signals ##### -->
920
<para>
921 922
Add an array of signals to a #GtkObjectClass.
Usually this is called when registering a new type of object.
923
</para>
Havoc Pennington's avatar
Havoc Pennington committed
924

925 926 927
@klass: the object class to append signals to.
@signals: the signals to append.
@nsignals: the number of signals being appended.
Havoc Pennington's avatar
Havoc Pennington committed
928

929
<!-- ##### FUNCTION gtk_object_class_user_signal_new ##### -->
930
<para>
931 932 933 934 935
Define a signal-handler for a new signal on an already defined
object.
</para>
<para>
See the signal documentation for more general information.