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


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


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


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


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

</para>


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

</para>


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



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


Havoc Pennington's avatar
Havoc Pennington committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
<!-- ##### SECTION ./tmpl/gtkdata.sgml:Long_Description ##### -->
<para>
The #GtkData object is a very simple object intended to be used as a base
class for objects which contain data (i.e. the 'Model' in the object-oriented
Model/View/Controller framework).
</para>
<para>
Currently it is not very useful since all it provides is a "disconnect" signal.
This signal could be emitted by a #GtkData subclass to notify any 'Views'
that they should disconnect from the #GtkData (the 'Model'), possibly just
before the #GtkData is destroyed.
</para>


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

</para>


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


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


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


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


104 105 106
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
<refsect2>
<title>What are Signal Marshallers?</title>
107
<para>
108 109 110 111
Marshals are functions which all have the same prototype:
they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
and an array of argument values.
The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
112 113
</para>
<para>
114 115 116 117 118 119 120
They then call a native function:  the GtkObject is the first
parameter passed in.  The arguments are passed in the native
calling convention:  chars, shorts, ints, longs may be packed
on the stack, or tucked in registers:  it doesn't matter
because the same calling convention will be generated
inside the gtkmarshal code as is expected where you define
your handlers.
121 122
</para>
<para>
123 124 125 126 127 128 129 130
So the function named:
<programlisting>
gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
</programlisting>
will call the #GtkSignalFunc assuming it was a function with signature:
<programlisting>
gboolean sigfunc(gpointer,gint,gint,guint);
</programlisting>
131
</para>
132 133 134
</refsect2>
<refsect2>
<title>Writing Custom Marshals</title>
135
<para>
136 137 138
Marshals are primarily used as arguments to gtk_signal_new().
Sometimes, you may find that a marshaller you need isn't available
in the standard list.  Then you have to write your own.
139
</para>
Owen Taylor's avatar
Owen Taylor committed
140
<para>
141 142 143 144 145 146 147
If you wish to define a signal with a new type of argument list.
Suppose you want 2 pointers and 2 integers.
You would write:
<programlisting>
typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
			gpointer, gpointer, gint, gint
);
148

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
void marshal_INT__POINTER_POINTER_INT_INT(GtkObject*    object,
					   GtkSignalFunc func,
					   gpointer      func_data,
                                           GtkArg*       args)
{
	GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
	gint* return_val;
	return_val = GTK_RETLOC_INT(args[4]);
	rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
	*return_val = (*rfunc)(object,
                               GTK_VALUE_POINTER(args[0]),
                               GTK_VALUE_POINTER(args[1]),
                               GTK_VALUE_INT(args[2]),
                               GTK_VALUE_INT(args[3]),
                               func_data);
}
</programlisting>
Owen Taylor's avatar
Owen Taylor committed
166
</para>
167
</refsect2>
Owen Taylor's avatar
Owen Taylor committed
168 169


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

174 175 176 177 178
<varlistentry>
<term>#GtkSignal</term>
<listitem><para>The signal handling functions (of which marshallers are 
really an implementation detail).</para></listitem>
</varlistentry>
Jonathan Blandford's avatar
Jonathan Blandford committed
179

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


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

187

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

191

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

</para>


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

</para>


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



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


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


Havoc Pennington's avatar
Havoc Pennington committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
<!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Long_Description ##### -->
<para>

</para>


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

</para>


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



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


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

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

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

</para>


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

</para>


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

</para>


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

</para>


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

</para>


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

</para>

@obj: 

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

</para>

@klass: 

288 289 290 291 292 293 294
<!-- ##### MACRO GTK_OBJECT_CONNECTED ##### -->
<para>
Tests whether a #GtkObject has had a signal connected to it.
</para>

@obj: the object to examine.

295
<!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
296
<para>
297
Test whether a GtkObject's arguments have been prepared.
298 299
</para>

300
@obj: the object to examine.
301

302 303 304 305 306 307 308
<!-- ##### MACRO GTK_OBJECT_DESTROYED ##### -->
<para>
Test whether a GtkObject has had gtk_object_destroy() invoked on it.
</para>

@obj: the object to examine.

309
<!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
Owen Taylor's avatar
Owen Taylor committed
310
<para>
311
Get the number of signals defined by this object.
Owen Taylor's avatar
Owen Taylor committed
312 313
</para>

314
@obj: the object to query.
Owen Taylor's avatar
Owen Taylor committed
315

316 317 318 319 320 321 322 323
<!-- ##### MACRO GTK_OBJECT_SET_FLAGS ##### -->
<para>
Turns on certain object flags.  (Private)
</para>

@obj: the object to affect.
@flag: the flags to set.

324
<!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
325
<para>
326
Get the array of signals defined for this object.
327 328
</para>

329
@obj: the object to fetch the signals from.
330

331 332 333 334 335 336 337 338
<!-- ##### MACRO GTK_OBJECT_UNSET_FLAGS ##### -->
<para>
Turns off certain object flags.  (Private)
</para>

@obj: the object to affect.
@flag: the flags to unset.

339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
<!-- ##### 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>


375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
<!-- ##### MACRO GTK_TIPS_QUERY ##### -->
<para>

</para>

@obj: 

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

</para>

@klass: 

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

</para>

@obj: 

Jonathan Blandford's avatar
docs  
Jonathan Blandford committed
396 397 398 399 400 401 402
<!-- ##### MACRO GTK_TREE_MODEL_GET_IFACE ##### -->
<para>

</para>

@obj: 

403
<!-- ##### MACRO GTK_TREE_SELECTION ##### -->
404
<para>
405
A macro that returns a GList that contains the selection of the root tree of @obj.
406 407
</para>

408
@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.
409

410
<!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
411
<para>
412
The first "flat" (no struct) enumerated type value.
413 414 415
</para>


416
<!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
417
<para>
418
The last "flat" (no struct) enumerated type value.
Havoc Pennington's avatar
Havoc Pennington committed
419 420 421
</para>


422
<!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
423
<para>
424
Hide the name of gtk_identifier_get_type
Havoc Pennington's avatar
Havoc Pennington committed
425 426 427
</para>


428
<!-- ##### MACRO GTK_TYPE_MAKE ##### -->
429
<para>
430
Combine a fundemantal type and a sequence number to create a gtk type.
431 432
</para>

433 434
@parent_t: 
@seqno: 
435

436
<!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
437
<para>
438
No idea.
439 440 441
</para>


442
<!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
443
<para>
444
Convert a gtk type into its sequence number
445 446
</para>

447
@type: 
448

449
<!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
450
<para>
451
The first structured enumerated type value.
452
</para>
453 454


455
<!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
456
<para>
457
The last structured enumerated type value.
458 459 460
</para>


461 462 463 464 465 466
<!-- ##### MACRO GTK_TYPE_TIPS_QUERY ##### -->
<para>

</para>


467 468 469 470 471 472
<!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
<para>

</para>


Havoc Pennington's avatar
docs  
Havoc Pennington committed
473 474 475 476 477 478
<!-- ##### MACRO GTK_TYPE_TREE_VIEW_COLUMN ##### -->
<para>

</para>


479
<!-- ##### MACRO GTK_VALUE_ARGS ##### -->
480
<para>
481
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
482 483
</para>

484
@a: 
485

486
<!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
487
<para>
488
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
489
</para>
Havoc Pennington's avatar
Havoc Pennington committed
490

491
@a: 
492

493
<!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
494
<para>
495
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
496 497
</para>

498
@a: 
499

500
<!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
501
<para>
502
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
Havoc Pennington's avatar
Havoc Pennington committed
503 504
</para>

505
@a: 
Havoc Pennington's avatar
Havoc Pennington committed
506

Tim Janik's avatar
Tim Janik committed
507 508 509 510 511 512 513 514 515
<!-- ##### USER_FUNCTION GValueCompareFunc ##### -->
<para>

</para>

@a: 
@b: 
@Returns: 

516 517 518 519 520 521 522 523 524 525 526 527
<!-- ##### STRUCT GtkAccelEntry ##### -->
<para>
This is a private struct used by GTK+ internally, don't worry about it.
</para>

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

528
<!-- ##### ARG GtkAccelLabel:accel-object ##### -->
529
<para>
530

531 532 533
</para>


534 535 536 537 538 539
<!-- ##### ARG GtkAccelLabel:accel-width ##### -->
<para>

</para>


540 541 542 543 544 545 546 547 548 549 550 551 552
<!-- ##### USER_FUNCTION GtkAccelMapNotify ##### -->
<para>

</para>

@data: 
@accel_path_quark: 
@accel_key: 
@accel_mods: 
@accel_group: 
@old_accel_key: 
@old_accel_mods: 

553 554 555 556 557 558 559 560 561
<!-- ##### USER_FUNCTION GtkArgGetFunc ##### -->
<para>
Define a function pointer.  Deprecated.
</para>

@object: 
@arg: 
@arg_id: 

Owen Taylor's avatar
Owen Taylor committed
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
<!-- ##### STRUCT GtkArgInfo ##### -->
<para>
A structure containing information about the argument.
Returned by gtk_arg_get_info().
</para>

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

579 580 581 582 583 584 585 586 587
<!-- ##### USER_FUNCTION GtkArgSetFunc ##### -->
<para>
Define a function pointer.  Deprecated.
</para>

@object: 
@arg: 
@arg_id: 

588 589 590 591 592 593 594
<!-- ##### STRUCT GtkCellRendererTextPixbuf ##### -->
<para>

</para>

@parent: 

Owen Taylor's avatar
Owen Taylor committed
595 596 597 598 599 600 601 602 603 604 605 606
<!-- ##### ARG GtkColorSelection:previous-alpha ##### -->
<para>

</para>


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

</para>


607 608 609 610 611 612 613 614 615
<!-- ##### SIGNAL GtkContainer::focus ##### -->
<para>

</para>

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

616 617 618 619 620 621
<!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
<para>

</para>


Havoc Pennington's avatar
Delete.  
Havoc Pennington committed
622 623 624 625 626 627 628 629 630 631 632 633 634 635
<!-- ##### 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.

636
<!-- ##### SIGNAL GtkEditable::activate ##### -->
637
<para>
638 639 640 641 642
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.)
643 644
</para>

645
@editable: the object which received the signal.
646

647
<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
648
<para>
649 650
An action signal. Causes the characters in the current selection to
be copied to the clipboard.
651 652
</para>

653
@editable: the object which received the signal.
654

655
<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
656
<para>
657 658 659
An action signal. Causes the characters in the current
selection to be copied to the clipboard and then deleted from
the widget.
660 661
</para>

662
@editable: the object which received the signal.
663

664
<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
665
<para>
666
An action signal. Delete a single character.
667
</para>
668 669 670 671 672 673

@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 ##### -->
674
<para>
675
An action signal. Delete a single line.
676
</para>
677 678 679 680 681 682

@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 ##### -->
683
<para>
684
An action signal. Delete a single word.
685 686
</para>

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

691
<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
692
<para>
693
An action signal. Move the cursor position.
694 695
</para>

696 697 698
@editable: the object which received the signal.
@x: horizontal distance to move the cursor.
@y: vertical distance to move the cursor.
699

700
<!-- ##### SIGNAL GtkEditable::move-page ##### -->
701
<para>
702
An action signal. Move the cursor by pages.
703 704
</para>

705 706 707
@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.
708

709
<!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
710
<para>
711
An action signal. Move the cursor to the given column.
712
</para>
713 714 715 716 717 718

@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 ##### -->
719
<para>
720
An action signal. Move the cursor to the given row.
721 722
</para>

723 724 725
@editable: the object which received the signal.
@row: the row to move to. (A negative value indicates 
      the last row)
726

727
<!-- ##### SIGNAL GtkEditable::move-word ##### -->
728
<para>
729
An action signal. Move the cursor by words.
730 731
</para>

732 733 734
@editable: the object which received the signal.
@num_words: The number of words to move the
cursor. (Can be negative).
735

736
<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
737
<para>
738 739 740
An action signal. Causes the contents of the clipboard to
be pasted into the editable widget at the current cursor
position.
741 742
</para>

743
@editable: the object which received the signal.
744

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

753 754 755
@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
756

757 758 759 760
<!-- ##### ARG GtkEditable:editable ##### -->
<para>
A boolean indicating whether the widget is editable by
the user.
Owen Taylor's avatar
Owen Taylor committed
761 762 763
</para>


764
<!-- ##### ARG GtkEditable:text-position ##### -->
765
<para>
766
The position of the cursor.
767 768 769
</para>


Havoc Pennington's avatar
Havoc Pennington committed
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
<!-- ##### 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: 

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
<!-- ##### SIGNAL GtkEntry::changed ##### -->
<para>

</para>

@entry: the object which received the signal.

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

</para>

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

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

</para>

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

814 815 816 817 818 819
<!-- ##### ARG GtkEntry:text-position ##### -->
<para>

</para>


820
<!-- ##### ENUM GtkFontFilterType ##### -->
821
<para>
822 823 824
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().
825 826
</para>

827 828 829
@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.
830

831
<!-- ##### ENUM GtkFontType ##### -->
832
<para>
833 834 835
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().
836 837
</para>

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

843 844 845 846 847 848 849 850 851 852 853 854
<!-- ##### ARG GtkHScale:adjustment ##### -->
<para>
the #GtkAdjustment which sets the range of the scale.
</para>


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

</para>


Owen Taylor's avatar
Owen Taylor committed
855 856 857 858 859 860 861 862 863 864 865 866 867
<!-- ##### USER_FUNCTION GtkImageLoader ##### -->
<para>
A GtkImageLoader is used to load a filename found in
a RC file.
</para>

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

868 869 870 871 872 873
<!-- ##### STRUCT GtkImageMenuItemClass ##### -->
<para>

</para>


874 875 876 877 878 879
<!-- ##### ARG GtkLabel:accel-keyval ##### -->
<para>

</para>


Owen Taylor's avatar
Owen Taylor committed
880 881 882 883 884 885 886 887
<!-- ##### SIGNAL GtkMenuBar::cycle-focus ##### -->
<para>

</para>

@menubar: the object which received the signal.
@arg1: 

888
<!-- ##### ARG GtkObject:object-signal ##### -->
889
<para>
890 891 892
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.
893 894
</para>
<para>
895 896 897 898
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.
899 900 901
</para>


902
<!-- ##### ARG GtkObject:object-signal-after ##### -->
903
<para>
904 905 906 907
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.
908 909
</para>
<para>
910
See gtk_signal_connect_object_after() for more details.
911 912 913
</para>


914
<!-- ##### ARG GtkObject:signal ##### -->
915
<para>
916 917
Setting this with a GtkType of GTK_TYPE_SIGNAL connects
the signal to the object.
918 919 920
</para>


921
<!-- ##### ARG GtkObject:signal-after ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
922
<para>
923 924 925
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
926 927
</para>

928

929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
<!-- ##### SIGNAL GtkOldEditable::changed ##### -->
<para>

</para>

@oldeditable: the object which received the signal.

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

</para>

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

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

</para>

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

955 956 957 958 959 960 961 962 963 964 965 966 967 968
<!-- ##### STRUCT GtkPacker ##### -->
<para>

</para>

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

Owen Taylor's avatar
Owen Taylor committed
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
<!-- ##### ARG GtkPacker:default-border-width ##### -->
<para>

</para>


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

</para>


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

</para>


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

</para>


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

</para>


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

</para>


1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
<!-- ##### STRUCT GtkPackerChild ##### -->
<para>

</para>

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

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

</para>

@GTK_PACK_EXPAND: 
@GTK_FILL_X: 
@GTK_FILL_Y: 

1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
<!-- ##### STRUCT GtkPatternSpec ##### -->
<para>

</para>

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

1042
<!-- ##### ENUM GtkPrivateFlags ##### -->
1043
<para>
1044

1045 1046
</para>

1047 1048 1049 1050 1051 1052 1053 1054
@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: 
1055

1056 1057 1058 1059 1060 1061
<!-- ##### STRUCT GtkRcStyleClass ##### -->
<para>

</para>


Owen Taylor's avatar
Owen Taylor committed
1062 1063 1064 1065 1066 1067
<!-- ##### ARG GtkScrolledWindow:shadow ##### -->
<para>

</para>


1068 1069 1070 1071 1072 1073
<!-- ##### STRUCT GtkSettingsClass ##### -->
<para>

</para>


1074
<!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
1075
<para>
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
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).
1087 1088
</para>

1089 1090
@data: The user data associated with the hook that is being
destroyed.
1091

1092
<!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
1093
<para>
1094 1095
This is currently a hack left in for a scheme wrapper library.
It may be removed.
1096 1097
</para>
<para>
1098
Don't use it.
1099 1100
</para>

1101 1102 1103 1104 1105 1106 1107
@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.
1108

1109
<!-- ##### STRUCT GtkSignalQuery ##### -->
1110
<para>
1111 1112 1113
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.
1114 1115
</para>

1116 1117 1118 1119 1120 1121 1122 1123
@object_type: 
@signal_id: 
@signal_name: 
@is_user_signal: 
@signal_flags: 
@return_val: 
@nparams: 
@params: 
1124

1125
<!-- ##### STRUCT GtkStatusbarMsg ##### -->
1126
<para>
1127
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.
1128 1129
</para>

1130 1131 1132
@text: 
@context_id: 
@message_id: 
1133

1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
<!-- ##### STRUCT GtkStyleClass ##### -->
<para>

</para>

@parent_class: 
@realize: 
@unrealize: 
@copy: 
@clone: 
@init_from_rc: 
@set_background: 
@render_icon: 
@draw_hline: 
@draw_vline: 
@draw_shadow: 
@draw_polygon: 
@draw_arrow: 
@draw_diamond: 
@draw_string: 
@draw_box: 
@draw_flat_box: 
@draw_check: 
@draw_option: 
@draw_tab: 
@draw_shadow_gap: 
@draw_box_gap: 
@draw_extension: 
@draw_focus: 
@draw_slider: 
@draw_handle: 
@draw_expander: 
@draw_layout: 
@draw_resize_grip: 
@_gtk_reserved1: 
@_gtk_reserved2: 
@_gtk_reserved3: 
@_gtk_reserved4: 
@_gtk_reserved5: 
@_gtk_reserved6: 
@_gtk_reserved7: 
@_gtk_reserved8: 
@_gtk_reserved9: 
@_gtk_reserved10: 
@_gtk_reserved11: 
@_gtk_reserved12: 

Owen Taylor's avatar
Owen Taylor committed
1181 1182 1183 1184 1185 1186
<!-- ##### STRUCT GtkTextBTreeNode ##### -->
<para>

</para>


1187 1188 1189 1190 1191 1192
<!-- ##### STRUCT GtkTextChildAnchorClass ##### -->
<para>

</para>


1193
<!-- ##### ARG GtkTextTag:justify ##### -->
1194
<para>
1195 1196
A #GtkJustification for the text. This is only used when the tag is
applied to the first character in a paragraph.
1197 1198 1199
</para>


1200
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
1201
<para>
1202 1203
Pixel width of the left margin of the text for lines after the first
line in a wrapped paragraph.
1204 1205 1206
</para>


1207
<!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
1208 1209 1210 1211 1212
<para>

</para>


1213
<!-- ##### ARG GtkTextTag:offset ##### -->
1214
<para>
1215 1216
Pixels to offset the text horizontally or vertically, useful to
produce superscript and subscript.
1217 1218 1219
</para>


1220 1221 1222 1223 1224 1225
<!-- ##### ARG GtkTextView:height-lines ##### -->
<para>

</para>


Havoc Pennington's avatar
Havoc Pennington committed
1226 1227 1228 1229 1230 1231
<!-- ##### ARG GtkTextView:justify ##### -->
<para>

</para>


1232 1233 1234 1235 1236 1237
<!-- ##### ARG GtkTextView:width-columns ##### -->
<para>

</para>