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


Matthias Clasen's avatar
2.11.1  
Matthias Clasen committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
<!-- ##### SECTION ./tmpl/gtkthemes.sgml:Long_Description ##### -->
<para>

</para>


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

</para>


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



<!-- ##### SECTION ./tmpl/gtkthemes.sgml:Stability_Level ##### -->



<!-- ##### SECTION ./tmpl/gtkthemes.sgml:Title ##### -->
Themes


Havoc Pennington's avatar
Havoc Pennington committed
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
<!-- ##### 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


260
<!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
261
<para>
262 263
A macro to check whether a child widget of the CList
has the focus.
264 265
</para>

266
@clist: The #GtkCList widget to check.
267

268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
<!-- ##### 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>


298 299 300 301 302 303 304 305 306 307 308 309 310 311
<!-- ##### MACRO GTK_IS_TIPS_QUERY ##### -->
<para>

</para>

@obj: 

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

</para>

@klass: 

312 313 314 315 316 317 318
<!-- ##### MACRO GTK_OBJECT_CONNECTED ##### -->
<para>
Tests whether a #GtkObject has had a signal connected to it.
</para>

@obj: the object to examine.

319
<!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
320
<para>
321
Test whether a GtkObject's arguments have been prepared.
322 323
</para>

324
@obj: the object to examine.
325

326 327 328 329 330 331 332
<!-- ##### MACRO GTK_OBJECT_DESTROYED ##### -->
<para>
Test whether a GtkObject has had gtk_object_destroy() invoked on it.
</para>

@obj: the object to examine.

333
<!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
Owen Taylor's avatar
Owen Taylor committed
334
<para>
335
Get the number of signals defined by this object.
Owen Taylor's avatar
Owen Taylor committed
336 337
</para>

338
@obj: the object to query.
Owen Taylor's avatar
Owen Taylor committed
339

340 341 342 343 344 345 346 347
<!-- ##### MACRO GTK_OBJECT_SET_FLAGS ##### -->
<para>
Turns on certain object flags.  (Private)
</para>

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

348
<!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
349
<para>
350
Get the array of signals defined for this object.
351 352
</para>

353
@obj: the object to fetch the signals from.
354

355 356 357 358 359 360 361 362
<!-- ##### MACRO GTK_OBJECT_UNSET_FLAGS ##### -->
<para>
Turns off certain object flags.  (Private)
</para>

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

Matthias Clasen's avatar
2.9.1  
Matthias Clasen committed
363 364 365 366 367 368
<!-- ##### MACRO GTK_PRINT_SETTINGS_NUM_COPIES ##### -->
<para>

</para>


Matthias Clasen's avatar
2.9.4  
Matthias Clasen committed
369 370 371 372 373 374
<!-- ##### MACRO GTK_PRINT_SETTINGS_PRINT_TO_FILE ##### -->
<para>

</para>


375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
<!-- ##### 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>


411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
<!-- ##### 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
432 433 434 435 436 437 438
<!-- ##### MACRO GTK_TREE_MODEL_GET_IFACE ##### -->
<para>

</para>

@obj: 

439
<!-- ##### MACRO GTK_TREE_SELECTION ##### -->
440
<para>
441
A macro that returns a GList that contains the selection of the root tree of @obj.
442 443
</para>

444
@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.
445

446
<!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
447
<para>
448
The first "flat" (no struct) enumerated type value.
449 450 451
</para>


452
<!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
453
<para>
454
The last "flat" (no struct) enumerated type value.
Havoc Pennington's avatar
Havoc Pennington committed
455 456 457
</para>


458
<!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
459
<para>
460
Hide the name of gtk_identifier_get_type
Havoc Pennington's avatar
Havoc Pennington committed
461 462 463
</para>


464
<!-- ##### MACRO GTK_TYPE_MAKE ##### -->
465
<para>
466
Combine a fundemantal type and a sequence number to create a gtk type.
467 468
</para>

469 470
@parent_t: 
@seqno: 
471

472
<!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
473
<para>
474
No idea.
475 476 477
</para>


478
<!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
479
<para>
480
Convert a gtk type into its sequence number
481 482
</para>

483
@type: 
484

485
<!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
486
<para>
487
The first structured enumerated type value.
488
</para>
489 490


491
<!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
492
<para>
493
The last structured enumerated type value.
494 495 496
</para>


497 498 499 500 501 502
<!-- ##### MACRO GTK_TYPE_TIPS_QUERY ##### -->
<para>

</para>


503 504 505 506 507 508
<!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
<para>

</para>


Havoc Pennington's avatar
docs  
Havoc Pennington committed
509 510 511 512 513 514
<!-- ##### MACRO GTK_TYPE_TREE_VIEW_COLUMN ##### -->
<para>

</para>


515
<!-- ##### MACRO GTK_VALUE_ARGS ##### -->
516
<para>
517
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
518 519
</para>

520
@a: 
521

522
<!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
523
<para>
524
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
525
</para>
Havoc Pennington's avatar
Havoc Pennington committed
526

527
@a: 
528

529
<!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
530
<para>
531
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
532 533
</para>

534
@a: 
535

536
<!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
537
<para>
538
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
Havoc Pennington's avatar
Havoc Pennington committed
539 540
</para>

541
@a: 
Havoc Pennington's avatar
Havoc Pennington committed
542

Tim Janik's avatar
Tim Janik committed
543 544 545 546 547 548 549 550 551
<!-- ##### USER_FUNCTION GValueCompareFunc ##### -->
<para>

</para>

@a: 
@b: 
@Returns: 

Matthias Clasen's avatar
2.9.0  
Matthias Clasen committed
552 553 554 555 556 557
<!-- ##### ARG GtkAboutDialog:link-color ##### -->
<para>

</para>


Matthias Clasen's avatar
2.11.0  
Matthias Clasen committed
558 559 560 561 562 563
<!-- ##### ARG GtkAboutDialog:name ##### -->
<para>

</para>


564 565 566 567 568 569 570 571 572 573 574 575
<!-- ##### 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: 

576
<!-- ##### ARG GtkAccelLabel:accel-object ##### -->
577
<para>
578

579 580 581
</para>


582 583 584 585 586 587
<!-- ##### ARG GtkAccelLabel:accel-width ##### -->
<para>

</para>


588 589 590 591 592 593 594 595 596 597 598 599 600
<!-- ##### USER_FUNCTION GtkAccelMapNotify ##### -->
<para>

</para>

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

Jonathan Blandford's avatar
Jonathan Blandford committed
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
<!-- ##### SIGNAL GtkAction::connect-proxy ##### -->
<para>

</para>

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

<!-- ##### SIGNAL GtkAction::disconnect-proxy ##### -->
<para>

</para>

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

617 618 619 620 621 622 623 624 625
<!-- ##### USER_FUNCTION GtkArgGetFunc ##### -->
<para>
Define a function pointer.  Deprecated.
</para>

@object: 
@arg: 
@arg_id: 

Owen Taylor's avatar
Owen Taylor committed
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
<!-- ##### 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: ???

643 644 645 646 647 648 649 650 651
<!-- ##### USER_FUNCTION GtkArgSetFunc ##### -->
<para>
Define a function pointer.  Deprecated.
</para>

@object: 
@arg: 
@arg_id: 

Matthias Clasen's avatar
2.11.5  
Matthias Clasen committed
652 653 654 655 656 657 658 659 660 661 662 663
<!-- ##### STRUCT GtkBuilderClass ##### -->
<para>

</para>

@get_type_from_name: Looks up a type by name. The default
  implementation applies heuristics to map type names to
  <function>_get_type</function> function names, e.g. 
  GtkHBox to gtk_hbox_get_type(). This virtual function
  is provided to allow language bindings to intercept the
  type resolution process.

664 665 666 667 668 669 670
<!-- ##### STRUCT GtkCellRendererTextPixbuf ##### -->
<para>

</para>

@parent: 

Matthias Clasen's avatar
2.11.0  
Matthias Clasen committed
671 672 673 674 675 676
<!-- ##### ARG GtkCellView:use-fg ##### -->
<para>

</para>


Owen Taylor's avatar
Owen Taylor committed
677 678 679 680 681 682 683 684 685 686 687 688
<!-- ##### ARG GtkColorSelection:previous-alpha ##### -->
<para>

</para>


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

</para>


Matthias Clasen's avatar
2.9.0  
Matthias Clasen committed
689 690 691 692 693 694 695 696 697 698 699 700 701 702
<!-- ##### SIGNAL GtkComboBox::popup-hide ##### -->
<para>

</para>

@combobox: the object which received the signal.

<!-- ##### SIGNAL GtkComboBox::popup-show ##### -->
<para>

</para>

@combobox: the object which received the signal.

Owen Taylor's avatar
Owen Taylor committed
703 704 705 706 707 708
<!-- ##### ARG GtkComboBox:appearance ##### -->
<para>

</para>


Matthias Clasen's avatar
2.5.1  
Matthias Clasen committed
709 710 711 712 713 714
<!-- ##### ARG GtkComboBox:row-separator-column ##### -->
<para>

</para>


715 716 717 718 719 720 721 722 723
<!-- ##### SIGNAL GtkContainer::focus ##### -->
<para>

</para>

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

724 725 726 727 728 729
<!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
<para>

</para>


Havoc Pennington's avatar
Delete.  
Havoc Pennington committed
730 731 732 733 734 735 736 737 738 739 740 741 742 743
<!-- ##### 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.

744
<!-- ##### SIGNAL GtkEditable::activate ##### -->
745
<para>
746 747 748 749 750
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.)
751 752
</para>

753
@editable: the object which received the signal.
754

755
<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
756
<para>
757 758
An action signal. Causes the characters in the current selection to
be copied to the clipboard.
759 760
</para>

761
@editable: the object which received the signal.
762

763
<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
764
<para>
765 766 767
An action signal. Causes the characters in the current
selection to be copied to the clipboard and then deleted from
the widget.
768 769
</para>

770
@editable: the object which received the signal.
771

772
<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
773
<para>
774
An action signal. Delete a single character.
775
</para>
776 777 778 779 780 781

@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 ##### -->
782
<para>
783
An action signal. Delete a single line.
784
</para>
785 786 787 788 789 790

@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 ##### -->
791
<para>
792
An action signal. Delete a single word.
793 794
</para>

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

799
<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
800
<para>
801
An action signal. Move the cursor position.
802 803
</para>

804 805 806
@editable: the object which received the signal.
@x: horizontal distance to move the cursor.
@y: vertical distance to move the cursor.
807

808
<!-- ##### SIGNAL GtkEditable::move-page ##### -->
809
<para>
810
An action signal. Move the cursor by pages.
811 812
</para>

813 814 815
@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.
816

817
<!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
818
<para>
819
An action signal. Move the cursor to the given column.
820
</para>
821 822 823 824 825 826

@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 ##### -->
827
<para>
828
An action signal. Move the cursor to the given row.
829 830
</para>

831 832 833
@editable: the object which received the signal.
@row: the row to move to. (A negative value indicates 
      the last row)
834

835
<!-- ##### SIGNAL GtkEditable::move-word ##### -->
836
<para>
837
An action signal. Move the cursor by words.
838 839
</para>

840 841 842
@editable: the object which received the signal.
@num_words: The number of words to move the
cursor. (Can be negative).
843

844
<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
845
<para>
846 847 848
An action signal. Causes the contents of the clipboard to
be pasted into the editable widget at the current cursor
position.
849 850
</para>

851
@editable: the object which received the signal.
852

853 854 855 856 857 858
<!-- ##### 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.
859 860
</para>

861 862 863
@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
864

865 866 867 868
<!-- ##### ARG GtkEditable:editable ##### -->
<para>
A boolean indicating whether the widget is editable by
the user.
Owen Taylor's avatar
Owen Taylor committed
869 870 871
</para>


872
<!-- ##### ARG GtkEditable:text-position ##### -->
873
<para>
874
The position of the cursor.
875 876 877
</para>


Havoc Pennington's avatar
Havoc Pennington committed
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
<!-- ##### 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: 

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921
<!-- ##### 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: 

922 923 924 925 926 927
<!-- ##### ARG GtkEntry:text-position ##### -->
<para>

</para>


Matthias Clasen's avatar
2.11.5  
Matthias Clasen committed
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
<!-- ##### ARG GtkFileChooser:action ##### -->
<para>

</para>


<!-- ##### ARG GtkFileChooser:do-overwrite-confirmation ##### -->
<para>

</para>


<!-- ##### ARG GtkFileChooser:extra-widget ##### -->
<para>

</para>


946 947 948 949 950 951
<!-- ##### ARG GtkFileChooser:file-system ##### -->
<para>

</para>


Matthias Clasen's avatar
2.11.5  
Matthias Clasen committed
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 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
<!-- ##### ARG GtkFileChooser:file-system-backend ##### -->
<para>

</para>


<!-- ##### ARG GtkFileChooser:filter ##### -->
<para>

</para>


<!-- ##### ARG GtkFileChooser:local-only ##### -->
<para>

</para>


<!-- ##### ARG GtkFileChooser:preview-widget ##### -->
<para>

</para>


<!-- ##### ARG GtkFileChooser:preview-widget-active ##### -->
<para>

</para>


<!-- ##### ARG GtkFileChooser:select-multiple ##### -->
<para>

</para>


<!-- ##### ARG GtkFileChooser:show-hidden ##### -->
<para>

</para>


<!-- ##### ARG GtkFileChooser:use-preview-label ##### -->
<para>

</para>


1000
<!-- ##### ENUM GtkFontFilterType ##### -->
1001
<para>
1002 1003 1004
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().
1005 1006
</para>

1007 1008 1009
@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.
1010

1011
<!-- ##### ENUM GtkFontType ##### -->
1012
<para>
1013 1014 1015
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().
1016 1017
</para>

1018 1019 1020 1021
@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.
1022

1023 1024 1025 1026 1027 1028 1029
<!-- ##### ARG GtkHScale:adjustment ##### -->
<para>
the #GtkAdjustment which sets the range of the scale.
</para>


<!-- ##### ARG GtkHScrollbar:adjustment ##### -->
Matthias Clasen's avatar
2.7.1  
Matthias Clasen committed
1030 1031 1032 1033 1034 1035
<para>

</para>


<!-- ##### STRUCT GtkIconViewPrivate ##### -->
1036 1037 1038 1039 1040
<para>

</para>


Owen Taylor's avatar
Owen Taylor committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
<!-- ##### 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

1054 1055 1056 1057 1058 1059
<!-- ##### STRUCT GtkImageMenuItemClass ##### -->
<para>

</para>


1060 1061 1062 1063 1064 1065
<!-- ##### ARG GtkLabel:accel-keyval ##### -->
<para>

</para>


Owen Taylor's avatar
Owen Taylor committed
1066 1067 1068 1069 1070 1071 1072 1073
<!-- ##### SIGNAL GtkMenuBar::cycle-focus ##### -->
<para>

</para>

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

Matthias Clasen's avatar
2.9.0  
Matthias Clasen committed
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
<!-- ##### SIGNAL GtkNotebook::tab-added ##### -->
<para>

</para>

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

<!-- ##### SIGNAL GtkNotebook::tab-removed ##### -->
<para>

</para>

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

<!-- ##### SIGNAL GtkNotebook::tab-reordered ##### -->
<para>

</para>

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

1101
<!-- ##### ARG GtkObject:object-signal ##### -->
1102
<para>
1103 1104 1105
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.
1106 1107
</para>
<para>
1108 1109 1110 1111
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.
1112 1113 1114
</para>


1115
<!-- ##### ARG GtkObject:object-signal-after ##### -->
1116
<para>
1117 1118 1119 1120
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.
1121 1122
</para>
<para>
1123
See gtk_signal_connect_object_after() for more details.
1124 1125 1126
</para>


1127
<!-- ##### ARG GtkObject:signal ##### -->
1128
<para>
1129 1130
Setting this with a GtkType of GTK_TYPE_SIGNAL connects
the signal to the object.
1131 1132 1133
</para>


1134
<!-- ##### ARG GtkObject:signal-after ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
1135
<para>
1136 1137 1138
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
1139 1140
</para>

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
<!-- ##### 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: 

1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
<!-- ##### 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
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
<!-- ##### 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>


1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
<!-- ##### 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: 

1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
<!-- ##### STRUCT GtkPatternSpec ##### -->
<para>

</para>

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

Matthias Clasen's avatar
2.9.1  
Matthias Clasen committed
1255 1256 1257 1258 1259 1260
<!-- ##### ARG GtkPrintOperation:number-of-pages ##### -->
<para>

</para>


1261
<!-- ##### ENUM GtkPrivateFlags ##### -->
1262
<para>
1263

1264 1265
</para>

1266 1267 1268 1269 1270 1271 1272 1273
@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: 
1274

1275 1276 1277 1278 1279 1280
<!-- ##### STRUCT GtkRcStyleClass ##### -->
<para>

</para>


Matthias Clasen's avatar
2.11.5  
Matthias Clasen committed
1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
<!-- ##### ARG GtkRecentChooser:filter ##### -->
<para>

</para>


<!-- ##### ARG GtkRecentChooser:limit ##### -->
<para>

</para>


<!-- ##### ARG GtkRecentChooser:local-only ##### -->
<para>

</para>


<!-- ##### ARG GtkRecentChooser:recent-manager ##### -->
<para>

</para>


<!-- ##### ARG GtkRecentChooser:select-multiple ##### -->
<para>

</para>


<!-- ##### ARG GtkRecentChooser:show-icons ##### -->
<para>

</para>


<!-- ##### ARG GtkRecentChooser:show-not-found ##### -->
<para>

</para>


<!-- ##### ARG GtkRecentChooser:show-private ##### -->
<para>

</para>


<!-- ##### ARG GtkRecentChooser:show-tips ##### -->
<para>

</para>


<!-- ##### ARG GtkRecentChooser:sort-type ##### -->
<para>

</para>


Owen Taylor's avatar
Owen Taylor committed
1341 1342 1343 1344 1345 1346
<!-- ##### ARG GtkScrolledWindow:shadow ##### -->
<para>

</para>


1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
<!-- ##### ARG GtkSettings:gtk-menu-bar-popout-delay ##### -->
<para>