Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtk-unused.sgml

   1 <!-- ##### SECTION ./tmpl/gtkarg.sgml:Long_Description ##### -->
   2 <para>
   3 All the functions in here are marked a Non-public.
   4 We describe it anyway because it is occasionally useful
   5 to understand how the work is done.
   6 </para>
   7 <para>
   8 Arguments are a way of describing a named parameter to a function.
   9 They have two important roles within gtk+:
  10 <itemizedlist>
  11 <listitem>
  12 <para>
  13 they describe <wordasword>object properties</wordasword>.
  14 This means that they present an interface to get and set a named-type
  15 for any type of object in a consistent way.
  16 (All the relevant functions to do this start with gtk_object_set
  17 or gtk_object_get).
  18 </para>
  19 </listitem>
  20 <listitem>
  21 <para>
  22 they describe <wordasword>signal arguments</wordasword>.
  23 This is a lot less often needed but still useful.
  24 Usually if you are just emitting or creating a particular signal
  25 it is more convenient to just use g_signal_emit() or g_signal_new().
  26 However if you are writing a function to emit or create an arbitrary
  27 signal, you must use g_signal_emitv() or g_signal_newv().
  28 </para>
  29 </listitem>
  30 </itemizedlist>
  31 </para>
  32
  33
  34 <!-- ##### SECTION ./tmpl/gtkarg.sgml:See_Also ##### -->
  35 <para>
  36 #GtkObject.
  37 </para>
  38
  39
  40 <!-- ##### SECTION ./tmpl/gtkarg.sgml:Short_Description ##### -->
  41 Utility function to manipulate lists of named, typed arguments.
  42
  43
  44 <!-- ##### SECTION ./tmpl/gtkarg.sgml:Title ##### -->
  45 Implementation of Object Properties
  46
  47
  48 <!-- ##### SECTION ./tmpl/gtkcellrenderertextpixbuf.sgml:Long_Description ##### -->
  49 <para>
  50
  51 </para>
  52
  53
  54 <!-- ##### SECTION ./tmpl/gtkcellrenderertextpixbuf.sgml:See_Also ##### -->
  55 <para>
  56
  57 </para>
  58
  59
  60 <!-- ##### SECTION ./tmpl/gtkcellrenderertextpixbuf.sgml:Short_Description ##### -->
  61
  62
  63
  64 <!-- ##### SECTION ./tmpl/gtkcellrenderertextpixbuf.sgml:Title ##### -->
  65 GtkCellRendererTextPixbuf
  66
  67
  68 <!-- ##### SECTION ./tmpl/gtkclist.sgml:Long_Description ##### -->
  69 <para>
  70 The #GtkCList widget is a very useful multi-columned scrolling list.
  71 It can display data in nicely aligned vertical columns, with titles
  72 at the top of the list.
  73 </para>
  74 <para>
  75 GtkCList has been deprecated since GTK+ 2.0 and should not be used
  76 in newly written code. Use #GtkTreeView instead.
  77 </para>
  78
  79
  80 <!-- ##### SECTION ./tmpl/gtkclist.sgml:See_Also ##### -->
  81 <para>
  82
  83 </para>
  84
  85
  86 <!-- ##### SECTION ./tmpl/gtkclist.sgml:Short_Description ##### -->
  87 A multi-columned scrolling list widget
  88
  89
  90 <!-- ##### SECTION ./tmpl/gtkclist.sgml:Stability_Level ##### -->
  91
  92
  93
  94 <!-- ##### SECTION ./tmpl/gtkclist.sgml:Title ##### -->
  95 GtkCList
  96
  97
  98 <!-- ##### SECTION ./tmpl/gtkcombo.sgml:Long_Description ##### -->
  99 <para>
 100 The #GtkCombo widget consists of a single-line text entry field and a drop-down
 101 list. The drop-down list is displayed when the user clicks on a small arrow
 102 button to the right of the entry field.
 103 </para>
 104 <para>
 105 The drop-down list is a #GtkList widget and can be accessed using the
 106 <structfield>list</structfield> member of the #GtkCombo-struct.
 107 List elements can contain arbitrary widgets, but if an element is not a
 108 plain label, then you must use the gtk_list_set_item_string() function.
 109 This sets the string which will be placed in the text entry field when the
 110 item is selected.
 111 </para>
 112 <para>
 113 By default, the user can step through the items in the list using the
 114 arrow (cursor) keys, though this behaviour can be turned off with
 115 gtk_combo_set_use_arrows().
 116 </para>
 117 <para>
 118 As of GTK+ 2.4, #GtkCombo has been deprecated in favor of #GtkComboBoxEntry.
 119 </para>
 120
 121 <example id="gtkcombo-simple-example">
 122 <title>Creating a <structname>GtkCombo</structname> widget with simple text
 123 items.</title>
 124 <programlisting>
 125   GtkWidget *combo;
 126   GList *items = NULL;
 127
 128   items = g_list_append (items, "First Item");
 129   items = g_list_append (items, "Second Item");
 130   items = g_list_append (items, "Third Item");
 131   items = g_list_append (items, "Fourth Item");
 132   items = g_list_append (items, "Fifth Item");
 133
 134   combo = gtk_combo_new (<!-- -->);
 135   gtk_combo_set_popdown_strings (GTK_COMBO (combo), items);
 136 </programlisting>
 137 </example>
 138
 139 <example>
 140 <title>Creating a <structname>GtkCombo</structname> widget with a complex item.</title>
 141 <programlisting>
 142   GtkWidget *combo, *item, *hbox, *arrow, *label;
 143
 144   combo = gtk_combo_new (<!-- -->);
 145
 146   item = gtk_list_item_new (<!-- -->);
 147   gtk_widget_show (item);
 148
 149   /* You can put almost anything into the GtkListItem widget. Here we will use
 150      a horizontal box with an arrow and a label in it. */
 151   hbox = gtk_hbox_new (FALSE, 3);
 152   gtk_container_add (GTK_CONTAINER (item), hbox);
 153   gtk_widget_show (hbox);
 154
 155   arrow = gtk_arrow_new (GTK_ARROW_RIGHT, GTK_SHADOW_OUT);
 156   gtk_widget_show (arrow);
 157   gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
 158
 159   label = gtk_label_new ("First Item");
 160   gtk_widget_show (label);
 161   gtk_box_pack_start (GTK_BOX (hbox), label, FALSE, FALSE, 0);
 162
 163   /* You must set the string to display in the entry field when the item is
 164      selected. */
 165   gtk_combo_set_item_string (GTK_COMBO (combo), GTK_ITEM (item), "1st Item");
 166
 167   /* Now we simply add the item to the combo's list. */
 168   gtk_container_add (GTK_CONTAINER (GTK_COMBO (combo)->list), item);
 169 </programlisting>
 170 </example>
 171
 172
 173 <!-- ##### SECTION ./tmpl/gtkcombo.sgml:See_Also ##### -->
 174 <para>
 175
 176 </para>
 177
 178
 179 <!-- ##### SECTION ./tmpl/gtkcombo.sgml:Short_Description ##### -->
 180 A text entry field with a dropdown list
 181
 182
 183 <!-- ##### SECTION ./tmpl/gtkcombo.sgml:Stability_Level ##### -->
 184
 185
 186
 187 <!-- ##### SECTION ./tmpl/gtkcombo.sgml:Title ##### -->
 188 GtkCombo
 189
 190
 191 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Long_Description ##### -->
 192 <para>
 193 The #GtkData object is a very simple object intended to be used as a base
 194 class for objects which contain data (i.e. the 'Model' in the object-oriented
 195 Model/View/Controller framework).
 196 </para>
 197 <para>
 198 Currently it is not very useful since all it provides is a "disconnect" signal.
 199 This signal could be emitted by a #GtkData subclass to notify any 'Views'
 200 that they should disconnect from the #GtkData (the 'Model'), possibly just
 201 before the #GtkData is destroyed.
 202 </para>
 203
 204
 205 <!-- ##### SECTION ./tmpl/gtkdata.sgml:See_Also ##### -->
 206 <para>
 207
 208 </para>
 209
 210
 211 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Short_Description ##### -->
 212 abstract base class for objects containing data.
 213
 214
 215 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Title ##### -->
 216 GtkData
 217
 218
 219 <!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
 220 Debugging
 221
 222
 223 <!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Title ##### -->
 224 gtkenums.sgml
 225
 226
 227 <!-- ##### SECTION ./tmpl/gtkfilesel.sgml:Long_Description ##### -->
 228 <para>
 229 #GtkFileSelection has been superseded by the newer #GtkFileChooser family
 230 of widgets.
 231 </para>
 232 <para>
 233 #GtkFileSelection should be used to retrieve file or directory names from
 234 the user. It will create a new dialog window containing a directory list,
 235 and a file list corresponding to the current working directory. The filesystem
 236 can be navigated using the directory list or the drop-down history menu.
 237 Alternatively, the TAB key can be used to navigate using filename
 238 completion - common in text based editors such as emacs and jed.
 239 </para>
 240 <para>
 241 File selection dialogs are created with a call to gtk_file_selection_new().
 242 </para>
 243 <para>
 244 The default filename can be set using gtk_file_selection_set_filename() and the selected filename retrieved using gtk_file_selection_get_filename().
 245 </para>
 246 <para>
 247 Use gtk_file_selection_complete() to display files and directories
 248 that match a given pattern. This can be used for example, to show only
 249 *.txt files, or only files beginning with gtk*.
 250 </para>
 251 <para>
 252 Simple file operations; create directory, delete file, and rename file, are available from buttons at the top of the dialog. These can be hidden using gtk_file_selection_hide_fileop_buttons() and shown again using gtk_file_selection_show_fileop_buttons().
 253 </para>
 254 <para>
 255 <example>
 256 <title>Getting a filename from the user.</title>
 257 <programlisting>
 258
 259 /* The file selection widget and the string to store the chosen filename */
 260
 261 void store_filename (GtkWidget *widget, gpointer user_data) {
 262    GtkWidget *file_selector = GTK_WIDGET (user_data);
 263    const gchar *selected_filename;
 264
 265    selected_filename = gtk_file_selection_get_filename (GTK_FILE_SELECTION (file_selector));
 266    g_print ("Selected filename: &percnt;s\n", selected_filename);
 267 }
 268
 269 void create_file_selection (void) {
 270
 271    GtkWidget *file_selector;
 272
 273    /* Create the selector */
 274
 275    file_selector = gtk_file_selection_new ("Please select a file for editing.");
 276
 277    g_signal_connect (GTK_FILE_SELECTION (file_selector)->ok_button,
 278                      "clicked",
 279                      G_CALLBACK (store_filename),
 280                      file_selector);
 281
 282    /* Ensure that the dialog box is destroyed when the user clicks a button. */
 283
 284    g_signal_connect_swapped (GTK_FILE_SELECTION (file_selector)->ok_button,
 285                              "clicked",
 286                              G_CALLBACK (gtk_widget_destroy),
 287                              file_selector);
 288
 289    g_signal_connect_swapped (GTK_FILE_SELECTION (file_selector)->cancel_button,
 290                              "clicked",
 291                              G_CALLBACK (gtk_widget_destroy),
 292                              file_selector);
 293
 294    /* Display that dialog */
 295
 296    gtk_widget_show (file_selector);
 297 }
 298
 299 </programlisting>
 300 </example>
 301 </para>
 302
 303
 304 <!-- ##### SECTION ./tmpl/gtkfilesel.sgml:See_Also ##### -->
 305
 306 <para>
 307 <variablelist>
 308 <varlistentry>
 309 <term>#GtkDialog</term>
 310 <listitem><para>Add your own widgets into the #GtkFileSelection.</para></listitem>
 311 </varlistentry>
 312 </variablelist>
 313 </para>
 314
 315
 316 <!-- ##### SECTION ./tmpl/gtkfilesel.sgml:Short_Description ##### -->
 317 Prompt the user for a file or directory name
 318
 319
 320 <!-- ##### SECTION ./tmpl/gtkfilesel.sgml:Stability_Level ##### -->
 321
 322
 323
 324 <!-- ##### SECTION ./tmpl/gtkfilesel.sgml:Title ##### -->
 325 GtkFileSelection
 326
 327
 328 <!-- ##### SECTION ./tmpl/gtkitemfactory.sgml:Long_Description ##### -->
 329 <para>
 330 As of GTK+ 2.4, #GtkItemFactory has been deprecated in favour of #GtkUIManager.
 331 </para>
 332
 333
 334 <!-- ##### SECTION ./tmpl/gtkitemfactory.sgml:See_Also ##### -->
 335 <para>
 336
 337 </para>
 338
 339
 340 <!-- ##### SECTION ./tmpl/gtkitemfactory.sgml:Short_Description ##### -->
 341 A factory for menus
 342
 343
 344 <!-- ##### SECTION ./tmpl/gtkitemfactory.sgml:Stability_Level ##### -->
 345
 346
 347
 348 <!-- ##### SECTION ./tmpl/gtkitemfactory.sgml:Title ##### -->
 349 GtkItemFactory
 350
 351
 352 <!-- ##### SECTION ./tmpl/gtklist.sgml:Long_Description ##### -->
 353 <para>
 354 The #GtkList widget is a container whose children are displayed
 355 vertically in order, and can be selected.
 356
 357 The list has many selection modes, which are programmer selective and
 358 depend on how many elements are able to be selected at the same time.
 359 </para>
 360 <para>
 361 GtkList has been deprecated since GTK+ 2.0 and should not be used
 362 in newly written code. Use #GtkTreeView instead.
 363 </para>
 364
 365
 366 <!-- ##### SECTION ./tmpl/gtklist.sgml:See_Also ##### -->
 367 <para>
 368 <variablelist>
 369 <varlistentry>
 370 <term>#GtkContainer</term>
 371 <listitem><para>For functions that apply to every #GtkContainer
 372 (like #GtkList).</para></listitem>
 373 </varlistentry>
 374 <varlistentry>
 375 <term>#GtkListitem</term>
 376 <listitem><para>Children of a #GtkList widget must be of this
 377 type.</para></listitem>
 378 </varlistentry>
 379 </variablelist>
 380 </para>
 381
 382
 383 <!-- ##### SECTION ./tmpl/gtklist.sgml:Short_Description ##### -->
 384 Widget for packing a list of selectable items
 385
 386
 387 <!-- ##### SECTION ./tmpl/gtklist.sgml:Stability_Level ##### -->
 388
 389
 390
 391 <!-- ##### SECTION ./tmpl/gtklist.sgml:Title ##### -->
 392 GtkList
 393
 394
 395 <!-- ##### SECTION ./tmpl/gtklistitem.sgml:Long_Description ##### -->
 396 <para>
 397 The #GtkListItem widget is used for each item in a #GtkList.
 398 </para>
 399 <para>
 400 GtkList has has been deprecated since GTK+ 2.0 and should not be used
 401 in newly written code. Use #GtkTreeView instead.
 402 </para>
 403
 404
 405 <!-- ##### SECTION ./tmpl/gtklistitem.sgml:See_Also ##### -->
 406 <para>
 407 <variablelist>
 408
 409 <varlistentry>
 410 <term>#GtkList</term>
 411 <listitem><para>the parent list widget.</para></listitem>
 412 </varlistentry>
 413
 414 </variablelist>
 415
 416 </para>
 417
 418
 419 <!-- ##### SECTION ./tmpl/gtklistitem.sgml:Short_Description ##### -->
 420 An item in a GtkList
 421
 422
 423 <!-- ##### SECTION ./tmpl/gtklistitem.sgml:Stability_Level ##### -->
 424
 425
 426
 427 <!-- ##### SECTION ./tmpl/gtklistitem.sgml:Title ##### -->
 428 GtkListItem
 429
 430
 431 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
 432 <refsect2>
 433 <title>What are Signal Marshallers?</title>
 434 <para>
 435 Marshals are functions which all have the same prototype:
 436 they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
 437 and an array of argument values.
 438 The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
 439 </para>
 440 <para>
 441 They then call a native function:  the GtkObject is the first
 442 parameter passed in.  The arguments are passed in the native
 443 calling convention:  chars, shorts, ints, longs may be packed
 444 on the stack, or tucked in registers:  it doesn't matter
 445 because the same calling convention will be generated
 446 inside the gtkmarshal code as is expected where you define
 447 your handlers.
 448 </para>
 449 <para>
 450 So the function named:
 451 <programlisting>
 452 gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
 453 </programlisting>
 454 will call the #GtkSignalFunc assuming it was a function with signature:
 455 <programlisting>
 456 gboolean sigfunc(gpointer,gint,gint,guint);
 457 </programlisting>
 458 </para>
 459 </refsect2>
 460 <refsect2>
 461 <title>Writing Custom Marshals</title>
 462 <para>
 463 Marshals are primarily used as arguments to g_signal_new().
 464 Sometimes, you may find that a marshaller you need isn't available
 465 in the standard list.  Then you have to write your own.
 466 </para>
 467 <para>
 468 If you wish to define a signal with a new type of argument list.
 469 Suppose you want 2 pointers and 2 integers.
 470 You would write:
 471 <programlisting>
 472 typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
 473                         gpointer, gpointer, gint, gint
 474 );
 475
 476 void marshal_INT__POINTER_POINTER_INT_INT(GtkObject*    object,
 477                                            GtkSignalFunc func,
 478                                            gpointer      func_data,
 479                                            GtkArg*       args)
 480 {
 481         GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
 482         gint* return_val;
 483         return_val = GTK_RETLOC_INT(args[4]);
 484         rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
 485         *return_val = (*rfunc)(object,
 486                                GTK_VALUE_POINTER(args[0]),
 487                                GTK_VALUE_POINTER(args[1]),
 488                                GTK_VALUE_INT(args[2]),
 489                                GTK_VALUE_INT(args[3]),
 490                                func_data);
 491 }
 492 </programlisting>
 493 </para>
 494 </refsect2>
 495
 496
 497 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
 498 <para>
 499 <variablelist>
 500
 501 <varlistentry>
 502 <term>#GtkSignal</term>
 503 <listitem><para>The signal handling functions (of which marshallers are
 504 really an implementation detail).</para></listitem>
 505 </varlistentry>
 506
 507 </variablelist>
 508 </para>
 509
 510
 511 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Short_Description ##### -->
 512 Functions to adapt C structures to native calling convention.
 513
 514
 515 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
 516 Signal Marshallers
 517
 518
 519 <!-- ##### SECTION ./tmpl/gtkpacker.sgml:Long_Description ##### -->
 520 <para>
 521
 522 </para>
 523
 524
 525 <!-- ##### SECTION ./tmpl/gtkpacker.sgml:See_Also ##### -->
 526 <para>
 527
 528 </para>
 529
 530
 531 <!-- ##### SECTION ./tmpl/gtkpacker.sgml:Short_Description ##### -->
 532
 533
 534
 535 <!-- ##### SECTION ./tmpl/gtkpacker.sgml:Title ##### -->
 536 GtkPacker
 537
 538
 539 <!-- ##### SECTION ./tmpl/gtkpreview.sgml:Long_Description ##### -->
 540 <para>
 541 The #GtkPreview widget provides a simple interface
 542 used to display images as RGB or grayscale data.
 543 It's deprecated; just use a #GdkPixbuf displayed by a #GtkImage, or
 544 perhaps a #GtkDrawingArea. #GtkPreview has no advantage over those
 545 approaches.
 546 </para>
 547
 548
 549 <!-- ##### SECTION ./tmpl/gtkpreview.sgml:See_Also ##### -->
 550 <para>
 551 <variablelist>
 552
 553 <varlistentry>
 554 <term>#GdkRGB</term>
 555 <listitem><para>the backend used by #GtkPreview.</para></listitem>
 556 </varlistentry>
 557
 558 </variablelist>
 559 </para>
 560
 561
 562 <!-- ##### SECTION ./tmpl/gtkpreview.sgml:Short_Description ##### -->
 563 A widget to display RGB or grayscale data
 564
 565
 566 <!-- ##### SECTION ./tmpl/gtkpreview.sgml:Stability_Level ##### -->
 567
 568
 569
 570 <!-- ##### SECTION ./tmpl/gtkpreview.sgml:Title ##### -->
 571 GtkPreview
 572
 573
 574 <!-- ##### SECTION ./tmpl/gtkprivate.sgml:Title ##### -->
 575 Private Information
 576
 577
 578 <!-- ##### SECTION ./tmpl/gtkthemes.sgml:Long_Description ##### -->
 579 <para>
 580
 581 </para>
 582
 583
 584 <!-- ##### SECTION ./tmpl/gtkthemes.sgml:See_Also ##### -->
 585 <para>
 586
 587 </para>
 588
 589
 590 <!-- ##### SECTION ./tmpl/gtkthemes.sgml:Short_Description ##### -->
 591
 592
 593
 594 <!-- ##### SECTION ./tmpl/gtkthemes.sgml:Stability_Level ##### -->
 595
 596
 597
 598 <!-- ##### SECTION ./tmpl/gtkthemes.sgml:Title ##### -->
 599 Themes
 600
 601
 602 <!-- ##### SECTION ./tmpl/gtktipsquery.sgml:Long_Description ##### -->
 603 <para>
 604 The #GtkTipsQuery widget is a subclass of #GtkLabel which is used to display
 605 help about widgets in a user interface.
 606 </para>
 607 <para>
 608 A query is started with a call to gtk_tips_query_start_query(), usually
 609 when some kind of 'Help' button is pressed. The #GtkTipsQuery then grabs all
 610 events, stopping the user interface from functioning normally.
 611 Then as the user moves the mouse over the widgets, the #GtkTipsQuery displays
 612 each widget's tooltip text.
 613 </para>
 614 <para>
 615 By connecting to the "widget-entered" or "widget-selected" signals, it is
 616 possible to customize the #GtkTipsQuery to perform other actions when widgets
 617 are entered or selected. For example, a help browser could be opened with
 618 documentation on the widget selected.
 619 </para>
 620 <para>
 621 At some point a call to gtk_tips_query_stop_query() must be made in order to
 622 stop the query and return the interface to its normal state.
 623 The gtk_tips_query_set_caller() function can be used to specify a widget
 624 which the user can select to stop the query (often the same button used to
 625 start the query).
 626 </para>
 627
 628
 629 <!-- ##### SECTION ./tmpl/gtktipsquery.sgml:See_Also ##### -->
 630 <para>
 631 <variablelist>
 632 <varlistentry>
 633 <term>#GtkTooltips</term>
 634 <listitem><para>the object which handles tooltips.</para></listitem>
 635 </varlistentry>
 636 </variablelist>
 637 </para>
 638
 639
 640 <!-- ##### SECTION ./tmpl/gtktipsquery.sgml:Short_Description ##### -->
 641 Displays help about widgets in the user interface
 642
 643
 644 <!-- ##### SECTION ./tmpl/gtktipsquery.sgml:Stability_Level ##### -->
 645
 646
 647
 648 <!-- ##### SECTION ./tmpl/gtktipsquery.sgml:Title ##### -->
 649 GtkTipsQuery
 650
 651
 652 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Long_Description ##### -->
 653 <para>
 654
 655 </para>
 656
 657
 658 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:See_Also ##### -->
 659 <para>
 660
 661 </para>
 662
 663
 664 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Short_Description ##### -->
 665
 666
 667
 668 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Title ##### -->
 669 GtkModelSimple
 670
 671
 672 <!-- ##### MACRO GTK_CELL_PIXMAP ##### -->
 673 <para>
 674 A macro to cast a generic #GtkCList cell item to a GtkCellPixmap pointer.
 675 </para>
 676
 677 @cell: The #GtkCList cell item to convert.
 678
 679 <!-- ##### MACRO GTK_CELL_PIXTEXT ##### -->
 680 <para>
 681 A macro to cast a generic #GtkCList cell item to a GtkCellPixText pointer.
 682 </para>
 683
 684 @cell: The #GtkCList cell item to convert.
 685
 686 <!-- ##### MACRO GTK_CELL_TEXT ##### -->
 687 <para>
 688 A macro to cast a generic #GtkCList cell item to a GtkCellText pointer.
 689 </para>
 690
 691 @cell: The #GtkCList cell item to convert.
 692
 693 <!-- ##### MACRO GTK_CELL_WIDGET ##### -->
 694 <para>
 695 A macro to cast a generic #GtkCList cell item to a GtkCellWidget pointer.
 696 </para>
 697
 698 @cell: The #GtkCList cell item to convert.
 699
 700 <!-- ##### MACRO GTK_CHECK_CAST ##### -->
 701 <para>
 702 Casts the object in @tobj into @cast.  If %G_DISABLE_CAST_CHECKS is
 703 defined, just cast it.  Otherwise, check to see if we can cast @tobj
 704 into a @cast.
 705 </para>
 706
 707
 708 <!-- ##### MACRO GTK_CHECK_CLASS_CAST ##### -->
 709 <para>
 710 Casts the object in @tobj into @cast.  If %G_DISABLE_CAST_CHECKS is
 711 defined, just cast it.  Otherwise, check to see if we can cast @tobj
 712 into a @cast.
 713 </para>
 714
 715 @tclass: a #GtkClassInitFunc
 716 @cast_type: a GTK+ type.
 717 @cast: a C type
 718
 719 <!-- ##### MACRO GTK_CHECK_CLASS_TYPE ##### -->
 720 <para>
 721 Determines whether @type_class is a type of @otype.
 722 </para>
 723
 724 @type_class: a #GtkTypeClass class.
 725
 726 <!-- ##### MACRO GTK_CHECK_GET_CLASS ##### -->
 727 <para>
 728 Gets the class of @tobj.
 729 </para>
 730
 731 @tobj: a #GtkObject.
 732
 733 <!-- ##### MACRO GTK_CHECK_TYPE ##### -->
 734 <para>
 735 Determines whether @type_object is a type of @otype.
 736 </para>
 737
 738 @type_object: a #GtkTypeObject object
 739
 740 <!-- ##### MACRO GTK_CLASS_NAME ##### -->
 741 <para>
 742 Returns the type name of @class.
 743 </para>
 744
 745 @class: a #GtkTypeClass.
 746 @Deprecated: Use g_type_name() and G_TYPE_FROM_CLASS() instead.
 747
 748 <!-- ##### MACRO GTK_CLASS_TYPE ##### -->
 749 <para>
 750 Returns the type of @class.
 751 </para>
 752
 753 @class: a #GtkTypeClass.
 754 @Deprecated: Use G_TYPE_FROM_CLASS() instead.
 755
 756 <!-- ##### MACRO GTK_CLIST_ADD_MODE ##### -->
 757 <para>
 758 A macro to test whether the CList is in "add mode."
 759 </para>
 760
 761 @clist: The #GtkCList widget to check.
 762
 763 <!-- ##### MACRO GTK_CLIST_AUTO_RESIZE_BLOCKED ##### -->
 764 <para>
 765 A macro to check if automatic resizing of columns is blocked.
 766 </para>
 767
 768 @clist: The #GtkCList widget to check.
 769
 770 <!-- ##### MACRO GTK_CLIST_AUTO_SORT ##### -->
 771 <para>
 772 A macro to test whether the CList has automatic sorting
 773 switched on.
 774 </para>
 775
 776 @clist: The #GtkCList widget to check.
 777
 778 <!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
 779 <para>
 780 A macro to check whether a child widget of the CList
 781 has the focus.
 782 </para>
 783
 784 @clist: The #GtkCList widget to check.
 785
 786 <!-- ##### MACRO GTK_CLIST_DRAW_DRAG_LINE ##### -->
 787 <para>
 788 A macro to check if the DRAW_DRAG_LINE property is enabled.
 789 </para>
 790
 791 @clist: The #GtkCList widget to check.
 792
 793 <!-- ##### MACRO GTK_CLIST_DRAW_DRAG_RECT ##### -->
 794 <para>
 795 A macro to check if the DRAW_DRAG_RECT property is enabled.
 796 </para>
 797
 798 @clist: The #GtkCList widget to check.
 799
 800 <!-- ##### MACRO GTK_CLIST_FLAGS ##### -->
 801 <para>
 802 Reads the current flags of the specified CList.
 803 </para>
 804
 805 @clist: The #GtkCList widget from which to get the flags
 806
 807 <!-- ##### MACRO GTK_CLIST_IN_DRAG ##### -->
 808 <para>
 809 A macro to check whether the #GtkCList is in "drag mode."
 810 </para>
 811
 812 @clist: The #GtkCList to check.
 813
 814 <!-- ##### MACRO GTK_CLIST_REORDERABLE ##### -->
 815 <para>
 816 A macro to test if the CList's columns are re-orderable
 817 </para>
 818
 819 @clist: The #GtkCList widget to check.
 820
 821 <!-- ##### MACRO GTK_CLIST_ROW ##### -->
 822 <para>
 823 A macro to cast a GList element to a CListRow pointer.
 824 </para>
 825
 826 @_glist_: The GList element to convert.
 827
 828 <!-- ##### MACRO GTK_CLIST_ROW_HEIGHT_SET ##### -->
 829 <para>
 830 A macro to check whether the #GtkCList's row height is set.
 831 </para>
 832
 833 @clist: The #GtkCList to check.
 834
 835 <!-- ##### MACRO GTK_CLIST_SET_FLAG ##### -->
 836 <para>
 837 A macro to set a particular flag for the specified CList.
 838 </para>
 839
 840 @clist: The #GtkCList widget to affect.
 841 @flag: A single #GtkCList flag to set.  NOTE: Do not add the GTK_ prefix.
 842
 843 <!-- ##### MACRO GTK_CLIST_SHOW_TITLES ##### -->
 844 <para>
 845 A macro to check whether the flag for showing the
 846 widget's column titles is set.
 847 </para>
 848
 849 @clist: The #GtkCList widget to check.
 850
 851 <!-- ##### MACRO GTK_CLIST_UNSET_FLAG ##### -->
 852 <para>
 853 A macro to clear a particular flag for the specified CList.
 854 </para>
 855
 856 @clist: The #GtkCList widget to affect.
 857 @flag: A single #GtkCList flag to clear.  NOTE: Do not add the GTK_ prefix.
 858
 859 <!-- ##### MACRO GTK_CLIST_USE_DRAG_ICONS ##### -->
 860 <para>
 861 A macro to check if the USE_DRAG_ICONS property is enabled.
 862 </para>
 863
 864 @clist: The #GtkCList widget to check.
 865
 866 <!-- ##### MACRO GTK_FUNDAMENTAL_TYPE ##### -->
 867 <para>
 868 Converts a GTK+ type into a fundamental type.
 869 </para>
 870
 871
 872 <!-- ##### MACRO GTK_ICON_SIZE_BUTTON ##### -->
 873 <para>
 874
 875 </para>
 876
 877
 878 <!-- ##### MACRO GTK_ICON_SIZE_DIALOG ##### -->
 879 <para>
 880
 881 </para>
 882
 883
 884 <!-- ##### MACRO GTK_ICON_SIZE_LARGE_TOOLBAR ##### -->
 885 <para>
 886
 887 </para>
 888
 889
 890 <!-- ##### MACRO GTK_ICON_SIZE_MENU ##### -->
 891 <para>
 892
 893 </para>
 894
 895
 896 <!-- ##### MACRO GTK_ICON_SIZE_SMALL_TOOLBAR ##### -->
 897 <para>
 898
 899 </para>
 900
 901
 902 <!-- ##### MACRO GTK_IS_TIPS_QUERY ##### -->
 903 <para>
 904
 905 </para>
 906
 907 @obj:
 908
 909 <!-- ##### MACRO GTK_IS_TIPS_QUERY_CLASS ##### -->
 910 <para>
 911
 912 </para>
 913
 914 @klass:
 915
 916 <!-- ##### MACRO GTK_OBJECT_CONNECTED ##### -->
 917 <para>
 918 Tests whether a #GtkObject has had a signal connected to it.
 919 </para>
 920
 921 @obj: the object to examine.
 922
 923 <!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
 924 <para>
 925 Test whether a GtkObject's arguments have been prepared.
 926 </para>
 927
 928 @obj: the object to examine.
 929
 930 <!-- ##### MACRO GTK_OBJECT_DESTROYED ##### -->
 931 <para>
 932 Test whether a GtkObject has had gtk_object_destroy() invoked on it.
 933 </para>
 934
 935 @obj: the object to examine.
 936
 937 <!-- ##### MACRO GTK_OBJECT_FLOATING ##### -->
 938 <para>
 939 Evaluates to %TRUE if the object still has its floating reference count.
 940 See the overview documentation for #GtkObject.
 941 </para>
 942
 943 @obj: the object to examine.
 944
 945 <!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
 946 <para>
 947 Get the number of signals defined by this object.
 948 </para>
 949
 950 @obj: the object to query.
 951
 952 <!-- ##### MACRO GTK_OBJECT_SET_FLAGS ##### -->
 953 <para>
 954 Turns on certain object flags.  (Private)
 955 </para>
 956
 957 @obj: the object to affect.
 958 @flag: the flags to set.
 959
 960 <!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
 961 <para>
 962 Get the array of signals defined for this object.
 963 </para>
 964
 965 @obj: the object to fetch the signals from.
 966
 967 <!-- ##### MACRO GTK_OBJECT_UNSET_FLAGS ##### -->
 968 <para>
 969 Turns off certain object flags.  (Private)
 970 </para>
 971
 972 @obj: the object to affect.
 973 @flag: the flags to unset.
 974
 975 <!-- ##### MACRO GTK_PRINT_SETTINGS_NUM_COPIES ##### -->
 976 <para>
 977
 978 </para>
 979
 980
 981 <!-- ##### MACRO GTK_PRINT_SETTINGS_PRINT_TO_FILE ##### -->
 982 <para>
 983
 984 </para>
 985
 986
 987 <!-- ##### MACRO GTK_RETLOC_BOOL ##### -->
 988 <para>
 989 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_BOOL.
 990 </para>
 991
 992 @a: a #GtkArg.
 993
 994 <!-- ##### MACRO GTK_RETLOC_BOXED ##### -->
 995 <para>
 996 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_BOXED.
 997 </para>
 998
 999 @a: a #GtkArg.
1000
1001 <!-- ##### MACRO GTK_RETLOC_CHAR ##### -->
1002 <para>
1003 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_CHAR.
1004 </para>
1005
1006 @a: a #GtkArg.
1007
1008 <!-- ##### MACRO GTK_RETLOC_DOUBLE ##### -->
1009 <para>
1010 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_DOUBLE.
1011 </para>
1012
1013 @a: a #GtkArg.
1014
1015 <!-- ##### MACRO GTK_RETLOC_ENUM ##### -->
1016 <para>
1017 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_ENUM.
1018 </para>
1019
1020 @a: a #GtkArg.
1021
1022 <!-- ##### MACRO GTK_RETLOC_FLAGS ##### -->
1023 <para>
1024 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_FLAGS.
1025 </para>
1026
1027 @a: a #GtkArg.
1028
1029 <!-- ##### MACRO GTK_RETLOC_FLOAT ##### -->
1030 <para>
1031 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_FLOAT.
1032 </para>
1033
1034 @a: a #GtkArg.
1035
1036 <!-- ##### MACRO GTK_RETLOC_INT ##### -->
1037 <para>
1038 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_INT.
1039 </para>
1040
1041 @a: a #GtkArg.
1042
1043 <!-- ##### MACRO GTK_RETLOC_LONG ##### -->
1044 <para>
1045 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_LONG.
1046 </para>
1047
1048 @a: a #GtkArg.
1049
1050 <!-- ##### MACRO GTK_RETLOC_OBJECT ##### -->
1051 <para>
1052 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_OBJECT.
1053 </para>
1054
1055 @a: a #GtkArg.
1056
1057 <!-- ##### MACRO GTK_RETLOC_POINTER ##### -->
1058 <para>
1059 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_POINTER.
1060 </para>
1061
1062 @a: a #GtkArg.
1063
1064 <!-- ##### MACRO GTK_RETLOC_STRING ##### -->
1065 <para>
1066 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_STRING.
1067 </para>
1068
1069 @a: a #GtkArg.
1070
1071 <!-- ##### MACRO GTK_RETLOC_UCHAR ##### -->
1072 <para>
1073 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_UCHAR.
1074 </para>
1075
1076 @a: a #GtkArg.
1077
1078 <!-- ##### MACRO GTK_RETLOC_UINT ##### -->
1079 <para>
1080 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_UINT.
1081 </para>
1082
1083 @a: a #GtkArg.
1084
1085 <!-- ##### MACRO GTK_RETLOC_ULONG ##### -->
1086 <para>
1087 If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_ULONG.
1088 </para>
1089
1090 @a: a #GtkArg.
1091
1092 <!-- ##### MACRO GTK_SIGNAL_FUNC ##### -->
1093 <para>
1094 Just a macroized cast into a #GtkSignalFunc.
1095 </para>
1096
1097 @f:
1098
1099 <!-- ##### MACRO GTK_STOCK_BUTTON_APPLY ##### -->
1100 <para>
1101
1102 </para>
1103
1104
1105 <!-- ##### MACRO GTK_STOCK_BUTTON_CANCEL ##### -->
1106 <para>
1107
1108 </para>
1109
1110
1111 <!-- ##### MACRO GTK_STOCK_BUTTON_CLOSE ##### -->
1112 <para>
1113
1114 </para>
1115
1116
1117 <!-- ##### MACRO GTK_STOCK_BUTTON_NO ##### -->
1118 <para>
1119
1120 </para>
1121
1122
1123 <!-- ##### MACRO GTK_STOCK_BUTTON_OK ##### -->
1124 <para>
1125
1126 </para>
1127
1128
1129 <!-- ##### MACRO GTK_STOCK_BUTTON_YES ##### -->
1130 <para>
1131
1132 </para>
1133
1134
1135 <!-- ##### MACRO GTK_STRUCT_OFFSET ##### -->
1136 <para>
1137 Use in place of <function>offsetof()</function>, which is used if it exists.
1138 </para>
1139
1140 @Deprecated: Use G_STRUCT_OFFSET() instead.
1141
1142 <!-- ##### MACRO GTK_TIPS_QUERY ##### -->
1143 <para>
1144
1145 </para>
1146
1147 @obj:
1148
1149 <!-- ##### MACRO GTK_TIPS_QUERY_CLASS ##### -->
1150 <para>
1151
1152 </para>
1153
1154 @klass:
1155
1156 <!-- ##### MACRO GTK_TIPS_QUERY_GET_CLASS ##### -->
1157 <para>
1158
1159 </para>
1160
1161 @obj:
1162
1163 <!-- ##### MACRO GTK_TREE_MODEL_GET_IFACE ##### -->
1164 <para>
1165
1166 </para>
1167
1168 @obj:
1169
1170 <!-- ##### MACRO GTK_TREE_SELECTION ##### -->
1171 <para>
1172 A macro that returns a GList that contains the selection of the root tree of @obj.
1173 </para>
1174
1175 @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.
1176
1177 <!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
1178 <para>
1179 The first "flat" (no struct) enumerated type value.
1180 </para>
1181
1182
1183 <!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
1184 <para>
1185 The last "flat" (no struct) enumerated type value.
1186 </para>
1187
1188
1189 <!-- ##### MACRO GTK_TYPE_FUNDAMENTAL_LAST ##### -->
1190 <para>
1191 The highest-numbered structured or flat enumerated type value.
1192 </para>
1193
1194 @Deprecated: Use #G_TYPE_LAST_RESERVED_FUNDAMENTAL - 1 instead.
1195
1196 <!-- ##### MACRO GTK_TYPE_FUNDAMENTAL_MAX ##### -->
1197 <para>
1198 The maximum fundamental enumerated type value.
1199 </para>
1200
1201 @Deprecated: Use #G_TYPE_FUNDAMENTAL_MAX instead.
1202
1203 <!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
1204 <para>
1205 Hide the name of gtk_identifier_get_type
1206 </para>
1207
1208
1209 <!-- ##### MACRO GTK_TYPE_IS_OBJECT ##### -->
1210 <para>
1211 Returns %TRUE if @type is a %GTK_TYPE_OBJECT.
1212 </para>
1213
1214 @type: a #GtkType.
1215 @Deprecated: Use G_TYPE_IS_OBJECT() instead.
1216
1217 <!-- ##### MACRO GTK_TYPE_MAKE ##### -->
1218 <para>
1219 Combine a fundemantal type and a sequence number to create a gtk type.
1220 </para>
1221
1222 @parent_t:
1223 @seqno:
1224
1225 <!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
1226 <para>
1227 No idea.
1228 </para>
1229
1230
1231 <!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
1232 <para>
1233 Convert a gtk type into its sequence number
1234 </para>
1235
1236 @type:
1237
1238 <!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
1239 <para>
1240 The first structured enumerated type value.
1241 </para>
1242
1243
1244 <!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
1245 <para>
1246 The last structured enumerated type value.
1247 </para>
1248
1249
1250 <!-- ##### MACRO GTK_TYPE_TIPS_QUERY ##### -->
1251 <para>
1252
1253 </para>
1254
1255
1256 <!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
1257 <para>
1258
1259 </para>
1260
1261
1262 <!-- ##### MACRO GTK_TYPE_TREE_VIEW_COLUMN ##### -->
1263 <para>
1264
1265 </para>
1266
1267
1268 <!-- ##### MACRO GTK_VALUE_ARGS ##### -->
1269 <para>
1270 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
1271 </para>
1272
1273 @a:
1274
1275 <!-- ##### MACRO GTK_VALUE_BOOL ##### -->
1276 <para>
1277 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_BOOL.
1278 </para>
1279
1280 @a: a #GtkArg.
1281
1282 <!-- ##### MACRO GTK_VALUE_BOXED ##### -->
1283 <para>
1284 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_BOXED.
1285 </para>
1286
1287 @a: a #GtkArg.
1288
1289 <!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
1290 <para>
1291 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
1292 </para>
1293
1294 @a:
1295
1296 <!-- ##### MACRO GTK_VALUE_CHAR ##### -->
1297 <para>
1298 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_CHAR.
1299 </para>
1300
1301 @a: a #GtkArg.
1302
1303 <!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
1304 <para>
1305 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
1306 </para>
1307
1308 @a:
1309
1310 <!-- ##### MACRO GTK_VALUE_DOUBLE ##### -->
1311 <para>
1312 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_DOUBLE.
1313 </para>
1314
1315 @a: a #GtkArg.
1316
1317 <!-- ##### MACRO GTK_VALUE_ENUM ##### -->
1318 <para>
1319 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_ENUM.
1320 </para>
1321
1322 @a: a #GtkArg.
1323
1324 <!-- ##### MACRO GTK_VALUE_FLAGS ##### -->
1325 <para>
1326 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_FLAGS.
1327 </para>
1328
1329 @a: a #GtkArg.
1330
1331 <!-- ##### MACRO GTK_VALUE_FLOAT ##### -->
1332 <para>
1333 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_FLOAT.
1334 </para>
1335
1336 @a: a #GtkArg.
1337
1338 <!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
1339 <para>
1340 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
1341 </para>
1342
1343 @a:
1344
1345 <!-- ##### MACRO GTK_VALUE_INT ##### -->
1346 <para>
1347 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_INT.
1348 </para>
1349
1350 @a: a #GtkArg.
1351
1352 <!-- ##### MACRO GTK_VALUE_LONG ##### -->
1353 <para>
1354 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_LONG.
1355 </para>
1356
1357 @a: a #GtkArg.
1358
1359 <!-- ##### MACRO GTK_VALUE_OBJECT ##### -->
1360 <para>
1361 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_OBJECT.
1362 </para>
1363
1364 @a: a #GtkArg.
1365
1366 <!-- ##### MACRO GTK_VALUE_POINTER ##### -->
1367 <para>
1368 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_POINTER.
1369 </para>
1370
1371 @a: a #GtkArg.
1372
1373 <!-- ##### MACRO GTK_VALUE_SIGNAL ##### -->
1374 <para>
1375 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_SIGNAL.
1376 </para>
1377
1378 @a: a #GtkArg.
1379
1380 <!-- ##### MACRO GTK_VALUE_STRING ##### -->
1381 <para>
1382 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_STRING.
1383 </para>
1384
1385 @a: a #GtkArg.
1386
1387 <!-- ##### MACRO GTK_VALUE_UCHAR ##### -->
1388 <para>
1389 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_UCHAR.
1390 </para>
1391
1392 @a: a #GtkArg.
1393
1394 <!-- ##### MACRO GTK_VALUE_UINT ##### -->
1395 <para>
1396 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_UINT.
1397 </para>
1398
1399 @a: a #GtkArg.
1400
1401 <!-- ##### MACRO GTK_VALUE_ULONG ##### -->
1402 <para>
1403 Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_ULONG.
1404 </para>
1405
1406 @a: a #GtkArg.
1407
1408 <!-- ##### USER_FUNCTION GValueCompareFunc ##### -->
1409 <para>
1410
1411 </para>
1412
1413 @a:
1414 @b:
1415 @Returns:
1416
1417 <!-- ##### ARG GtkAboutDialog:link-color ##### -->
1418 <para>
1419
1420 </para>
1421
1422
1423 <!-- ##### ARG GtkAboutDialog:name ##### -->
1424 <para>
1425
1426 </para>
1427
1428
1429 <!-- ##### STRUCT GtkAccelEntry ##### -->
1430 <para>
1431 This is a private struct used by GTK+ internally, don't worry about it.
1432 </para>
1433
1434 @accel_group:
1435 @accelerator_key:
1436 @accelerator_mods:
1437 @accel_flags:
1438 @object:
1439 @signal_id:
1440
1441 <!-- ##### ARG GtkAccelLabel:accel-object ##### -->
1442 <para>
1443
1444 </para>
1445
1446
1447 <!-- ##### ARG GtkAccelLabel:accel-width ##### -->
1448 <para>
1449
1450 </para>
1451
1452
1453 <!-- ##### USER_FUNCTION GtkAccelMapNotify ##### -->
1454 <para>
1455
1456 </para>
1457
1458 @data:
1459 @accel_path_quark:
1460 @accel_key:
1461 @accel_mods:
1462 @accel_group:
1463 @old_accel_key:
1464 @old_accel_mods:
1465
1466 <!-- ##### SIGNAL GtkAction::connect-proxy ##### -->
1467 <para>
1468
1469 </para>
1470
1471 @action: the object which received the signal.
1472 @widget:
1473
1474 <!-- ##### SIGNAL GtkAction::disconnect-proxy ##### -->
1475 <para>
1476
1477 </para>
1478
1479 @action: the object which received the signal.
1480 @widget:
1481
1482 <!-- ##### ENUM GtkArgFlags ##### -->
1483 <para>
1484 Possible flags indicating how an argument should be treated.
1485 </para>
1486
1487 @GTK_ARG_READABLE: the argument is readable. (i.e. can be queried)
1488 @GTK_ARG_WRITABLE: the argument is writable. (i.e. settable)
1489 @GTK_ARG_CONSTRUCT: the argument needs construction.
1490 @GTK_ARG_CONSTRUCT_ONLY: the argument needs construction (and will
1491 be set once during object creation), but is otherwise cannot be
1492 set.  Hence this flag is not allowed with #GTK_ARG_WRITABLE,
1493 and is redundant with #GTK_ARG_CONSTRUCT.
1494 @GTK_ARG_CHILD_ARG: an argument type that applies to (and may be different for)
1495 each child.  Used by #GtkContainer.
1496 @Deprecated: Use corresponding #GParamSpec features instead
1497
1498 <!-- ##### USER_FUNCTION GtkArgGetFunc ##### -->
1499 <para>
1500 Define a function pointer.  Deprecated.
1501 </para>
1502
1503 @object:
1504 @arg:
1505 @arg_id:
1506
1507 <!-- ##### STRUCT GtkArgInfo ##### -->
1508 <para>
1509 A structure containing information about the argument.
1510 Returned by gtk_arg_get_info().
1511 </para>
1512
1513 @class_type: if the argument is an object, this is the object class type.
1514 @name: the name of the argument.
1515 @type: the type of the argument; it may be an object's type
1516 or a fundamental type.
1517 @arg_flags: flags applicable to the argument (i.e. readable, writable,
1518 and whether it needs to be constructed).
1519 @full_name: the object name and argument name separated by ::,
1520 e.g. "GtkObject::user_data" or "GtkButton::label".
1521 @arg_id: the unique argument identified.
1522 @seq_id: ???
1523
1524 <!-- ##### USER_FUNCTION GtkArgSetFunc ##### -->
1525 <para>
1526 Define a function pointer.  Deprecated.
1527 </para>
1528
1529 @object:
1530 @arg:
1531 @arg_id:
1532
1533 <!-- ##### STRUCT GtkBuilderClass ##### -->
1534 <para>
1535
1536 </para>
1537
1538 @get_type_from_name: Looks up a type by name. The default
1539   implementation applies heuristics to map type names to
1540   <function>_get_type</function> function names, e.g.
1541   GtkHBox to gtk_hbox_get_type(). This virtual function
1542   is provided to allow language bindings to intercept the
1543   type resolution process.
1544
1545 <!-- ##### ENUM GtkButtonAction ##### -->
1546 <para>
1547 Values for specifying what mouse button events a CList will
1548 react to.
1549 </para>
1550
1551 @GTK_BUTTON_IGNORED:
1552 @GTK_BUTTON_SELECTS:
1553 @GTK_BUTTON_DRAGS:
1554 @GTK_BUTTON_EXPANDS:
1555
1556 <!-- ##### STRUCT GtkCList ##### -->
1557 <para>
1558 This is the embodiment of the #GtkCList widget.  This structure contains
1559 only private data, and should be accessed only via the CList API.
1560 </para>
1561
1562
1563 <!-- ##### SIGNAL GtkCList::abort-column-resize ##### -->
1564 <para>
1565 This signal is emitted when a column resize is aborted.
1566 </para>
1567
1568 @clist: the object which received the signal.
1569
1570 <!-- ##### SIGNAL GtkCList::click-column ##### -->
1571 <para>
1572 This signal is emitted when a column title is clicked.
1573 </para>
1574
1575 @clist: The object which received the signal.
1576 @column: The number of the column.
1577
1578 <!-- ##### SIGNAL GtkCList::end-selection ##### -->
1579 <para>
1580 This signal is emitted when a selection ends in a
1581 multiple selection CList.
1582 </para>
1583
1584 @clist: the object which received the signal.
1585
1586 <!-- ##### SIGNAL GtkCList::extend-selection ##### -->
1587 <para>
1588 This signal is emitted when the selection is extended.
1589 </para>
1590
1591 @clist: the object which received the signal.
1592 @scroll_type: A #GtkScrollType value of any scrolling operation the
1593 occured during the selection.
1594 @position: A value between 0.0 and 1.0.
1595 @auto_start_selection: %TRUE or %FALSE.
1596
1597 <!-- ##### SIGNAL GtkCList::resize-column ##### -->
1598 <para>
1599 This signal is emitted when a column is resized.
1600 </para>
1601
1602 @clist: The object which received the signal.
1603 @column: The number of the column
1604 @width: The new width of the column.
1605
1606 <!-- ##### SIGNAL GtkCList::row-move ##### -->
1607 <para>
1608 This signal is emitted when a row is moved.
1609 </para>
1610
1611 @clist: The object which received the signal.
1612 @arg1: The source position of the row.
1613 @arg2: The destination position of the row.
1614
1615 <!-- ##### SIGNAL GtkCList::scroll-horizontal ##### -->
1616 <para>
1617 This signal is emitted when the CList is scrolled horizontally.
1618 </para>
1619
1620 @clist: the object which received the signal.
1621 @scroll_type: A #GtkScrollType value of how the scroll operation occured.
1622 @position: a value between 0.0 and 1.0.
1623
1624 <!-- ##### SIGNAL GtkCList::scroll-vertical ##### -->
1625 <para>
1626 This signal is emitted when the CList is scrolled vertically.
1627 </para>
1628
1629 @clist: the object which received the signal.
1630 @scroll_type: A #GtkScrollType value of how the scroll operation occured.
1631 @position: A value between 0.0 and 1.0.
1632
1633 <!-- ##### SIGNAL GtkCList::select-all ##### -->
1634 <para>
1635 This signal is emitted when all the rows are selected in a CList.
1636 </para>
1637
1638 @clist: the object which received the signal.
1639
1640 <!-- ##### SIGNAL GtkCList::select-row ##### -->
1641 <para>
1642 This signal is emitted when the user selects a row in the list.
1643 It is emitted for every row that is selected in a multi-selection or
1644 by calling gtk_clist_select_all().
1645 </para>
1646
1647 @clist: The object which received the signal.
1648 @row: The row selected.
1649 @column: The column where the selection occured.
1650 @event: A #GdkEvent structure for the selection.
1651
1652 <!-- ##### SIGNAL GtkCList::set-scroll-adjustments ##### -->
1653 <para>
1654
1655 </para>
1656
1657 @clist: the object which received the signal.
1658 @arg1:
1659 @arg2:
1660
1661 <!-- ##### SIGNAL GtkCList::start-selection ##### -->
1662 <para>
1663 This signal is emitted when a drag-selection is started in
1664 a multiple-selection CList.
1665 </para>
1666
1667 @clist: the object which received the signal.
1668
1669 <!-- ##### SIGNAL GtkCList::toggle-add-mode ##### -->
1670 <para>
1671 This signal is emitted when "add mode" is toggled.
1672 </para>
1673
1674 @clist: the object which received the signal.
1675
1676 <!-- ##### SIGNAL GtkCList::toggle-focus-row ##### -->
1677 <para>
1678
1679 </para>
1680
1681 @clist: The object which received the signal.
1682
1683 <!-- ##### SIGNAL GtkCList::undo-selection ##### -->
1684 <para>
1685 This signal is emitted when an undo selection occurs in the CList,
1686 probably via calling gtk_clist_undo_selection().
1687 </para>
1688
1689 @clist: the object which received the signal.
1690
1691 <!-- ##### SIGNAL GtkCList::unselect-all ##### -->
1692 <para>
1693 This signal is emitted when all rows are unselected in a CList.
1694 </para>
1695
1696 @clist: the object which received the signal.
1697
1698 <!-- ##### SIGNAL GtkCList::unselect-row ##### -->
1699 <para>
1700 This signal is emitted when the user unselects a row in the list.
1701 It is emitted for every row that is unselected in a multi-selection or
1702 by calling gtk_clist_unselect_all().  It is also emitted for the
1703 previously selected row in a "single" or "browse" mode CList.
1704 </para>
1705
1706 @clist: The object which received the signal.
1707 @row: The selected row
1708 @column: The column where the selection occured.
1709 @event:
1710
1711 <!-- ##### ARG GtkCList:n-columns ##### -->
1712 <para>
1713 An integer value for a column.
1714 </para>
1715
1716
1717 <!-- ##### ARG GtkCList:reorderable ##### -->
1718 <para>
1719 A boolean value for determining if the user can re-order the CList's
1720 columns.
1721 </para>
1722
1723
1724 <!-- ##### ARG GtkCList:row-height ##### -->
1725 <para>
1726 An integer value representing the height of a row in pixels.
1727 </para>
1728
1729
1730 <!-- ##### ARG GtkCList:selection-mode ##### -->
1731 <para>
1732 Sets the type of selection mode for the CList.
1733 </para>
1734
1735
1736 <!-- ##### ARG GtkCList:shadow-type ##### -->
1737 <para>
1738 Sets the shadowing for the CList.
1739 </para>
1740
1741
1742 <!-- ##### ARG GtkCList:sort-type ##### -->
1743 <para>
1744
1745 </para>
1746
1747
1748 <!-- ##### ARG GtkCList:titles-active ##### -->
1749 <para>
1750 A boolean value for setting whether the column titles can be
1751 clicked.
1752 </para>
1753
1754
1755 <!-- ##### ARG GtkCList:use-drag-icons ##### -->
1756 <para>
1757 A boolean value for setting whether to use icons during drag
1758 operations.
1759 </para>
1760
1761
1762 <!-- ##### STRUCT GtkCListCellInfo ##### -->
1763 <para>
1764 A simple structure that the #GtkCList widget uses to keep track
1765 of the location of a cell.
1766 </para>
1767
1768 @row:
1769 @column:
1770
1771 <!-- ##### STRUCT GtkCListColumn ##### -->
1772 <para>
1773 A structure that the #GtkCList widget uses to keep track of information
1774 about its columns.
1775 </para>
1776
1777 @title:
1778 @area:
1779 @button:
1780 @window:
1781 @width:
1782 @min_width:
1783 @max_width:
1784 @justification:
1785 @visible:
1786 @width_set:
1787 @resizeable:
1788 @auto_resize:
1789 @button_passive:
1790
1791 <!-- ##### USER_FUNCTION GtkCListCompareFunc ##### -->
1792 <para>
1793 Function prototype for the compare function callback.
1794 </para>
1795
1796 @clist: The #GtkCList that is affected.
1797 @ptr1: A #gconstpointer to the first node to compare.
1798 @ptr2: A #gconstpointer to the second node to compare.
1799 @Returns: 0 if the nodes are equal, less than 0 if the first node should
1800 come before the second, and greater than 1 if the second come before the
1801 first.
1802
1803 <!-- ##### STRUCT GtkCListDestInfo ##### -->
1804 <para>
1805 A simple structure that the #GtkCList widget uses to track
1806 a cell for a drag operation.
1807 </para>
1808
1809 @cell:
1810 @insert_pos:
1811
1812 <!-- ##### ENUM GtkCListDragPos ##### -->
1813 <para>
1814 An enumeration for drag operations.
1815 </para>
1816
1817 @GTK_CLIST_DRAG_NONE:
1818 @GTK_CLIST_DRAG_BEFORE:
1819 @GTK_CLIST_DRAG_INTO:
1820 @GTK_CLIST_DRAG_AFTER:
1821
1822 <!-- ##### STRUCT GtkCListRow ##### -->
1823 <para>
1824 A structure that the #GtkCList widget uses to keep track of information
1825 about its rows.
1826 </para>
1827
1828 @cell:
1829 @state:
1830 @foreground:
1831 @background:
1832 @style:
1833 @data:
1834 @destroy:
1835 @fg_set:
1836 @bg_set:
1837 @selectable:
1838
1839 <!-- ##### STRUCT GtkCell ##### -->
1840 <para>
1841 A generic structure that the #GtkCList widget uses to keep track of the
1842 contents of each of its cells.
1843 </para>
1844
1845 @type:
1846 @vertical:
1847 @horizontal:
1848 @style:
1849 @widget:
1850
1851 <!-- ##### STRUCT GtkCellPixText ##### -->
1852 <para>
1853 A structure that the #GtkCList widget uses to keep track of #GtkCList cells
1854 that contain a combination of text and a GdkPixmap.
1855 </para>
1856
1857 @type:
1858 @vertical:
1859 @horizontal:
1860 @style:
1861 @text:
1862 @spacing:
1863 @pixmap:
1864 @mask:
1865
1866 <!-- ##### STRUCT GtkCellPixmap ##### -->
1867 <para>
1868 A structure that the #GtkCList widget uses to keep track of #GtkCList cells
1869 that contain a GdkPixmap.
1870 </para>
1871
1872 @type:
1873 @vertical:
1874 @horizontal:
1875 @style:
1876 @pixmap:
1877 @mask:
1878
1879 <!-- ##### STRUCT GtkCellRendererTextPixbuf ##### -->
1880 <para>
1881
1882 </para>
1883
1884 @parent:
1885
1886 <!-- ##### STRUCT GtkCellText ##### -->
1887 <para>
1888 A structure that the #GtkCList widget uses to keep track of #GtkCList cells
1889 that contain text.
1890 </para>
1891
1892 @type:
1893 @vertical:
1894 @horizontal:
1895 @style:
1896 @text:
1897
1898 <!-- ##### ENUM GtkCellType ##### -->
1899 <para>
1900 Identifies the type of element in the current cell of the CList.  Cells can
1901 contain text, pixmaps, or both. Unfortunately support for %GTK_CELL_WIDGET
1902 was never completed.
1903 </para>
1904
1905 @GTK_CELL_EMPTY:
1906 @GTK_CELL_TEXT:
1907 @GTK_CELL_PIXMAP:
1908 @GTK_CELL_PIXTEXT:
1909 @GTK_CELL_WIDGET:
1910
1911 <!-- ##### ARG GtkCellView:use-fg ##### -->
1912 <para>
1913
1914 </para>
1915
1916
1917 <!-- ##### STRUCT GtkCellWidget ##### -->
1918 <para>
1919 A structure that the #GtkCList widget uses to keep track of #GtkCList cells
1920 that contain another widget.
1921 </para>
1922
1923 @type:
1924 @vertical:
1925 @horizontal:
1926 @style:
1927 @widget:
1928
1929 <!-- ##### TYPEDEF GtkClassInitFunc ##### -->
1930 <para>
1931 Defines a function pointer.
1932 </para>
1933
1934
1935 <!-- ##### ARG GtkColorSelection:previous-alpha ##### -->
1936 <para>
1937
1938 </para>
1939
1940
1941 <!-- ##### ARG GtkColorSelection:previous-color ##### -->
1942 <para>
1943
1944 </para>
1945
1946
1947 <!-- ##### STRUCT GtkCombo ##### -->
1948 <para>
1949 The #GtkCombo-struct struct contains the following fields.
1950 (These fields should be considered read-only. They should never be set by
1951 an application.)
1952 </para>
1953
1954 @entry: the text entry field.
1955 @list: the list shown in the drop-down window.
1956 @Deprecated: 2.4: Use #GtkComboBox instead.
1957
1958 <!-- ##### ARG GtkCombo:allow-empty ##### -->
1959 <para>
1960
1961 </para>
1962
1963
1964 <!-- ##### ARG GtkCombo:case-sensitive ##### -->
1965 <para>
1966
1967 </para>
1968
1969
1970 <!-- ##### ARG GtkCombo:enable-arrow-keys ##### -->
1971 <para>
1972
1973 </para>
1974
1975
1976 <!-- ##### ARG GtkCombo:enable-arrows-always ##### -->
1977 <para>
1978
1979 </para>
1980
1981
1982 <!-- ##### ARG GtkCombo:value-in-list ##### -->
1983 <para>
1984
1985 </para>
1986
1987
1988 <!-- ##### SIGNAL GtkComboBox::popup-hide ##### -->
1989 <para>
1990
1991 </para>
1992
1993 @combobox: the object which received the signal.
1994
1995 <!-- ##### SIGNAL GtkComboBox::popup-show ##### -->
1996 <para>
1997
1998 </para>
1999
2000 @combobox: the object which received the signal.
2001
2002 <!-- ##### ARG GtkComboBox:appearance ##### -->
2003 <para>
2004
2005 </para>
2006
2007
2008 <!-- ##### ARG GtkComboBox:row-separator-column ##### -->
2009 <para>
2010
2011 </para>
2012
2013
2014 <!-- ##### SIGNAL GtkContainer::focus ##### -->
2015 <para>
2016
2017 </para>
2018
2019 @container: the object which received the signal.
2020 @direction:
2021 @Returns:
2022
2023 <!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
2024 <para>
2025
2026 </para>
2027
2028
2029 <!-- ##### STRUCT GtkData ##### -->
2030 <para>
2031 The #GtkData-struct struct contains no public fields.
2032 </para>
2033
2034
2035 <!-- ##### SIGNAL GtkData::disconnect ##### -->
2036 <para>
2037 Emitted to notify any views on the #GtkData object to disconnect from it,
2038 possibly because the #GtkData object is about to be destroyed.
2039 </para>
2040
2041 @data: the object which received the signal.
2042
2043 <!-- ##### USER_FUNCTION GtkDestroyNotify ##### -->
2044 <para>
2045 Defines a function pointer.
2046 </para>
2047
2048 @data: #gpointer
2049
2050 <!-- ##### UNION GtkDitherInfo ##### -->
2051 <para>
2052 This union not used in GTK+.
2053 </para>
2054
2055
2056 <!-- ##### SIGNAL GtkEditable::activate ##### -->
2057 <para>
2058 Indicates that the user has activated the widget
2059 in some fashion. Generally, this will be done
2060 with a keystroke. (The default binding for this
2061 action is Return for #GtkEntry and
2062 Control-Return for #GtkText.)
2063 </para>
2064
2065 @editable: the object which received the signal.
2066
2067 <!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
2068 <para>
2069 An action signal. Causes the characters in the current selection to
2070 be copied to the clipboard.
2071 </para>
2072
2073 @editable: the object which received the signal.
2074
2075 <!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
2076 <para>
2077 An action signal. Causes the characters in the current
2078 selection to be copied to the clipboard and then deleted from
2079 the widget.
2080 </para>
2081
2082 @editable: the object which received the signal.
2083
2084 <!-- ##### SIGNAL GtkEditable::kill-char ##### -->
2085 <para>
2086 An action signal. Delete a single character.
2087 </para>
2088
2089 @editable: the object which received the signal.
2090 @direction: the direction in which to delete. Positive
2091    indicates forward deletion, negative, backwards deletion.
2092
2093 <!-- ##### SIGNAL GtkEditable::kill-line ##### -->
2094 <para>
2095 An action signal. Delete a single line.
2096 </para>
2097
2098 @editable: the object which received the signal.
2099 @direction: the direction in which to delete. Positive
2100    indicates forward deletion, negative, backwards deletion.
2101
2102 <!-- ##### SIGNAL GtkEditable::kill-word ##### -->
2103 <para>
2104 An action signal. Delete a single word.
2105 </para>
2106
2107 @editable: the object which received the signal.
2108 @direction: the direction in which to delete. Positive
2109    indicates forward deletion, negative, backwards deletion.
2110
2111 <!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
2112 <para>
2113 An action signal. Move the cursor position.
2114 </para>
2115
2116 @editable: the object which received the signal.
2117 @x: horizontal distance to move the cursor.
2118 @y: vertical distance to move the cursor.
2119
2120 <!-- ##### SIGNAL GtkEditable::move-page ##### -->
2121 <para>
2122 An action signal. Move the cursor by pages.
2123 </para>
2124
2125 @editable: the object which received the signal.
2126 @x: Number of pages to move the cursor horizontally.
2127 @y: Number of pages to move the cursor vertically.
2128
2129 <!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
2130 <para>
2131 An action signal. Move the cursor to the given column.
2132 </para>
2133
2134 @editable: the object which received the signal.
2135 @column: the column to move to. (A negative value indicates
2136          the last column)
2137
2138 <!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
2139 <para>
2140 An action signal. Move the cursor to the given row.
2141 </para>
2142
2143 @editable: the object which received the signal.
2144 @row: the row to move to. (A negative value indicates
2145       the last row)
2146
2147 <!-- ##### SIGNAL GtkEditable::move-word ##### -->
2148 <para>
2149 An action signal. Move the cursor by words.
2150 </para>
2151
2152 @editable: the object which received the signal.
2153 @num_words: The number of words to move the
2154 cursor. (Can be negative).
2155
2156 <!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
2157 <para>
2158 An action signal. Causes the contents of the clipboard to
2159 be pasted into the editable widget at the current cursor
2160 position.
2161 </para>
2162
2163 @editable: the object which received the signal.
2164
2165 <!-- ##### SIGNAL GtkEditable::set-editable ##### -->
2166 <para>
2167 Determines if the user can edit the text in the editable
2168 widget or not. This is meant to be overriden by
2169 child classes and should not generally useful to
2170 applications.
2171 </para>
2172
2173 @editable: the object which received the signal.
2174 @is_editable: %TRUE if the user is allowed to edit the text
2175   in the widget.
2176
2177 <!-- ##### ARG GtkEditable:editable ##### -->
2178 <para>
2179 A boolean indicating whether the widget is editable by
2180 the user.
2181 </para>
2182
2183
2184 <!-- ##### ARG GtkEditable:text-position ##### -->
2185 <para>
2186 The position of the cursor.
2187 </para>
2188
2189
2190 <!-- ##### USER_FUNCTION GtkEmissionHook ##### -->
2191 <para>
2192 A simple function pointer to get invoked when the
2193 signal is emitted.  This allows you tie a hook to the signal type,
2194 so that it will trap all emissions of that signal, from any object.
2195 </para>
2196 <para>
2197 You may not attach these to signals created with the
2198 #GTK_RUN_NO_HOOKS flag.
2199 </para>
2200
2201 @object:
2202 @signal_id:
2203 @n_params:
2204 @params:
2205 @data:
2206 @Returns:
2207
2208 <!-- ##### SIGNAL GtkEntry::changed ##### -->
2209 <para>
2210
2211 </para>
2212
2213 @entry: the object which received the signal.
2214
2215 <!-- ##### SIGNAL GtkEntry::delete-text ##### -->
2216 <para>
2217
2218 </para>
2219
2220 @entry: the object which received the signal.
2221 @arg1:
2222 @arg2:
2223
2224 <!-- ##### SIGNAL GtkEntry::icon-pressed ##### -->
2225 <para>
2226
2227 </para>
2228
2229 @entry: the object which received the signal.
2230 @arg1:
2231 @event:
2232
2233 <!-- ##### SIGNAL GtkEntry::icon-released ##### -->
2234 <para>
2235
2236 </para>
2237
2238 @entry: the object which received the signal.
2239 @arg1:
2240 @event:
2241
2242 <!-- ##### SIGNAL GtkEntry::insert-text ##### -->
2243 <para>
2244
2245 </para>
2246
2247 @entry: the object which received the signal.
2248 @arg1:
2249 @arg2:
2250 @arg3:
2251
2252 <!-- ##### ARG GtkEntry:activatable-primary ##### -->
2253 <para>
2254
2255 </para>
2256
2257
2258 <!-- ##### ARG GtkEntry:activatable-secondary ##### -->
2259 <para>
2260
2261 </para>
2262
2263
2264 <!-- ##### ARG GtkEntry:gicon-primary ##### -->
2265 <para>
2266
2267 </para>
2268
2269
2270 <!-- ##### ARG GtkEntry:gicon-secondary ##### -->
2271 <para>
2272
2273 </para>
2274
2275
2276 <!-- ##### ARG GtkEntry:icon-name-primary ##### -->
2277 <para>
2278
2279 </para>
2280
2281
2282 <!-- ##### ARG GtkEntry:icon-name-secondary ##### -->
2283 <para>
2284
2285 </para>
2286
2287
2288 <!-- ##### ARG GtkEntry:pixbuf-primary ##### -->
2289 <para>
2290
2291 </para>
2292
2293
2294 <!-- ##### ARG GtkEntry:pixbuf-secondary ##### -->
2295 <para>
2296
2297 </para>
2298
2299
2300 <!-- ##### ARG GtkEntry:prelight ##### -->
2301 <para>
2302
2303 </para>
2304
2305
2306 <!-- ##### ARG GtkEntry:sensitive-primary ##### -->
2307 <para>
2308
2309 </para>
2310
2311
2312 <!-- ##### ARG GtkEntry:sensitive-secondary ##### -->
2313 <para>
2314
2315 </para>
2316
2317
2318 <!-- ##### ARG GtkEntry:stock-primary ##### -->
2319 <para>
2320
2321 </para>
2322
2323
2324 <!-- ##### ARG GtkEntry:stock-secondary ##### -->
2325 <para>
2326
2327 </para>
2328
2329
2330 <!-- ##### ARG GtkEntry:storage-type-primary ##### -->
2331 <para>
2332
2333 </para>
2334
2335
2336 <!-- ##### ARG GtkEntry:storage-type-secondary ##### -->
2337 <para>
2338
2339 </para>
2340
2341
2342 <!-- ##### ARG GtkEntry:text-position ##### -->
2343 <para>
2344
2345 </para>
2346
2347
2348 <!-- ##### STRUCT GtkEntryBufferClass ##### -->
2349 <para>
2350
2351 </para>
2352
2353 @parent_class:
2354 @inserted_text:
2355 @deleted_text:
2356 @get_text:
2357 @get_length:
2358 @insert_text:
2359 @delete_text:
2360 @_gtk_reserved0:
2361 @_gtk_reserved1:
2362 @_gtk_reserved2:
2363 @_gtk_reserved3:
2364 @_gtk_reserved4:
2365 @_gtk_reserved5:
2366
2367 <!-- ##### TYPEDEF GtkEnumValue ##### -->
2368 <para>
2369 A structure which contains a single enum value, and its name, and its
2370 nickname.
2371 </para>
2372
2373
2374 <!-- ##### ARG GtkFileChooser:file-system ##### -->
2375 <para>
2376
2377 </para>
2378
2379
2380 <!-- ##### STRUCT GtkFileSelection ##### -->
2381 <para>
2382 The #GtkFileSelection struct contains the following #GtkWidget fields:
2383 </para>
2384
2385 @dir_list:
2386 @file_list:
2387 @selection_entry:
2388 @selection_text:
2389 @main_vbox:
2390 @ok_button:
2391 @cancel_button: the two main buttons that signals should be connected
2392     to in order to perform an action when the user hits either OK or
2393     Cancel.
2394 @help_button:
2395 @history_pulldown: the #GtkOptionMenu used to create the drop-down
2396     directory history.
2397 @history_menu:
2398 @history_list:
2399 @fileop_dialog: the dialog box used to display the #GtkFileSelection.
2400    It can be customized by adding/removing widgets from it using the
2401    standard #GtkDialog functions.
2402 @fileop_entry:
2403 @fileop_file:
2404 @cmpl_state:
2405 @fileop_c_dir:
2406 @fileop_del_file:
2407 @fileop_ren_file: the buttons that appear at the top of the file
2408     selection dialog. These "operation buttons" can be hidden and
2409     redisplayed with gtk_file_selection_hide_fileop_buttons() and
2410     gtk_file_selection_show_fileop_buttons() respectively.
2411 @button_area:
2412 @action_area:
2413
2414 <!-- ##### ARG GtkFileSelection:filename ##### -->
2415 <para>
2416
2417 </para>
2418
2419
2420 <!-- ##### ARG GtkFileSelection:select-multiple ##### -->
2421 <para>
2422
2423 </para>
2424
2425
2426 <!-- ##### ARG GtkFileSelection:show-fileops ##### -->
2427 <para>
2428
2429 </para>
2430
2431
2432 <!-- ##### STRUCT GtkFixedChild ##### -->
2433 <para>
2434 The #GtkFixedChild-struct struct contains the following fields.
2435 (These fields should be considered read-only. They should never be set by
2436 an application.)
2437
2438 <informaltable pgwide="1" frame="none" role="struct">
2439 <tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
2440 <tbody>
2441
2442 <row>
2443 <entry>#GtkWidget *widget;</entry>
2444 <entry>the child #GtkWidget.</entry>
2445 </row>
2446
2447 <row>
2448 <entry>#gint x;</entry>
2449 <entry>the horizontal position of the widget within the #GtkFixed
2450 container.</entry>
2451 </row>
2452
2453 <row>
2454 <entry>#gint y;</entry>
2455 <entry>the vertical position of the widget within the #GtkFixed
2456 container.</entry>
2457 </row>
2458
2459 </tbody></tgroup></informaltable>
2460 </para>
2461
2462 @widget:
2463 @x:
2464 @y:
2465
2466 <!-- ##### TYPEDEF GtkFlagValue ##### -->
2467 <para>
2468
2469 </para>
2470
2471
2472 <!-- ##### ENUM GtkFontFilterType ##### -->
2473 <para>
2474 A set of bit flags used to specify the filter being set
2475 when calling gtk_font_selection_dialog_set_filter() or
2476 gtk_font_selection_set_filter().
2477 </para>
2478
2479 @GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user.
2480 @GTK_FONT_FILTER_USER: the user filter, which can be changed from within the
2481 'Filter' page of the #GtkFontSelection widget.
2482
2483 <!-- ##### ENUM GtkFontType ##### -->
2484 <para>
2485 A set of bit flags used to specify the type of fonts shown
2486 when calling gtk_font_selection_dialog_set_filter() or
2487 gtk_font_selection_set_filter().
2488 </para>
2489
2490 @GTK_FONT_BITMAP: bitmap fonts.
2491 @GTK_FONT_SCALABLE: scalable fonts.
2492 @GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts.
2493 @GTK_FONT_ALL: a bitwise combination of all of the above.
2494
2495 <!-- ##### TYPEDEF GtkFundamentalType ##### -->
2496 <para>
2497 #GtkFundamentalType is an enumerated type which lists all the possible
2498 fundamental types (e.g. <type>char</type>, <type>uchar</type>, <type>int</type>,
2499 <type>long</type>, <type>float</type>, etc).
2500 </para>
2501
2502
2503 <!-- ##### ARG GtkHScale:adjustment ##### -->
2504 <para>
2505 the #GtkAdjustment which sets the range of the scale.
2506 </para>
2507
2508
2509 <!-- ##### ARG GtkHScrollbar:adjustment ##### -->
2510 <para>
2511
2512 </para>
2513
2514
2515 <!-- ##### STRUCT GtkIconViewPrivate ##### -->
2516 <para>
2517
2518 </para>
2519
2520
2521 <!-- ##### USER_FUNCTION GtkImageLoader ##### -->
2522 <para>
2523 A GtkImageLoader is used to load a filename found in
2524 a RC file.
2525 </para>
2526
2527 @window: the window for creating image
2528 @colormap: the colormap for this image
2529 @mask: a pointer to the location to store the mask
2530 @transparent_color: the transparent color for the image
2531 @filename: filename to load
2532 @Returns: a #GtkPixmap representing @filename
2533
2534 <!-- ##### STRUCT GtkImageMenuItemClass ##### -->
2535 <para>
2536
2537 </para>
2538
2539
2540 <!-- ##### STRUCT GtkItemFactory ##### -->
2541 <para>
2542
2543 </para>
2544
2545
2546 <!-- ##### USER_FUNCTION GtkItemFactoryCallback ##### -->
2547 <para>
2548
2549 </para>
2550
2551
2552 <!-- ##### USER_FUNCTION GtkItemFactoryCallback1 ##### -->
2553 <para>
2554
2555 </para>
2556
2557 @callback_data:
2558 @callback_action:
2559 @widget:
2560
2561 <!-- ##### USER_FUNCTION GtkItemFactoryCallback2 ##### -->
2562 <para>
2563
2564 </para>
2565
2566 @widget:
2567 @callback_data:
2568 @callback_action:
2569
2570 <!-- ##### STRUCT GtkItemFactoryEntry ##### -->
2571 <para>
2572
2573 </para>
2574
2575 @path:
2576 @accelerator:
2577 @callback:
2578 @callback_action:
2579 @item_type:
2580 @extra_data:
2581
2582 <!-- ##### STRUCT GtkItemFactoryItem ##### -->
2583 <para>
2584
2585 </para>
2586
2587 @path:
2588 @widgets:
2589
2590 <!-- ##### ARG GtkLabel:accel-keyval ##### -->
2591 <para>
2592
2593 </para>
2594
2595
2596 <!-- ##### STRUCT GtkList ##### -->
2597 <para>
2598
2599 </para>
2600
2601
2602 <!-- ##### SIGNAL GtkList::select-child ##### -->
2603 <para>
2604 The child @widget has just been selected.
2605 </para>
2606
2607 @list: the object which received the signal.
2608 @widget: the newly selected child.
2609
2610 <!-- ##### SIGNAL GtkList::selection-changed ##### -->
2611 <para>
2612 The selection of the widget has just changed.
2613 </para>
2614
2615 @list: the object which received the signal.
2616
2617 <!-- ##### SIGNAL GtkList::unselect-child ##### -->
2618 <para>
2619 The child @widget has just been unselected.
2620 </para>
2621
2622 @list: the object which received the signal.
2623 @widget: the newly unselected child.
2624
2625 <!-- ##### ARG GtkList:selection-mode ##### -->
2626 <para>
2627
2628 </para>
2629
2630
2631 <!-- ##### STRUCT GtkListItem ##### -->
2632 <para>
2633 The #GtkListItem struct contains private data only, and should
2634 only be accessed using the functions below.
2635 </para>
2636
2637
2638 <!-- ##### SIGNAL GtkListItem::end-selection ##### -->
2639 <para>
2640
2641 </para>
2642
2643 @listitem: the object which received the signal.
2644
2645 <!-- ##### SIGNAL GtkListItem::extend-selection ##### -->
2646 <para>
2647
2648 </para>
2649
2650 @listitem: the object which received the signal.
2651 @scroll_type:
2652 @position:
2653 @auto_start_selection:
2654
2655 <!-- ##### SIGNAL GtkListItem::scroll-horizontal ##### -->
2656 <para>
2657
2658 </para>
2659
2660 @listitem: the object which received the signal.
2661 @scroll_type:
2662 @position:
2663
2664 <!-- ##### SIGNAL GtkListItem::scroll-vertical ##### -->
2665 <para>
2666
2667 </para>
2668
2669 @listitem: the object which received the signal.
2670 @scroll_type:
2671 @position:
2672
2673 <!-- ##### SIGNAL GtkListItem::select-all ##### -->
2674 <para>
2675
2676 </para>
2677
2678 @listitem: the object which received the signal.
2679
2680 <!-- ##### SIGNAL GtkListItem::start-selection ##### -->
2681 <para>
2682
2683 </para>
2684
2685 @listitem: the object which received the signal.
2686
2687 <!-- ##### SIGNAL GtkListItem::toggle-add-mode ##### -->
2688 <para>
2689
2690 </para>
2691
2692 @listitem: the object which received the signal.
2693
2694 <!-- ##### SIGNAL GtkListItem::toggle-focus-row ##### -->
2695 <para>
2696
2697 </para>
2698
2699 @listitem: the object which received the signal.
2700
2701 <!-- ##### SIGNAL GtkListItem::undo-selection ##### -->
2702 <para>
2703
2704 </para>
2705
2706 @listitem: the object which received the signal.
2707
2708 <!-- ##### SIGNAL GtkListItem::unselect-all ##### -->
2709 <para>
2710
2711 </para>
2712
2713 @listitem: the object which received the signal.
2714
2715 <!-- ##### ENUM GtkMatchType ##### -->
2716 <para>
2717
2718 </para>
2719
2720 @GTK_MATCH_ALL:
2721 @GTK_MATCH_ALL_TAIL:
2722 @GTK_MATCH_HEAD:
2723 @GTK_MATCH_TAIL:
2724 @GTK_MATCH_EXACT:
2725 @GTK_MATCH_LAST:
2726
2727 <!-- ##### SIGNAL GtkMenuBar::cycle-focus ##### -->
2728 <para>
2729
2730 </para>
2731
2732 @menubar: the object which received the signal.
2733 @arg1:
2734
2735 <!-- ##### SIGNAL GtkNotebook::tab-added ##### -->
2736 <para>
2737
2738 </para>
2739
2740 @notebook: the object which received the signal.
2741 @arg1:
2742 @arg2:
2743
2744 <!-- ##### SIGNAL GtkNotebook::tab-removed ##### -->
2745 <para>
2746
2747 </para>
2748
2749 @notebook: the object which received the signal.
2750 @arg1:
2751 @arg2:
2752
2753 <!-- ##### SIGNAL GtkNotebook::tab-reordered ##### -->
2754 <para>
2755
2756 </para>
2757
2758 @notebook: the object which received the signal.
2759 @arg1:
2760 @arg2:
2761
2762 <!-- ##### ARG GtkNotebook:group-id ##### -->
2763 <para>
2764
2765 </para>
2766
2767
2768 <!-- ##### ARG GtkNotebook:homogeneous ##### -->
2769 <para>
2770
2771 </para>
2772
2773
2774 <!-- ##### ARG GtkNotebook:tab-border ##### -->
2775 <para>
2776
2777 </para>
2778
2779
2780 <!-- ##### ARG GtkNotebook:tab-hborder ##### -->
2781 <para>
2782
2783 </para>
2784
2785
2786 <!-- ##### ARG GtkNotebook:tab-vborder ##### -->
2787 <para>
2788
2789 </para>
2790
2791
2792 <!-- ##### ARG GtkObject:object-signal ##### -->
2793 <para>
2794 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
2795 the signal to the object, so that the user data and objects
2796 and swapped when the signal handler is invoked.
2797 </para>
2798 <para>
2799 This is useful for handlers that are primarily notifying
2800 other objects and could just invoke an already existing function
2801 if the parameters were swapped.
2802 See g_signal_connect_swapped() for more details.
2803 </para>
2804
2805
2806 <!-- ##### ARG GtkObject:object-signal-after ##### -->
2807 <para>
2808 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
2809 the signal to the object, so that the user data and objects
2810 and swapped when the signal handler is invoked,
2811 and so that the handler is invoked after all others.
2812 </para>
2813 <para>
2814 See g_signal_connect_data() for more details.
2815 </para>
2816
2817
2818 <!-- ##### ARG GtkObject:signal ##### -->
2819 <para>
2820 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
2821 the signal to the object.
2822 </para>
2823
2824
2825 <!-- ##### ARG GtkObject:signal-after ##### -->
2826 <para>
2827 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
2828 the signal to the object, so that the signal is always run
2829 after other user handlers and the default handler.
2830 </para>
2831
2832
2833 <!-- ##### ARG GtkObject:user-data ##### -->
2834 <para>
2835
2836 </para>
2837
2838
2839 <!-- ##### TYPEDEF GtkObjectInitFunc ##### -->
2840 <para>
2841 Defines a function pointer.
2842 </para>
2843
2844
2845 <!-- ##### SIGNAL GtkOldEditable::changed ##### -->
2846 <para>
2847
2848 </para>
2849
2850 @oldeditable: the object which received the signal.
2851
2852 <!-- ##### SIGNAL GtkOldEditable::delete-text ##### -->
2853 <para>
2854
2855 </para>
2856
2857 @oldeditable: the object which received the signal.
2858 @arg1:
2859 @arg2:
2860
2861 <!-- ##### SIGNAL GtkOldEditable::insert-text ##### -->
2862 <para>
2863
2864 </para>
2865
2866 @oldeditable: the object which received the signal.
2867 @arg1:
2868 @arg2:
2869 @arg3:
2870
2871 <!-- ##### STRUCT GtkPacker ##### -->
2872 <para>
2873
2874 </para>
2875
2876 @parent:
2877 @children:
2878 @spacing:
2879 @default_border_width:
2880 @default_pad_x:
2881 @default_pad_y:
2882 @default_i_pad_x:
2883 @default_i_pad_y:
2884
2885 <!-- ##### ARG GtkPacker:default-border-width ##### -->
2886 <para>
2887
2888 </para>
2889
2890
2891 <!-- ##### ARG GtkPacker:default-ipad-x ##### -->
2892 <para>
2893
2894 </para>
2895
2896
2897 <!-- ##### ARG GtkPacker:default-ipad-y ##### -->
2898 <para>
2899
2900 </para>
2901
2902
2903 <!-- ##### ARG GtkPacker:default-pad-x ##### -->
2904 <para>
2905
2906 </para>
2907
2908
2909 <!-- ##### ARG GtkPacker:default-pad-y ##### -->
2910 <para>
2911
2912 </para>
2913
2914
2915 <!-- ##### ARG GtkPacker:spacing ##### -->
2916 <para>
2917
2918 </para>
2919
2920
2921 <!-- ##### STRUCT GtkPackerChild ##### -->
2922 <para>
2923
2924 </para>
2925
2926 @widget:
2927 @anchor:
2928 @side:
2929 @options:
2930 @use_default:
2931 @border_width:
2932 @pad_x:
2933 @pad_y:
2934 @i_pad_x:
2935 @i_pad_y:
2936
2937 <!-- ##### ENUM GtkPackerOptions ##### -->
2938 <para>
2939
2940 </para>
2941
2942 @GTK_PACK_EXPAND:
2943 @GTK_FILL_X:
2944 @GTK_FILL_Y:
2945
2946 <!-- ##### STRUCT GtkPatternSpec ##### -->
2947 <para>
2948
2949 </para>
2950
2951 @match_type:
2952 @pattern_length:
2953 @pattern:
2954 @pattern_reversed:
2955 @user_data:
2956 @seq_id:
2957
2958 <!-- ##### STRUCT GtkPreview ##### -->
2959 <para>
2960 The #GtkPreview-struct struct contains private data only, and
2961 should be accessed using the functions below.
2962 </para>
2963
2964
2965 <!-- ##### ARG GtkPreview:expand ##### -->
2966 <para>
2967
2968 </para>
2969
2970
2971 <!-- ##### STRUCT GtkPreviewInfo ##### -->
2972 <para>
2973 Contains information about global properties
2974 of preview widgets.
2975
2976 The #GtkPreviewInfo struct contains the following fields.
2977 (These fields should be considered read-only. They should never be set by
2978 an application.)
2979
2980 <informaltable pgwide="1" frame="none" role="struct">
2981 <tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
2982 <tbody>
2983
2984 <row>
2985 <entry>#GdkVisual *visual;</entry>
2986 <entry>the visual used by all previews.</entry>
2987 </row>
2988
2989 <row>
2990 <entry>#GdkColormap *cmap;</entry>
2991 <entry>the colormap used by all previews.</entry>
2992 </row>
2993
2994 <row>
2995 <entry>gdouble gamma;</entry>
2996 <entry>the gamma correction value used by all previews (See gtk_preview_set_gamma()).</entry>
2997 </row>
2998
2999 </tbody>
3000 </tgroup>
3001 </informaltable>
3002
3003 </para>
3004
3005 @lookup:
3006 @gamma:
3007
3008 <!-- ##### ENUM GtkPreviewType ##### -->
3009 <para>
3010 An enumeration which describes whether a preview
3011 contains grayscale or red-green-blue data.
3012 </para>
3013
3014 @GTK_PREVIEW_COLOR: the preview contains red-green-blue data.
3015 @GTK_PREVIEW_GRAYSCALE: The preview contains grayscale data.
3016
3017 <!-- ##### USER_FUNCTION GtkPrintFunc ##### -->
3018 <para>
3019
3020 </para>
3021
3022 @func_data:
3023 @str:
3024
3025 <!-- ##### ARG GtkPrintOperation:number-of-pages ##### -->
3026 <para>
3027
3028 </para>
3029
3030
3031 <!-- ##### ENUM GtkPrivateFlags ##### -->
3032 <para>
3033
3034 </para>
3035
3036 @PRIVATE_GTK_USER_STYLE:
3037 @PRIVATE_GTK_RESIZE_PENDING:
3038 @PRIVATE_GTK_RESIZE_NEEDED:
3039 @PRIVATE_GTK_LEAVE_PENDING:
3040 @PRIVATE_GTK_HAS_SHAPE_MASK:
3041 @PRIVATE_GTK_IN_REPARENT:
3042 @PRIVATE_GTK_DIRECTION_SET:
3043 @PRIVATE_GTK_DIRECTION_LTR:
3044
3045 <!-- ##### ARG GtkProgressBar:activity-blocks ##### -->
3046 <para>
3047
3048 </para>
3049
3050
3051 <!-- ##### ARG GtkProgressBar:activity-step ##### -->
3052 <para>
3053
3054 </para>
3055
3056
3057 <!-- ##### ARG GtkProgressBar:adjustment ##### -->
3058 <para>
3059
3060 </para>
3061
3062
3063 <!-- ##### ARG GtkProgressBar:bar-style ##### -->
3064 <para>
3065
3066 </para>
3067
3068
3069 <!-- ##### ARG GtkProgressBar:discrete-blocks ##### -->
3070 <para>
3071
3072 </para>
3073
3074
3075 <!-- ##### STRUCT GtkRcStyleClass ##### -->
3076 <para>
3077
3078 </para>
3079
3080
3081 <!-- ##### ARG GtkScaleButton:orientation ##### -->
3082 <para>
3083
3084 </para>
3085
3086
3087 <!-- ##### ARG GtkScrolledWindow:shadow ##### -->
3088 <para>
3089
3090 </para>
3091
3092
3093 <!-- ##### ARG GtkSettings:gtk-menu-bar-popout-delay ##### -->
3094 <para>
3095
3096 </para>
3097
3098
3099 <!-- ##### ARG GtkSettings:gtk-menu-popout-delay ##### -->
3100 <para>
3101
3102 </para>
3103
3104
3105 <!-- ##### ARG GtkSettings:gtk-menu-submenu-hysteresis ##### -->
3106 <para>
3107
3108 </para>
3109
3110
3111 <!-- ##### STRUCT GtkSettingsClass ##### -->
3112 <para>
3113
3114 </para>
3115
3116
3117 <!-- ##### ENUM GtkSideType ##### -->
3118 <para>
3119
3120 </para>
3121
3122 @GTK_SIDE_TOP:
3123 @GTK_SIDE_BOTTOM:
3124 @GTK_SIDE_LEFT:
3125 @GTK_SIDE_RIGHT:
3126
3127 <!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
3128 <para>
3129 A function which you can use to clean up when the
3130 signal handler is destroyed.
3131 </para>
3132 <para>
3133 For example, if your handler requires a few variables
3134 that you made into a struct and allocated (using g_new()
3135 or something), then you will probably want to free
3136 it as soon as the hook is destroyed.  This will
3137 allow you to do that. (For this in particular
3138 it is convenient to pass g_free() as a #GtkSignalDestroy
3139 function).
3140 </para>
3141
3142 @data: The user data associated with the hook that is being
3143 destroyed.
3144
3145 <!-- ##### USER_FUNCTION GtkSignalFunc ##### -->
3146 <para>
3147 Defines a function pointer.
3148 </para>
3149
3150
3151 <!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
3152 <para>
3153 This is currently a hack left in for a scheme wrapper library.
3154 It may be removed.
3155 </para>
3156 <para>
3157 Don't use it.
3158 </para>
3159
3160 @object: The object which emits the signal.
3161 @data: The user data associated with the hook.
3162 @nparams: The number of parameters to the function.
3163 @args: The actual values of the arguments.
3164 @arg_types: The types of the arguments.
3165 @return_type: The type of the return value from the function
3166 or #GTK_TYPE_NONE for no return value.
3167
3168 <!-- ##### TYPEDEF GtkSignalMarshaller ##### -->
3169 <para>
3170 Defines a function pointer.
3171 </para>
3172
3173
3174 <!-- ##### STRUCT GtkSignalQuery ##### -->
3175 <para>
3176 This structure contains all the information about a particular
3177 signal:  its name, the type it affects, the signature of the handlers,
3178 and its unique identifying integer.
3179 </para>
3180
3181 @object_type:
3182 @signal_id:
3183 @signal_name:
3184 @is_user_signal:
3185 @signal_flags:
3186 @return_val:
3187 @nparams:
3188 @params:
3189
3190 <!-- ##### STRUCT GtkStatusbarMsg ##### -->
3191 <para>
3192 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.
3193 </para>
3194
3195 @text:
3196 @context_id:
3197 @message_id:
3198
3199 <!-- ##### STRUCT GtkStyleClass ##### -->
3200 <para>
3201
3202 </para>
3203
3204 @parent_class:
3205 @realize:
3206 @unrealize:
3207 @copy:
3208 @clone:
3209 @init_from_rc:
3210 @set_background:
3211 @render_icon:
3212 @draw_hline:
3213 @draw_vline:
3214 @draw_shadow:
3215 @draw_polygon:
3216 @draw_arrow:
3217 @draw_diamond:
3218 @draw_string:
3219 @draw_box:
3220 @draw_flat_box:
3221 @draw_check:
3222 @draw_option:
3223 @draw_tab:
3224 @draw_shadow_gap:
3225 @draw_box_gap:
3226 @draw_extension:
3227 @draw_focus:
3228 @draw_slider:
3229 @draw_handle:
3230 @draw_expander:
3231 @draw_layout:
3232 @draw_resize_grip:
3233 @_gtk_reserved1:
3234 @_gtk_reserved2:
3235 @_gtk_reserved3:
3236 @_gtk_reserved4:
3237 @_gtk_reserved5:
3238 @_gtk_reserved6:
3239 @_gtk_reserved7:
3240 @_gtk_reserved8:
3241 @_gtk_reserved9:
3242 @_gtk_reserved10:
3243 @_gtk_reserved11:
3244 @_gtk_reserved12:
3245
3246 <!-- ##### STRUCT GtkTableChild ##### -->
3247 <para>
3248 The <structfield>widget</structfield> field is a pointer to the widget that
3249 this %GtkTableChild structure is keeping track of.
3250 The <structfield>left_attach</structfield>,
3251 <structfield>right_attach</structfield>,
3252 <structfield>top_attach</structfield>, and
3253 <structfield>bottom_attach</structfield> fields specify the row and column
3254 numbers which make up the invisible rectangle that the child widget is packed into.
3255 </para>
3256 <para>
3257 <structfield>xpadding</structfield> and <structfield>ypadding</structfield>
3258 specify the space between this widget and the surrounding table cells.
3259 </para>
3260
3261 @widget:
3262 @left_attach:
3263 @right_attach:
3264 @top_attach:
3265 @bottom_attach:
3266 @xpadding:
3267 @ypadding:
3268 @xexpand:
3269 @yexpand:
3270 @xshrink:
3271 @yshrink:
3272 @xfill:
3273 @yfill:
3274
3275 <!-- ##### STRUCT GtkTableRowCol ##### -->
3276 <para>
3277 These fields should be considered read-only and not be modified directly.
3278 </para>
3279
3280 @requisition:
3281 @allocation:
3282 @spacing:
3283 @need_expand:
3284 @need_shrink:
3285 @expand:
3286 @shrink:
3287 @empty:
3288
3289 <!-- ##### STRUCT GtkTextBTreeNode ##### -->
3290 <para>
3291
3292 </para>
3293
3294
3295 <!-- ##### STRUCT GtkTextChildAnchorClass ##### -->
3296 <para>
3297
3298 </para>
3299
3300
3301 <!-- ##### ARG GtkTextTag:justify ##### -->
3302 <para>
3303 A #GtkJustification for the text. This is only used when the tag is
3304 applied to the first character in a paragraph.
3305 </para>
3306
3307
3308 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
3309 <para>
3310 Pixel width of the left margin of the text for lines after the first
3311 line in a wrapped paragraph.
3312 </para>
3313
3314
3315 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
3316 <para>
3317
3318 </para>
3319
3320
3321 <!-- ##### ARG GtkTextTag:offset ##### -->
3322 <para>
3323 Pixels to offset the text horizontally or vertically, useful to
3324 produce superscript and subscript.
3325 </para>
3326
3327
3328 <!-- ##### SIGNAL GtkTextView::move-focus ##### -->
3329 <para>
3330
3331 </para>
3332
3333 @textview: the object which received the signal.
3334 @arg1:
3335
3336 <!-- ##### ARG GtkTextView:height-lines ##### -->
3337 <para>
3338
3339 </para>
3340
3341
3342 <!-- ##### ARG GtkTextView:justify ##### -->
3343 <para>
3344
3345 </para>
3346
3347
3348 <!-- ##### ARG GtkTextView:width-columns ##### -->
3349 <para>
3350
3351 </para>
3352
3353
3354 <!-- ##### STRUCT GtkTipsQuery ##### -->
3355 <para>
3356 The #GtkTipsQuery-struct struct contains private data only, and
3357 should be accessed using the functions below.
3358 </para>
3359
3360
3361 <!-- ##### SIGNAL GtkTipsQuery::start-query ##### -->
3362 <para>
3363 Emitted when the query is started.
3364 </para>
3365
3366 @tipsquery: the object which received the signal.
3367
3368 <!-- ##### SIGNAL GtkTipsQuery::stop-query ##### -->
3369 <para>
3370 Emitted when the query is stopped.
3371 </para>
3372
3373 @tipsquery: the object which received the signal.
3374
3375 <!-- ##### SIGNAL GtkTipsQuery::widget-entered ##### -->
3376 <para>
3377 Emitted when a widget is entered by the pointer while the query is in effect.
3378 </para>
3379
3380 @tipsquery: the object which received the signal.
3381 @widget: the widget that was entered by the pointer.
3382 @tip_text: the widget's tooltip.
3383 @tip_private: the widget's private tooltip (see gtk_tooltips_set_tip()).
3384
3385 <!-- ##### SIGNAL GtkTipsQuery::widget-selected ##### -->
3386 <para>
3387 Emitted when a widget is selected during a query.
3388 </para>
3389
3390 @tipsquery: the object which received the signal.
3391 @widget: the widget that was selected.
3392 @tip_text: the widget's tooltip.
3393 @tip_private: the widget's private tooltip (see gtk_tooltips_set_tip()).
3394 @event: the button press or button release event.
3395 @Returns: %TRUE if the query should be stopped.
3396
3397 <!-- ##### ARG GtkTipsQuery:caller ##### -->
3398 <para>
3399 The widget that starts the tips query, usually a button.
3400 If it is selected while the query is in effect the query is automatically
3401 stopped.
3402 </para>
3403
3404
3405 <!-- ##### ARG GtkTipsQuery:emit-always ##### -->
3406 <para>
3407 %TRUE if the widget-entered and widget-selected signals are emitted even when
3408 the widget has no tooltip set.
3409 </para>
3410
3411
3412 <!-- ##### ARG GtkTipsQuery:label-inactive ##### -->
3413 <para>
3414 The text to display in the #GtkTipsQuery widget when the query is not in
3415 effect.
3416 </para>
3417
3418
3419 <!-- ##### ARG GtkTipsQuery:label-no-tip ##### -->
3420 <para>
3421 The text to display in the #GtkTipsQuery widget when the query is running
3422 and the widget that the pointer is over has no tooltip.
3423 </para>
3424
3425
3426 <!-- ##### ARG GtkToolButton:show-label-horizontally ##### -->
3427 <para>
3428
3429 </para>
3430
3431
3432 <!-- ##### SIGNAL GtkToolItem::set-tooltip ##### -->
3433 <para>
3434
3435 </para>
3436
3437 @toolitem: the object which received the signal.
3438 @arg1:
3439 @arg2:
3440 @arg3:
3441 @Returns:
3442
3443 <!-- ##### SIGNAL GtkToolbar::move-focus ##### -->
3444 <para>
3445
3446 </para>
3447
3448 @toolbar: the object which received the signal.
3449 @arg1:
3450 @Returns:
3451
3452 <!-- ##### ARG GtkToolbar:orientation ##### -->
3453 <para>
3454
3455 </para>
3456
3457
3458 <!-- ##### ARG GtkToolbar:pack-end ##### -->
3459 <para>
3460
3461 </para>
3462
3463
3464 <!-- ##### ARG GtkToolbar:tooltips ##### -->
3465 <para>
3466
3467 </para>
3468
3469
3470 <!-- ##### USER_FUNCTION GtkTranslateFunc ##### -->
3471 <para>
3472 The function used to translate messages in e.g. #GtkIconFactory
3473 and #GtkActionGroup.
3474 </para>
3475
3476 @path: The id of the message. In #GtkItemFactory this will be a path
3477   from a #GtkItemFactoryEntry, in #GtkActionGroup, it will be a label
3478   or tooltip from a #GtkActionEntry.
3479 @func_data: user data passed in when registering the function
3480 @Returns: the translated message
3481
3482 <!-- ##### STRUCT GtkTreeSelectionClass ##### -->
3483 <para>
3484
3485 </para>
3486
3487
3488 <!-- ##### ENUM GtkTreeSelectionMode ##### -->
3489 <para>
3490
3491 </para>
3492
3493 @GTK_TREE_SELECTION_SINGLE:
3494 @GTK_TREE_SELECTION_MULTI:
3495
3496 <!-- ##### SIGNAL GtkTreeView::focus-column-header ##### -->
3497 <para>
3498
3499 </para>
3500
3501 @treeview: the object which received the signal.
3502
3503 <!-- ##### USER_FUNCTION GtkTreeViewDraggableFunc ##### -->
3504 <para>
3505
3506 </para>
3507
3508 @tree_view:
3509 @context:
3510 @path:
3511 @user_data:
3512 @Returns:
3513
3514 <!-- ##### USER_FUNCTION GtkTreeViewDroppableFunc ##### -->
3515 <para>
3516
3517 </para>
3518
3519 @tree_view:
3520 @context:
3521 @path:
3522 @pos:
3523 @user_data:
3524 @Returns:
3525
3526 <!-- ##### TYPEDEF GtkType ##### -->
3527 <para>
3528 #GtkType is unique integer identifying the type.  The guts of the
3529 information about the type is held in a private struct named
3530 #GtkTypeNode.
3531 </para>
3532
3533
3534 <!-- ##### TYPEDEF GtkTypeClass ##### -->
3535 <para>
3536 The base structure for a GTK+ type. Every type inherits this as a base structure.
3537 </para>
3538
3539
3540 <!-- ##### STRUCT GtkTypeInfo ##### -->
3541 <para>
3542 Holds information about the type.  gtk_type_name() returns the name.
3543 @object_size is somehow set to the number of bytes that an instance of
3544 the object will occupy.  @class_init_func holds the type's
3545 initialization function.  @object_init_func holds the initialization
3546 function for an instance of the object.  @reserved_1 is used for
3547 #GtkEnumValue to hold the enumerated values.
3548 </para>
3549
3550 @type_name:
3551 @object_size:
3552 @class_size:
3553 @class_init_func:
3554 @object_init_func:
3555 @reserved_1:
3556 @reserved_2:
3557 @base_class_init_func:
3558
3559 <!-- ##### TYPEDEF GtkTypeObject ##### -->
3560 <para>
3561 A #GtkTypeObject defines the minimum structure requirements
3562 for type instances. Type instances returned from gtk_type_new ()
3563 and initialized through a #GtkObjectInitFunc need to directly inherit
3564 from this structure or at least copy its fields one by one.
3565 </para>
3566
3567
3568 <!-- ##### SIGNAL GtkUIManager::changed ##### -->
3569 <para>
3570
3571 </para>
3572
3573 @uimanager: the object which received the signal.
3574
3575 <!-- ##### ARG GtkVScale:adjustment ##### -->
3576 <para>
3577 the #GtkAdjustment which sets the range of the scale.
3578 </para>
3579
3580
3581 <!-- ##### ARG GtkVScrollbar:adjustment ##### -->
3582 <para>
3583
3584 </para>
3585
3586
3587 <!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
3588 <para>
3589
3590 </para>
3591
3592 @widget: the object which received the signal.
3593 @arg1:
3594 @Returns:
3595
3596 <!-- ##### SIGNAL GtkWidget::add-accelerator ##### -->
3597 <para>
3598
3599 </para>
3600
3601 @widget: the object which received the signal.
3602 @accel_signal_id:
3603 @accel_group:
3604 @accel_key:
3605 @accel_mods:
3606 @accel_flags:
3607
3608 <!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
3609 <para>
3610
3611 </para>
3612
3613 @widget: the object which received the signal.
3614 @message:
3615
3616 <!-- ##### SIGNAL GtkWidget::draw ##### -->
3617 <para>
3618
3619 </para>
3620
3621 @widget: the object which received the signal.
3622 @area:
3623
3624 <!-- ##### SIGNAL GtkWidget::draw-default ##### -->
3625 <para>
3626
3627 </para>
3628
3629 @widget: the object which received the signal.
3630
3631 <!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
3632 <para>
3633
3634 </para>
3635
3636 @widget: the object which received the signal.
3637
3638 <!-- ##### SIGNAL GtkWidget::remove-accelerator ##### -->
3639 <para>
3640
3641 </para>
3642
3643 @widget: the object which received the signal.
3644 @accel_group:
3645 @accel_key:
3646 @accel_mods:
3647
3648 <!-- ##### ARG GtkWidget:height ##### -->
3649 <para>
3650
3651 </para>
3652
3653
3654 <!-- ##### ARG GtkWidget:width ##### -->
3655 <para>
3656
3657 </para>
3658
3659
3660 <!-- ##### ARG GtkWidget:x ##### -->
3661 <para>
3662
3663 </para>
3664
3665
3666 <!-- ##### ARG GtkWidget:y ##### -->
3667 <para>
3668
3669 </para>
3670
3671
3672 <!-- ##### SIGNAL GtkWindow::accels-changed ##### -->
3673 <para>
3674
3675 </para>
3676
3677 @window: the object which received the signal.
3678
3679 <!-- ##### SIGNAL GtkWindow::move-focus ##### -->
3680 <para>
3681
3682 </para>
3683
3684 @window: the object which received the signal.
3685 @arg1:
3686
3687 <!-- ##### ARG GtkWindow:auto-shrink ##### -->
3688 <para>
3689 If the window shrinks automatically when widgets within it shrink.
3690 </para>
3691
3692
3693 <!-- ##### ARG GtkWindow:icon-list ##### -->
3694 <para>
3695
3696 </para>
3697
3698
3699 <!-- ##### FUNCTION gtk_accel_group_add ##### -->
3700 <para>
3701
3702 </para>
3703
3704 @accel_group:
3705 @path:
3706 @accel_key:
3707 @accel_mods:
3708 @accel_flags:
3709 @object:
3710 @accel_signal:
3711
3712 <!-- ##### FUNCTION gtk_accel_group_attach ##### -->
3713 <para>
3714
3715 </para>
3716
3717 @accel_group:
3718 @object:
3719
3720 <!-- ##### FUNCTION gtk_accel_group_create_add ##### -->
3721 <para>
3722
3723 </para>
3724
3725 @class_type:
3726 @signal_flags:
3727 @handler_offset:
3728 @Returns:
3729
3730 <!-- ##### FUNCTION gtk_accel_group_create_remove ##### -->
3731 <para>
3732
3733 </para>
3734
3735 @class_type:
3736 @signal_flags:
3737 @handler_offset:
3738 @Returns:
3739
3740 <!-- ##### FUNCTION gtk_accel_group_detach ##### -->
3741 <para>
3742
3743 </para>
3744
3745 @accel_group:
3746 @object:
3747
3748 <!-- ##### FUNCTION gtk_accel_group_entries_from_object ##### -->
3749 <para>
3750
3751 </para>
3752
3753 @object:
3754 @Returns:
3755
3756 <!-- ##### FUNCTION gtk_accel_group_get_default ##### -->
3757 <para>
3758
3759 </para>
3760
3761 @Returns:
3762
3763 <!-- ##### FUNCTION gtk_accel_group_get_entry ##### -->
3764 <para>
3765
3766 </para>
3767
3768 @accel_group:
3769 @accel_key:
3770 @accel_mods:
3771 @Returns:
3772
3773 <!-- ##### FUNCTION gtk_accel_group_get_type ##### -->
3774 <para>
3775
3776 </para>
3777
3778 @Returns:
3779
3780 <!-- ##### FUNCTION gtk_accel_group_handle_add ##### -->
3781 <para>
3782
3783 </para>
3784
3785 @object:
3786 @accel_signal_id:
3787 @accel_group:
3788 @accel_key:
3789 @accel_mods:
3790 @accel_flags:
3791
3792 <!-- ##### FUNCTION gtk_accel_group_handle_remove ##### -->
3793 <para>
3794
3795 </para>
3796
3797 @object:
3798 @accel_group:
3799 @accel_key:
3800 @accel_mods:
3801
3802 <!-- ##### FUNCTION gtk_accel_group_lock_entry ##### -->
3803 <para>
3804
3805 </para>
3806
3807 @accel_group:
3808 @accel_key:
3809 @accel_mods:
3810
3811 <!-- ##### FUNCTION gtk_accel_group_remove ##### -->
3812 <para>
3813
3814 </para>
3815
3816 @accel_group:
3817 @accel_key:
3818 @accel_mods:
3819 @object:
3820
3821 <!-- ##### FUNCTION gtk_accel_group_unlock_entry ##### -->
3822 <para>
3823
3824 </para>
3825
3826 @accel_group:
3827 @accel_key:
3828 @accel_mods:
3829
3830 <!-- ##### FUNCTION gtk_accel_label_get_accel_object ##### -->
3831 <para>
3832
3833 </para>
3834
3835 @accel_label:
3836 @Returns:
3837
3838 <!-- ##### FUNCTION gtk_accel_label_set_accel_object ##### -->
3839 <para>
3840
3841 </para>
3842
3843 @accel_label:
3844 @accel_object:
3845
3846 <!-- ##### FUNCTION gtk_accel_map_add_notifer ##### -->
3847 <para>
3848
3849 </para>
3850
3851 @accel_path:
3852 @notify_data:
3853 @notify_func:
3854 @accel_group:
3855
3856 <!-- ##### FUNCTION gtk_accel_map_remove_notifer ##### -->
3857 <para>
3858
3859 </para>
3860
3861 @accel_path:
3862 @notify_data:
3863 @notify_func:
3864
3865 <!-- ##### FUNCTION gtk_arg_copy ##### -->
3866 <para>
3867 It will either copy data into an existing argument or allocate a new argument
3868 and copy the data.  Strings are duplicated.  All other pointers and
3869 values are copied (shallowly-- that is the pointers themselves are
3870 copied, not the data they point to.)
3871 </para>
3872 <para>
3873 You should call gtk_arg_reset() on dest_arg before calling this
3874 if the argument may contain string data that you want freed.
3875 </para>
3876
3877 @src_arg: the argument to duplicate.
3878 @dest_arg: the argument to copy over (or NULL to create a new #GtkArg).
3879 @Returns: the new #GtkArg (or dest_arg, if it was not NULL).
3880
3881 <!-- ##### FUNCTION gtk_arg_free ##### -->
3882 <para>
3883 Frees the argument, and optionally its contents.
3884 </para>
3885
3886 @arg: the argument to free.
3887 @free_contents: whether to free the string, if it is a string.
3888
3889 <!-- ##### FUNCTION gtk_arg_get_info ##### -->
3890 <para>
3891 Private: get information about an argument.
3892 </para>
3893
3894 @object_type: the type of object.
3895 @arg_info_hash_table: the hashtable of #GtkArgInfos.
3896 @arg_name: the name of the argument to lookup.
3897 @info_p: the argument info.
3898 @Returns: an error message on failure, or NULL otherwise.
3899
3900 <!-- ##### FUNCTION gtk_arg_info_equal ##### -->
3901 <para>
3902 A #GCompareFunc for hashing #GtkArgInfos.
3903 </para>
3904
3905 @arg_info_1: a #GtkArgInfo.
3906 @arg_info_2: a #GtkArgInfo.
3907 @Returns: whether the arguments are the same.
3908
3909 <!-- ##### FUNCTION gtk_arg_info_hash ##### -->
3910 <para>
3911 A #GHashFunc for hashing #GtkArgInfos.
3912 </para>
3913
3914 @arg_info: a #GtkArgInfo.
3915 @Returns: a hash value for that #GtkArgInfo.
3916
3917 <!-- ##### FUNCTION gtk_arg_name_strip_type ##### -->
3918 <para>
3919 Given a fully qualified argument name (e.g. "GtkButton::label")
3920 it returns just the argument name (e.g. "label") unless
3921 the argument name was invalid, in which case it returns NULL.
3922 </para>
3923
3924 @arg_name: the fully-qualified argument name.
3925 @Returns: the base argument name.
3926
3927 <!-- ##### FUNCTION gtk_arg_new ##### -->
3928 <para>
3929 Creates a new argument of a certain type, set to 0 or NULL.
3930 </para>
3931
3932 @arg_type: the type of the argument.
3933 @Returns: the newly created #GtkArg.
3934
3935 <!-- ##### FUNCTION gtk_arg_reset ##### -->
3936 <para>
3937
3938 </para>
3939
3940 @arg:
3941
3942 <!-- ##### FUNCTION gtk_arg_to_valueloc ##### -->
3943 <para>
3944
3945 </para>
3946
3947 @arg:
3948 @value_pointer:
3949
3950 <!-- ##### FUNCTION gtk_arg_type_new_static ##### -->
3951 <para>
3952 Create a new argument registered with a class.
3953 </para>
3954
3955 @base_class_type: the basic type having the arguments, almost alway
3956 GTK_TYPE_OBJECT, except if your defining a different type argument
3957 that gets a different namespace.  #GtkContainer does this to define
3958 per-child arguments of the container.
3959 @arg_name: name of the argument to create.  (must be a static constant string)
3960 @class_n_args_offset: offset into the base class structure that tells
3961 the number of arguments.
3962 @arg_info_hash_table: hashtable of #GtkArgInfos.
3963 @arg_type: type of the argument.
3964 @arg_flags: flags of the argument.
3965 @arg_id: ???
3966 @Returns: the new #GtkArgInfo.
3967
3968 <!-- ##### FUNCTION gtk_arg_values_equal ##### -->
3969 <para>
3970
3971 </para>
3972
3973 @arg1:
3974 @arg2:
3975 @Returns:
3976
3977 <!-- ##### FUNCTION gtk_args_collect ##### -->
3978 <para>
3979 Private:  given a hashtable of argument information it takes a vararg
3980 list and parses it into arguments (in the form of lists of #GtkArgs
3981 and lists of #GtkArgInfos.
3982 </para>
3983 <para>
3984 The list of arguments starts with first_arg_name then the first argument's
3985 value.  Followed by any number of additional name/argument pairs,
3986 terminated with NULL.
3987 </para>
3988
3989 @object_type: the type of object we are collecting arguments for.
3990 @arg_info_hash_table: a hashtable mapping from names of arguments
3991 to their #GtkArgInfos.
3992 @arg_list_p: a returned list of arguments obtained from parsing the
3993 varargs.
3994 @info_list_p: a returned list of the #GtkArgInfos.
3995 @first_arg_name: the name of the first argument.
3996 @var_args: a va_list containing the value of the first argument,
3997 followed by name/value pairs, followed by NULL.
3998 @Returns: an error message on failure, or NULL otherwise.
3999
4000 <!-- ##### FUNCTION gtk_args_collect_cleanup ##### -->
4001 <para>
4002 Private: erase lists of arguments returned from gtk_args_collect().
4003 </para>
4004
4005 @arg_list: arg_list_p returned from gtk_args_collect().
4006 @info_list: info_list_p returned from gtk_args_collect().
4007
4008 <!-- ##### FUNCTION gtk_args_query ##### -->
4009 <para>
4010 Private: from a class type and its arginfo hashtable,
4011 get an array of #GtkArgs that this object accepts.
4012 </para>
4013
4014 @class_type: the class type.
4015 @arg_info_hash_table: the hashtable of #GtkArgInfos.
4016 @arg_flags: returned array of argument flags.
4017 @n_args_p: the number of arguments this object accepts.
4018 @Returns: the array of arguments (or NULL on error).
4019
4020 <!-- ##### MACRO gtk_binding_entry_add ##### -->
4021 <para>
4022
4023 </para>
4024
4025
4026 <!-- ##### FUNCTION gtk_binding_entry_clear ##### -->
4027 <para>
4028
4029 </para>
4030
4031 @binding_set:
4032 @keyval:
4033 @modifiers:
4034
4035 <!-- ##### FUNCTION gtk_binding_parse_binding ##### -->
4036 <para>
4037
4038 </para>
4039
4040 @scanner:
4041 @Returns:
4042
4043 <!-- ##### FUNCTION gtk_button_box_child_requisition ##### -->
4044 <para>\r
4045 This is an internally used function and should never be called from an\r
4046 application.\r
4047 </para>
4048
4049 @widget:
4050 @nvis_children:
4051 @width:
4052 @height:
4053
4054 <!-- ##### FUNCTION gtk_button_box_get_child_ipadding_default ##### -->
4055 <para>\r
4056 The internal padding of a button is the amount of space between the outside\r
4057 of the button and the widget it contains. This function gets the default\r
4058 amount of horizontal and vertical padding, placing the results in @ipad_x\r
4059 and @ipad_y, respectively.\r
4060 </para>
4061
4062 @ipad_x: the default horizontal internal button padding.
4063 @ipad_y: the default vertical internal button padding.
4064
4065 <!-- ##### FUNCTION gtk_button_box_get_child_size_default ##### -->
4066 <para>\r
4067 Retrieves the default minimum width and height for all button boxes, and\r
4068 places the values in @min_width and @min_height, respectively.\r
4069 </para>
4070
4071 @min_width: the default minimum width of a child widget.
4072 @min_height: the default minimum height of a child widget.
4073
4074 <!-- ##### FUNCTION gtk_button_box_set_child_ipadding_default ##### -->
4075 <para>\r
4076 Sets the default number of pixels that pad each button in every button box.\r
4077 </para>
4078
4079 @ipad_x: new default horizontal padding.
4080 @ipad_y: new default vertical padding.
4081
4082 <!-- ##### FUNCTION gtk_button_box_set_child_size_default ##### -->
4083 <para>\r
4084 Sets the default size of child buttons.\r
4085 </para>
4086
4087 @min_width: minimum default width for child buttons.
4088 @min_height: minimum default height for child buttons.
4089
4090 <!-- ##### FUNCTION gtk_button_new_accel ##### -->
4091 <para>
4092
4093 </para>
4094
4095 @uline_label:
4096 @accel_group:
4097 @Returns:
4098
4099 <!-- ##### FUNCTION gtk_button_new_stock ##### -->
4100 <para>
4101
4102 </para>
4103
4104 @stock_id:
4105 @accel_group:
4106 @Returns:
4107
4108 <!-- ##### FUNCTION gtk_calendar_display_options ##### -->
4109 <para>
4110 </para>
4111
4112 @calendar:
4113 @flags:
4114
4115 <!-- ##### FUNCTION gtk_calendar_freeze ##### -->
4116 <para>
4117 </para>
4118
4119 @calendar:
4120
4121 <!-- ##### FUNCTION gtk_calendar_thaw ##### -->
4122 <para>
4123 </para>
4124
4125 @calendar:
4126
4127 <!-- ##### FUNCTION gtk_cell_renderer_event ##### -->
4128 <para>
4129
4130 </para>
4131
4132 @cell:
4133 @event:
4134 @widget:
4135 @path:
4136 @background_area:
4137 @cell_area:
4138 @flags:
4139 @Returns:
4140
4141 <!-- ##### FUNCTION gtk_cell_renderer_text_pixbuf_new ##### -->
4142 <para>
4143
4144 </para>
4145
4146 @Returns:
4147
4148 <!-- ##### FUNCTION gtk_cell_view_get_cell_renderers ##### -->
4149 <para>
4150
4151 </para>
4152
4153 @cell_view:
4154 @Returns:
4155
4156 <!-- ##### FUNCTION gtk_cell_view_get_use_fg ##### -->
4157 <para>
4158
4159 </para>
4160
4161 @cell_view:
4162 @Returns:
4163
4164 <!-- ##### FUNCTION gtk_cell_view_set_cell_data ##### -->
4165 <para>
4166
4167 </para>
4168
4169 @cell_view:
4170 @cellview:
4171
4172 <!-- ##### FUNCTION gtk_cell_view_set_use_fg ##### -->
4173 <para>
4174
4175 </para>
4176
4177 @cell_view:
4178 @use_fg:
4179
4180 <!-- ##### FUNCTION gtk_clist_append ##### -->
4181 <para>
4182 Adds a row to the CList at the bottom.
4183 </para>
4184
4185 @clist: The #GtkCList to affect.
4186 @text: An array of strings to add.
4187 @Returns: The number of the row added.
4188
4189 <!-- ##### FUNCTION gtk_clist_clear ##### -->
4190 <para>
4191 Removes all the CList's rows.
4192 </para>
4193
4194 @clist: The #GtkCList to affect.
4195
4196 <!-- ##### FUNCTION gtk_clist_column_title_active ##### -->
4197 <para>
4198 Sets the specified column in the #GtkCList to become selectable.  You can
4199 then respond to events from the user clicking on a title button, and take
4200 appropriate action.
4201 </para>
4202
4203 @clist: The #GtkCList to affect.
4204 @column: The column to make active, counting from 0.
4205
4206 <!-- ##### FUNCTION gtk_clist_column_title_passive ##### -->
4207 <para>
4208 Causes the specified column title button to become passive, i.e., does
4209 not respond to events, such as the user clicking on it.
4210 </para>
4211
4212 @clist: The #GtkCList to affect.
4213 @column: The column to make passive, counting from 0.
4214
4215 <!-- ##### FUNCTION gtk_clist_column_titles_active ##### -->
4216 <para>
4217 Causes all column title buttons to become active.  This is the same
4218 as calling gtk_clist_column_title_active() for each column.
4219 </para>
4220
4221 @clist: The #GtkCList to affect.
4222
4223 <!-- ##### FUNCTION gtk_clist_column_titles_hide ##### -->
4224 <para>
4225 Causes the #GtkCList to hide its column titles, if they are currently
4226 showing.
4227 </para>
4228
4229 @clist: The #GtkCList to affect.
4230
4231 <!-- ##### FUNCTION gtk_clist_column_titles_passive ##### -->
4232 <para>
4233 Causes all column title buttons to become passive.  This is the same
4234 as calling gtk_clist_column_title_passive() for each column.
4235 </para>
4236
4237 @clist: The #GtkCList to affect.
4238
4239 <!-- ##### FUNCTION gtk_clist_column_titles_show ##### -->
4240 <para>
4241 This function causes the #GtkCList to show its column titles, if
4242 they are not already showing.
4243 </para>
4244
4245 @clist: The #GtkCList to affect.
4246
4247 <!-- ##### FUNCTION gtk_clist_columns_autosize ##### -->
4248 <para>
4249 Auto-sizes all columns in the CList and returns the total width of the CList.
4250 </para>
4251
4252 @clist: The #GtkCList to affect.
4253 @Returns: The total width of the CList.
4254
4255 <!-- ##### FUNCTION gtk_clist_construct ##### -->
4256 <para>
4257 Initializes a previously allocated #GtkCList widget for use.  This should not
4258 normally be used to create a #GtkCList widget.  Use gtk_clist_new() instead.
4259 </para>
4260
4261 @clist: A pointer to an uninitialized #GtkCList widget.
4262 @columns: The number of columns the #GtkCList should have.
4263 @titles: An array of strings that should be used as the titles i
4264 of the columns.  There should be enough strings in the array for
4265 the number of columns specified.
4266
4267 <!-- ##### FUNCTION gtk_clist_find_row_from_data ##### -->
4268 <para>
4269 Searches the CList for the row with the specified data.
4270 </para>
4271
4272 @clist: The #GtkCList to search.
4273 @data: The data to search for a match.
4274 @Returns: The number of the matching row, or -1 if no match could be found.
4275
4276 <!-- ##### FUNCTION gtk_clist_freeze ##### -->
4277 <para>
4278 Causes the #GtkCList to stop updating its visuals until a matching call to
4279 gtk_clist_thaw() is made.  This function is useful if a lot of changes
4280 will be made to the widget that may cause a lot of visual updating to
4281 occur.  Note that calls to gtk_clist_freeze() can be nested.
4282 </para>
4283
4284 @clist: The #GtkCList to freeze.
4285
4286 <!-- ##### FUNCTION gtk_clist_get_cell_style ##### -->
4287 <para>
4288 Gets the current style of the specified cell.
4289 </para>
4290
4291 @clist: The #GtkCList to affect.
4292 @row: The row of the cell.
4293 @column: The column of the cell.
4294 @Returns: A #GtkStyle object.
4295
4296 <!-- ##### FUNCTION gtk_clist_get_cell_type ##### -->
4297 <para>
4298 Checks the type of cell at the location specified.
4299 </para>
4300
4301 @clist: The #GtkCList to affect.
4302 @row: The row of the cell.
4303 @column: The column of the cell.
4304 @Returns: A #GtkCellType value describing the cell.
4305
4306 <!-- ##### FUNCTION gtk_clist_get_column_title ##### -->
4307 <para>
4308 Gets the current title of the specified column
4309 </para>
4310
4311 @clist: The #GtkCList to affect.
4312 @column: The column to query.
4313 @Returns: The title of the column.
4314
4315 <!-- ##### FUNCTION gtk_clist_get_column_widget ##### -->
4316 <para>
4317 Gets the widget in the column header for the specified column.
4318 </para>
4319
4320 @clist: The #GtkCList to affect.
4321 @column: The column to query.
4322 @Returns: Pointer to a #GtkWidget for the column header.
4323
4324 <!-- ##### FUNCTION gtk_clist_get_hadjustment ##### -->
4325 <para>
4326 Gets the #GtkAdjustment currently being used for the horizontal
4327 aspect.
4328 </para>
4329
4330 @clist: The #GtkCList to check.
4331 @Returns: A #GtkAdjustment object, or NULL if none is currently
4332 being used.
4333
4334 <!-- ##### FUNCTION gtk_clist_get_pixmap ##### -->
4335 <para>
4336 Gets the pixmap and bitmap mask of the specified cell.  The returned mask value can be NULL.
4337 </para>
4338
4339 @clist: The #GtkCList to affect.
4340 @row: The row of the cell.
4341 @column: The column of the cell.
4342 @pixmap: A pointer to a pointer to store the cell's #GdkPixmap.
4343 @mask: A pointer to a pointer to store the cell's #GdkBitmap mask.
4344 @Returns: 1 if the cell's pixmap could be retrieved, 0 otherwise.
4345
4346 <!-- ##### FUNCTION gtk_clist_get_pixtext ##### -->
4347 <para>
4348 Gets the text, pixmap and bitmap mask for the specified cell.
4349 </para>
4350
4351 @clist: The #GtkCList to affect.
4352 @row: The row to query.
4353 @column: The column to query.
4354 @text: A pointer to a pointer to store the text.
4355 @spacing: A pointer to a #guint8 to store the spacing.
4356 @pixmap: A pointer to a #GdkPixmap pointer to store the cell's pixmap.
4357 @mask: A pointer to a #GdkBitmap pointer to store the cell's bitmap mask.
4358 @Returns: 1 if the retrieval was successful, 0 otherwise.
4359
4360 <!-- ##### FUNCTION gtk_clist_get_row_data ##### -->
4361 <para>
4362 Gets the currently set data for the specified row.
4363 </para>
4364
4365 @clist: The #GtkCList to affect.
4366 @row: The row to query.
4367 @Returns: The data set for the row.
4368
4369 <!-- ##### FUNCTION gtk_clist_get_row_style ##### -->
4370 <para>
4371 Gets the style set for the specified row.
4372 </para>
4373
4374 @clist: The #GtkCList to affect.
4375 @row: The row to query.
4376 @Returns: The #GtkStyle of the row.
4377
4378 <!-- ##### FUNCTION gtk_clist_get_selectable ##### -->
4379 <para>
4380 Gets whether the specified row is selectable or not.
4381 </para>
4382
4383 @clist: The #GtkCList to affect.
4384 @row: The row to query.
4385 @Returns: A #gboolean value.
4386
4387 <!-- ##### FUNCTION gtk_clist_get_selection_info ##### -->
4388 <para>
4389 Gets the row and column at the specified pixel position in the CList.
4390 </para>
4391
4392 @clist: The #GtkCList to affect.
4393 @x: The horizontal pixel position to check.
4394 @y: The vertical pixel position to check..
4395 @row: Pointer to a #gint to store the row value.
4396 @column: Pointer to a #gint to store the column value.
4397 @Returns: 1 if row/column is returned and in range, 0 otherwise.
4398
4399 <!-- ##### FUNCTION gtk_clist_get_text ##### -->
4400 <para>
4401 Gets the text for the specified cell.
4402 </para>
4403
4404 @clist: The #GtkCList to affect.
4405 @row: The row to query.
4406 @column: The column to query.
4407 @text: A pointer to a pointer to store the text.
4408 @Returns: 1 if the cell's text could be retrieved, 0 otherwise.
4409
4410 <!-- ##### FUNCTION gtk_clist_get_vadjustment ##### -->
4411 <para>
4412 Gets the #GtkAdjustment currently being used for the vertical
4413 aspect.
4414 </para>
4415
4416 @clist: The #GtkCList to check.
4417 @Returns: A #GtkAdjustment object, or NULL if none is currently
4418 being used.
4419
4420 <!-- ##### FUNCTION gtk_clist_insert ##### -->
4421 <para>
4422 Adds a row of text to the CList at the specified position.
4423 </para>
4424
4425 @clist: The #GtkCList to affect.
4426 @row: The row where the text should be inserted.
4427 @text: An array of string to add.
4428 @Returns: The number of the row added.
4429
4430 <!-- ##### FUNCTION gtk_clist_moveto ##### -->
4431 <para>
4432 Tells the CList widget to visually move to the specified
4433 row and column.
4434 </para>
4435
4436 @clist: The #GtkCList to affect.
4437 @row: The row to which to move.
4438 @column: The column to which to move.
4439 @row_align: A value between 0 and 1 that describes the positioning of
4440 the row in relation to the viewable area of the CList's contents.
4441 @col_align: A value between 0 and 1 that describes the positioning of
4442 the column in relation to the viewable area of the CList's contents.
4443
4444 <!-- ##### FUNCTION gtk_clist_new ##### -->
4445 <para>
4446 Creates a new #GtkCList widget for use.
4447 </para>
4448
4449 @columns: The number of columns the #GtkCList should have.
4450 @Returns: A pointer to a new GtkCList object.
4451
4452 <!-- ##### FUNCTION gtk_clist_new_with_titles ##### -->
4453 <para>
4454 Creates a new #GtkCList widget with column titles for use.
4455 </para>
4456
4457 @columns: The number of columns the #GtkCList should have.
4458 @titles: A string array of titles for the widget.  There should be
4459 enough strings in the array for the specified number of columns.
4460 @Returns: A pointer to a new GtkCList object.
4461
4462 <!-- ##### FUNCTION gtk_clist_optimal_column_width ##### -->
4463 <para>
4464 Gets the required width in pixels that is needed to show
4465 everything in the specified column.
4466 </para>
4467
4468 @clist: The #GtkCList to check.
4469 @column: The column to check.
4470 @Returns: The required width in pixels for the column.
4471
4472 <!-- ##### FUNCTION gtk_clist_prepend ##### -->
4473 <para>
4474 Adds a row to the CList at the top.
4475 </para>
4476
4477 @clist: The #GtkCList to affect.
4478 @text: An array of strings to add.
4479 @Returns: The number of the row added.
4480
4481 <!-- ##### FUNCTION gtk_clist_remove ##### -->
4482 <para>
4483 Removes the specified row from the CList.
4484 </para>
4485
4486 @clist: The #GtkCList to affect.
4487 @row: The row to remove.
4488
4489 <!-- ##### FUNCTION gtk_clist_row_is_visible ##### -->
4490 <para>
4491 Checks how the specified row is visible.
4492 </para>
4493
4494 @clist: The #GtkCList to affect.
4495 @row: The row to query.
4496 @Returns: A #GtkVisibility value that tells you how the row is visible.
4497
4498 <!-- ##### FUNCTION gtk_clist_row_move ##### -->
4499 <para>
4500 Allows you to move a row from one position to another in the
4501 list.
4502 </para>
4503
4504 @clist: The #GtkCList to affect.
4505 @source_row: The original position of the row to move.
4506 @dest_row: The position to which the row should be moved.
4507
4508 <!-- ##### FUNCTION gtk_clist_select_all ##### -->
4509 <para>
4510 Selects all rows in the CList.  This function has no affect for a
4511 CList in "single" or "browse" selection mode.
4512 </para>
4513
4514 @clist: The #GtkCList to affect.
4515
4516 <!-- ##### FUNCTION gtk_clist_select_row ##### -->
4517 <para>
4518 Selects the specified row.  Causes the "select-row" signal to be emitted for the specified row and column.
4519 </para>
4520
4521 @clist: The #GtkCList to affect.
4522 @row: The row to select.
4523 @column: The column to select.
4524
4525 <!-- ##### FUNCTION gtk_clist_set_auto_sort ##### -->
4526 <para>
4527 Turns on or off auto sort of the #GtkCList. If auto sort is on, then the CList will be resorted when a row is inserted into the CList.
4528 </para>
4529
4530 @clist: The #GtkCList to affect.
4531 @auto_sort: whether auto sort should be on or off
4532
4533 <!-- ##### FUNCTION gtk_clist_set_background ##### -->
4534 <para>
4535 Sets the background color for the specified row.
4536 </para>
4537
4538 @clist: The #GtkCList to affect.
4539 @row: The row to affect.
4540 @color: A pointer to a #GdkColor structure.
4541
4542 <!-- ##### FUNCTION gtk_clist_set_button_actions ##### -->
4543 <para>
4544 Sets the action(s) that the specified mouse button will have
4545 on the CList.
4546 </para>
4547
4548 @clist: The #GtkCList to affect.
4549 @button: The mouse button to set. The values here, unlike in the
4550          rest of GTK+ start from 0. For instance, the right mouse
4551          button, which is 3 elsewhere, should be given as 2 here.
4552 @button_actions: A logically OR'd value of #GtkButtonAction values
4553 for the button.
4554
4555 <!-- ##### FUNCTION gtk_clist_set_cell_style ##### -->
4556 <para>
4557 Sets the style for the specified cell.
4558 </para>
4559
4560 @clist: The #GtkCList to affect.
4561 @row: The row of the cell.
4562 @column: The column of the cell.
4563 @style: A pointer to a #GtkStyle structure.
4564
4565 <!-- ##### FUNCTION gtk_clist_set_column_auto_resize ##### -->
4566 <para>
4567 Lets you specify whether a column should be automatically resized
4568 by the widget when data is added or removed.  Enabling auto-resize
4569 on a column explicity disallows user-resizing of the column.
4570 </para>
4571
4572 @clist: The #GtkCList to affect.
4573 @column: The column on which to set auto-resizing.
4574 @auto_resize: %TRUE or %FALSE.
4575
4576 <!-- ##### FUNCTION gtk_clist_set_column_justification ##### -->
4577 <para>
4578 Sets the justification to be used for all text in the specified
4579 column.
4580 </para>
4581
4582 @clist: The #GtkCList to affect.
4583 @column: The column which should be affected.
4584 @justification: A GtkJustification value for the column.
4585
4586 <!-- ##### FUNCTION gtk_clist_set_column_max_width ##### -->
4587 <para>
4588 Causes the column specified to have a maximum width, preventing
4589 the user from resizing it larger than that specified.
4590 </para>
4591
4592 @clist: The #GtkCList to affect.
4593 @column: The column to set the maximum width.
4594 @max_width: The width, in pixels.
4595
4596 <!-- ##### FUNCTION gtk_clist_set_column_min_width ##### -->
4597 <para>
4598 Causes the column specified to have a minimum width, preventing
4599 the user from resizing it smaller than that specified.
4600 </para>
4601
4602 @clist: The #GtkCList to affect.
4603 @column: The column to set the minimum width.
4604 @min_width: The width, in pixels.
4605
4606 <!-- ##### FUNCTION gtk_clist_set_column_resizeable ##### -->
4607 <para>
4608 Lets you specify whether a specified column should be resizeable
4609 by the user.  Note that turning on resizeability for the column will
4610 automatically shut off auto-resizing, but turning off resizeability
4611 will NOT turn on auto-resizing.  This must be done manually via a
4612 call to gtk_clist_set_column_auto_resize().
4613 </para>
4614
4615 @clist: The #GtkCList to affect.
4616 @column: The column on which to set resizeability.
4617 @resizeable: %TRUE or %FALSE.
4618
4619 <!-- ##### FUNCTION gtk_clist_set_column_title ##### -->
4620 <para>
4621 Sets the title for the specified column.
4622 </para>
4623
4624 @clist: The #GtkCList to affect.
4625 @column: The column whose title should be changed.
4626 @title: A string to be the column's title.
4627
4628 <!-- ##### FUNCTION gtk_clist_set_column_visibility ##### -->
4629 <para>
4630 Allows you to set whether a specified column in the #GtkCList should
4631 be hidden or shown.  Note that at least one column must always be
4632 showing, so attempting to hide the last visible column will be
4633 ignored.
4634 </para>
4635
4636 @clist: The #GtkCList to affect.
4637 @column: The column to set visibility.
4638 @visible: %TRUE or %FALSE.
4639
4640 <!-- ##### FUNCTION gtk_clist_set_column_widget ##### -->
4641 <para>
4642 Sets a widget to be used as the specified column's title.  This
4643 can be used to place a pixmap or something else as the column
4644 title, instead of the standard text.
4645 </para>
4646
4647 @clist: The #GtkCList to affect.
4648 @column: The column whose title should be a widget.
4649 @widget: A pointer to a previously create widget.
4650
4651 <!-- ##### FUNCTION gtk_clist_set_column_width ##### -->
4652 <para>
4653 Causes the column specified for the #GtkCList to be set to
4654 a specified width.
4655 </para>
4656
4657 @clist: The #GtkCList to affect.
4658 @column: The column to set the width.
4659 @width: The width, in pixels.
4660
4661 <!-- ##### FUNCTION gtk_clist_set_compare_func ##### -->
4662 <para>
4663 Sets the compare function of the #GtkClist to @cmp_func. If @cmp_func is NULL,
4664 then the default compare function is used. The default compare function sorts
4665 ascending or with the type set by gtk_clist_set_sort_type() by the column set
4666 by gtk_clist_set_sort_column().
4667 </para>
4668
4669 @clist: The #GtkCList to affect.
4670 @cmp_func: The #GtkCompareFunction to use.
4671
4672 <!-- ##### FUNCTION gtk_clist_set_foreground ##### -->
4673 <para>
4674 Sets the foreground color for the specified row.
4675 </para>
4676
4677 @clist: The #GtkCList to affect.
4678 @row: The row to affect.
4679 @color: A pointer to a #GdkColor structure.
4680
4681 <!-- ##### FUNCTION gtk_clist_set_hadjustment ##### -->
4682 <para>
4683 Allows you to set the #GtkAdjustment to be used for the horizontal
4684 aspect of the #GtkCList widget.
4685 </para>
4686
4687 @clist: The #GtkCList to affect.
4688 @adjustment: A pointer to a #GtkAdjustment widget, or NULL.
4689
4690 <!-- ##### FUNCTION gtk_clist_set_pixmap ##### -->
4691 <para>
4692 Sets a pixmap for the specified cell.
4693 </para>
4694
4695 @clist: The #GtkCList to affect.
4696 @row: The row of the cell.
4697 @column: The column of the cell.
4698 @pixmap: A pointer to a #GdkPixmap to place in the cell.
4699 @mask: A pointer to a #GdkBitmap mask for the cell.
4700
4701 <!-- ##### FUNCTION gtk_clist_set_pixtext ##### -->
4702 <para>
4703 Sets text and a pixmap/bitmap on the specified cell.
4704 </para>
4705
4706 @clist: The #GtkCList to affect.
4707 @row: The row of the cell.
4708 @column: The column of the cell.
4709 @text: The text to set in the cell.
4710 @spacing: The spacing between the cell's text and pixmap.
4711 @pixmap: A pointer to a #GdkPixmap for the cell.
4712 @mask: A pointer to a #GdkBitmap mask for the cell.
4713
4714 <!-- ##### FUNCTION gtk_clist_set_reorderable ##### -->
4715 <para>
4716 Sets whether the CList's rows are re-orderable using drag-and-drop.
4717 </para>
4718
4719 @clist: The #GtkCList to affect.
4720 @reorderable: %TRUE or %FALSE.
4721
4722 <!-- ##### FUNCTION gtk_clist_set_row_data ##### -->
4723 <para>
4724 Sets data for the specified row.  This is the same as calling gtk_clist_set_row_data_full(clist, row, data, NULL).
4725 </para>
4726
4727 @clist: The #GtkCList to affect.
4728 @row: The row to affect.
4729 @data: The data to set for the row.
4730
4731 <!-- ##### FUNCTION gtk_clist_set_row_data_full ##### -->
4732 <para>
4733 Sets the data for specified row, with a callback when the row is destroyed.
4734 </para>
4735
4736 @clist: The #GtkCList to affect.
4737 @row: The row to affect.
4738 @data: The data to set for the row.
4739 @destroy: A #GtkDestroyNotify function to be called when the row is destroyed.
4740
4741 <!-- ##### FUNCTION gtk_clist_set_row_height ##### -->
4742 <para>
4743 Causes the #GtkCList to have a specified height for its
4744 rows.  Setting the row height to 0 allows the #GtkCList to adjust
4745 automatically to data in the row.
4746 </para>
4747
4748 @clist: The #GtkCList to affect.
4749 @height: The height, in pixels.
4750
4751 <!-- ##### FUNCTION gtk_clist_set_row_style ##### -->
4752 <para>
4753 Sets the style for all cells in the specified row.
4754 </para>
4755
4756 @clist: The #GtkCList to affect.
4757 @row: The row to affect.
4758 @style: A pointer to a #GtkStyle to set.
4759
4760 <!-- ##### FUNCTION gtk_clist_set_selectable ##### -->
4761 <para>
4762 Sets whether the specified row is selectable or not.
4763 </para>
4764
4765 @clist: The #GtkCList to affect.
4766 @row: The row to affect.
4767 @selectable: %TRUE or %FALSE.
4768
4769 <!-- ##### FUNCTION gtk_clist_set_selection_mode ##### -->
4770 <para>
4771 Sets the selection mode for the specified CList.  This allows you to
4772 set whether only one or more than one item can be selected at a time
4773 in the widget.  Note that setting the widget's selection mode to one
4774 of GTK_SELECTION_BROWSE or GTK_SELECTION_SINGLE will cause all the
4775 items in the #GtkCList to become deselected.
4776 </para>
4777
4778 @clist: The #GtkCList to affect.
4779 @mode: The GtkSelectionMode type to set for this CList.
4780
4781 <!-- ##### FUNCTION gtk_clist_set_shadow_type ##### -->
4782 <para>
4783 Sets the shadow type for the specified CList.  Changing this value
4784 will cause the #GtkCList to update its visuals.
4785 </para>
4786
4787 @clist: The #GtkCList to affect.
4788 @type: The GtkShadowType desired.
4789
4790 <!-- ##### FUNCTION gtk_clist_set_shift ##### -->
4791 <para>
4792 Sets the vertical and horizontal shift of the specified cell.
4793 </para>
4794
4795 @clist: The #GtkCList to affect.
4796 @row: The row of the cell.
4797 @column: The column of the cell.
4798 @vertical: The value to set for the vertical shift.
4799 @horizontal: The value to set for the vertical shift.
4800
4801 <!-- ##### FUNCTION gtk_clist_set_sort_column ##### -->
4802 <para>
4803 Sets the sort column of the clist. The sort column is used by the
4804 default compare function to determine which column to sort by.
4805 </para>
4806
4807 @clist: The #GtkCList to affect.
4808 @column: The column to sort by
4809
4810 <!-- ##### FUNCTION gtk_clist_set_sort_type ##### -->
4811 <para>
4812 Sets the sort type of the #GtkClist. This is either GTK_SORT_ASCENDING for
4813 ascening sort or GTK_SORT_DESCENDING for descending sort.
4814 </para>
4815
4816 @clist: The #GtkCList to affect.
4817 @sort_type: the #GtkSortType to use
4818
4819 <!-- ##### FUNCTION gtk_clist_set_text ##### -->
4820 <para>
4821 Sets the displayed text in the specified cell.
4822 </para>
4823
4824 @clist: The #GtkCList to affect.
4825 @row: The row of the cell.
4826 @column: The column of the cell.
4827 @text: The text to set in the cell.
4828
4829 <!-- ##### FUNCTION gtk_clist_set_use_drag_icons ##### -->
4830 <para>
4831 Determines whether the #GtkClist should use icons when
4832 doing drag-and-drop operations.
4833 </para>
4834
4835 @clist: The #GtkCList to affect.
4836 @use_icons: %TRUE or %FALSE.
4837
4838 <!-- ##### FUNCTION gtk_clist_set_vadjustment ##### -->
4839 <para>
4840 Allows you to set the #GtkAdjustment to be used for the vertical
4841 aspect of the #GtkCList widget.
4842 </para>
4843
4844 @clist: The #GtkCList to affect.
4845 @adjustment: A pointer to a #GtkAdjustment widget, or NULL.
4846
4847 <!-- ##### FUNCTION gtk_clist_sort ##### -->
4848 <para>
4849 Sorts the #GtkClist according to the current compare function, which
4850 can be set with the gtk_clist_set_compare_func() function.
4851 </para>
4852
4853 @clist: The #GtkCList to sort.
4854
4855 <!-- ##### FUNCTION gtk_clist_swap_rows ##### -->
4856 <para>
4857 Swaps the two specified rows with each other.
4858 </para>
4859
4860 @clist: The #GtkCList to affect.
4861 @row1: Number of the first row.
4862 @row2: Number of the second row.
4863
4864 <!-- ##### FUNCTION gtk_clist_thaw ##### -->
4865 <para>
4866 Causes the specified #GtkCList to allow visual updates.
4867 </para>
4868
4869 @clist: The #GtkCList to thaw.
4870
4871 <!-- ##### FUNCTION gtk_clist_undo_selection ##### -->
4872 <para>
4873 Undoes the last selection for an "extended selection mode" CList.
4874 </para>
4875
4876 @clist: The #GtkCList to affect.
4877
4878 <!-- ##### FUNCTION gtk_clist_unselect_all ##### -->
4879 <para>
4880 Unselects all rows in the CList.
4881 </para>
4882
4883 @clist: The #GtkCList to affect.
4884
4885 <!-- ##### FUNCTION gtk_clist_unselect_row ##### -->
4886 <para>
4887 Unselects the specified row.  Causes the "unselect-row" signal to be emitted for the specified row and column.
4888 </para>
4889
4890 @clist: The #GtkCList to affect.
4891 @row: The row to select.
4892 @column: The column to select.
4893
4894 <!-- ##### FUNCTION gtk_color_selection_get_color ##### -->
4895 <para>
4896
4897 </para>
4898
4899 @colorsel:
4900 @color:
4901
4902 <!-- ##### FUNCTION gtk_color_selection_get_old_color ##### -->
4903 <para>
4904
4905 </para>
4906
4907 @colorsel:
4908 @color:
4909
4910 <!-- ##### FUNCTION gtk_color_selection_get_use_opacity ##### -->
4911 <para>
4912
4913 </para>
4914
4915 @colorsel:
4916 @Returns:
4917
4918 <!-- ##### FUNCTION gtk_color_selection_get_use_palette ##### -->
4919 <para>
4920
4921 </para>
4922
4923 @colorsel:
4924 @Returns:
4925
4926 <!-- ##### FUNCTION gtk_color_selection_set_change_palette_hook ##### -->
4927 <para>
4928
4929 </para>
4930
4931 @func:
4932 @Returns:
4933
4934 <!-- ##### FUNCTION gtk_color_selection_set_color ##### -->
4935 <para>
4936
4937 </para>
4938
4939 @colorsel:
4940 @color:
4941
4942 <!-- ##### FUNCTION gtk_color_selection_set_old_color ##### -->
4943 <para>
4944
4945 </para>
4946
4947 @colorsel:
4948 @color:
4949
4950 <!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
4951 <para>
4952 Controls whether opacity can be set with the #GtkColorSelection.
4953 If this functionality is enabled, the necessary additional widgets
4954 are added to the #GtkColorSelection and the opacity value can be
4955 retrieved via the fourth value in the color array returned by
4956 the gtk_color_selection_get_color() function.
4957 </para>
4958
4959 @colorsel: a #GtkColorSelection.
4960 @use_opacity: a boolean indicating whether the opacity selection
4961 is enabled.
4962
4963 <!-- ##### FUNCTION gtk_color_selection_set_use_opacity ##### -->
4964 <para>
4965
4966 </para>
4967
4968 @colorsel:
4969 @use_opacity:
4970
4971 <!-- ##### FUNCTION gtk_color_selection_set_use_palette ##### -->
4972 <para>
4973
4974 </para>
4975
4976 @colorsel:
4977 @use_palette:
4978
4979 <!-- ##### FUNCTION gtk_combo_box_get_row_separator_column ##### -->
4980 <para>
4981
4982 </para>
4983
4984 @combo_box:
4985 @Returns:
4986
4987 <!-- ##### FUNCTION gtk_combo_box_set_row_separator_column ##### -->
4988 <para>
4989
4990 </para>
4991
4992 @combo_box:
4993 @column:
4994
4995 <!-- ##### FUNCTION gtk_combo_disable_activate ##### -->
4996 <para>
4997 Stops the #GtkCombo widget from showing the popup list when the #GtkEntry
4998 emits the "activate" signal, i.e. when the Return key is pressed.
4999 This may be useful if, for example, you want the Return key to close a dialog
5000 instead.
5001 </para>
5002
5003 @combo: a #GtkCombo.
5004 @Deprecated: 2.4: Use #GtkComboBox instead.
5005
5006 <!-- ##### FUNCTION gtk_combo_new ##### -->
5007 <para>
5008 Creates a new #GtkCombo.
5009 </para>
5010
5011 @Returns: a new #GtkCombo.
5012 @Deprecated: 2.4: Use #GtkComboBox instead.
5013
5014 <!-- ##### FUNCTION gtk_combo_set_case_sensitive ##### -->
5015 <para>
5016 Specifies whether the text entered into the #GtkEntry field and the text in
5017 the list items is case sensitive.
5018 </para>
5019 <para>
5020 This may be useful, for example, when you have called
5021 gtk_combo_set_value_in_list() to limit the values entered, but you are not
5022 worried about differences in case.
5023 </para>
5024
5025 @combo: a #GtkCombo.
5026 @val: %TRUE if the text in the list items is case sensitive.
5027 @Deprecated: 2.4: Use #GtkComboBox instead.
5028
5029 <!-- ##### FUNCTION gtk_combo_set_item_string ##### -->
5030 <para>
5031 Sets the string to place in the #GtkEntry field when a particular list item is
5032 selected. This is needed if the list item is not a simple label.
5033 </para>
5034
5035 @combo: a #GtkCombo.
5036 @item: a #GtkItem.
5037 @item_value: the string to place in the #GtkEntry when @item is selected.
5038 @Deprecated: 2.4: Use #GtkComboBox instead.
5039
5040 <!-- ##### FUNCTION gtk_combo_set_popdown_strings ##### -->
5041 <para>
5042 Convenience function to set all of the items in the popup list.
5043 (See the <link linkend="gtkcombo-simple-example">example</link> above.)
5044 </para>
5045
5046 @combo: a #GtkCombo.
5047 @strings: a list of strings, or %NULL to clear the popup list
5048 @Deprecated: 2.4: Use #GtkComboBox instead.
5049
5050 <!-- ##### FUNCTION gtk_combo_set_use_arrows ##### -->
5051 <para>
5052 Specifies if the arrow (cursor) keys can be used to step through the items in
5053 the list. This is on by default.
5054 </para>
5055
5056 @combo: a #GtkCombo.
5057 @val: %TRUE if the arrow keys can be used to step through the items in
5058      the list.
5059 @Deprecated: 2.4: Use #GtkComboBox instead.
5060
5061 <!-- ##### FUNCTION gtk_combo_set_use_arrows_always ##### -->
5062 <para>
5063 Obsolete function, does nothing.
5064 </para>
5065
5066 @combo: a #GtkCombo.
5067 @val: unused
5068 @Deprecated: 2.4: Use #GtkComboBox instead.
5069
5070 <!-- ##### FUNCTION gtk_combo_set_value_in_list ##### -->
5071 <para>
5072 Specifies whether the value entered in the text entry field must match one of
5073 the values in the list. If this is set then the user will not be able to
5074 perform any other action until a valid value has been entered.
5075 </para>
5076 <para>
5077 If an empty field is acceptable, the @ok_if_empty parameter should be %TRUE.
5078 </para>
5079
5080 @combo: a #GtkCombo.
5081 @val: %TRUE if the value entered must match one of the values in the list.
5082 @ok_if_empty: %TRUE if an empty value is considered valid.
5083 @Deprecated: 2.4: Use #GtkComboBox instead.
5084
5085 <!-- ##### FUNCTION gtk_container_add_child_arg_type ##### -->
5086 <para>
5087
5088 </para>
5089
5090 @arg_name:
5091 @arg_type:
5092 @arg_flags:
5093 @arg_id:
5094
5095 <!-- ##### FUNCTION gtk_container_add_with_args ##### -->
5096 <para>
5097
5098 </para>
5099
5100 @container:
5101 @widget:
5102 @first_arg_name:
5103 @Varargs:
5104
5105 <!-- ##### FUNCTION gtk_container_addv ##### -->
5106 <para>
5107
5108 </para>
5109
5110 @container:
5111 @widget:
5112 @n_args:
5113 @args:
5114
5115 <!-- ##### FUNCTION gtk_container_arg_get ##### -->
5116 <para>
5117
5118 </para>
5119
5120 @container:
5121 @child:
5122 @arg:
5123 @info:
5124
5125 <!-- ##### FUNCTION gtk_container_arg_set ##### -->
5126 <para>
5127
5128 </para>
5129
5130 @container:
5131 @child:
5132 @arg:
5133 @info:
5134
5135 <!-- ##### FUNCTION gtk_container_child_arg_get_info ##### -->
5136 <para>
5137
5138 </para>
5139
5140 @object_type:
5141 @arg_name:
5142 @info_p:
5143 @Returns:
5144
5145 <!-- ##### FUNCTION gtk_container_child_args_collect ##### -->
5146 <para>
5147
5148 </para>
5149
5150 @object_type:
5151 @arg_list_p:
5152 @info_list_p:
5153 @first_arg_name:
5154 @args:
5155 @Returns:
5156
5157 <!-- ##### FUNCTION gtk_container_child_getv ##### -->
5158 <para>
5159
5160 </para>
5161
5162 @container:
5163 @child:
5164 @n_args:
5165 @args:
5166
5167 <!-- ##### FUNCTION gtk_container_child_setv ##### -->
5168 <para>
5169
5170 </para>
5171
5172 @container:
5173 @child:
5174 @n_args:
5175 @args:
5176
5177 <!-- ##### FUNCTION gtk_container_dequeue_resize_handler ##### -->
5178 <para>
5179
5180 </para>
5181
5182 @container:
5183
5184 <!-- ##### FUNCTION gtk_container_focus ##### -->
5185 <para>
5186
5187 </para>
5188
5189 @container:
5190 @direction:
5191 @Returns:
5192
5193 <!-- ##### FUNCTION gtk_container_query_child_args ##### -->
5194 <para>
5195
5196 </para>
5197
5198 @class_type:
5199 @arg_flags:
5200 @nargs:
5201 @Returns:
5202
5203 <!-- ##### FUNCTION gtk_decorated_window_calculate_frame_size ##### -->
5204 <para>
5205
5206 </para>
5207
5208 @window:
5209
5210 <!-- ##### FUNCTION gtk_decorated_window_init ##### -->
5211 <para>
5212
5213 </para>
5214
5215 @window:
5216
5217 <!-- ##### FUNCTION gtk_decorated_window_move_resize_window ##### -->
5218 <para>
5219
5220 </para>
5221
5222 @window:
5223 @x:
5224 @y:
5225 @width:
5226 @height:
5227
5228 <!-- ##### FUNCTION gtk_decorated_window_set_title ##### -->
5229 <para>
5230
5231 </para>
5232
5233 @window:
5234 @title:
5235
5236 <!-- ##### FUNCTION gtk_drag_dest_handle_event ##### -->
5237 <para>
5238 Internal function.
5239 </para>
5240
5241 @toplevel:
5242 @event:
5243
5244 <!-- ##### FUNCTION gtk_drag_set_default_icon ##### -->
5245 <para>
5246
5247 </para>
5248
5249 @colormap:
5250 @pixmap:
5251 @mask:
5252 @hot_x:
5253 @hot_y:
5254
5255 <!-- ##### FUNCTION gtk_drag_source_handle_event ##### -->
5256 <para>
5257 Internal function.
5258 </para>
5259
5260 @widget:
5261 @event:
5262
5263 <!-- ##### FUNCTION gtk_drawing_area_size ##### -->
5264 <para>
5265 Sets the size that the drawing area will request
5266 in response to a "size_request" signal. The
5267 drawing area may actually be allocated a size
5268 larger than this depending on how it is packed
5269 within the enclosing containers.
5270 </para>
5271
5272 @darea: a #GtkDrawingArea
5273 @width: the width to request
5274 @height: the height to request
5275 @Deprecated: Use gtk_widget_set_size_request() instead.
5276
5277 <!-- ##### FUNCTION gtk_editable_changed ##### -->
5278 <para>
5279 Causes the "changed" signal to be emitted.
5280 </para>
5281
5282 @editable: a #GtkEditable widget.
5283
5284 <!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
5285 <para>
5286 Claim or disclaim ownership of the PRIMARY X selection.
5287 </para>
5288
5289 @editable: a #GtkEditable widget.
5290 @claim: if %TRUE, claim the selection, otherwise, disclaim it.
5291 @time: the timestamp for claiming the selection.
5292
5293 <!-- ##### FUNCTION gtk_entry_get_gicon ##### -->
5294 <para>
5295
5296 </para>
5297
5298 @entry:
5299 @icon_pos:
5300 @Returns:
5301
5302 <!-- ##### FUNCTION gtk_entry_get_pixbuf ##### -->
5303 <para>
5304
5305 </para>
5306
5307 @entry:
5308 @icon_pos:
5309 @Returns:
5310
5311 <!-- ##### FUNCTION gtk_entry_get_stock ##### -->
5312 <para>
5313
5314 </para>
5315
5316 @entry:
5317 @icon_pos:
5318 @Returns:
5319
5320 <!-- ##### FUNCTION gtk_entry_get_storage_type ##### -->
5321 <para>
5322
5323 </para>
5324
5325 @entry:
5326 @icon_pos:
5327 @Returns:
5328
5329 <!-- ##### FUNCTION gtk_file_chooser_dialog_new_with_backend ##### -->
5330 <para>
5331
5332 </para>
5333
5334 @title:
5335 @parent:
5336 @action:
5337 @backend:
5338 @first_button_text:
5339 @Varargs:
5340 @Returns:
5341
5342
5343 <!--
5344 Local variables:
5345 mode: sgml
5346 sgml-parent-document: ("../gtk-docs.sgml" "book" "refsect1")
5347 End:
5348 -->
5349
5350 <!-- ##### FUNCTION gtk_file_chooser_error_quark ##### -->
5351 <para>
5352
5353 </para>
5354
5355 @Returns:
5356
5357 <!-- ##### FUNCTION gtk_file_chooser_get_folder_mode ##### -->
5358 <para>
5359
5360 </para>
5361
5362 @chooser:
5363 @Returns:
5364
5365 <!-- ##### FUNCTION gtk_file_chooser_set_folder_mode ##### -->
5366 <para>
5367
5368 </para>
5369
5370 @chooser:
5371 @folder_mode:
5372
5373 <!-- ##### FUNCTION gtk_file_chooser_widget_new_with_backend ##### -->
5374 <para>
5375
5376 </para>
5377
5378 @action:
5379 @backend:
5380 @Returns:
5381
5382 <!-- ##### FUNCTION gtk_file_selection_complete ##### -->
5383 <para>
5384 Will attempt to match @pattern to a valid filenames or subdirectories in the current directory. If a match can be made, the matched filename will appear in the text entry field of the file selection dialog.
5385 If a partial match can be made, the "Files" list will contain those
5386 file names which have been partially matched, and the "Folders"
5387 list those directories which have been partially matched.
5388 </para>
5389
5390 @filesel: a #GtkFileSelection.
5391 @pattern: a string of characters which may or may not match any filenames in the current directory.
5392
5393 <!-- ##### FUNCTION gtk_file_selection_get_filename ##### -->
5394 <para>
5395 </para>
5396
5397 @filesel:
5398 @Returns:
5399
5400 <!-- ##### FUNCTION gtk_file_selection_get_select_multiple ##### -->
5401 <para>
5402
5403 </para>
5404
5405 @filesel:
5406 @Returns:
5407
5408 <!-- ##### FUNCTION gtk_file_selection_get_selections ##### -->
5409 <para>
5410
5411 </para>
5412
5413 @filesel:
5414 @Returns:
5415
5416 <!-- ##### FUNCTION gtk_file_selection_hide_fileop_buttons ##### -->
5417 <para>
5418 Hides the file operation buttons that normally appear at the top of the dialog. Useful if you wish to create a custom file selector, based on #GtkFileSelection.
5419 </para>
5420
5421 @filesel: a #GtkFileSelection.
5422
5423 <!-- ##### FUNCTION gtk_file_selection_new ##### -->
5424 <para>
5425 Creates a new file selection dialog box. By default it will contain a #GtkTreeView of the application's current working directory, and a file listing. Operation buttons that allow the user to create a directory, delete files and rename files, are also present.
5426 </para>
5427
5428 @title: a message that will be placed in the file requestor's titlebar.
5429 @Returns: the new file selection.
5430 @Deprecated: Use gtk_file_chooser_dialog_new() instead
5431
5432 <!-- ##### FUNCTION gtk_file_selection_set_filename ##### -->
5433 <para>
5434 </para>
5435
5436 @filesel:
5437 @filename:
5438
5439 <!-- ##### FUNCTION gtk_file_selection_set_select_multiple ##### -->
5440 <para>
5441
5442 </para>
5443
5444 @filesel:
5445 @select_multiple:
5446
5447 <!-- ##### FUNCTION gtk_file_selection_show_fileop_buttons ##### -->
5448 <para>
5449 Shows the file operation buttons, if they have previously been hidden. The rest of the widgets in the dialog will be resized accordingly.
5450 </para>
5451
5452 @filesel: a #GtkFileSelection.
5453
5454 <!-- ##### FUNCTION gtk_font_selection_dialog_get_apply_button ##### -->
5455 <para>
5456
5457 </para>
5458
5459 @fsd:
5460 @Returns:
5461
5462 <!-- ##### FUNCTION gtk_font_selection_dialog_get_font ##### -->
5463 <para>
5464
5465 </para>
5466
5467 @fsd:
5468 @Returns:
5469
5470 <!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
5471 <para>
5472 Sets one of the two font filters, to limit the fonts shown.
5473 </para>
5474
5475 @fsd: a #GtkFontSelectionDialog.
5476 @filter_type: which of the two font filters to set, either
5477 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
5478 can be changed by the user, but the base filter is permanent.
5479 @font_type: the types of font to be shown. This is a bitwise combination of
5480 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
5481 or #GTK_FONT_ALL to show all three font types.
5482 @foundries: a NULL-terminated array of strings containing foundry names which
5483 will be shown, or NULL to show all foundries.
5484 @weights: a NULL-terminated array of strings containing weight names which
5485 will be shown, or NULL to show all weights.
5486 @slants: a NULL-terminated array of strings containing slant names which
5487 will be shown, or NULL to show all slants.
5488 @setwidths: a NULL-terminated array of strings containing setwidth names which
5489 will be shown, or NULL to show all setwidths.
5490 @spacings: a NULL-terminated array of strings containing spacings which
5491 will be shown, or NULL to show all spacings.
5492 @charsets: a NULL-terminated array of strings containing charset names which
5493 will be shown, or NULL to show all charsets.
5494
5495 <!-- ##### FUNCTION gtk_font_selection_get_face_entry ##### -->
5496 <para>
5497
5498 </para>
5499
5500 @fontsel:
5501 @Returns:
5502
5503 <!-- ##### FUNCTION gtk_font_selection_get_family_entry ##### -->
5504 <para>
5505
5506 </para>
5507
5508 @fontsel:
5509 @Returns:
5510
5511 <!-- ##### FUNCTION gtk_font_selection_get_font ##### -->
5512 <para>
5513
5514 </para>
5515
5516 @fontsel:
5517 @Returns:
5518
5519 <!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
5520 <para>
5521 Sets one of the two font filters, to limit the fonts shown.
5522 </para>
5523
5524 @fontsel: a #GtkFontSelection.
5525 @filter_type: which of the two font filters to set, either
5526 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
5527 can be changed by the user, but the base filter is permanent.
5528 @font_type: the types of font to be shown. This is a bitwise combination of
5529 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
5530 or #GTK_FONT_ALL to show all three font types.
5531 @foundries: a NULL-terminated array of strings containing foundry names which
5532 will be shown, or NULL to show all foundries.
5533 @weights: a NULL-terminated array of strings containing weight names which
5534 will be shown, or NULL to show all weights.
5535 @slants: a NULL-terminated array of strings containing slant names which
5536 will be shown, or NULL to show all slants.
5537 @setwidths: a NULL-terminated array of strings containing setwidth names which
5538 will be shown, or NULL to show all setwidths.
5539 @spacings: a NULL-terminated array of strings containing spacings which
5540 will be shown, or NULL to show all spacings.
5541 @charsets: a NULL-terminated array of strings containing charset names which
5542 will be shown, or NULL to show all charsets.
5543
5544 <!-- ##### FUNCTION gtk_icon_view_get_type ##### -->
5545 <para>
5546
5547 </para>
5548
5549 @Returns:
5550
5551 <!-- ##### FUNCTION gtk_identifier_get_type ##### -->
5552 <para>
5553 Get the type of GtkIdentifier.
5554 </para>
5555
5556 @Returns: GtkType -- the enumerated type of something.
5557
5558 <!-- ##### FUNCTION gtk_image_menu_item_add_image ##### -->
5559 <para>
5560
5561 </para>
5562
5563 @image_menu_item:
5564 @child:
5565
5566 <!-- ##### FUNCTION gtk_image_menu_item_get_type ##### -->
5567 <para>
5568
5569 </para>
5570
5571 @Returns:
5572
5573 <!-- ##### FUNCTION gtk_item_factories_path_delete ##### -->
5574 <para>
5575
5576 </para>
5577
5578 @ifactory_path:
5579 @path:
5580
5581 <!-- ##### FUNCTION gtk_item_factory_add_foreign ##### -->
5582 <para>
5583
5584 </para>
5585
5586 @accel_widget:
5587 @full_path:
5588 @accel_group:
5589 @keyval:
5590 @modifiers:
5591
5592 <!-- ##### FUNCTION gtk_item_factory_construct ##### -->
5593 <para>
5594
5595 </para>
5596
5597 @ifactory:
5598 @container_type:
5599 @path:
5600 @accel_group:
5601
5602 <!-- ##### FUNCTION gtk_item_factory_create_item ##### -->
5603 <para>
5604
5605 </para>
5606
5607 @ifactory:
5608 @entry:
5609 @callback_data:
5610 @callback_type:
5611
5612 <!-- ##### FUNCTION gtk_item_factory_create_items ##### -->
5613 <para>
5614
5615 </para>
5616
5617 @ifactory:
5618 @n_entries:
5619 @entries:
5620 @callback_data:
5621
5622 <!-- ##### FUNCTION gtk_item_factory_create_items_ac ##### -->
5623 <para>
5624
5625 </para>
5626
5627 @ifactory:
5628 @n_entries:
5629 @entries:
5630 @callback_data:
5631 @callback_type:
5632
5633 <!-- ##### FUNCTION gtk_item_factory_create_menu_entries ##### -->
5634 <para>
5635
5636 </para>
5637
5638 @n_entries:
5639 @entries:
5640
5641 <!-- ##### FUNCTION gtk_item_factory_delete_entries ##### -->
5642 <para>
5643
5644 </para>
5645
5646 @ifactory:
5647 @n_entries:
5648 @entries:
5649
5650 <!-- ##### FUNCTION gtk_item_factory_delete_entry ##### -->
5651 <para>
5652
5653 </para>
5654
5655 @ifactory:
5656 @entry:
5657
5658 <!-- ##### FUNCTION gtk_item_factory_delete_item ##### -->
5659 <para>
5660
5661 </para>
5662
5663 @ifactory:
5664 @path:
5665
5666 <!-- ##### FUNCTION gtk_item_factory_dump_items ##### -->
5667 <para>
5668
5669 </para>
5670
5671 @path_pspec:
5672 @modified_only:
5673 @print_func:
5674 @func_data:
5675
5676 <!-- ##### FUNCTION gtk_item_factory_dump_rc ##### -->
5677 <para>
5678
5679 </para>
5680
5681 @file_name:
5682 @path_pspec:
5683 @modified_only:
5684
5685 <!-- ##### FUNCTION gtk_item_factory_from_path ##### -->
5686 <para>
5687
5688 </para>
5689
5690 @path:
5691 @Returns:
5692
5693 <!-- ##### FUNCTION gtk_item_factory_from_widget ##### -->
5694 <para>
5695
5696 </para>
5697
5698 @widget:
5699 @Returns:
5700
5701 <!-- ##### FUNCTION gtk_item_factory_get_item ##### -->
5702 <para>
5703
5704 </para>
5705
5706 @ifactory:
5707 @path:
5708 @Returns:
5709
5710 <!-- ##### FUNCTION gtk_item_factory_get_item_by_action ##### -->
5711 <para>
5712
5713 </para>
5714
5715 @ifactory:
5716 @action:
5717 @Returns:
5718
5719 <!-- ##### FUNCTION gtk_item_factory_get_widget ##### -->
5720 <para>
5721
5722 </para>
5723
5724 @ifactory:
5725 @path:
5726 @Returns:
5727
5728 <!-- ##### FUNCTION gtk_item_factory_get_widget_by_action ##### -->
5729 <para>
5730
5731 </para>
5732
5733 @ifactory:
5734 @action:
5735 @Returns:
5736
5737 <!-- ##### FUNCTION gtk_item_factory_new ##### -->
5738 <para>
5739
5740 </para>
5741
5742 @container_type:
5743 @path:
5744 @accel_group:
5745 @Returns:
5746
5747 <!-- ##### FUNCTION gtk_item_factory_parse_rc ##### -->
5748 <para>
5749
5750 </para>
5751
5752 @file_name:
5753
5754 <!-- ##### FUNCTION gtk_item_factory_parse_rc_scanner ##### -->
5755 <para>
5756
5757 </para>
5758
5759 @scanner:
5760
5761 <!-- ##### FUNCTION gtk_item_factory_parse_rc_string ##### -->
5762 <para>
5763
5764 </para>
5765
5766 @rc_string:
5767
5768 <!-- ##### FUNCTION gtk_item_factory_path_from_widget ##### -->
5769 <para>
5770
5771 </para>
5772
5773 @widget:
5774 @Returns:
5775
5776 <!-- ##### FUNCTION gtk_item_factory_popup ##### -->
5777 <para>
5778
5779 </para>
5780
5781 @ifactory:
5782 @x:
5783 @y:
5784 @mouse_button:
5785 @time_:
5786
5787 <!-- ##### FUNCTION gtk_item_factory_popup_data ##### -->
5788 <para>
5789
5790 </para>
5791
5792 @ifactory:
5793 @Returns:
5794
5795 <!-- ##### FUNCTION gtk_item_factory_popup_data_from_widget ##### -->
5796 <para>
5797
5798 </para>
5799
5800 @widget:
5801 @Returns:
5802
5803 <!-- ##### FUNCTION gtk_item_factory_popup_with_data ##### -->
5804 <para>
5805
5806 </para>
5807
5808 @ifactory:
5809 @popup_data:
5810 @destroy:
5811 @x:
5812 @y:
5813 @mouse_button:
5814 @time_:
5815
5816 <!-- ##### FUNCTION gtk_item_factory_print_func ##### -->
5817 <para>
5818
5819 </para>
5820
5821 @FILE_pointer:
5822 @string:
5823
5824 <!-- ##### FUNCTION gtk_item_factory_set_translate_func ##### -->
5825 <para>
5826
5827 </para>
5828
5829 @ifactory:
5830 @func:
5831 @data:
5832 @notify:
5833
5834 <!-- ##### FUNCTION gtk_label_get ##### -->
5835 <para>
5836 Gets the current string of text within the #GtkLabel and writes it to
5837 the given @str argument.  It does not make a copy of this string so you
5838 must not write to it.
5839 </para>
5840
5841 @label: The #GtkLabel widget you want to get the text from.
5842 @str: The reference to the pointer you want to point to the text.
5843 @Deprecated: Use gtk_label_get_text() instead.
5844
5845 <!-- ##### MACRO gtk_label_set ##### -->
5846 <para>
5847 Sets the text within the GtkLabel widget.
5848 </para>
5849
5850 @Deprecated: Use gtk_label_set_text() instead.
5851
5852 <!-- ##### FUNCTION gtk_label_set_markup_with_accel ##### -->
5853 <para>
5854
5855 </para>
5856
5857 @label:
5858 @str:
5859 @Returns:
5860
5861 <!-- ##### FUNCTION gtk_layout_freeze ##### -->
5862 <para>
5863
5864 </para>
5865
5866 @layout:
5867
5868 <!-- ##### FUNCTION gtk_layout_thaw ##### -->
5869 <para>
5870
5871 </para>
5872
5873 @layout:
5874
5875 <!-- ##### FUNCTION gtk_list_append_items ##### -->
5876 <para>
5877 Adds @items to the end of the @list.
5878 </para>
5879
5880 @list: the list widget.
5881 @items: the items.
5882
5883 <!-- ##### FUNCTION gtk_list_child_position ##### -->
5884 <para>
5885 Searches the children of @list for the index of @child.
5886 </para>
5887
5888 @list: the list widget.
5889 @child: the child to look for.
5890 @Returns: the index of the child, -1 if not found.
5891
5892 <!-- ##### FUNCTION gtk_list_clear_items ##### -->
5893 <para>
5894 Removes the items between index @start (included) and @end (excluded)
5895 from the @list. If @end is negative, or greater than the number of
5896 children of @list, it's assumed to be exactly the number of
5897 elements. If @start is greater than or equal to @end, nothing is
5898 done.
5899 </para>
5900
5901 @list: the list widget.
5902 @start: the index of the first item to remove.
5903 @end: the index of the lest item to remove plus one.
5904
5905 <!-- ##### FUNCTION gtk_list_end_drag_selection ##### -->
5906 <para>
5907 Stops the drag selection mode and ungrabs the pointer. This has no
5908 effect if a drag selection is not active.
5909 </para>
5910
5911 @list: the list widget.
5912
5913 <!-- ##### FUNCTION gtk_list_end_selection ##### -->
5914 <para>
5915 Ends the selection. Used with gtk_list_extend_selection() and
5916 gtk_list_start_selection(). Only in #GTK_SELECTION_EXTENDED mode.
5917 </para>
5918
5919 @list: the list widget.
5920
5921 <!-- ##### FUNCTION gtk_list_extend_selection ##### -->
5922 <para>
5923 Extends the selection by moving the anchor according to @scroll_type. Only
5924 in #GTK_SELECTION_EXTENDED.
5925 </para>
5926
5927 @list: the list widget.
5928 @scroll_type: the direction and length.
5929 @position: the position if @scroll_type is #GTK_SCROLL_JUMP.
5930 @auto_start_selection: if %TRUE, gtk_list_start_selection() is automatically
5931 carried out before extending the selection.
5932
5933 <!-- ##### FUNCTION gtk_list_insert_items ##### -->
5934 <para>
5935 Inserts @items into the @list at the position @position. The #GList items
5936 must not be freed after.
5937 </para>
5938
5939 @list: the list widget.
5940 @items: the items.
5941 @position: the position to insert @items, starting at 0.
5942
5943 <!-- ##### FUNCTION gtk_list_item_deselect ##### -->
5944 <para>
5945 Deselects the item, by emitting the item's "deselect" signal.
5946 </para>
5947
5948 @list_item: a #GtkListItem.
5949
5950 <!-- ##### FUNCTION gtk_list_item_new ##### -->
5951 <para>
5952 Creates a new #GtkListitem.
5953 </para>
5954
5955 @Returns: a new #GtkListItem.
5956
5957 <!-- ##### FUNCTION gtk_list_item_new_with_label ##### -->
5958 <para>
5959 Creates a new #GtkListItem with a child label containing the given string.
5960 </para>
5961
5962 @label: the string to use for the child label.
5963 @Returns: a new #GtkListItem with a child #GtkLabel with the text set to
5964 @label.
5965
5966 <!-- ##### FUNCTION gtk_list_item_select ##### -->
5967 <para>
5968 Selects the item, by emitting the item's "select" signal.
5969 Depending on the selection mode of the list, this may cause other items to
5970 be deselected.
5971 </para>
5972
5973 @list_item: a #GtkListItem.
5974
5975 <!-- ##### FUNCTION gtk_list_new ##### -->
5976 <para>
5977 Creates a new #GtkList.
5978 </para>
5979
5980 @Returns: the newly-created #GtkList
5981
5982 <!-- ##### FUNCTION gtk_list_prepend_items ##### -->
5983 <para>
5984 Inserts @items at the beginning of the @list.
5985 </para>
5986
5987 @list: the list widget.
5988 @items: the items.
5989
5990 <!-- ##### FUNCTION gtk_list_remove_items ##### -->
5991 <para>
5992 Removes the @items from the @list.
5993 </para>
5994
5995 @list: the list widget.
5996 @items: the items to remove.
5997
5998 <!-- ##### FUNCTION gtk_list_remove_items_no_unref ##### -->
5999 <para>
6000 Removes the @items from the @list, without unreferencing them. It
6001 may be useful if you want to move the items from one list to another.
6002 </para>
6003
6004 @list: the list widget.
6005 @items: the items.
6006
6007 <!-- ##### FUNCTION gtk_list_scroll_horizontal ##### -->
6008 <para>
6009 Scrolls @list horizontaly. This supposes that the list is packed into a
6010 scrolled window or something similar, and adjustments are well
6011 set. Step and page increment are those from the horizontal adjustment
6012 of @list. Backward means to the left, and forward to the
6013 right. Out of bounds values are truncated.
6014 @scroll_type may be any valid #GtkScrollType. If @scroll_type is
6015 #GTK_SCROLL_NONE, nothing is done. If it's #GTK_SCROLL_JUMP, the list
6016 scrolls to the ratio @position: 0 is full left, 1 is full right.
6017 </para>
6018
6019 @list: the list widget.
6020 @scroll_type: the scrolling type.
6021 @position: the position if @scroll_type is #GTK_SCROLL_JUMP
6022
6023 <!-- ##### FUNCTION gtk_list_scroll_vertical ##### -->
6024 <para>
6025 Scrolls @list vertically. This supposes that the list is packed into a
6026 scrolled window or something similar, and adjustments are well
6027 set. Step and page increment are those from the vertical adjustment
6028 of @list. Backward means up, and forward down. Out of bounds values are
6029 truncated.
6030 @scroll_type may be any valid #GtkScrollType. If @scroll_type is
6031 #GTK_SCROLL_NONE, nothing is done. If it's #GTK_SCROLL_JUMP, the list
6032 scrolls to the ratio @position: 0 is top, 1 is bottom.
6033 </para>
6034
6035 @list: the list widget.
6036 @scroll_type: the scrolling type.
6037 @position: the position if @scroll_type is #GTK_SCROLL_JUMP
6038
6039 <!-- ##### FUNCTION gtk_list_select_all ##### -->
6040 <para>
6041 Selects all children of @list. A signal will be emitted for each
6042 newly selected child.
6043 </para>
6044
6045 @list: the list widget.
6046
6047 <!-- ##### FUNCTION gtk_list_select_child ##### -->
6048 <para>
6049 Selects the given @child. The signal GtkList::select-child will be
6050 emitted.
6051 </para>
6052
6053 @list: the list widget
6054 @child: the child to select.
6055
6056 <!-- ##### FUNCTION gtk_list_select_item ##### -->
6057 <para>
6058 Selects the child number @item of the @list. Nothing happens if @item
6059 is out of bounds. The signal GtkList::select-child will be emitted.
6060 </para>
6061
6062 @list: the list widget.
6063 @item: the index of the child to select.
6064
6065 <!-- ##### FUNCTION gtk_list_set_selection_mode ##### -->
6066 <para>
6067 Set the list selection mode. The selection mode can be any value in
6068 #GtkSelectionMode:
6069 <variablelist>
6070 <varlistentry>
6071 <term>#GTK_SELECTION_SINGLE</term>
6072 <listitem><para>
6073 Zero or one element may be selected.
6074 </para></listitem>
6075 </varlistentry>
6076
6077 <varlistentry>
6078 <term>#GTK_SELECTION_BROWSE</term>
6079 <listitem><para>
6080 Exactly one element is always selected (this can be false after you have
6081 changed the selection mode).
6082 </para></listitem>
6083 </varlistentry>
6084
6085 <varlistentry>
6086 <term>#GTK_SELECTION_MULTIPLE</term>
6087 <listitem><para>
6088 Any number of elements may be selected. Clicks toggle the state of an
6089 item.
6090 </para></listitem>
6091 </varlistentry>
6092
6093 <varlistentry>
6094 <term>#GTK_SELECTION_EXTENDED</term>
6095 <listitem><para>
6096 Any number of elements may be selected. Click-drag selects a range of
6097 elements; the Ctrl key may be used to enlarge the selection, and
6098 Shift key to select between the focus and the child pointed to.
6099 </para></listitem>
6100 </varlistentry>
6101 </variablelist>
6102 </para>
6103
6104 @list: the list widget.
6105 @mode: the new selection mode.
6106
6107 <!-- ##### FUNCTION gtk_list_start_selection ##### -->
6108 <para>
6109 Starts a selection (or part of selection) at the focused child. Only in
6110 #GTK_SELECTION_EXTENDED mode.
6111 </para>
6112
6113 @list: the list widget.
6114
6115 <!-- ##### FUNCTION gtk_list_store_move ##### -->
6116 <para>
6117
6118 </para>
6119
6120 @store:
6121 @iter:
6122 @position:
6123
6124 <!-- ##### FUNCTION gtk_list_store_new_with_types ##### -->
6125 <para>
6126
6127 </para>
6128
6129 @n_columns:
6130 @Varargs:
6131 @Returns:
6132
6133 <!-- ##### FUNCTION gtk_list_store_set_cell ##### -->
6134 <para>
6135
6136 </para>
6137
6138 @store:
6139 @iter:
6140 @column:
6141 @value:
6142
6143 <!-- ##### FUNCTION gtk_list_store_set_column_type ##### -->
6144 <para>
6145
6146 </para>
6147
6148 @store:
6149 @column:
6150 @type:
6151
6152 <!-- ##### FUNCTION gtk_list_store_set_n_columns ##### -->
6153 <para>
6154
6155 </para>
6156
6157 @store:
6158 @n_columns:
6159
6160 <!-- ##### FUNCTION gtk_list_toggle_add_mode ##### -->
6161 <para>
6162 Toggles between adding to the selection and beginning a new selection. Only
6163 in #GTK_SELECTION_EXTENDED. Useful with gtk_list_extend_selection().
6164 </para>
6165
6166 @list: the list widget.
6167
6168 <!-- ##### FUNCTION gtk_list_toggle_focus_row ##### -->
6169 <para>
6170 Toggles the focus row. If the focus row is selected, it's
6171 unselected. If the focus row is unselected, it's selected. If the
6172 selection mode of @list is #GTK_SELECTION_BROWSE, this has no effect,
6173 as the selection is always at the focus row.
6174 </para>
6175
6176 @list: the list widget.
6177
6178 <!-- ##### FUNCTION gtk_list_toggle_row ##### -->
6179 <para>
6180 Toggles the child @item of list. If the selection mode of @list is
6181 #GTK_SELECTION_BROWSE, the item is selected, and the others are
6182 unselected.
6183 </para>
6184
6185 @list: the list widget.
6186 @item: the child to toggle.
6187
6188 <!-- ##### FUNCTION gtk_list_undo_selection ##### -->
6189 <para>
6190 Restores the selection in the last state, only if selection mode is
6191 #GTK_SELECTION_EXTENDED. If this function is called twice, the selection is
6192 cleared. This function sometimes gives stranges "last states".
6193 </para>
6194
6195 @list: the list widget.
6196
6197 <!-- ##### FUNCTION gtk_list_unselect_all ##### -->
6198 <para>
6199 Unselects all children of @list. A signal will be emitted for each
6200 newly unselected child.
6201 </para>
6202
6203 @list: the list widget.
6204
6205 <!-- ##### FUNCTION gtk_list_unselect_child ##### -->
6206 <para>
6207 Unselects the given @child. The signal GtkList::unselect-child will be
6208 emitted.
6209 </para>
6210
6211 @list: the list widget.
6212 @child: the child to unselect.
6213
6214 <!-- ##### FUNCTION gtk_list_unselect_item ##### -->
6215 <para>
6216 Unselects the child number @item of the @list. Nothing happens if
6217 @item is out of bounds. The signal GtkList::unselect-child will be
6218 emitted.
6219 </para>
6220
6221 @list: the list widget.
6222 @item: the index of the child to unselect.
6223
6224 <!-- ##### MACRO gtk_menu_bar_append ##### -->
6225 <para>
6226 Adds a new #GtkMenuItem to the end of the GtkMenuBar
6227 </para>
6228
6229 @menu: a #GtkMenuBar
6230 @child: the #GtkMenuItem to add
6231 @Deprecated: Use gtk_menu_shell_append() instead.
6232
6233 <!-- ##### MACRO gtk_menu_bar_insert ##### -->
6234 <para>
6235 Adds a new #GtkMenuItem to the GtkMenuBar at the position defined by @position
6236 </para>
6237
6238 @menu: a #GtkMenuBar
6239 @child: the #GtkMenuItem to add
6240 @pos: the position in the item list where the @child is added.
6241 @Deprecated: Use gtk_menu_shell_insert() instead.
6242
6243 <!-- ##### MACRO gtk_menu_bar_prepend ##### -->
6244 <para>
6245 Adds a new #GtkMenuItem to the beginning of the GtkMenuBar
6246 </para>
6247
6248 @menu: a #GtkMenuBar
6249 @child: the #GtkMenuItem to add
6250 @Deprecated: Use gtk_menu_shell_prepend() instead.
6251
6252 <!-- ##### FUNCTION gtk_menu_ensure_uline_accel_group ##### -->
6253 <para>
6254
6255 </para>
6256
6257 @menu:
6258 @Returns:
6259
6260 <!-- ##### FUNCTION gtk_menu_get_uline_accel_group ##### -->
6261 <para>
6262
6263 </para>
6264
6265 @menu:
6266 @Returns:
6267
6268 <!-- ##### FUNCTION gtk_menu_item_configure ##### -->
6269 <para>
6270 Sets whether the menu item should show a submenu indicator, which is a right
6271 arrow.
6272 </para>
6273
6274 @menu_item: the menu item
6275 @show_toggle_indicator: unused
6276 @show_submenu_indicator: whether to show the arrow or not
6277
6278 <!-- ##### FUNCTION gtk_menu_item_remove_submenu ##### -->
6279 <para>
6280
6281 </para>
6282
6283 @menu_item:
6284
6285 <!-- ##### MACRO gtk_menu_item_right_justify ##### -->
6286 <para>
6287 Sets the menu item to be right-justified. Only useful for menu bars.
6288 </para>
6289
6290 @menu_item: the menu item
6291
6292 <!-- ##### FUNCTION gtk_menu_item_set_placement ##### -->
6293 <para>
6294 Specifies the placement of the submenu around the menu item. The placement
6295 is usually #GTK_LEFT_RIGHT for menu items in a popup menu and
6296 #GTK_TOP_BOTTOM in menu bars.
6297 </para>
6298 <para>
6299 This function is useless in usual applications.
6300 </para>
6301
6302 @menu_item: the menu item
6303 @placement: the submenu placement
6304
6305 <!-- ##### FUNCTION gtk_menu_tool_button_set_arrow_tooltip ##### -->
6306 <para>
6307
6308 </para>
6309
6310 @button:
6311 @tooltips:
6312 @tip_text:
6313 @tip_private:
6314
6315 <!-- ##### MACRO gtk_notebook_current_page ##### -->
6316 <para>
6317 Deprecated compatibility macro.
6318 </para>
6319
6320 @Deprecated: Use gtk_notebook_get_current_page() instead.
6321
6322 <!-- ##### FUNCTION gtk_notebook_get_group_id ##### -->
6323 <para>
6324
6325 </para>
6326
6327 @notebook:
6328 @Returns:
6329
6330 <!-- ##### FUNCTION gtk_notebook_set_group_id ##### -->
6331 <para>
6332
6333 </para>
6334
6335 @notebook:
6336 @group_id:
6337
6338 <!-- ##### FUNCTION gtk_notebook_set_homogeneous_tabs ##### -->
6339 <para>
6340 </para>
6341
6342 @notebook:
6343 @homogeneous:
6344
6345 <!-- ##### MACRO gtk_notebook_set_page ##### -->
6346 <para>
6347 Deprecated compatibility macro.
6348 </para>
6349
6350 @Deprecated: Use gtk_notebook_set_current_page() instead.
6351
6352 <!-- ##### FUNCTION gtk_notebook_set_tab_border ##### -->
6353 <para>
6354 </para>
6355
6356 @notebook:
6357 @border_width:
6358
6359 <!-- ##### FUNCTION gtk_notebook_set_tab_hborder ##### -->
6360 <para>
6361 </para>
6362
6363 @notebook:
6364 @tab_hborder:
6365
6366 <!-- ##### FUNCTION gtk_notebook_set_tab_vborder ##### -->
6367 <para>
6368 </para>
6369
6370 @notebook:
6371 @tab_vborder:
6372
6373 <!-- ##### FUNCTION gtk_object_add_arg_type ##### -->
6374 <para>
6375 Deprecated in favor of the #GObject property system including #GParamSpec.
6376 Add a new type of argument to an object class.
6377 Usually this is called when registering a new type of object.
6378 </para>
6379
6380 @arg_name: fully qualify object name, for example GtkObject::user_data.
6381 @arg_type: type of the argument.
6382 @arg_flags: bitwise-OR of the #GtkArgFlags enum.  (Whether the argument is
6383 settable or gettable, whether it is set when the object is constructed.)
6384 @arg_id: an internal number, passed in from here to the "set_arg" and
6385 "get_arg" handlers of the object.
6386
6387 <!-- ##### FUNCTION gtk_object_arg_get ##### -->
6388 <para>
6389 Private function to get an argument and argument info from an object.
6390 </para>
6391
6392 @object: the object whose argument should be retrieved.
6393 @arg: the argument, for the name on input, the rest is filled on output.
6394 @info: a #GtkArgInfo structure to optionally fill in.
6395
6396 <!-- ##### FUNCTION gtk_object_arg_get_info ##### -->
6397 <para>
6398 Query information about an argument type.
6399 </para>
6400
6401 @object_type: type of object to query about.
6402 @arg_name: name of the argument.
6403 @info_p: pointer to be filled in with a pointer to the GtkArgInfo.
6404 @Returns: an error message, or NULL on success.
6405 It is the caller's responsibility to call g_free() in the event of error.
6406
6407 <!-- ##### FUNCTION gtk_object_arg_set ##### -->
6408 <para>
6409 Private function to set an argument and argument info to an object.
6410 </para>
6411
6412 @object: the object whose argument should be set.
6413 @arg: the argument.
6414 @info: infomation about this type of argument in general.
6415
6416 <!-- ##### FUNCTION gtk_object_args_collect ##### -->
6417 <para>
6418 Private: Gets an array of #GtkArgs from a va_list C structure.
6419 </para>
6420
6421 @object_type: the type of object to collect arguments for.
6422 @arg_list_p: pointer to be filled in with a list of parsed arguments.
6423 @info_list_p: optional pointer for a returned list #GtkArgInfos.
6424 @first_arg_name: name of first argument.
6425 @var_args: value of first argument, followed by more key/value pairs,
6426 terminated by NULL.
6427 @Returns: an error message, or NULL on success.
6428 It is the caller's responsibility to call g_free() in the event of error.
6429
6430 <!-- ##### FUNCTION gtk_object_class_add_signals ##### -->
6431 <para>
6432 Add an array of signals to a #GtkObjectClass.
6433 Usually this is called when registering a new type of object.
6434 </para>
6435
6436 @klass: the object class to append signals to.
6437 @signals: the signals to append.
6438 @nsignals: the number of signals being appended.
6439
6440 <!-- ##### FUNCTION gtk_object_class_user_signal_new ##### -->
6441 <para>
6442 Define a signal-handler for a new signal on an already defined
6443 object.
6444 </para>
6445 <para>
6446 See the signal documentation for more general information.
6447 </para>
6448
6449 @klass: the object class to define the signal for.
6450 @name: the name of the signal.
6451 @signal_flags: the default emission behavior for the signal.
6452 See g_signal_new().
6453 @marshaller: a function that will take an array of GtkArgs
6454 and invoke the appropriate handler with the normal calling
6455 conventions.
6456 @return_val: specify the return-value type for the signal
6457 (or GTK_TYPE_NONE for no return-value).
6458 @nparams: specify the number of parameters the signal
6459 receives from the caller of g_signal_emit().
6460 @Varargs: list of nparams #GtkTypes to pass to the signal handlers.
6461 @Returns: the signal id.  (See #GtkSignals)
6462
6463 <!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### -->
6464 <para>
6465 Define a signal-handler for a new signal on an already defined
6466 object.
6467 </para>
6468
6469 @klass: the object class to define the signal for.
6470 @name: the name of the signal.
6471 @signal_flags: the default emission behavior for the signal.
6472 See g_signal_new().
6473 @marshaller: takes a GtkObject, a #GtkSignalFunc, and an array
6474 of arguments, and invokes the function using the appropriate
6475 calling conventions.  Usually just select a function
6476 out of gtkmarshal.h.
6477 @return_val: specify the return-value type for the signal (possibly
6478 #GTK_TYPE_NONE).
6479 @nparams: specify the number of parameters the signal
6480 receives from the caller of g_signal_emit().
6481 @params: array of #GtkTypes the signal handlers for this signal
6482 should have in their prototype (of length nparams).
6483 @Returns: the signal id.  (See #GtkSignals)
6484
6485 <!-- ##### FUNCTION gtk_object_constructed ##### -->
6486 <para>
6487 Mark an allocated object as constructed.
6488 This is used for situations
6489 that require precise control of the construction process.
6490 </para>
6491 <para>
6492 This is done when gtk_object_default_construct() is inadequate.
6493 In #GtkCList the need arises because #GtkCList does construction work that
6494 must happen <emphasis>after</emphasis> its derivers.  This work
6495 cannot be done in an initializer function, so an alternate
6496 constructor is mandatory.  It calls gtk_object_constructed() to
6497 indicate it has done its job, so that no other constructor will
6498 be invoked.
6499 </para>
6500 <para>
6501 Normally this function is just automatically run from
6502 gtk_object_default_construct().
6503 </para>
6504
6505 @object: object which has been constructed.  This is usually
6506 done automatically by gtk_object_new() and gtk_object_newv().
6507
6508 <!-- ##### MACRO gtk_object_data_force_id ##### -->
6509 <para>
6510 Useless deprecated macro. Ignore it.
6511 </para>
6512
6513
6514 <!-- ##### MACRO gtk_object_data_try_key ##### -->
6515 <para>
6516 Useless deprecated macro. Ignore it.
6517 </para>
6518
6519
6520 <!-- ##### FUNCTION gtk_object_default_construct ##### -->
6521 <para>
6522 This function is called to construct arguments that haven't been initialized
6523 but have the #GTK_ARG_CONSTRUCT flag set.
6524 </para>
6525 <para>
6526 All number arguments are set to 0.  All pointers and strings
6527 are set to NULL.
6528 </para>
6529 <para>
6530 Normally invoked by gtk_object_new() automatically; gtk_type_new() can
6531 be used to bypass it.
6532 </para>
6533
6534 @object: the object to initialize.
6535
6536 <!-- ##### FUNCTION gtk_object_get ##### -->
6537 <para>
6538 Gets properties of an object.
6539 </para>
6540
6541 @object: a #GtkObject.
6542 @first_property_name: name of first property to get the value for.
6543 @Varargs: %NULL-terminated list of name-return location pairs.
6544 @Deprecated: Use g_object_get() instead.
6545
6546 <!-- ##### FUNCTION gtk_object_get_data ##### -->
6547 <para>
6548 Get a named field from the object's table of associations (the object_data).
6549 </para>
6550
6551 @object: the object maintaining the associations.
6552 @key: name of the key for that association.
6553 @Returns: the data if found, or %NULL if no such data exists.
6554 @Deprecated: Use g_object_get_data() instead.
6555
6556 <!-- ##### FUNCTION gtk_object_get_data_by_id ##### -->
6557 <para>
6558 Just like gtk_object_get_data() except that it takes
6559 a #GQuark instead of a string, so it is slightly faster.
6560 </para>
6561 <para>
6562 Use gtk_object_data_try_key() and gtk_object_data_force_id()
6563 to get an id from a string.
6564 </para>
6565
6566 @object: object containing the associations.
6567 @data_id: quark of the key.
6568 @Returns: the data if found, or %NULL if no such data exists.
6569 @Deprecated: Use g_object_get_qdata() instead.
6570
6571 <!-- ##### FUNCTION gtk_object_get_user_data ##### -->
6572 <para>
6573 Get the object's user data pointer.
6574 </para>
6575 <para>
6576 This is intended to be a pointer for your convenience in
6577 writing applications.
6578 </para>
6579
6580 @object: the object.
6581 @Returns: the user data field for object.
6582 @Deprecated: Use g_object_get_data() instead.
6583
6584 <!-- ##### FUNCTION gtk_object_getv ##### -->
6585 <para>
6586 Gets an array of argument values from an object.
6587 </para>
6588
6589 @object: the object to get arguments from.
6590 @n_args: the number of arguments to query.
6591 @args: the arguments to fill in.
6592
6593 <!-- ##### FUNCTION gtk_object_new ##### -->
6594 <para>
6595 Constructs an object given its arguments, enumerated in the call to the
6596 function.
6597 </para>
6598
6599 @type: the type identifying this object.  Returned by gtk_type_unique()
6600 (although for a properly-written object it should be accessible through
6601 a #GTK_TYPE_FOO macro.)
6602 @first_property_name: name of the first property to set when constructing
6603    the object.
6604 @Varargs: the first argument's value, followed by any number of
6605 name/argument-value pairs, terminated with %NULL.
6606 @Returns: the new #GtkObject.
6607 @Deprecated: Use g_object_new() instead.
6608
6609 <!-- ##### FUNCTION gtk_object_newv ##### -->
6610 <para>
6611 Construct an object with an array of arguments.
6612 </para>
6613
6614 @object_type: the type of the object to create.
6615 @n_args: the number of arguments to set.
6616 @args: an array of n_args arguments (which are name and value pairs).
6617 @Returns: the new GtkObject.
6618
6619 <!-- ##### FUNCTION gtk_object_query_args ##### -->
6620 <para>
6621 Get all the arguments that may be used for a given type.
6622 </para>
6623 <para>
6624 In Java, this type of mechanism is called
6625 <wordasword>introspection</wordasword>.  It is used by applications
6626 like Glade, that have to determine what can be done to an object
6627 at run-time.
6628 </para>
6629
6630 @class_type: the GtkType of the ObjectClass
6631 (returned from GTK_OBJECT_CLASS(class)-&gt;type for example).
6632 @arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to
6633 each argument.  You must g_free() this if you request it.
6634 @n_args: the number of arguments is returned in this field.
6635 @Returns: an array of arguments, that you must deallocate with g_free().
6636
6637 <!-- ##### FUNCTION gtk_object_ref ##### -->
6638 <para>
6639 Increases the reference count of the object.
6640 </para>
6641
6642 @object: the object to reference.
6643 @Returns: @object.
6644 @Deprecated: Use g_object_ref() instead.
6645
6646 <!-- ##### FUNCTION gtk_object_remove_data ##### -->
6647 <para>
6648 Removes a specified datum from the object's data associations (the object_data).
6649 Subsequent calls to gtk_object_get_data() will return %NULL.
6650 </para>
6651 <para>
6652 If you specified a destroy handler with gtk_object_set_data_full(),
6653 it will be invoked.
6654 </para>
6655
6656 @object: the object maintaining the association.
6657 @key: name of the key for that association.
6658 @Deprecated: Use g_object_set_data() to set the object data to %NULL instead.
6659
6660 <!-- ##### FUNCTION gtk_object_remove_data_by_id ##### -->
6661 <para>
6662 Just like gtk_object_remove_data() except that it takes
6663 a #GQuark instead of a string, so it is slightly faster.
6664 </para>
6665 <para>
6666 Remove a specified datum from the object's data associations.
6667 Subsequent calls to gtk_object_get_data() will return %NULL.
6668 </para>
6669 <para>
6670 Use gtk_object_data_try_key() and gtk_object_data_force_id()
6671 to get an id from a string.
6672 </para>
6673
6674 @object: object containing the associations.
6675 @data_id: quark of the key.
6676 @Deprecated: Use g_object_set_qdata() with data of %NULL instead.
6677
6678 <!-- ##### FUNCTION gtk_object_remove_no_notify ##### -->
6679 <para>
6680 Remove a specified datum from the object's data associations (the object_data),
6681 without invoking the association's destroy handler.
6682 </para>
6683 <para>
6684 Just like gtk_object_remove_data() except that any destroy handler
6685 will be ignored.
6686 Therefore this only affects data set using gtk_object_set_data_full().
6687 </para>
6688
6689 @object: the object maintaining the association.
6690 @key: name of the key for that association.
6691 @Deprecated: Use g_object_steal_data() instead.
6692
6693 <!-- ##### FUNCTION gtk_object_remove_no_notify_by_id ##### -->
6694 <para>
6695 Just like gtk_object_remove_no_notify() except that it takes
6696 a #GQuark instead of a string, so it is slightly faster.
6697 </para>
6698 <para>
6699 Use gtk_object_data_try_key() and gtk_object_data_force_id()
6700 to get an id from a string.
6701 </para>
6702
6703 @object: object containing the associations.
6704 @key_id: quark of the key.
6705 @Deprecated: Use g_object_steal_qdata() instead.
6706
6707 <!-- ##### FUNCTION gtk_object_set ##### -->
6708 <para>
6709 Sets properties on an object.
6710 </para>
6711 <para>
6712 <informalexample>
6713 <programlisting>
6714 void set_box_properties (GtkBox* box)
6715 {
6716   gtk_object_set (GTK_OBJECT (box), "homogeneous", TRUE,
6717                                     "spacing", 8,
6718                                     NULL);
6719 }
6720 </programlisting>
6721 </informalexample>
6722 </para>
6723
6724 @object: a #GtkObject.
6725 @first_property_name: name of the first property to set
6726 @Varargs: the value of the first argument, followed optionally
6727 by more name/value pairs, followed by %NULL.
6728 @Deprecated: Use g_object_set() instead.
6729
6730 <!-- ##### FUNCTION gtk_object_set_data ##### -->
6731 <para>
6732 Each object carries around a table of associations from
6733 strings to pointers.  This function lets you set an association.
6734 </para>
6735 <para>
6736 If the object already had an association with that name,
6737 the old association will be destroyed.
6738 </para>
6739
6740 @object: object containing the associations.
6741 @key: name of the key.
6742 @data: data to associate with that key.
6743 @Deprecated: Use g_object_set_data() instead.
6744
6745 <!-- ##### FUNCTION gtk_object_set_data_by_id ##### -->
6746 <para>
6747 Just like gtk_object_set_data() except that it takes
6748 a #GQuark instead of a string, so it is slightly faster.
6749 </para>
6750 <para>
6751 Use gtk_object_data_try_key() and gtk_object_data_force_id()
6752 to get an id from a string.
6753 </para>
6754
6755 @object: object containing the associations.
6756 @data_id: quark of the key.
6757 @data: data to associate with that key.
6758 @Deprecated: Use g_object_set_qdata() instead.
6759
6760 <!-- ##### FUNCTION gtk_object_set_data_by_id_full ##### -->
6761 <para>
6762 Just like gtk_object_set_data_full() except that it takes
6763 a #GQuark instead of a string, so it is slightly faster.
6764 </para>
6765 <para>
6766 Use gtk_object_data_try_key() and gtk_object_data_force_id()
6767 to get an id from a string.
6768 </para>
6769
6770 @object: object containing the associations.
6771 @data_id: quark of the key.
6772 @data: data to associate with that key.
6773 @destroy: function to call when the association is destroyed.
6774 @Deprecated: Use g_object_set_qdata_full() instead.
6775
6776 <!-- ##### FUNCTION gtk_object_set_data_full ##### -->
6777 <para>
6778 Like gtk_object_set_data() except it adds notification
6779 for when the association is destroyed, either by
6780 gtk_object_remove_data() or when the object is destroyed.
6781 </para>
6782
6783 @object: object containing the associations.
6784 @key: name of the key.
6785 @data: data to associate with that key.
6786 @destroy: function to call when the association is destroyed.
6787 @Deprecated: Use g_object_set_data_full() instead.
6788
6789 <!-- ##### FUNCTION gtk_object_set_user_data ##### -->
6790 <para>
6791 For convenience, every object offers a generic user data
6792 pointer.  This function sets it.
6793 </para>
6794
6795 @object: the object whose user data should be set.
6796 @data: the new value for the user data.
6797 @Deprecated: Use g_object_set_data() instead.
6798
6799 <!-- ##### FUNCTION gtk_object_setv ##### -->
6800 <para>
6801 Set an array of arguments.
6802 </para>
6803
6804 @object: the object whose arguments should be set.
6805 @n_args: the number of arguments to set.
6806 @args: the desired values, as an array of #GtkArgs (which contain
6807 the names, types, and values of the arguments).
6808
6809 <!-- ##### FUNCTION gtk_object_sink ##### -->
6810 <para>
6811 Removes the floating reference from a #GtkObject, if it exists;
6812 otherwise does nothing. See the #GtkObject overview documentation at
6813 the top of the page.
6814 </para>
6815
6816 @object: the object to sink.
6817 @Deprecated: 2.10: Use g_object_ref_sink() instead
6818
6819 <!-- ##### FUNCTION gtk_object_unref ##### -->
6820 <para>
6821 Decreases the reference count of an object.  When its reference count drops
6822 to 0, the object is finalized (i.e. its memory is freed).
6823 </para>
6824
6825 @object: the object to dereference.
6826 @Deprecated: Use g_object_unref() instead.
6827
6828 <!-- ##### FUNCTION gtk_object_weakref ##### -->
6829 <para>
6830 Adds a weak reference callback to an object. Weak references are used for notification when an object is
6831 finalized. They are called "weak references" because they allow you to safely
6832 hold a pointer to an object without calling g_object_ref() (g_object_ref() adds
6833 a strong reference, that is, forces the object to stay alive).
6834 </para>
6835
6836 @object: object to weakly reference.
6837 @notify: callback to invoke before the object is freed.
6838 @data: extra data to pass to #notify.
6839 @Deprecated: Use g_object_weak_ref() instead.
6840
6841 <!-- ##### FUNCTION gtk_object_weakunref ##### -->
6842 <para>
6843 Removes a weak reference callback to an object.
6844 </para>
6845
6846 @object: object stop weakly referencing.
6847 @notify: callback to search for.
6848 @data: data to search for.
6849 @Deprecated: Use g_object_weak_unref() instead.
6850
6851 <!-- ##### FUNCTION gtk_packer_add ##### -->
6852 <para>
6853
6854 </para>
6855
6856 @packer:
6857 @child:
6858 @side:
6859 @anchor:
6860 @options:
6861 @border_width:
6862 @pad_x:
6863 @pad_y:
6864 @i_pad_x:
6865 @i_pad_y:
6866
6867 <!-- ##### FUNCTION gtk_packer_add_defaults ##### -->
6868 <para>
6869
6870 </para>
6871
6872 @packer:
6873 @child:
6874 @side:
6875 @anchor:
6876 @options:
6877
6878 <!-- ##### MACRO gtk_packer_configure ##### -->
6879 <para>
6880
6881 </para>
6882
6883
6884 <!-- ##### FUNCTION gtk_packer_new ##### -->
6885 <para>
6886
6887 </para>
6888
6889 @Returns:
6890
6891 <!-- ##### FUNCTION gtk_packer_reorder_child ##### -->
6892 <para>
6893
6894 </para>
6895
6896 @packer:
6897 @child:
6898 @position:
6899
6900 <!-- ##### FUNCTION gtk_packer_set_child_packing ##### -->
6901 <para>
6902
6903 </para>
6904
6905 @packer:
6906 @child:
6907 @side:
6908 @anchor:
6909 @options:
6910 @border_width:
6911 @pad_x:
6912 @pad_y:
6913 @i_pad_x:
6914 @i_pad_y:
6915
6916 <!-- ##### FUNCTION gtk_packer_set_default_border_width ##### -->
6917 <para>
6918
6919 </para>
6920
6921 @packer:
6922 @border:
6923
6924 <!-- ##### FUNCTION gtk_packer_set_default_ipad ##### -->
6925 <para>
6926
6927 </para>
6928
6929 @packer:
6930 @i_pad_x:
6931 @i_pad_y:
6932
6933 <!-- ##### FUNCTION gtk_packer_set_default_pad ##### -->
6934 <para>
6935
6936 </para>
6937
6938 @packer:
6939 @pad_x:
6940 @pad_y:
6941
6942 <!-- ##### FUNCTION gtk_packer_set_spacing ##### -->
6943 <para>
6944
6945 </para>
6946
6947 @packer:
6948 @spacing:
6949
6950 <!-- ##### FUNCTION gtk_paint_string ##### -->
6951 <para>
6952
6953 </para>
6954
6955 @style:
6956 @window:
6957 @state_type:
6958 @area:
6959 @widget:
6960 @detail:
6961 @x:
6962 @y:
6963 @string:
6964
6965 <!-- ##### MACRO gtk_paned_handle_size ##### -->
6966 <para>
6967 Old name for gtk_paned_set_handle_size().
6968 </para>
6969
6970
6971 <!-- ##### FUNCTION gtk_paned_set_handle_size ##### -->
6972 <para>
6973 Set the the handle size to @size x @size pixels.
6974 </para>
6975
6976 @paned: a paned widget
6977 @size: the size in pixels
6978
6979 <!-- ##### FUNCTION gtk_pattern_match ##### -->
6980 <para>
6981
6982 </para>
6983
6984 @pspec:
6985 @string_length:
6986 @string:
6987 @string_reversed:
6988 @Returns:
6989
6990 <!-- ##### FUNCTION gtk_pattern_match_simple ##### -->
6991 <para>
6992
6993 </para>
6994
6995 @pattern:
6996 @string:
6997 @Returns:
6998
6999 <!-- ##### FUNCTION gtk_pattern_match_string ##### -->
7000 <para>
7001
7002 </para>
7003
7004 @pspec:
7005 @string:
7006 @Returns:
7007
7008 <!-- ##### FUNCTION gtk_pattern_spec_free_segs ##### -->
7009 <para>
7010
7011 </para>
7012
7013 @pspec:
7014
7015 <!-- ##### FUNCTION gtk_pattern_spec_init ##### -->
7016 <para>
7017
7018 </para>
7019
7020 @pspec:
7021 @pattern:
7022
7023 <!-- ##### FUNCTION gtk_preview_draw_row ##### -->
7024 <para>
7025 Sets the data for a portion of a row.
7026 </para>
7027
7028 @preview: a #GtkPreview.
7029 @data: the new data for the portion. It should contain
7030        @w bytes of data if the preview is of type
7031        GTK_TYPE_GRAYSCALE, and 3*@w bytes of data
7032        if the preview is of type GTK_TYPE_COLOR.
7033 @x: the starting value on the row to set.
7034 @y: the row to change.
7035 @w: the number of pixels in the row to change.
7036
7037 <!-- ##### FUNCTION gtk_preview_get_cmap ##### -->
7038 <para>
7039 Returns the colormap used by preview widgets. This
7040 function is deprecated, and you should use
7041 gdk_rgb_get_cmap() instead.
7042 </para>
7043
7044 @Returns: the colormap for previews.
7045
7046 <!-- ##### FUNCTION gtk_preview_get_info ##### -->
7047 <para>
7048 Return a #GtkPreviewInfo structure containing
7049 global information about preview widgets.
7050 </para>
7051
7052 @Returns: a #GtkPreviewInfo structure. The return
7053  value belongs to GTK+ and must not be modified
7054  or freed.
7055
7056 <!-- ##### FUNCTION gtk_preview_get_visual ##### -->
7057 <para>
7058 Returns the visual used by preview widgets. This
7059 function is deprecated, and you should use
7060 gdk_rgb_get_visual() instead.
7061 </para>
7062
7063 @Returns: the visual for previews.
7064
7065 <!-- ##### FUNCTION gtk_preview_new ##### -->
7066 <para>
7067 Create a new preview widget.
7068 </para>
7069
7070 @type: the type data contained by the widget.
7071 (Grayscale or RGB)
7072 @Returns: a new #GtkPreview
7073
7074 <!-- ##### FUNCTION gtk_preview_put ##### -->
7075 <para>
7076 Takes a portion of the contents of a preview widget
7077 and draws it onto the given drawable, @window.
7078 </para>
7079
7080 @preview: a #GtkPreview.
7081 @window: a window or pixmap.
7082 @gc: The graphics context for the operation. Only the
7083      clip mask for this GC matters.
7084 @srcx: the x coordinate of the upper left corner in the source image.
7085 @srcy: the y coordinate of the upper left corner in the source image.
7086 @destx: the x coordinate of the upper left corner in the destination image.
7087 @desty: the y coordinate of the upper left corner in the destination image.
7088 @width: the width of the rectangular portion to draw.
7089 @height: the height of the rectangular portion to draw.
7090
7091 <!-- ##### FUNCTION gtk_preview_reset ##### -->
7092 <para>
7093 This function is deprecated and does nothing. It was
7094 once used for changing the colormap and visual on the fly.
7095 </para>
7096
7097
7098 <!-- ##### FUNCTION gtk_preview_set_color_cube ##### -->
7099 <para>
7100 This function is deprecated and does nothing. GdkRGB
7101 automatically picks an optimium color cube for the
7102 display.
7103 </para>
7104
7105 @nred_shades: ignored
7106 @ngreen_shades: ignored
7107 @nblue_shades: ignored
7108 @ngray_shades: ignored
7109
7110 <!-- ##### FUNCTION gtk_preview_set_dither ##### -->
7111 <para>
7112 Set the dithering mode for the display.
7113 </para>
7114
7115 @preview: a #GtkPreview.
7116 @dither: the dithering mode.
7117
7118 <!-- ##### FUNCTION gtk_preview_set_expand ##### -->
7119 <para>
7120 Determines the way that the the preview widget behaves
7121 when the size it is allocated is larger than the requested
7122 size. If @expand is %FALSE, then the preview's window
7123 and buffer will be no larger than the size set with
7124 gtk_preview_size(), and the data set will be centered
7125 in the allocation if it is larger. If @expand is %TRUE
7126 then the window and buffer will expand with the allocation;
7127 the application is responsible for catching
7128 the "size_allocate" signal and providing the data
7129 appropriate for this size.
7130 </para>
7131
7132 @preview: a #GtkPreview.
7133 @expand: whether the preview's window should expand or not.
7134
7135 <!-- ##### FUNCTION gtk_preview_set_gamma ##### -->
7136 <para>
7137 Set the gamma-correction value for all preview widgets.
7138 (This function will eventually be replaced with a
7139 function that sets a per-preview-widget gamma value).
7140 The resulting intensity is given by:
7141 <literal>destination_value * pow (source_value/255, 1/gamma)</literal>.
7142 The gamma value is applied when the data is
7143 set with gtk_preview_draw_row() so changing this
7144 value will not affect existing data in preview
7145 widgets.
7146 </para>
7147
7148 @gamma_: the new gamma value.
7149
7150 <!-- ##### FUNCTION gtk_preview_set_install_cmap ##### -->
7151 <para>
7152 This function is deprecated
7153 and does nothing. GdkRGB will automatically pick
7154 a private colormap if it cannot allocate sufficient
7155 colors.
7156 </para>
7157
7158 @install_cmap: ignored.
7159
7160 <!-- ##### FUNCTION gtk_preview_set_reserved ##### -->
7161 <para>
7162 This function is deprecated and does nothing.
7163 </para>
7164
7165 @nreserved: ignored.
7166
7167 <!-- ##### FUNCTION gtk_preview_size ##### -->
7168 <para>
7169 Set the size that the preview widget will request
7170 in response to a "size_request" signal. The
7171 drawing area may actually be allocated a size
7172 larger than this depending on how it is packed
7173 within the enclosing containers. The effect
7174 of this is determined by whether the preview
7175 is set to expand or not (see gtk_preview_expand())
7176 </para>
7177
7178 @preview: a #GtkPreview.
7179 @width: the new width.
7180 @height: the new height.
7181
7182 <!-- ##### FUNCTION gtk_preview_uninit ##### -->
7183 <para>
7184 This function is deprecated and does nothing.
7185 </para>
7186
7187
7188 <!-- ##### FUNCTION gtk_print_context_create_context ##### -->
7189 <para>
7190
7191 </para>
7192
7193 @context:
7194 @Returns:
7195
7196 <!-- ##### FUNCTION gtk_print_context_create_layout ##### -->
7197 <para>
7198
7199 </para>
7200
7201 @context:
7202 @Returns:
7203
7204 <!-- ##### FUNCTION gtk_print_context_get_cairo ##### -->
7205 <para>
7206
7207 </para>
7208
7209 @context:
7210 @Returns:
7211
7212 <!-- ##### FUNCTION gtk_print_context_get_fontmap ##### -->
7213 <para>
7214
7215 </para>
7216
7217 @context:
7218 @Returns:
7219
7220 <!-- ##### FUNCTION gtk_print_operation_set_nr_of_pages ##### -->
7221 <para>
7222
7223 </para>
7224
7225 @op:
7226 @n_pages:
7227
7228 <!-- ##### FUNCTION gtk_print_settings_get_num_copies ##### -->
7229 <para>
7230
7231 </para>
7232
7233 @settings:
7234 @Returns:
7235
7236 <!-- ##### FUNCTION gtk_print_settings_get_print_to_file ##### -->
7237 <para>
7238
7239 </para>
7240
7241 @settings:
7242 @Returns:
7243
7244 <!-- ##### FUNCTION gtk_print_settings_set_num_copies ##### -->
7245 <para>
7246
7247 </para>
7248
7249 @settings:
7250 @num_copies:
7251
7252 <!-- ##### FUNCTION gtk_print_settings_set_print_to_file ##### -->
7253 <para>
7254
7255 </para>
7256
7257 @settings:
7258 @print_to_file:
7259
7260 <!-- ##### FUNCTION gtk_progress_bar_new_with_adjustment ##### -->
7261
7262
7263 @adjustment:
7264 @Returns:
7265
7266 <!-- ##### FUNCTION gtk_progress_bar_set_activity_blocks ##### -->
7267 <para>
7268 Sets the number of blocks used when the progress bar is in activity
7269 mode.  Larger numbers make the visible block smaller.
7270 </para>
7271
7272 @pbar: a #GtkProgressBar.
7273 @blocks: number of blocks which can fit within the progress bar area.
7274
7275 <!-- ##### FUNCTION gtk_progress_bar_set_activity_step ##### -->
7276 <para>
7277 Sets the step value used when the progress bar is in activity
7278 mode.  The step is the amount by which the progress is incremented
7279 each iteration.
7280 </para>
7281
7282 @pbar: a #GtkProgressBar.
7283 @step: the amount which the progress is incremented in activity
7284 mode.
7285
7286 <!-- ##### FUNCTION gtk_progress_bar_set_bar_style ##### -->
7287 <para>
7288 Sets the style of the #GtkProgressBar.  The default style is
7289 %GTK_PROGRESS_CONTINUOUS.
7290 </para>
7291
7292 @pbar: a #GtkProgressBar.
7293 @style: a #GtkProgressBarStyle value indicating the desired style.
7294
7295 <!-- ##### FUNCTION gtk_progress_bar_set_discrete_blocks ##### -->
7296 <para>
7297 Sets the number of blocks that the progress bar is divided into
7298 when the style is %GTK_PROGRESS_DISCRETE.
7299 </para>
7300
7301 @pbar: a #GtkProgressBar.
7302 @blocks: number of individual blocks making up the bar.
7303
7304 <!-- ##### FUNCTION gtk_progress_bar_update ##### -->
7305 <para>
7306 This function is deprecated.  Please use gtk_progress_set_value() or
7307 gtk_progress_set_percentage() instead.
7308 </para>
7309
7310 @pbar: a #GtkProgressBar.
7311 @percentage: the new percent complete value.
7312
7313 <!-- ##### MACRO gtk_radio_menu_item_group ##### -->
7314 <para>
7315 Deprecated compatibility macro. Use gtk_radio_menu_item_get_group() instead.
7316 </para>
7317
7318
7319 <!-- ##### FUNCTION gtk_rc_add_class_style ##### -->
7320 <para>
7321 Adds a #GtkRcStyle that will be looked up by a matching against
7322 the class hierarchy of the widget. This is equivalent to a:
7323 <literal>class PATTERN style STYLE</literal>
7324 statement in a RC file.
7325 </para>
7326
7327 @rc_style: the #GtkRcStyle to use for widgets deriving from @pattern
7328 @pattern: the pattern
7329 @Deprecated: Use gtk_rc_parse_string() with a suitable string instead.
7330
7331 <!-- ##### FUNCTION gtk_rc_add_widget_class_style ##### -->
7332 <para>
7333 Adds a #GtkRcStyle that will be looked up by a match against
7334 the widget's class pathname. This is equivalent to a:
7335 <literal>widget_class PATTERN style STYLE</literal>
7336 statement in a RC file.
7337 </para>
7338
7339 @rc_style: the #GtkRcStyle to use for widgets matching @pattern
7340 @pattern: the pattern
7341 @Deprecated: Use gtk_rc_parse_string() with a suitable string instead.
7342
7343 <!-- ##### FUNCTION gtk_rc_add_widget_name_style ##### -->
7344 <para>
7345 Adds a #GtkRcStyle that will be looked up by a match against
7346 the widget's pathname. This is equivalent to a:
7347  <literal>widget PATTERN style STYLE</literal>
7348 statement in a RC file.
7349 </para>
7350
7351 @rc_style: the #GtkRcStyle to use for widgets matching @pattern
7352 @pattern: the pattern
7353 @Deprecated: Use gtk_rc_parse_string() with a suitable string instead.
7354
7355 <!-- ##### FUNCTION gtk_rc_init ##### -->
7356 <para>
7357 Internal function.
7358 </para>
7359
7360
7361 <!-- ##### FUNCTION gtk_rc_load_image ##### -->
7362 <para>
7363 Internal function. Loads an image using the current
7364 image loader.
7365 </para>
7366
7367 @colormap: the colormap to use for the image
7368 @transparent_color: the transparent color for the image
7369 @filename: the filename of the image file
7370 @Returns: a #GtkPixmap representing @filename
7371
7372 <!-- ##### FUNCTION gtk_rc_set_image_loader ##### -->
7373 <para>
7374 Sets the function that GTK+ will use to load images
7375 </para>
7376
7377 @loader: the #GtkImageLoader to use
7378
7379 <!-- ##### FUNCTION gtk_rc_style_ref ##### -->
7380 <para>
7381 Increments the reference count of a #GtkRcStyle.
7382 </para>
7383
7384 @rc_style: a #GtkRcStyle
7385 @Deprecated: Use g_object_ref() instead
7386
7387 <!-- ##### FUNCTION gtk_rc_style_unref ##### -->
7388 <para>
7389 Decrements the reference count of a #GtkRcStyle and
7390 frees if the result is 0.
7391 </para>
7392
7393 @rc_style: a #GtkRcStyle
7394 @Deprecated: Use g_object_unref() instead
7395
7396 <!-- ##### FUNCTION gtk_recent_chooser_get_show_numbers ##### -->
7397 <para>
7398
7399 </para>
7400
7401 @chooser:
7402 @Returns:
7403
7404 <!-- ##### FUNCTION gtk_recent_chooser_set_show_numbers ##### -->
7405 <para>
7406
7407 </para>
7408
7409 @chooser:
7410 @show_numbers:
7411
7412 <!-- ##### FUNCTION gtk_recent_manager_get_for_screen ##### -->
7413 <para>
7414
7415 </para>
7416
7417 @screen:
7418 @Returns:
7419
7420 <!-- ##### FUNCTION gtk_recent_manager_set_screen ##### -->
7421 <para>
7422
7423 </para>
7424
7425 @manager:
7426 @screen:
7427
7428 <!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
7429 <para>
7430
7431 </para>
7432
7433 @ruler: the gtkruler
7434
7435 <!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
7436 <para>
7437
7438 </para>
7439
7440 @ruler: the gtkruler
7441
7442 <!-- ##### FUNCTION gtk_scale_button_get_orientation ##### -->
7443 <para>
7444
7445 </para>
7446
7447 @button:
7448 @Returns:
7449
7450 <!-- ##### FUNCTION gtk_scale_button_set_orientation ##### -->
7451 <para>
7452
7453 </para>
7454
7455 @button:
7456 @orientation:
7457
7458 <!-- ##### FUNCTION gtk_selection_clear ##### -->
7459 <para>
7460 </para>
7461
7462 @widget:
7463 @event:
7464 @Returns:
7465
7466 <!-- ##### FUNCTION gtk_selection_incr_event ##### -->
7467 <para>
7468 Internal function.
7469 </para>
7470
7471 @window:
7472 @event:
7473 @Returns:
7474
7475 <!-- ##### FUNCTION gtk_selection_notify ##### -->
7476 <para>
7477 Internal function.
7478 </para>
7479
7480 @widget:
7481 @event:
7482 @Returns:
7483
7484 <!-- ##### FUNCTION gtk_selection_property_notify ##### -->
7485 <para>
7486 Internal function.
7487 </para>
7488
7489 @widget:
7490 @event:
7491 @Returns:
7492
7493 <!-- ##### FUNCTION gtk_selection_request ##### -->
7494 <para>
7495 Internal function.
7496 </para>
7497
7498 @widget:
7499 @event:
7500 @Returns:
7501
7502 <!-- ##### FUNCTION gtk_settings_get_global ##### -->
7503 <para>
7504
7505 </para>
7506
7507 @Returns:
7508
7509 <!-- ##### MACRO gtk_spin_button_get_value_as_float ##### -->
7510 <para>
7511 Gets the value in the @spin_button.
7512 </para>
7513
7514 @Returns: the value of @spin_button
7515 @Deprecated: Use gtk_spin_button_get_value() instead.
7516 @spin_button: a #GtkSpinButton
7517
7518 <!-- ##### FUNCTION gtk_spin_button_set_shadow_type ##### -->
7519 <para>
7520 Creates a border around the arrows of a #GtkSpinButton. The type of border is determined by @shadow_type.
7521 </para>
7522
7523 @spin_button: a #GtkSpinButton
7524 @shadow_type: the new border type.
7525
7526 <!-- ##### FUNCTION gtk_status_icon_set_tooltip ##### -->
7527 <para>
7528
7529 </para>
7530
7531 @status_icon:
7532 @tooltip_text:
7533
7534 <!-- ##### FUNCTION gtk_stock_list_items ##### -->
7535 <para>
7536
7537 </para>
7538
7539 @Returns:
7540
7541 <!-- ##### MACRO gtk_style_apply_default_pixmap ##### -->
7542 <para>
7543 Does the same as gtk_style_apply_default_background().
7544 </para>
7545
7546 @s:
7547 @gw:
7548 @st:
7549 @a:
7550 @x:
7551 @y:
7552 @w:
7553 @h:
7554 @Deprecated: Use gtk_style_apply_default_background() instead.
7555
7556 <!-- ##### FUNCTION gtk_style_get_font ##### -->
7557 <para>
7558
7559 </para>
7560
7561 @style:
7562 @Returns:
7563
7564 <!-- ##### FUNCTION gtk_style_get_font_for_display ##### -->
7565 <para>
7566
7567 </para>
7568
7569 @display:
7570 @style:
7571 @Returns:
7572
7573 <!-- ##### FUNCTION gtk_style_get_property ##### -->
7574 <para>
7575
7576 </para>
7577
7578 @style:
7579 @widget_type:
7580 @property_name:
7581 @value:
7582
7583 <!-- ##### FUNCTION gtk_style_lookup_icon_set ##### -->
7584 <para>
7585
7586 </para>
7587
7588 @style:
7589 @stock_id:
7590 @Returns:
7591
7592 <!-- ##### FUNCTION gtk_style_ref ##### -->
7593 <para>
7594
7595 </para>
7596
7597 @style:
7598 @Returns:
7599
7600 <!-- ##### FUNCTION gtk_style_set_font ##### -->
7601 <para>
7602
7603 </para>
7604
7605 @style:
7606 @font:
7607
7608 <!-- ##### FUNCTION gtk_style_unref ##### -->
7609 <para>
7610
7611 </para>
7612
7613 @style:
7614
7615 <!-- ##### FUNCTION gtk_text_buffer_paste_primary ##### -->
7616 <para>
7617
7618 </para>
7619
7620 @buffer:
7621 @override_location:
7622 @default_editable:
7623
7624 <!-- ##### FUNCTION gtk_text_iter_reorder ##### -->
7625 <para>
7626
7627 </para>
7628
7629 @first:
7630 @second:
7631
7632 <!-- ##### FUNCTION gtk_text_iter_spew ##### -->
7633 <para>
7634
7635 </para>
7636
7637 @iter:
7638 @desc:
7639
7640 <!-- ##### FUNCTION gtk_text_view_set_text_window_size ##### -->
7641 <para>
7642
7643 </para>
7644
7645 @text_view:
7646 @width:
7647 @height:
7648
7649 <!-- ##### FUNCTION gtk_tips_query_get_type ##### -->
7650 <para>
7651
7652 </para>
7653
7654 @Returns:
7655
7656 <!-- ##### FUNCTION gtk_tips_query_new ##### -->
7657 <para>
7658 Creates a new #GtkTipsQuery.
7659 </para>
7660
7661 @Returns: a new #GtkTipsQuery.
7662
7663 <!-- ##### FUNCTION gtk_tips_query_set_caller ##### -->
7664 <para>
7665 Sets the widget which initiates the query, usually a button.
7666 If the @caller is selected while the query is running, the query is
7667 automatically stopped.
7668 </para>
7669
7670 @tips_query: a #GtkTipsQuery.
7671 @caller: the widget which initiates the query.
7672
7673 <!-- ##### FUNCTION gtk_tips_query_set_labels ##### -->
7674 <para>
7675 Sets the text to display when the query is not in effect,
7676 and the text to display when the query is in effect but the widget beneath
7677 the pointer has no tooltip.
7678 </para>
7679
7680 @tips_query: a #GtkTipsQuery.
7681 @label_inactive: the text to display when the query is not running.
7682 @label_no_tip: the text to display when the query is running but the widget
7683 beneath the pointer has no tooltip.
7684
7685 <!-- ##### FUNCTION gtk_tips_query_start_query ##### -->
7686 <para>
7687 Starts a query.
7688 The #GtkTipsQuery widget will take control of the mouse and as the mouse
7689 moves it will display the tooltip of the widget beneath the mouse.
7690 </para>
7691
7692 @tips_query: a #GtkTipsQuery.
7693
7694 <!-- ##### FUNCTION gtk_tips_query_stop_query ##### -->
7695 <para>
7696 Stops a query.
7697 </para>
7698
7699 @tips_query: a #GtkTipsQuery.
7700
7701 <!-- ##### FUNCTION gtk_tool_item_get_pack_end ##### -->
7702 <para>
7703
7704 </para>
7705
7706 @tool_item:
7707 @Returns:
7708
7709 <!-- ##### FUNCTION gtk_tool_item_set_pack_end ##### -->
7710 <para>
7711
7712 </para>
7713
7714 @tool_item:
7715 @pack_end:
7716
7717 <!-- ##### FUNCTION gtk_toolbar_append_element ##### -->
7718 <para>
7719
7720 </para>
7721 <para>
7722
7723 </para>
7724
7725 @toolbar:
7726 @type:
7727 @widget:
7728 @text:
7729 @tooltip_text:
7730 @tooltip_private_text:
7731 @icon:
7732 @callback:
7733 @user_data:
7734 @Returns:
7735
7736 <!-- ##### FUNCTION gtk_toolbar_append_item ##### -->
7737 <para>
7738
7739 </para>
7740
7741 @toolbar:
7742 @text:
7743 @tooltip_text:
7744 @tooltip_private_text:
7745 @icon:
7746 @callback:
7747 @user_data:
7748 @Returns:
7749
7750 <!-- ##### FUNCTION gtk_toolbar_append_space ##### -->
7751 <para>
7752
7753 </para>
7754
7755 @toolbar:
7756
7757 <!-- ##### FUNCTION gtk_toolbar_append_widget ##### -->
7758 <para>
7759
7760 </para>
7761
7762 @toolbar:
7763 @widget:
7764 @tooltip_text:
7765 @tooltip_private_text:
7766
7767 <!-- ##### FUNCTION gtk_toolbar_get_orientation ##### -->
7768 <para>
7769
7770 </para>
7771
7772 @toolbar:
7773 @Returns:
7774
7775 <!-- ##### FUNCTION gtk_toolbar_get_tooltips ##### -->
7776 <para>
7777
7778 </para>
7779
7780 @toolbar:
7781 @Returns:
7782
7783 <!-- ##### FUNCTION gtk_toolbar_insert_element ##### -->
7784 <para>
7785
7786 </para>
7787
7788 @toolbar:
7789 @type:
7790 @widget:
7791 @text:
7792 @tooltip_text:
7793 @tooltip_private_text:
7794 @icon:
7795 @callback:
7796 @user_data:
7797 @position:
7798 @Returns:
7799
7800 <!-- ##### FUNCTION gtk_toolbar_insert_item ##### -->
7801 <para>
7802
7803 </para>
7804
7805 @toolbar:
7806 @text:
7807 @tooltip_text:
7808 @tooltip_private_text:
7809 @icon:
7810 @callback:
7811 @user_data:
7812 @position:
7813 @Returns:
7814
7815 <!-- ##### FUNCTION gtk_toolbar_insert_space ##### -->
7816 <para>
7817
7818 </para>
7819
7820 @toolbar:
7821 @position:
7822
7823 <!-- ##### FUNCTION gtk_toolbar_insert_stock ##### -->
7824 <para>
7825
7826 </para>
7827
7828 @toolbar:
7829 @stock_id:
7830 @tooltip_text:
7831 @tooltip_private_text:
7832 @callback:
7833 @user_data:
7834 @position:
7835 @Returns:
7836
7837 <!-- ##### FUNCTION gtk_toolbar_insert_widget ##### -->
7838 <para>
7839
7840 </para>
7841
7842 @toolbar:
7843 @widget:
7844 @tooltip_text:
7845 @tooltip_private_text:
7846 @position:
7847
7848 <!-- ##### FUNCTION gtk_toolbar_prepend_element ##### -->
7849 <para>
7850
7851 </para>
7852
7853 @toolbar:
7854 @type:
7855 @widget:
7856 @text:
7857 @tooltip_text:
7858 @tooltip_private_text:
7859 @icon:
7860 @callback:
7861 @user_data:
7862 @Returns:
7863
7864 <!-- ##### FUNCTION gtk_toolbar_prepend_item ##### -->
7865 <para>
7866
7867 </para>
7868
7869 @toolbar:
7870 @text:
7871 @tooltip_text:
7872 @tooltip_private_text:
7873 @icon:
7874 @callback:
7875 @user_data:
7876 @Returns:
7877
7878 <!-- ##### FUNCTION gtk_toolbar_prepend_space ##### -->
7879 <para>
7880
7881 </para>
7882
7883 @toolbar:
7884
7885 <!-- ##### FUNCTION gtk_toolbar_prepend_widget ##### -->
7886 <para>
7887
7888 </para>
7889
7890 @toolbar:
7891 @widget:
7892 @tooltip_text:
7893 @tooltip_private_text:
7894
7895 <!-- ##### FUNCTION gtk_toolbar_remove_space ##### -->
7896 <para>
7897
7898 </para>
7899
7900 @toolbar:
7901 @position:
7902
7903 <!-- ##### FUNCTION gtk_toolbar_set_orientation ##### -->
7904 <para>
7905
7906 </para>
7907
7908 @toolbar:
7909 @orientation:
7910
7911 <!-- ##### FUNCTION gtk_toolbar_set_tooltips ##### -->
7912 <para>
7913
7914 </para>
7915
7916 @toolbar:
7917 @enable:
7918
7919 <!-- ##### FUNCTION gtk_trace_referencing ##### -->
7920 <para>
7921 Private: print debugging information while doing a gtk_object_ref() or
7922 a gtk_object_unref().
7923 </para>
7924
7925 @object: object to reference or unreference.
7926 @func: name of caller's function to print (used within macros).
7927 @dummy: unused.
7928 @line: line number (used within macros).
7929 @do_ref: whether to reference or unreference.
7930
7931 <!-- ##### MACRO gtk_tree_model_get_iter_root ##### -->
7932 <para>
7933 A alternate name for gtk_tree_model_get_iter_first() provided for
7934 compatibility reasons; this macro will be deprecated in future
7935 versions of GTK+.
7936 </para>
7937
7938 @tree_model:  A #GtkTreeModel.
7939 @iter: uninitialized #GtkTreeIter.
7940 @Returns:  %TRUE, if @iter was set.
7941
7942 <!-- ##### FUNCTION gtk_tree_model_ref_iter ##### -->
7943 <para>
7944
7945 </para>
7946
7947 @tree_model:
7948 @iter:
7949
7950 <!-- ##### FUNCTION gtk_tree_model_sort_convert_iter ##### -->
7951 <para>
7952
7953 </para>
7954
7955 @tree_model_sort:
7956 @sort_iter:
7957 @child_iter:
7958
7959 <!-- ##### FUNCTION gtk_tree_model_sort_convert_path ##### -->
7960 <para>
7961
7962 </para>
7963
7964 @tree_model_sort:
7965 @child_path:
7966 @Returns:
7967 @path:
7968
7969 <!-- ##### FUNCTION gtk_tree_model_sort_new ##### -->
7970 <para>
7971
7972 </para>
7973
7974 @Returns:
7975
7976 <!-- ##### FUNCTION gtk_tree_model_sort_set_compare ##### -->
7977 <para>
7978
7979 </para>
7980
7981 @tree_model_sort:
7982 @func:
7983
7984 <!-- ##### FUNCTION gtk_tree_model_sort_set_model ##### -->
7985 <para>
7986
7987 </para>
7988
7989 @tree_model_sort:
7990 @child_model:
7991 @model:
7992
7993 <!-- ##### FUNCTION gtk_tree_model_sort_set_sort_column ##### -->
7994 <para>
7995
7996 </para>
7997
7998 @tree_model_sort:
7999 @sort_col:
8000
8001 <!-- ##### FUNCTION gtk_tree_model_unref_iter ##### -->
8002 <para>
8003
8004 </para>
8005
8006 @tree_model:
8007 @iter:
8008
8009 <!-- ##### MACRO gtk_tree_path_new_root ##### -->
8010 <para>
8011 An alternate name for gtk_tree_path_new_first() provided for
8012 compatibility reasons.
8013 </para>
8014
8015 @Returns: A new #GtkTreePath.
8016 @Deprecated: Use gtk_tree_path_new_first() instead.
8017
8018 <!-- ##### FUNCTION gtk_tree_store_move ##### -->
8019 <para>
8020
8021 </para>
8022
8023 @tree_store:
8024 @iter:
8025 @position:
8026
8027 <!-- ##### FUNCTION gtk_tree_store_new_with_types ##### -->
8028 <para>
8029
8030 </para>
8031
8032 @n_columns:
8033 @Varargs:
8034 @Returns:
8035
8036 <!-- ##### FUNCTION gtk_tree_store_set_cell ##### -->
8037 <para>
8038
8039 </para>
8040
8041 @tree_store:
8042 @iter:
8043 @column:
8044 @value:
8045
8046 <!-- ##### FUNCTION gtk_tree_store_set_column_type ##### -->
8047 <para>
8048
8049 </para>
8050
8051 @tree_store:
8052 @column:
8053 @type:
8054 @store:
8055
8056 <!-- ##### FUNCTION gtk_tree_store_set_n_columns ##### -->
8057 <para>
8058
8059 </para>
8060
8061 @tree_store:
8062 @n_columns:
8063
8064 <!-- ##### FUNCTION gtk_tree_view_column_cell_event ##### -->
8065 <para>
8066
8067 </para>
8068
8069 @tree_column:
8070 @event:
8071 @path_string:
8072 @background_area:
8073 @cell_area:
8074 @flags:
8075 @Returns:
8076
8077 <!-- ##### FUNCTION gtk_tree_view_column_set_cell_data ##### -->
8078 <para>
8079
8080 </para>
8081
8082 @tree_column:
8083 @tree_model:
8084 @iter:
8085
8086 <!-- ##### FUNCTION gtk_tree_view_column_set_cell_renderer ##### -->
8087 <para>
8088
8089 </para>
8090
8091 @tree_column:
8092 @cell:
8093
8094 <!-- ##### FUNCTION gtk_tree_view_column_set_width ##### -->
8095 <para>
8096
8097 </para>
8098
8099 @tree_column:
8100 @width:
8101 @size:
8102
8103 <!-- ##### FUNCTION gtk_tree_view_set_rows_drag_dest ##### -->
8104 <para>
8105
8106 </para>
8107
8108 @tree_view:
8109 @targets:
8110 @n_targets:
8111 @actions:
8112 @location_droppable_func:
8113 @user_data:
8114
8115 <!-- ##### FUNCTION gtk_tree_view_set_rows_drag_source ##### -->
8116 <para>
8117
8118 </para>
8119
8120 @tree_view:
8121 @start_button_mask:
8122 @targets:
8123 @n_targets:
8124 @actions:
8125 @row_draggable_func:
8126 @user_data:
8127
8128 <!-- ##### FUNCTION gtk_tree_view_tree_to_widget_coords ##### -->
8129 <para>
8130
8131 </para>
8132
8133 @tree_view:
8134 @tx:
8135 @ty:
8136 @wx:
8137 @wy:
8138
8139 <!-- ##### FUNCTION gtk_tree_view_widget_to_tree_coords ##### -->
8140 <para>
8141
8142 </para>
8143
8144 @tree_view:
8145 @wx:
8146 @wy:
8147 @tx:
8148 @ty:
8149
8150 <!-- ##### FUNCTION gtk_type_check_class_cast ##### -->
8151 <para>
8152 Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make
8153 sure that it's okay to cast something of that @klass into a @cast_type.
8154 </para>
8155
8156 @klass: GtkTypeClass*
8157 @cast_type: GtkType
8158 @Returns: Always return @klass.
8159
8160 <!-- ##### FUNCTION gtk_type_check_object_cast ##### -->
8161 <para>
8162 Given a pointer to a GtkTypeObject @type_object, and a GtkType @cast_type,
8163 make sure that it's okay to cast @type_object into a @cast_type.
8164 </para>
8165
8166 @type_object: GtkTypeObject*
8167 @cast_type: GtkType
8168 @Returns: the same GtkTypeObject* as @type_object
8169
8170 <!-- ##### FUNCTION gtk_type_children_types ##### -->
8171 <para>
8172 Return the pointer to the type's children's types.
8173 </para>
8174
8175 @type: GtkType
8176 @Returns: pointer to a GList
8177
8178 <!-- ##### FUNCTION gtk_type_class ##### -->
8179 <para>
8180 Returns a pointer pointing to the class of @type or %NULL if there was
8181 any trouble identifying @type.  Initializes the class if necessary.
8182 </para>
8183
8184 @type: a #GtkType.
8185 @Returns: pointer to the class.
8186
8187 <!-- ##### FUNCTION gtk_type_describe_heritage ##### -->
8188 <para>
8189 Print the types @type inherits from.
8190 </para>
8191
8192 @type: GtkType
8193
8194 <!-- ##### FUNCTION gtk_type_describe_tree ##### -->
8195 <para>
8196 Given a @type, describe all of its children, and their children.  Only
8197 show the size if @show_size is true.
8198 </para>
8199
8200 @type: GtkType
8201 @show_size: gboolean
8202
8203 <!-- ##### FUNCTION gtk_type_enum_find_value ##### -->
8204 <para>
8205 Returns a pointer to one of @enum_type's #GtkEnumValues's whose name (or nickname) matches @value_name.
8206 </para>
8207
8208 @enum_type: a #GtkType.
8209 @value_name: the name to look for.
8210 @Returns: #GtkEnumValue*
8211
8212 <!-- ##### FUNCTION gtk_type_enum_get_values ##### -->
8213 <para>
8214 If @enum_type has values, then return a pointer to all of them.
8215 </para>
8216
8217 @enum_type: a #GtkType.
8218 @Returns: #GtkEnumValue*
8219
8220 <!-- ##### FUNCTION gtk_type_flags_find_value ##### -->
8221 <para>
8222 Returns a pointer to one of @flag_type's #GtkFlagValue's whose name (or nickname) matches @value_name.
8223 </para>
8224
8225 @flags_type: a #GtkType.
8226 @value_name: the name to look for.
8227 @Returns: #GtkFlagValue*
8228 @flag_type: GtkType
8229
8230 <!-- ##### FUNCTION gtk_type_flags_get_values ##### -->
8231 <para>
8232 If @flags_type has values, then return a pointer to all of them.
8233 </para>
8234
8235 @flags_type: a #GtkType.
8236 @Returns: #GtkFlagValue*
8237
8238 <!-- ##### FUNCTION gtk_type_free ##### -->
8239 <para>
8240 Given the type of an object and a pointer to it, the object is freed.
8241 </para>
8242
8243 @type: GtkType
8244 @mem: gpointer to the object
8245
8246 <!-- ##### MACRO gtk_type_from_name ##### -->
8247 <para>
8248 Gets the internal representation of a type, given its name.
8249 </para>
8250
8251 @name: the name of a GTK+ type
8252 @Returns: a #GtkType.
8253
8254 <!-- ##### FUNCTION gtk_type_get_varargs_type ##### -->
8255 <para>
8256 Get the varargs type associated with @foreign_type
8257 </para>
8258
8259 @foreign_type: GtkType
8260 @Returns: GtkType
8261
8262 <!-- ##### FUNCTION gtk_type_init ##### -->
8263 <para>
8264 Initializes the data structures associated with GTK+ types.
8265 </para>
8266
8267 @debug_flags: debug flags
8268
8269 <!-- ##### MACRO gtk_type_is_a ##### -->
8270 <para>
8271 Looks in the type hierarchy to see if @type has @is_a_type among its
8272 ancestors.  Do so with a simple lookup, not a loop.
8273 </para>
8274
8275 @type: a #GtkType.
8276 @is_a_type: another #GtkType.
8277 @Returns: %TRUE if @type is a @is_a_type.
8278
8279 <!-- ##### MACRO gtk_type_name ##### -->
8280 <para>
8281 Returns a pointer to the name of a type, or %NULL if it has none.
8282 </para>
8283
8284 @type: a #GtkType.
8285 @Returns: a pointer to the name of a type, or %NULL if it has none.
8286
8287 <!-- ##### FUNCTION gtk_type_new ##### -->
8288 <para>
8289 Creates a new object of a given type, and return a pointer to it.
8290 Returns %NULL if you give it an invalid type.  It allocates the object
8291 out of the type's memory chunk if there is a memory chunk.  The object
8292 has all the proper initializers called.
8293 </para>
8294
8295 @type: a #GtkType.
8296 @Returns: pointer to a #GtkTypeObject.
8297
8298 <!-- ##### MACRO gtk_type_parent ##### -->
8299 <para>
8300 Returns the parent type of a #GtkType.
8301 </para>
8302
8303 @type: a #GtkType.
8304 @Returns: the #GtkType of the parent.
8305
8306 <!-- ##### FUNCTION gtk_type_parent_class ##### -->
8307 <para>
8308 Return the class of the parent.  Initialize the class if necessary.
8309 Return NULL if anything goes wrong.
8310 </para>
8311
8312 @type: GtkType
8313 @Returns: gpointer to the klass.
8314
8315 <!-- ##### FUNCTION gtk_type_query ##### -->
8316 <para>
8317 Given a type, return various interesting parameters of the type.
8318 </para>
8319
8320 @type: GtkType
8321 @Returns: GtkTypeQuery*
8322
8323 <!-- ##### FUNCTION gtk_type_register_enum ##### -->
8324 <para>
8325 Register a new set of enum @values and give them the name in
8326 @type_name.
8327 </para>
8328
8329 @type_name: must not be null.
8330 @values: GtkEnumValue*
8331 @Returns:
8332
8333 <!-- ##### FUNCTION gtk_type_register_flags ##### -->
8334 <para>
8335 Register a new set of flags @values and give them the name in
8336 @type_name.
8337 </para>
8338
8339 @type_name: must not be null.
8340 @values: GtkFlagValue*
8341 @Returns:
8342
8343 <!-- ##### FUNCTION gtk_type_set_chunk_alloc ##### -->
8344 <para>
8345 Set the mem_chunk size so it will hold @n_chunks of the objects of that @type.
8346 </para>
8347
8348 @type: There must be an unlocked TypeNode associated with this type otherwise nothing happens.
8349 @n_chunks:
8350
8351 <!-- ##### FUNCTION gtk_type_set_varargs_type ##### -->
8352 <para>
8353 Set the varargs type for a fundamental type @foreign_type.
8354 </para>
8355
8356 @foreign_type: Must be a GtkType with a sequence number of zero.  Must not be a
8357 fundamental type.
8358 @varargs_type: Must be a GtkType which is either structured or flag, or NONE.
8359
8360 <!-- ##### FUNCTION gtk_type_unique ##### -->
8361 <para>
8362 Creates a new, unique type.
8363 </para>
8364
8365 @parent_type: if zero, a fundamental type is created
8366 @gtkinfo: must not be %NULL, and @type_info->type_name must also not be %NULL
8367 @Returns: the new #GtkType
8368
8369 <!-- ##### FUNCTION gtk_widget_accelerator_signal ##### -->
8370 <para>
8371
8372 </para>
8373
8374 @widget:
8375 @accel_group:
8376 @accel_key:
8377 @accel_mods:
8378 @Returns:
8379
8380 <!-- ##### FUNCTION gtk_widget_accelerators_locked ##### -->
8381 <para>
8382
8383 </para>
8384
8385 @widget:
8386 @Returns:
8387
8388 <!-- ##### FUNCTION gtk_widget_activate_mnemonic ##### -->
8389 <para>
8390
8391 </para>
8392
8393 @widget:
8394 @group_cycling:
8395 @Returns:
8396
8397 <!-- ##### FUNCTION gtk_widget_get_usize ##### -->
8398 <para>
8399
8400 </para>
8401
8402 @widget:
8403 @width:
8404 @height:
8405
8406 <!-- ##### FUNCTION gtk_widget_lock_accelerators ##### -->
8407 <para>
8408
8409 </para>
8410
8411 @widget:
8412
8413 <!-- ##### FUNCTION gtk_widget_pop_style ##### -->
8414 <para>
8415
8416 </para>
8417
8418
8419 <!-- ##### FUNCTION gtk_widget_popup ##### -->
8420 <para>
8421
8422 </para>
8423
8424 @widget:
8425 @x:
8426 @y:
8427
8428 <!-- ##### FUNCTION gtk_widget_push_style ##### -->
8429 <para>
8430
8431 </para>
8432
8433 @style:
8434
8435 <!-- ##### FUNCTION gtk_widget_remove_accelerators ##### -->
8436 <para>
8437
8438 </para>
8439
8440 @widget:
8441 @accel_signal:
8442 @visible_only:
8443
8444 <!-- ##### FUNCTION gtk_widget_set_default_style ##### -->
8445 <para>
8446
8447 </para>
8448
8449 @style:
8450
8451 <!-- ##### FUNCTION gtk_widget_unlock_accelerators ##### -->
8452 <para>
8453
8454 </para>
8455
8456 @widget:
8457
8458 <!-- ##### FUNCTION gtk_window_activate_mnemonic ##### -->
8459 <para>
8460
8461 </para>
8462
8463 @window:
8464 @keyval:
8465 @modifier:
8466 @Returns:
8467
8468 <!-- ##### FUNCTION gtk_window_get_default ##### -->
8469 <para>
8470
8471 </para>
8472
8473 @window:
8474 @Returns:
8475
8476 <!-- ##### FUNCTION gtk_window_get_default_accel_group ##### -->
8477 <para>
8478
8479 </para>
8480
8481 @window:
8482 @Returns:
8483
8484 <!-- ##### FUNCTION gtk_window_get_resizeable ##### -->
8485 <para>
8486
8487 </para>
8488
8489 @window:
8490 @Returns:
8491
8492 <!-- ##### FUNCTION gtk_window_set_decorations_hint ##### -->
8493 <para>
8494
8495 </para>
8496
8497 @window:
8498 @decorations:
8499
8500 <!-- ##### FUNCTION gtk_window_set_functions_hint ##### -->
8501 <para>
8502
8503 </para>
8504
8505 @window:
8506 @functions:
8507
8508 <!-- ##### FUNCTION gtk_window_set_resizeable ##### -->
8509 <para>
8510
8511 </para>
8512
8513 @window:
8514 @setting:
8515 @resizeable:
8516