libs/gtkmm2/gtk/src/gtk_docs_override.xml

   1 <root>
   2 <function name="gtk_box_pack_start">
   3 <description>
   4 Left side insert a widget to a box.
   5 The expand argument to pack_start() or pack_end()
   6 controls whether the widgets are laid out in the box to fill in all
   7 the extra space in the box so the box is expanded to fill the area
   8 allocated to it (%TRUE). Or the box is shrunk to just fit the widgets
   9 (%FALSE).  Setting @expand to %FALSE will allow you to do right and left
  10 justifying of your widgets.  Otherwise, they will all expand to fit in
  11 the box, and the same effect could be achieved by using only one of
  12 pack_start() or pack_end() functions.
  13
  14 The @fill argument to the pack_start()/pack_end() functions control whether the
  15 extra space is allocated to the objects themselves (%TRUE), or as extra
  16 padding in the box around these objects (%FALSE). It only has an effect
  17 if the @expand argument is also %TRUE.
  18
  19 The difference between spacing (set when the box is created)
  20 and padding (set when elements are packed) is, that spacing is added between
  21 objects, and padding is added on either side of an object.
  22 </description>
  23 </function>
  24
  25 <function name="gtk_text_view_get_default_attributes">
  26 <description>
  27 Obtains a copy of the default text attributes. These are the
  28 attributes used for text unless a tag overrides them.
  29 You&apos;d typically pass the default attributes in to
  30 Gtk::TextIter::get_attributes() in order to get the
  31 attributes in effect at a given text position.
  32
  33 </description>
  34 <parameters>
  35 <parameter name="text_view">
  36 <parameter_description> a #GtkTextView
  37
  38 </parameter_description>
  39 </parameter>
  40 </parameters>
  41 <return> a new #Gtk::TextAttributes
  42 </return>
  43 </function>
  44
  45 <function name="gtk_label_get_label">
  46 <description>
  47 Fetches the text from a label widget including any embedded
  48 underlines indicating mnemonics and Pango markup. (See
  49 get_text ()).
  50 </description>
  51 <parameters>
  52 <parameter name="label">
  53 <parameter_description> a #GtkLabel
  54
  55 </parameter_description>
  56 </parameter>
  57 </parameters>
  58 <return> the text of the label widget..
  59 </return>
  60 </function>
  61
  62 <function name="gtk_label_get_text">
  63 <description>
  64 Fetches the text from a label widget, as displayed on the
  65 screen. This does not include any embedded underlines
  66 indicating mnemonics or Pango markup. (See get_label())
  67 </description>
  68 <parameters>
  69 <parameter name="label">
  70 <parameter_description> a #GtkLabel
  71 </parameter_description>
  72 </parameter>
  73 </parameters>
  74 <return> the text in the label widget.
  75 </return>
  76 </function>
  77
  78 <function name="gtk_label_get_layout">
  79 <description>
  80 Gets the #PangoLayout used to display the label.
  81 The layout is useful to e.g. convert text positions to
  82 pixel positions, in combination with gtk_label_get_layout_offsets().
  83 </description>
  84 <parameters>
  85 <parameter name="label">
  86 <parameter_description> a #GtkLabel
  87
  88 </parameter_description>
  89 </parameter>
  90 </parameters>
  91 <return> the #PangoLayout for this label
  92 </return>
  93 </function>
  94
  95 <function name="gtk_notebook_get_tab_label_text">
  96 <description>
  97 Retrieves the text of the tab label for the page containing
  98 @child.
  99 </description>
 100 <parameters>
 101 <parameter name="notebook">
 102 <parameter_description> a #GtkNotebook
 103
 104 </parameter_description>
 105 </parameter>
 106 <parameter name="child">
 107 <parameter_description> a widget contained in a page of @notebook
 108
 109 </parameter_description>
 110 </parameter>
 111 </parameters>
 112 <return>value: the text of the tab label.
 113 </return>
 114 </function>
 115
 116 <function name="gtk_notebook_get_menu_label_text">
 117 <description>
 118 Retrieves the text of the menu label for the page containing
 119 @child.
 120 </description>
 121 <parameters>
 122 <parameter name="notebook">
 123 <parameter_description> a #GtkNotebook
 124
 125 </parameter_description>
 126 </parameter>
 127 <parameter name="child">
 128 <parameter_description> the child widget of a page of the notebook.
 129
 130 </parameter_description>
 131 </parameter>
 132 </parameters>
 133 <return>value: the text of the tab label.
 134 </return>
 135 </function>
 136
 137 <function name="gtk_text_buffer_create_mark">
 138 <description>
 139 Creates a mark at position @where. The mark can be retrieved by name using
 140 gtk_text_buffer_get_mark (). If a mark has left gravity, and text is
 141 inserted at the mark&apos;s current location, the mark will be moved to
 142 the left of the newly-inserted text. If the mark has right gravity
 143 (@left_gravity = %FALSE), the mark will end up on the right of
 144 newly-inserted text. The standard left-to-right cursor is a mark
 145 with right gravity (when you type, the cursor stays on the right
 146 side of the text you&apos;re typing).
 147
 148 Emits the &quot;mark_set&quot; signal as notification of the mark&apos;s initial
 149 placement.
 150
 151
 152 </description>
 153 <parameters>
 154 <parameter name="buffer">
 155 <parameter_description> a #GtkTextBuffer
 156 </parameter_description>
 157 </parameter>
 158 <parameter name="mark_name">
 159 <parameter_description> name for mark, or %NULL
 160 </parameter_description>
 161 </parameter>
 162 <parameter name="where">
 163 <parameter_description> location to place mark
 164 </parameter_description>
 165 </parameter>
 166 <parameter name="left_gravity">
 167 <parameter_description> whether the mark has left gravity
 168 </parameter_description>
 169 </parameter>
 170 </parameters>
 171 <return> the new #GtkTextMark object
 172 </return>
 173 </function>
 174
 175
 176 <function name="gtk_text_buffer_delete_mark">
 177 <description>
 178 Deletes @mark, so that it&apos;s no longer located anywhere in the
 179 buffer. Removes the reference the buffer holds to the mark, so if
 180 you don't keep a Glib::RefPtr to the mark, it will be freed. Even
 181 if the mark isn&apos;t freed, most operations on @mark become
 182 invalid. There is no way to undelete a
 183 mark. gtk_text_mark_get_deleted () will return TRUE after this
 184 function has been called on a mark; gtk_text_mark_get_deleted ()
 185 indicates that a mark no longer belongs to a buffer. The &quot;mark_deleted&quot;
 186 signal will be emitted as notification after the mark is deleted.
 187 </description>
 188 <parameters>
 189 <parameter name="buffer">
 190 <parameter_description> a #GtkTextBuffer
 191
 192 </parameter_description>
 193 </parameter>
 194 <parameter name="mark">
 195 <parameter_description> a #GtkTextMark in @buffer
 196
 197 </parameter_description>
 198 </parameter>
 199 </parameters>
 200 <return></return>
 201 </function>
 202
 203 <function name="gtk_text_iter_get_tags">
 204 <description>
 205 Returns a list of tags that apply to @iter, in ascending order of
 206 priority (highest-priority tags are last).
 207 </description>
 208 <parameters>
 209 <parameter name="iter">
 210 <parameter_description> a #GtkTextIter
 211
 212 </parameter_description>
 213 </parameter>
 214 </parameters>
 215 <return> list of #GtkTextTag
 216 </return>
 217 </function>
 218
 219 <function name="gtk_text_view_get_tabs">
 220 <description>
 221 Gets the default tabs for @text_view. Tags in the buffer may
 222 override the defaults. The returned array will be empty if
 223 &quot;standard&quot; (8-space) tabs are used.
 224 </description>
 225 <parameters>
 226 <parameter name="text_view">
 227 <parameter_description> a #GtkTextView
 228
 229 </parameter_description>
 230 </parameter>
 231 </parameters>
 232 <return> copy of default tab array, or an empty array if &quot;standard&quot; tabs are used.
 233 </return>
 234 </function>
 235
 236
 237
 238 <function name="gtk_dialog_run">
 239 <description>
 240 Blocks in a recursive main loop until the @dialog emits the
 241 response signal. It returns the response ID from the &quot;response&quot; signal emission.
 242 Before entering the recursive main loop, gtk_dialog_run() calls
 243 Gtk::Widget::show() on the dialog for you. Note that you still
 244 need to show any children of the dialog yourself.
 245
 246 If the dialog receives &quot;delete_event&quot;,  Gtk::Dialog::run() will return
 247 #GTK_RESPONSE_DELETE_EVENT. Also, during Gtk::Dialog::run() the dialog will be
 248 modal. You can force Gtk::Dialog::run() to return at any time by
 249 calling Gtk::Dialog::response() to emit the &quot;response&quot;
 250 signal.
 251
 252 After Gtk::Dialog::run() returns, you are responsible for hiding or
 253 destroying the dialog if you wish to do so.
 254
 255 Typical usage of this function might be:
 256 &amp;lt;informalexample&amp;gt;&amp;lt;programlisting&amp;gt;
 257 gint result = dialog.run();
 258 switch (result)
 259 {
 260 case GTK_RESPONSE_ACCEPT:
 261 do_application_specific_something (&amp;lt;!-- --&amp;gt;);
 262 break;
 263 default:
 264 do_nothing_since_dialog_was_cancelled (&amp;lt;!-- --&amp;gt;);
 265 break;
 266 }
 267 &amp;lt;/programlisting&amp;gt;&amp;lt;/informalexample&amp;gt;
 268
 269
 270 </description>
 271 <parameters>
 272 <parameter name="dialog">
 273 <parameter_description> a #GtkDialog
 274 </parameter_description>
 275 </parameter>
 276 </parameters>
 277 <return> response ID
 278 </return>
 279 </function>
 280
 281 <function name="gtk_accel_label_set_accel_width">
 282 <description>
 283 Sets the widget to be monitored by this accelerator label.
 284 </description>
 285 <parameters>
 286 <parameter name="accel_label">
 287 <parameter_description> Ignored :)
 288 </parameter_description>
 289 </parameter>
 290 <parameter name="widget">
 291 <parameter_description> The Widget to be monitored.
 292 </parameter_description>
 293 </parameter>
 294 </parameters>
 295 <return></return>
 296 </function>
 297
 298 <function name="gtk_accel_label_get_accel_width">
 299 <description>
 300 Gets the width needed to display this accelerator label. This is used by menus to align all of the Gtk::MenuItem widgets, and shouldn't be needed by applications.
 301 </description>
 302 <parameters>
 303 </parameters>
 304 <return> width of this accelerator label.
 305 </return>
 306 </function>
 307
 308 <function name="gtk_accel_label_refetch">
 309 <description>
 310 Recreates the string representing the accelerator keys.
 311 </description>
 312 <parameters>
 313 </parameters>
 314 <return> always returns %FALSE.
 315 </return>
 316 </function>
 317
 318 <function name="gtk_adjustment_changed">
 319 <description>
 320 Emits a "changed" signal from the Adjustment.  This is typically called by the owner of the Adjustment after it has changed any of the Adjustment fields other than the value.
 321 </description>
 322 <parameters>
 323 </parameters>
 324 <return>
 325 </return>
 326 </function>
 327
 328 <function name="gtk_adjustment_value_changed">
 329 <description>
 330 Emits a "value_changed" signal from the Adjustment.  This is typically called by the owner of the Adjustment after it has changed the Adjustment value field.
 331 </description>
 332 <parameters>
 333 </parameters>
 334 <return>
 335 </return>
 336 </function>
 337
 338 <function name="gtk_adjustment_clamp_page">
 339 <description>
 340 Updates the Adjustment value to ensure that the range between the parameters @lower and @upper is in the current page (i.e. between @value and @value + @page_size).  If this range is larger than the page size, then only the start of it will be in the current page.  A "changed" signal will be emitted if the value is changed.
 341 </description>
 342 <parameters>
 343 <parameter name="adjustment">
 344 <parameter_description> Ignored :)
 345 </parameter_description>
 346 </parameter>
 347 <parameter name="upper">
 348 <parameter_description> The upper value.
 349 </parameter_description>
 350 </parameter>
 351 <parameter name="lower">
 352 <parameter_description> The lower value.
 353 </parameter_description>
 354 </parameter>
 355 </parameters>
 356 <return>
 357 </return>
 358 </function>
 359
 360 <function name="gtk_adjustment_set_value">
 361 <description>
 362 Sets the current value of the Adjustment
 363 </description>
 364 <parameters>
 365 <parameter name="adjustment">
 366 <parameter_description> Ignored :)
 367 </parameter_description>
 368 </parameter>
 369 <parameter name="value">
 370 <parameter_description> The new value of the Adjustment
 371 </parameter_description>
 372 </parameter>
 373 </parameters>
 374 <return></return>
 375 </function>
 376
 377 <function name="gtk_alignment_set">
 378 <description>
 379 Sets the Alignment values.
 380 </description>
 381 <parameters>
 382 <parameter name="alignment">
 383 <parameter_description> Ignored :)
 384 </parameter_description>
 385 </parameter>
 386 <parameter name="xalign">
 387 <parameter_description> The horizontal alignment of the child of this Alignment, from 0 (left) to 1 (right).
 388 </parameter_description>
 389 </parameter>
 390 <parameter name="yalign">
 391 <parameter_description> The vertical alignment of the child of this Alignment, from 0 (top) to 1 (bottom).
 392 </parameter_description>
 393 </parameter>
 394 <parameter name="xscale">
 395 <parameter_description> The amount that the child expands horizontally to fill up unused space, from 0 to 1.  A value of 0 indicates that the child widget should never expand.  A value of 1 indicates that the child widget will expand to fill all the space allocated for the Alignment.
 396 </parameter_description>
 397 </parameter>
 398 <parameter name="yscale">
 399 <parameter_description> The amount that the child widget expands vertically to fill up unused space from 0 to 1.  The values are similar to @xscale.
 400 </parameter_description>
 401 </parameter>
 402 </parameters>
 403 <return></return>
 404 </function>
 405
 406 <function name="gtk_arrow_set">
 407 <description>
 408 Sets the direction and shadow of this Arrow.
 409 </description>
 410 <parameters>
 411 <parameter name="arrow">
 412 <parameter_description> Ignored :)
 413 </parameter_description>
 414 </parameter>
 415 <parameter name="arrow_type">
 416 <parameter_description> A Gtk::ArrowType enum describing what arrow type to set this Arrow to.
 417 </parameter_description>
 418 </parameter>
 419 <parameter name="shadow_type">
 420 <parameter_description> A Gtk::ShadowType enum describing what shadow type to set this Arrow to.
 421 </parameter_description>
 422 </parameter>
 423 </parameters>
 424 <return></return>
 425 </function>
 426
 427
 428 <function name="gtk_text_child_anchor_get_widgets">
 429 <description>
 430 Gets a list of all widgets anchored at this child anchor.
 431
 432 </description>
 433 <parameters>
 434 <parameter name="anchor">
 435 <parameter_description> a #GtkTextChildAnchor
 436 </parameter_description>
 437 </parameter>
 438 </parameters>
 439 <return> list of widgets anchored at @anchor
 440 </return>
 441 </function>
 442
 443
 444 <function name="gtk_tree_model_get_path">
 445 <description>
 446 Returns a #GtkTreePath referenced by @iter.
 447
 448
 449 </description>
 450 <parameters>
 451 <parameter name="tree_model">
 452 <parameter_description> A #GtkTreeModel.
 453 </parameter_description>
 454 </parameter>
 455 <parameter name="iter">
 456 <parameter_description> The #GtkTreeIter.
 457 </parameter_description>
 458 </parameter>
 459 </parameters>
 460 <return> a #GtkTreePath.
 461 </return>
 462 </function>
 463
 464
 465 <function name="gtk_tree_view_column_get_cell_renderers">
 466 <description>
 467 Returns a list of all the cell renderers in the column,
 468 in no particular order.
 469
 470 </description>
 471 <parameters>
 472 <parameter name="tree_column">
 473 <parameter_description> A #GtkTreeViewColumn
 474 </parameter_description>
 475 </parameter>
 476 </parameters>
 477 <return> A list of #GtkCellRenderers
 478 </return>
 479 </function>
 480
 481
 482 <function name="gtk_tree_view_get_columns">
 483 <description>
 484 Returns a list of all the #GtkTreeViewColumn s currently in @tree_view.
 485
 486 </description>
 487 <parameters>
 488 <parameter name="tree_view">
 489 <parameter_description> A #GtkTreeView
 490 </parameter_description>
 491 </parameter>
 492 </parameters>
 493 <return> A list of #GtkTreeViewColumn s
 494 </return>
 495 </function>
 496
 497
 498 <function name="gtk_window_get_default_icon_list">
 499 <description>
 500 Gets the value set by Gtk::Window::set_default_icon_list().
 501
 502 </description>
 503 <parameters>
 504 </parameters>
 505 <return> copy of default icon list
 506 </return>
 507 </function>
 508
 509
 510 <function name="gtk_window_set_default">
 511 <description>
 512 The default widget is the widget that&apos;s activated when the user
 513 presses Enter in a dialog (for example). This function sets or
 514 unsets the default widget for a #GtkWindow. When setting
 515 (rather than unsetting) the default widget it&apos;s generally easier to
 516 call gtk_widget_grab_focus() on the widget. Before making a widget
 517 the default widget, you must set the #GTK_CAN_DEFAULT flag on the
 518 widget you&apos;d like to make the default using Gtk::Widget::set_flags().
 519
 520 </description>
 521 <parameters>
 522 <parameter name="window">
 523 <parameter_description> a #GtkWindow
 524 </parameter_description>
 525 </parameter>
 526 <parameter name="default_widget">
 527 <parameter_description> widget to be the default.
 528 </parameter_description>
 529 </parameter>
 530 </parameters>
 531 <return></return>
 532 </function>
 533
 534 <function name="gtk_menu_item_set_accel_path">
 535 <description>
 536 Set the accelerator path on @menu_item, through which runtime changes of the
 537 menu item&apos;s accelerator caused by the user can be identified and saved to
 538 persistant storage (see gtk_accel_map_save() on this).
 539 To setup a default accelerator for this menu item, call
 540 gtk_accel_map_add_entry() with the same @accel_path.
 541 See also gtk_accel_map_add_entry() on the specifics of accelerator paths,
 542 and gtk_menu_set_accel_path() for a more convenient variant of this function.
 543
 544 This function is basically a convenience wrapper that handles calling
 545 gtk_widget_set_accel_path() with the appropriate accelerator group for
 546 the menu item.
 547
 548 Note that you do need to set an accelerator on the parent menu with
 549 gtk_menu_set_accel_group() for this to work.
 550
 551 </description>
 552 <parameters>
 553 <parameter name="menu_item">
 554 <parameter_description>  a valid #GtkMenuItem
 555 </parameter_description>
 556 </parameter>
 557 <parameter name="accel_path">
 558 <parameter_description> accelerator path, corresponding to this menu item&apos;s
 559 functionality.
 560 </parameter_description>
 561 </parameter>
 562 </parameters>
 563 <return></return>
 564 </function>
 565
 566 <function name="gtk_notebook_append_page">
 567 <description>
 568 Appends a page to @notebook.
 569
 570 </description>
 571 <parameters>
 572 <parameter name="notebook">
 573 <parameter_description> a #GtkNotebook
 574 </parameter_description>
 575 </parameter>
 576 <parameter name="child">
 577 <parameter_description> the #GtkWidget to use as the contents of the page.
 578 </parameter_description>
 579 </parameter>
 580 <parameter name="tab_label">
 581 <parameter_description> the #GtkWidget to be used as the label for the page.
 582 </parameter_description>
 583 </parameter>
 584 </parameters>
 585 <return></return>
 586 </function>
 587
 588 <function name="gtk_notebook_append_page_menu">
 589 <description>
 590 Appends a page to @notebook, specifying the widget to use as the
 591 label in the popup menu.
 592
 593 </description>
 594 <parameters>
 595 <parameter name="notebook">
 596 <parameter_description> a #GtkNotebook
 597 </parameter_description>
 598 </parameter>
 599 <parameter name="child">
 600 <parameter_description> the #GtkWidget to use as the contents of the page.
 601 </parameter_description>
 602 </parameter>
 603 <parameter name="tab_label">
 604 <parameter_description> the #GtkWidget to be used as the label for the page.
 605 </parameter_description>
 606 </parameter>
 607 <parameter name="menu_label">
 608 <parameter_description> the widget to use as a label for the page-switch
 609 menu.
 610 </parameter_description>
 611 </parameter>
 612 </parameters>
 613 <return></return>
 614 </function>
 615
 616 <function name="gtk_notebook_insert_page">
 617 <description>
 618 Insert a page into @notebook at the given position
 619
 620 </description>
 621 <parameters>
 622 <parameter name="notebook">
 623 <parameter_description> a #GtkNotebook
 624 </parameter_description>
 625 </parameter>
 626 <parameter name="child">
 627 <parameter_description> the #GtkWidget to use as the contents of the page.
 628 </parameter_description>
 629 </parameter>
 630 <parameter name="tab_label">
 631 <parameter_description> the #GtkWidget to be used as the label for the page.
 632 </parameter_description>
 633 </parameter>
 634 <parameter name="position">
 635 <parameter_description> the index (starting at 0) at which to insert the page,
 636 or -1 to append the page after all other pages.
 637 </parameter_description>
 638 </parameter>
 639 </parameters>
 640 <return></return>
 641 </function>
 642
 643 <function name="gtk_notebook_insert_page_menu">
 644 <description>
 645 Insert a page into @notebook at the given position, specifying
 646 the widget to use as the label in the popup menu.
 647
 648 </description>
 649 <parameters>
 650 <parameter name="notebook">
 651 <parameter_description> a #GtkNotebook
 652 </parameter_description>
 653 </parameter>
 654 <parameter name="child">
 655 <parameter_description> the #GtkWidget to use as the contents of the page.
 656 </parameter_description>
 657 </parameter>
 658 <parameter name="tab_label">
 659 <parameter_description> the #GtkWidget to be used as the label for the page..
 660 </parameter_description>
 661 </parameter>
 662 <parameter name="menu_label">
 663 <parameter_description> the widget to use as a label for the page-switch
 664 menu.
 665 </parameter_description>
 666 </parameter>
 667 <parameter name="position">
 668 <parameter_description> the index (starting at 0) at which to insert the page,
 669 or -1 to append the page after all other pages.
 670 </parameter_description>
 671 </parameter>
 672 </parameters>
 673 <return></return>
 674 </function>
 675
 676 <function name="gtk_notebook_prepend_page">
 677 <description>
 678 Prepends a page to @notebook.
 679
 680 </description>
 681 <parameters>
 682 <parameter name="notebook">
 683 <parameter_description> a #GtkNotebook
 684 </parameter_description>
 685 </parameter>
 686 <parameter name="child">
 687 <parameter_description> the #GtkWidget to use as the contents of the page.
 688 </parameter_description>
 689 </parameter>
 690 <parameter name="tab_label">
 691 <parameter_description> the #GtkWidget to be used as the label for the page.
 692 </parameter_description>
 693 </parameter>
 694 </parameters>
 695 <return></return>
 696 </function>
 697
 698 <function name="gtk_notebook_prepend_page_menu">
 699 <description>
 700 Prepends a page to @notebook, specifying the widget to use as the
 701 label in the popup menu.
 702
 703 </description>
 704 <parameters>
 705 <parameter name="notebook">
 706 <parameter_description> a #GtkNotebook
 707 </parameter_description>
 708 </parameter>
 709 <parameter name="child">
 710 <parameter_description> the #GtkWidget to use as the contents of the page.
 711 </parameter_description>
 712 </parameter>
 713 <parameter name="tab_label">
 714 <parameter_description> the #GtkWidget to be used as the label for the page.
 715 </parameter_description>
 716 </parameter>
 717 <parameter name="menu_label">
 718 <parameter_description> the widget to use as a label for the page-switch
 719 menu.
 720 </parameter_description>
 721 </parameter>
 722 </parameters>
 723 <return></return>
 724 </function>
 725
 726 <function name="gtk_tree_view_get_background_area">
 727 <description>
 728 Fills the bounding rectangle in tree window coordinates for the cell at the
 729 row specified by @path and the column specified by @column.  The returned rectangle is equivalent to the
 730 @background_area passed to gtk_cell_renderer_render().  These background
 731 areas tile to cover the entire tree window (except for the area used for
 732 header buttons). Contrast with the @cell_area, returned by
 733 gtk_tree_view_get_cell_area(), which returns only the cell itself, excluding
 734 surrounding borders and the tree expander area.
 735
 736
 737 </description>
 738 <parameters>
 739 <parameter name="tree_view">
 740 <parameter_description> a #GtkTreeView
 741 </parameter_description>
 742 </parameter>
 743 <parameter name="path">
 744 <parameter_description> a #GtkTreePath for the row.
 745 </parameter_description>
 746 </parameter>
 747 <parameter name="column">
 748 <parameter_description> a #GtkTreeViewColumn for the column.
 749 </parameter_description>
 750 </parameter>
 751 <parameter name="rect">
 752 <parameter_description> rectangle to fill with cell background rect
 753 </parameter_description>
 754 </parameter>
 755 </parameters>
 756 <return></return>
 757 </function>
 758
 759 <function name="gtk_tree_view_get_cell_area">
 760 <description>
 761 Fills the bounding rectangle in tree window coordinates for the cell at the
 762 row specified by @path and the column specified by @column.  If @path points to a path not currently displayed, the @y and @height fields
 763 of the rectangle will be filled with 0.  The sum of all cell rects does not cover the
 764 entire tree; there are extra pixels in between rows, for example. The
 765 returned rectangle is equivalent to the @cell_area passed to
 766 gtk_cell_renderer_render().  This function is only valid if #tree_view is
 767 realized.
 768
 769 </description>
 770 <parameters>
 771 <parameter name="tree_view">
 772 <parameter_description> a #GtkTreeView
 773 </parameter_description>
 774 </parameter>
 775 <parameter name="path">
 776 <parameter_description> a #GtkTreePath for the row.
 777 </parameter_description>
 778 </parameter>
 779 <parameter name="column">
 780 <parameter_description> a #GtkTreeViewColumn for the column.
 781 </parameter_description>
 782 </parameter>
 783 <parameter name="rect">
 784 <parameter_description> rectangle to fill with cell rect
 785 </parameter_description>
 786 </parameter>
 787 </parameters>
 788 <return></return>
 789 </function>
 790
 791 <function name="gtk_widget_modify_base">
 792 <description>
 793 Sets the base color for a widget in a particular state.
 794 All other style values are left untouched. The base color
 795 is the background color used along with the text color
 796 (see gtk_widget_modify_text()) for widgets such as #GtkEntry
 797 and #GtkTextView. See also gtk_widget_modify_style().
 798
 799 </description>
 800 <parameters>
 801 <parameter name="widget">
 802 <parameter_description> a #GtkWidget.
 803 </parameter_description>
 804 </parameter>
 805 <parameter name="state">
 806 <parameter_description> the state for which to set the base color.
 807 </parameter_description>
 808 </parameter>
 809 <parameter name="color">
 810 <parameter_description> the color to assign (does not need to be allocated).
 811 </parameter_description>
 812 </parameter>
 813 </parameters>
 814 <return></return>
 815 </function>
 816
 817 <function name="gtk_widget_modify_bg">
 818 <description>
 819 Sets the background color for a widget in a particular state.  All
 820 other style values are left untouched. See also
 821 gtk_widget_modify_style().
 822
 823 </description>
 824 <parameters>
 825 <parameter name="widget">
 826 <parameter_description> a #GtkWidget.
 827 </parameter_description>
 828 </parameter>
 829 <parameter name="state">
 830 <parameter_description> the state for which to set the background color.
 831 </parameter_description>
 832 </parameter>
 833 <parameter name="color">
 834 <parameter_description> the color to assign (does not need to be allocated).
 835 </parameter_description>
 836 </parameter>
 837 </parameters>
 838 <return></return>
 839 </function>
 840
 841 <function name="gtk_widget_modify_fg">
 842 <description>
 843 Sets the foreground color for a widget in a particular state.  All
 844 other style values are left untouched. See also
 845 gtk_widget_modify_style().
 846
 847 </description>
 848 <parameters>
 849 <parameter name="widget">
 850 <parameter_description> a #GtkWidget.
 851 </parameter_description>
 852 </parameter>
 853 <parameter name="state">
 854 <parameter_description> the state for which to set the foreground color.
 855 </parameter_description>
 856 </parameter>
 857 <parameter name="color">
 858 <parameter_description> the color to assign (does not need to be allocated).
 859 </parameter_description>
 860 </parameter>
 861 </parameters>
 862 <return></return>
 863 </function>
 864
 865 <function name="gtk_widget_modify_font">
 866 <description>
 867 Sets the font to use for a widget.  All other style values are left
 868 untouched. See also gtk_widget_modify_style().
 869
 870 </description>
 871 <parameters>
 872 <parameter name="widget">
 873 <parameter_description> a #GtkWidget
 874 </parameter_description>
 875 </parameter>
 876 <parameter name="font_desc">
 877 <parameter_description> the font description to use.
 878 </parameter_description>
 879 </parameter>
 880 </parameters>
 881 <return></return>
 882 </function>
 883
 884 <function name="gtk_widget_modify_text">
 885 <description>
 886 Sets the text color for a widget in a particular state.  All other
 887 style values are left untouched. The text color is the foreground
 888 color used along with the base color (see gtk_widget_modify_base())
 889 for widgets such as #GtkEntry and #GtkTextView. See also
 890 gtk_widget_modify_style().
 891
 892 </description>
 893 <parameters>
 894 <parameter name="widget">
 895 <parameter_description> a #GtkWidget.
 896 </parameter_description>
 897 </parameter>
 898 <parameter name="state">
 899 <parameter_description> the state for which to set the text color.
 900 </parameter_description>
 901 </parameter>
 902 <parameter name="color">
 903 <parameter_description> the color to assign (does not need to be allocated).
 904 </parameter_description>
 905 </parameter>
 906 </parameters>
 907 <return></return>
 908 </function>
 909
 910 <function name="gtk_widget_set_style">
 911 <description>
 912 Sets the #GtkStyle for a widget (@widget-&amp;gt;style). You probably don&apos;t
 913 want to use this function; it interacts badly with themes, because
 914 themes work by replacing the #GtkStyle. Instead, use
 915 gtk_widget_modify_style().
 916
 917
 918 </description>
 919 <parameters>
 920 <parameter name="widget">
 921 <parameter_description> a #GtkWidget
 922 </parameter_description>
 923 </parameter>
 924 <parameter name="style">
 925 <parameter_description> a #GtkStyle.
 926 </parameter_description>
 927 </parameter>
 928 </parameters>
 929 <return></return>
 930 </function>
 931
 932 <function name="gtk_widget_shape_combine_mask">
 933 <description>
 934 Sets a shape for this widget&apos;s GDK window. This allows for
 935 transparent windows etc., see gdk_window_shape_combine_mask()
 936 for more information.
 937
 938 </description>
 939 <parameters>
 940 <parameter name="widget">
 941 <parameter_description> a #GtkWidget.
 942 </parameter_description>
 943 </parameter>
 944 <parameter name="shape_mask">
 945 <parameter_description> shape to be added.
 946 </parameter_description>
 947 </parameter>
 948 <parameter name="offset_x">
 949 <parameter_description> X position of shape mask with respect to @window.
 950 </parameter_description>
 951 </parameter>
 952 <parameter name="offset_y">
 953 <parameter_description> Y position of shape mask with respect to @window.
 954 </parameter_description>
 955 </parameter>
 956 </parameters>
 957 <return></return>
 958 </function>
 959
 960 <function name="gtk_window_set_default">
 961 <description>
 962 The default widget is the widget that&apos;s activated when the user
 963 presses Enter in a dialog (for example). This function sets the default widget for a #GtkWindow. When setting
 964 (rather than unsetting) the default widget it&apos;s generally easier to
 965 call gtk_widget_grab_focus() on the widget. Before making a widget
 966 the default widget, you must set the #GTK_CAN_DEFAULT flag on the
 967 widget you&apos;d like to make the default using GTK_WIDGET_SET_FLAGS().
 968
 969 </description>
 970 <parameters>
 971 <parameter name="window">
 972 <parameter_description> a #GtkWindow
 973 </parameter_description>
 974 </parameter>
 975 <parameter name="default_widget">
 976 <parameter_description> widget to be the default.
 977 </parameter_description>
 978 </parameter>
 979 </parameters>
 980 <return></return>
 981 </function>
 982
 983 <function name="gtk_window_set_focus">
 984 <description>
 985 If @focus is not the current focus widget, and is focusable, sets
 986 it as the focus widget for the window. To set the focus to a particular
 987 widget in the toplevel, it is usually more convenient to use
 988 gtk_widget_grab_focus() instead of this function.
 989
 990 </description>
 991 <parameters>
 992 <parameter name="window">
 993 <parameter_description> a #GtkWindow
 994 </parameter_description>
 995 </parameter>
 996 <parameter name="focus">
 997 <parameter_description> widget to be the new focus widget.
 998 </parameter_description>
 999 </parameter>
1000 </parameters>
1001 <return></return>
1002 </function>
1003
1004 <function name="gtk_drag_dest_find_target">
1005 <description>
1006 Looks for a match between @context-&amp;gt;targets and the
1007 @dest_target_list, returning the first matching target, otherwise
1008 returning %GDK_NONE. @dest_target_list should usually be the return
1009 value from gtk_drag_dest_get_target_list(), but some widgets may
1010 have different valid targets for different parts of the widget; in
1011 that case, they will have to implement a drag_motion handler that
1012 passes the correct target list to this function.
1013 </description>
1014 <parameters>
1015 <parameter name="widget">
1016 <parameter_description> drag destination widget
1017 </parameter_description>
1018 </parameter>
1019 <parameter name="context">
1020 <parameter_description> drag context
1021 </parameter_description>
1022 </parameter>
1023 <parameter name="target_list">
1024 <parameter_description> list of droppable targets.
1025 </parameter_description>
1026 </parameter>
1027 </parameters>
1028 <return> first target that the source offers and the dest can accept, or %GDK_NONE
1029 </return>
1030     <mapping class="Widget" />
1031 </function>
1032
1033 <function name="gdk_drawable_get_image">
1034 <description>
1035 A #GdkImage stores client-side image data (pixels). In contrast,
1036 #GdkPixmap and #GdkWindow are server-side
1037 objects. gdk_drawable_get_image() obtains the pixels from a
1038 server-side drawable as a client-side #GdkImage.  The format of a
1039 #GdkImage depends on the #GdkVisual of the current display, which
1040 makes manipulating #GdkImage extremely difficult; therefore, in
1041 most cases you should use the Gdk::Pixbuf constructor that takes a Gdk::Drawable instead of
1042 this lower-level function. A #GdkPixbuf contains image data in a
1043 canonicalized RGB format, rather than a display-dependent format.
1044 Of course, there&apos;s a convenience vs. speed tradeoff here, so you&apos;ll
1045 want to think about what makes sense for your application.
1046
1047 @x, @y, @width, and @height define the region of @drawable to
1048 obtain as an image.
1049
1050 You would usually copy image data to the client side if you intend
1051 to examine the values of individual pixels, for example to darken
1052 an image or add a red tint. It would be prohibitively slow to
1053 make a round-trip request to the windowing system for each pixel,
1054 so instead you get all of them at once, modify them, then copy
1055 them all back at once.
1056
1057 If the X server or other windowing system backend is on the local
1058 machine, this function may use shared memory to avoid copying
1059 the image data.
1060
1061 If the source drawable is a #GdkWindow and partially offscreen
1062 or obscured, then the obscured portions of the returned image
1063 will contain undefined data.
1064
1065
1066 </description>
1067 <parameters>
1068 <parameter name="drawable">
1069 <parameter_description> a #GdkDrawable
1070 </parameter_description>
1071 </parameter>
1072 <parameter name="x">
1073 <parameter_description> x coordinate on @drawable
1074 </parameter_description>
1075 </parameter>
1076 <parameter name="y">
1077 <parameter_description> y coordinate on @drawable
1078 </parameter_description>
1079 </parameter>
1080 <parameter name="width">
1081 <parameter_description> width of region to get
1082 </parameter_description>
1083 </parameter>
1084 <parameter name="height">
1085 <parameter_description> height or region to get
1086 </parameter_description>
1087 </parameter>
1088 </parameters>
1089 <return> a #GdkImage containing the contents of @drawable
1090 </return>
1091 </function>
1092
1093 <function name="gtk_clipboard_wait_for_text">
1094 <description>
1095 Requests the contents of the clipboard as text and converts
1096 the result to UTF-8 if necessary. This function waits for
1097 the data to be received using the main loop, so events,
1098 timeouts, etc, may be dispatched during the wait.
1099
1100
1101 </description>
1102 <parameters>
1103 <parameter name="clipboard">
1104 <parameter_description> a #GtkClipboard
1105 </parameter_description>
1106 </parameter>
1107 </parameters>
1108 <return> A UTF-8 string, which is empty if retrieving
1109 the selection data failed. (This could happen
1110 for various reasons, in particular if the
1111 clipboard was empty or if the contents of the
1112 clipboard could not be converted into text form.)
1113 </return>
1114 </function>
1115
1116 <function name="gtk_tree_path_to_string">
1117 <description>
1118 Generates a string representation of the path.  This string is a &apos;:&apos;
1119 separated list of numbers.  For example, &quot;4:10:0:3&quot; would be an acceptable return value for this string.
1120
1121
1122 </description>
1123 <parameters>
1124 <parameter name="path">
1125 <parameter_description> A #GtkTreePath
1126 </parameter_description>
1127 </parameter>
1128 </parameters>
1129 <return> The string.
1130 </return>
1131 </function>
1132
1133 <function name="gtk_tree_model_get_string_from_iter">
1134 <description>
1135 Generates a string representation of the iter. This string is a &apos;:&apos;
1136 separated list of numbers. For example, &quot;4:10:0:3&quot; would be an
1137 acceptable return value for this string.
1138
1139 @newin2p2
1140 </description>
1141 <parameters>
1142 <parameter name="tree_model">
1143 <parameter_description> A #GtkTreeModel.
1144 </parameter_description>
1145 </parameter>
1146 <parameter name="iter">
1147 <parameter_description> An #GtkTreeIter.
1148 </parameter_description>
1149 </parameter>
1150 </parameters>
1151 <return> The string.
1152 </return>
1153 </function>
1154
1155 <function name="gtk_paint_arrow">
1156     <mapping class="Style" />
1157 </function>
1158
1159 <function name="gtk_paint_box">
1160     <mapping class="Style" />
1161 </function>
1162
1163 <function name="gtk_paint_box_gap">
1164     <mapping class="Style" />
1165 </function>
1166
1167 <function name="gtk_paint_check">
1168     <mapping class="Style" />
1169 </function>
1170
1171 <function name="gtk_paint_diamond">
1172     <mapping class="Style" />
1173 </function>
1174
1175 <function name="gtk_paint_expander">
1176     <mapping class="Style" />
1177 </function>
1178
1179 <function name="gtk_paint_extension">
1180     <mapping class="Style" />
1181 </function>
1182
1183 <function name="gtk_paint_flat_box">
1184     <mapping class="Style" />
1185 </function>
1186
1187 <function name="gtk_paint_focus">
1188     <mapping class="Style" />
1189 </function>
1190
1191 <function name="gtk_paint_handle">
1192     <mapping class="Style" />
1193 </function>
1194
1195 <function name="gtk_paint_hline">
1196     <mapping class="Style" />
1197 </function>
1198
1199 <function name="gtk_paint_layout">
1200     <mapping class="Style" />
1201 </function>
1202
1203 <function name="gtk_paint_option">
1204     <mapping class="Style" />
1205 </function>
1206
1207 <function name="gtk_paint_polygon">
1208     <mapping class="Style" />
1209 </function>
1210
1211 <function name="gtk_paint_resize_grip">
1212     <mapping class="Style" />
1213 </function>
1214
1215 <function name="gtk_paint_shadow">
1216     <mapping class="Style" />
1217 </function>
1218
1219 <function name="gtk_paint_shadow_gap">
1220     <mapping class="Style" />
1221 </function>
1222
1223 <function name="gtk_paint_slider">
1224     <mapping class="Style" />
1225 </function>
1226
1227 <function name="gtk_paint_tab">
1228     <mapping class="Style" />
1229 </function>
1230
1231 <function name="gtk_paint_vline">
1232     <mapping class="Style" />
1233 </function>
1234
1235 <function name="gtk_window_set_icon_from_file">
1236 <description>
1237 Sets the icon for the window.
1238
1239 This function is equivalent to calling gtk_window_set_icon()
1240 with a pixbuf created by loading the image from @filename.
1241 </description>
1242 <parameters>
1243 <parameter name="window">
1244 <parameter_description> a #GtkWindow
1245 </parameter_description>
1246 </parameter>
1247 <parameter name="filename">
1248 <parameter_description> location of icon file
1249 </parameter_description>
1250 </parameter>
1251 </parameters>
1252 </function>
1253
1254 <function name="gtk_window_get_position">
1255 <parameters>
1256 <parameter name="window">
1257 <parameter_description> a #GtkWindow
1258 </parameter_description>
1259 </parameter>
1260 <parameter name="root_x">
1261 <parameter_description> return location for X coordinate of gravity-determined reference point
1262 </parameter_description>
1263 </parameter>
1264 <parameter name="root_y">
1265 <parameter_description> return location for Y coordinate of gravity-determined reference point
1266 </parameter_description>
1267 </parameter>
1268 </parameters>
1269 </function>
1270
1271 <function name="gtk_window_set_default_icon_from_file">
1272 <parameters>
1273 <parameter name="filename">
1274 <parameter_description> location of icon file
1275 </parameter_description>
1276 </parameter>
1277 </parameters>
1278 </function>
1279
1280 <function name="gtk_widget_style_get_property">
1281 <parameters>
1282 <parameter name="widget">
1283 <parameter_description> a #GtkWidget
1284 </parameter_description>
1285 </parameter>
1286 <parameter name="the_property_name">
1287 <parameter_description> the name of a style property
1288 </parameter_description>
1289 </parameter>
1290 <parameter name="value">
1291 <parameter_description> location to return the property value
1292 </parameter_description>
1293 </parameter>
1294 </parameters>
1295 </function>
1296
1297 <function name="gtk_drag_dest_get_target_list">
1298     <mapping class="Widget" />
1299 </function>
1300
1301 <function name="gtk_drag_source_set_icon">
1302     <mapping class="Widget" />
1303 </function>
1304
1305 <function name="gtk_drag_source_set_icon_pixbuf">
1306     <mapping class="Widget" />
1307 </function>
1308
1309 <function name="gtk_drag_source_set_icon_stock">
1310     <mapping class="Widget" />
1311 </function>
1312
1313 <function name="gtk_drag_begin">
1314     <mapping class="Widget" />
1315 </function>
1316
1317 <function name="gtk_drag_check_threshold">
1318     <mapping class="Widget" />
1319 </function>
1320
1321 <function name="gtk_drag_dest_set_target_list">
1322     <mapping class="Widget" />
1323 </function>
1324
1325 <function name="gtk_ui_manager_add_ui_from_file">
1326 <parameters>
1327 <parameter name="self">
1328 <parameter_description> a #GtkUIManager object
1329 </parameter_description>
1330 </parameter>
1331 <parameter name="filename">
1332 <parameter_description> the name of the file to parse
1333 </parameter_description>
1334 </parameter>
1335 </parameters>
1336 </function>
1337
1338 <function name="gtk_icon_theme_load_icon">
1339 <parameters>
1340 <parameter name="icon_theme">
1341 <parameter_description> a #GtkIconTheme
1342 </parameter_description>
1343 </parameter>
1344 <parameter name="icon_name">
1345 <parameter_description> the name of the icon to lookup
1346 </parameter_description>
1347 </parameter>
1348 <parameter name="size">
1349 <parameter_description> the desired icon size. The resulting icon may not be exactly this size; see gtk_icon_info_load_icon().
1350 </parameter_description>
1351 </parameter>
1352 <parameter name="flags">
1353 <parameter_description> flags modifying the behavior of the icon lookup
1354 </parameter_description>
1355 </parameter>
1356 </parameters>
1357 </function>
1358
1359 <function name="gtk_icon_theme_get_example_icon_name">
1360 <description>
1361 Gets the name of an icon that is representative of the
1362 current theme (for instance, to use when presenting
1363 a list of themes to the user.)
1364
1365 Since: 2.4
1366 </description>
1367 <parameters>
1368 <parameter name="icon_theme">
1369 <parameter_description> a #GtkIconTheme
1370 </parameter_description>
1371 </parameter>
1372 </parameters>
1373 <return>
1374 </return>
1375 </function>
1376
1377 <function name="gtk_file_chooser_add_shortcut_folder">
1378 <parameters>
1379 <parameter name="chooser">
1380 <parameter_description> a #GtkFileChooser
1381 </parameter_description>
1382 </parameter>
1383 <parameter name="folder">
1384 <parameter_description> filename of the folder to add
1385 </parameter_description>
1386 </parameter>
1387 </parameters>
1388 </function>
1389
1390 <function name="gtk_file_chooser_remove_shortcut_folder">
1391 <parameters>
1392 <parameter name="chooser">
1393 <parameter_description> a #GtkFileChooser
1394 </parameter_description>
1395 </parameter>
1396 <parameter name="folder">
1397 <parameter_description> filename of the folder to remove
1398 </parameter_description>
1399 </parameter>
1400 </parameters>
1401 </function>
1402
1403 <function name="gtk_file_chooser_add_shortcut_folder_uri">
1404 <parameters>
1405 <parameter name="chooser">
1406 <parameter_description> a #GtkFileChooser
1407 </parameter_description>
1408 </parameter>
1409 <parameter name="uri">
1410 <parameter_description> URI of the folder to add
1411 </parameter_description>
1412 </parameter>
1413 </parameters>
1414 </function>
1415
1416 <function name="gtk_file_chooser_remove_shortcut_folder_uri">
1417 <parameters>
1418 <parameter name="chooser">
1419 <parameter_description> a #GtkFileChooser
1420 </parameter_description>
1421 </parameter>
1422 <parameter name="uri">
1423 <parameter_description> URI of the folder to remove
1424 </parameter_description>
1425 </parameter>
1426 </parameters>
1427 </function>
1428
1429 <function name="gtk_tree_view_move_column_after">
1430 <description>
1431 Moves @column to be after to @base_column.  See also move_column_to_start().
1432
1433 </description>
1434 <parameters>
1435 <parameter name="tree_view">
1436 <parameter_description> A #GtkTreeView
1437 </parameter_description>
1438 </parameter>
1439 <parameter name="column">
1440 <parameter_description> The #GtkTreeViewColumn to be moved.
1441 </parameter_description>
1442 </parameter>
1443 <parameter name="base_column">
1444 <parameter_description> The #GtkTreeViewColumn to be moved relative to.
1445 </parameter_description>
1446 </parameter>
1447 </parameters>
1448 <return></return>
1449 </function>
1450
1451 <function name="gtk_cell_renderer_get_size">
1452 <description>
1453 Obtains the width and height needed to render the cell. Used by view widgets
1454 to determine the appropriate size for the cell_area passed to
1455 gtk_cell_renderer_render().  Fills in the x and y
1456 offsets of the cell relative to this location.  Please note that the
1457 values set in @width and @height, as well as those in @x_offset and @y_offset
1458 are inclusive of the xpad and ypad properties.
1459
1460 </description>
1461 <parameters>
1462 <parameter name="cell">
1463 <parameter_description> a #GtkCellRenderer
1464 </parameter_description>
1465 </parameter>
1466 <parameter name="widget">
1467 <parameter_description> the widget the renderer is rendering to
1468 </parameter_description>
1469 </parameter>
1470 <parameter name="cell_area">
1471 <parameter_description> The area a cell will be allocated.
1472 </parameter_description>
1473 </parameter>
1474 <parameter name="x_offset">
1475 <parameter_description> location to return x offset of cell relative to @cell_area.
1476 </parameter_description>
1477 </parameter>
1478 <parameter name="y_offset">
1479 <parameter_description> location to return y offset of cell relative to @cell_area.
1480 </parameter_description>
1481 </parameter>
1482 <parameter name="width">
1483 <parameter_description> location to return width needed to render a cell.
1484 </parameter_description>
1485 </parameter>
1486 <parameter name="height">
1487 <parameter_description> location to return height needed to render a cell.
1488 </parameter_description>
1489 </parameter>
1490 </parameters>
1491 <return></return>
1492 </function>
1493
1494 <function name="gtk_menu_popup">
1495 <description>
1496 Displays a menu and makes it available for selection.  Applications can use
1497 this function to display context-sensitive menus. The default menu positioning function will position the menu
1498 at the current mouse cursor position.
1499
1500 The @button parameter should be the mouse button pressed to initiate
1501 the menu popup. If the menu popup was initiated by something other than
1502 a mouse button press, such as a mouse button release or a keypress,
1503 @button should be 0.
1504
1505 The @activate_time parameter should be the time stamp of the event that
1506 initiated the popup. If such an event is not available, use
1507 gtk_get_current_event_time() instead.
1508
1509
1510 </description>
1511 <parameters>
1512 <parameter name="menu">
1513 <parameter_description> a #GtkMenu.
1514 </parameter_description>
1515 </parameter>
1516 <parameter name="parent_menu_shell">
1517 <parameter_description> the menu shell containing the triggering menu item.
1518 </parameter_description>
1519 </parameter>
1520 <parameter name="parent_menu_item">
1521 <parameter_description> the menu item whose activation triggered the popup.
1522 </parameter_description>
1523 </parameter>
1524 <parameter name="func">
1525 <parameter_description> a user supplied function used to position the menu, or %NULL
1526 </parameter_description>
1527 </parameter>
1528 <parameter name="data">
1529 <parameter_description> user supplied data to be passed to @func.
1530 </parameter_description>
1531 </parameter>
1532 <parameter name="button">
1533 <parameter_description> the mouse button which was pressed to initiate the event.
1534 </parameter_description>
1535 </parameter>
1536 <parameter name="activate_time">
1537 <parameter_description> the time at which the activation event occurred.
1538 </parameter_description>
1539 </parameter>
1540 </parameters>
1541 <return></return>
1542 </function>
1543
1544 <function name="gtk_tree_view_column_cell_get_size">
1545 <description>
1546 Obtains the width and height needed to render the column.  This is used
1547 primarily by the #GtkTreeView.
1548
1549 </description>
1550 <parameters>
1551 <parameter name="tree_column">
1552 <parameter_description> A #GtkTreeViewColumn.
1553 </parameter_description>
1554 </parameter>
1555 <parameter name="cell_area">
1556 <parameter_description> The area a cell in the column will be allocated.
1557 </parameter_description>
1558 </parameter>
1559 <parameter name="x_offset">
1560 <parameter_description> location to return x offset of a cell relative to @cell_area.
1561 </parameter_description>
1562 </parameter>
1563 <parameter name="y_offset">
1564 <parameter_description> location to return y offset of a cell relative to @cell_area.
1565 </parameter_description>
1566 </parameter>
1567 <parameter name="width">
1568 <parameter_description> location to return width needed to render a cell.
1569 </parameter_description>
1570 </parameter>
1571 <parameter name="height">
1572 <parameter_description> location to return height needed to render a cell.
1573 </parameter_description>
1574 </parameter>
1575 </parameters>
1576 <return></return>
1577 </function>
1578
1579
1580 <function name="gtk_tree_view_column_cell_get_position">
1581 <description>
1582 Obtains the horizontal position and size of a cell in a column. If the
1583 cell is not found in the column, @start_pos and @width are not changed and
1584 %FALSE is returned.
1585
1586
1587 </description>
1588 <parameters>
1589 <parameter name="tree_column">
1590 <parameter_description> a #GtkTreeViewColumn
1591 </parameter_description>
1592 </parameter>
1593 <parameter name="cell_renderer">
1594 <parameter_description> a #GtkCellRenderer
1595 </parameter_description>
1596 </parameter>
1597 <parameter name="start_pos">
1598 <parameter_description> return location for the horizontal position of @cell within
1599 @tree_column.
1600 </parameter_description>
1601 </parameter>
1602 <parameter name="width">
1603 <parameter_description> return location for the width of @cell.
1604 </parameter_description>
1605 </parameter>
1606 </parameters>
1607 <return> %TRUE if @cell belongs to @tree_column.
1608 </return>
1609 </function>
1610
1611 <function name="gtk_tree_view_set_vadjustment">
1612 <description>
1613 Sets the #GtkAdjustment for the current vertical aspect. See also unset_vadjustment().
1614
1615 </description>
1616 <parameters>
1617 <parameter name="tree_view">
1618 <parameter_description> A #GtkTreeView
1619 </parameter_description>
1620 </parameter>
1621 <parameter name="adjustment">
1622 <parameter_description> The #GtkAdjustment to set.
1623 </parameter_description>
1624 </parameter>
1625 </parameters>
1626 <return></return>
1627 </function>
1628
1629 <function name="gtk_tree_view_set_hadjustment">
1630 <description>
1631 Sets the #GtkAdjustment for the current horizontal aspect. See also unset_hadjustment().
1632
1633 </description>
1634 <parameters>
1635 <parameter name="tree_view">
1636 <parameter_description> A #GtkTreeView
1637 </parameter_description>
1638 </parameter>
1639 <parameter name="adjustment">
1640 <parameter_description> The #GtkAdjustment to set.
1641 </parameter_description>
1642 </parameter>
1643 </parameters>
1644 <return></return>
1645 </function>
1646
1647 <function name="gtk_tree_view_set_expander_column">
1648 <description>
1649 Sets the column to draw the expander arrow at. It must be in the TreeView.  See also reset_expander_column().
1650
1651 </description>
1652 <parameters>
1653 <parameter name="tree_view">
1654 <parameter_description> A #GtkTreeView
1655 </parameter_description>
1656 </parameter>
1657 <parameter name="column">
1658 <parameter_description>The column to draw the expander arrow at.
1659 </parameter_description>
1660 </parameter>
1661 </parameters>
1662 <return></return>
1663 </function>
1664
1665 <function name="gtk_tree_view_set_cursor">
1666 <description>
1667 Sets the current keyboard focus to be at @path, and selects it.  This is
1668 useful when you want to focus the user&apos;s attention on a particular row. Focus is given to the column specified.
1669 Additionally, if @start_editing is
1670 %TRUE, then editing should be started in the specified cell.
1671 This function is often followed by Gtk::Widget::grab_focus(@tree_view)
1672 in order to give keyboard focus to the widget.  Please note that editing
1673 can only happen when the widget is realized.
1674
1675 </description>
1676 <parameters>
1677 <parameter name="tree_view">
1678 <parameter_description> A #GtkTreeView
1679 </parameter_description>
1680 </parameter>
1681 <parameter name="path">
1682 <parameter_description> A #GtkTreePath
1683 </parameter_description>
1684 </parameter>
1685 <parameter name="focus_column">
1686 <parameter_description> A #GtkTreeViewColumn.
1687 </parameter_description>
1688 </parameter>
1689 <parameter name="start_editing">
1690 <parameter_description> %TRUE if the specified cell should start being edited.
1691 </parameter_description>
1692 </parameter>
1693 </parameters>
1694 <return></return>
1695 </function>
1696
1697 <function name="gtk_ui_manager_add_ui">
1698 <description>
1699 Adds a UI element to the current contents of @self.
1700
1701 If @type is %GTK_UI_MANAGER_AUTO, GTK+ inserts a menuitem, toolitem or
1702 separator if such an element can be inserted at the place determined by
1703 @path. Otherwise @type must indicate an element that can be inserted at
1704 the place determined by @path.
1705
1706 @see add_ui_separator().
1707
1708 @newin2p4
1709
1710 </description>
1711 <parameters>
1712 <parameter name="self">
1713 <parameter_description> a #GtkUIManager
1714 </parameter_description>
1715 </parameter>
1716 <parameter name="merge_id">
1717 <parameter_description> the merge id for the merged UI, see gtk_ui_manager_new_merge_id()
1718 </parameter_description>
1719 </parameter>
1720 <parameter name="path">
1721 <parameter_description> a path
1722 </parameter_description>
1723 </parameter>
1724 <parameter name="name">
1725 <parameter_description> the name for the added UI element
1726 </parameter_description>
1727 </parameter>
1728 <parameter name="action">
1729 <parameter_description> the name of the action to be proxied, if this is not a separator.
1730 </parameter_description>
1731 </parameter>
1732 <parameter name="type">
1733 <parameter_description> the type of UI element to add.
1734 </parameter_description>
1735 </parameter>
1736 <parameter name="top">
1737 <parameter_description> if %TRUE, the UI element is added before its siblings, otherwise it
1738 is added after its siblings.
1739 </parameter_description>
1740 </parameter>
1741 </parameters>
1742 <return></return>
1743 </function>
1744
1745 <function name="gtk_window_get_frame_dimensions">
1746 <parameters>
1747 <parameter name="window">
1748 <parameter_description> a #GtkWindow
1749 </parameter_description>
1750 </parameter>
1751 <parameter name="left">
1752 <parameter_description> location to store the width of the frame at the left.
1753 </parameter_description>
1754 </parameter>
1755 <parameter name="top">
1756 <parameter_description> location to store the height of the frame at the top.
1757 </parameter_description>
1758 </parameter>
1759 <parameter name="right">
1760 <parameter_description> location to store the width of the frame at the returns.
1761 </parameter_description>
1762 </parameter>
1763 <parameter name="bottom">
1764 <parameter_description> location to store the height of the frame at the bottom.
1765 </parameter_description>
1766 </parameter>
1767 </parameters>
1768 <return></return>
1769 </function>
1770
1771 <function name="gtk_window_get_default_size">
1772 <parameters>
1773 <parameter name="window">
1774 <parameter_description> a #GtkWindow
1775 </parameter_description>
1776 </parameter>
1777 <parameter name="width">
1778 <parameter_description> location to store the default width.
1779 </parameter_description>
1780 </parameter>
1781 <parameter name="height">
1782 <parameter_description> location to store the default height.
1783 </parameter_description>
1784 </parameter>
1785 </parameters>
1786 <return></return>
1787 </function>
1788
1789 <function name="gtk_window_get_size">
1790
1791 <parameters>
1792 <parameter name="window">
1793 <parameter_description> a #GtkWindow
1794 </parameter_description>
1795 </parameter>
1796 <parameter name="width">
1797 <parameter_description> return location for width.
1798 </parameter_description>
1799 </parameter>
1800 <parameter name="height">
1801 <parameter_description> return location for height.
1802 </parameter_description>
1803 </parameter>
1804 </parameters>
1805 <return></return>
1806 </function>
1807
1808 <function name="gtk_icon_info_get_filename">
1809 <parameters>
1810 <parameter name="icon_info">
1811 <parameter_description> a #GtkIconInfo
1812 </parameter_description>
1813 </parameter>
1814 </parameters>
1815 <return> the filename for the icon, or %NULL
1816 if gtk_icon_info_get_builtin_pixbuf() should
1817 be used instead.
1818 </return>
1819 </function>
1820
1821 <function name="gtk_icon_info_get_builtin_pixbuf">
1822 <parameters>
1823 <parameter name="icon_info">
1824 <parameter_description> a #GtkIconInfo structure
1825 </parameter_description>
1826 </parameter>
1827 </parameters>
1828 <return> the built-in image pixbuf, or %NULL.
1829 The returned image must not be modified.
1830 </return>
1831 </function>
1832
1833 <function name="gtk_file_chooser_get_preview_filename">
1834 <parameters>
1835 <parameter name="chooser">
1836 <parameter_description> a #GtkFileChooser
1837 </parameter_description>
1838 </parameter>
1839 </parameters>
1840 <return> the filename to preview, or an empty string if no file
1841 is selected, or if the selected file cannot be represented
1842 as a local filename.
1843 </return>
1844 </function>
1845
1846 <function name="gtk_file_chooser_get_preview_uri">
1847 <parameters>
1848 <parameter name="chooser">
1849 <parameter_description> a #GtkFileChooser
1850 </parameter_description>
1851 </parameter>
1852 </parameters>
1853 <return> the URI for the file to preview, or an empty string if no file is
1854 selected.
1855 </return>
1856 </function>
1857
1858 <function name="gtk_file_chooser_get_current_folder_uri">
1859 <parameters>
1860 <parameter name="chooser">
1861 <parameter_description> a #GtkFileChooser
1862 </parameter_description>
1863 </parameter>
1864 </parameters>
1865 <return> the URI for the current folder.
1866 </return>
1867 </function>
1868
1869 <function name="gtk_file_chooser_get_uri">
1870 <parameters>
1871 <parameter name="chooser">
1872 <parameter_description> a #GtkFileChooser
1873 </parameter_description>
1874 </parameter>
1875 </parameters>
1876 <return> The currently selected URI, or an empty string
1877 if no file is selected.
1878 </return>
1879 </function>
1880
1881 <function name="gtk_file_chooser_get_filename">
1882 <parameters>
1883 <parameter name="chooser">
1884 <parameter_description> a #GtkFileChooser
1885 </parameter_description>
1886 </parameter>
1887 </parameters>
1888 <return> The currently selected filename, or an empty string
1889 if no file is selected, or the selected file can&apos;t
1890 be represented with a local filename.
1891 </return>
1892 </function>
1893
1894 <function name="gtk_cell_renderer_get_fixed_size">
1895 <parameters>
1896 <parameter name="cell">
1897 <parameter_description> A #GtkCellRenderer
1898 </parameter_description>
1899 </parameter>
1900 <parameter name="width">
1901 <parameter_description> location to fill in with the fixed width of the widget.
1902 </parameter_description>
1903 </parameter>
1904 <parameter name="height">
1905 <parameter_description> location to fill in with the fixed height of the widget.
1906 </parameter_description>
1907 </parameter>
1908 </parameters>
1909 <return></return>
1910 </function>
1911
1912 <function name="gtk_text_iter_forward_search">
1913 <description>
1914 Searches forward for @str. Any match is returned by setting
1915 @match_start to the first character of the match and @match_end to the
1916 first character after the match. The search will not continue past
1917 @limit. Note that a search is a linear or O(n) operation, so you
1918 may wish to use @limit to avoid locking up your UI on large
1919 buffers.
1920
1921 If the #GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may
1922 have invisible text interspersed in @str. i.e. @str will be a
1923 possibly-noncontiguous subsequence of the matched range. similarly,
1924 if you specify #GTK_TEXT_SEARCH_TEXT_ONLY, the match may have
1925 pixbufs or child widgets mixed inside the matched range. If these
1926 flags are not given, the match must be exact; the special 0xFFFC
1927 character in @str will match embedded pixbufs or child widgets.
1928 </description>
1929 <parameters>
1930 <parameter name="iter">
1931 <parameter_description> start of search
1932 </parameter_description>
1933 </parameter>
1934 <parameter name="str">
1935 <parameter_description> a search string
1936 </parameter_description>
1937 </parameter>
1938 <parameter name="flags">
1939 <parameter_description> flags affecting how the search is done
1940 </parameter_description>
1941 </parameter>
1942 <parameter name="match_start">
1943 <parameter_description> return location for start of match
1944 </parameter_description>
1945 </parameter>
1946 <parameter name="match_end">
1947 <parameter_description> return location for end of match
1948 </parameter_description>
1949 </parameter>
1950 <parameter name="limit">
1951 <parameter_description> bound for the search
1952 </parameter_description>
1953 </parameter>
1954 </parameters>
1955 <return> whether a match was found
1956 </return>
1957 </function>
1958
1959
1960 <function name="gtk_text_iter_backward_search">
1961 <description>
1962 Same as gtk_text_iter_forward_search(), but moves backward.
1963 </description>
1964 <parameters>
1965 <parameter name="iter">
1966 <parameter_description> a #GtkTextIter where the search begins
1967 </parameter_description>
1968 </parameter>
1969 <parameter name="str">
1970 <parameter_description> search string
1971 </parameter_description>
1972 </parameter>
1973 <parameter name="flags">
1974 <parameter_description> bitmask of flags affecting the search
1975 </parameter_description>
1976 </parameter>
1977 <parameter name="match_start">
1978 <parameter_description> return location for start of match
1979 </parameter_description>
1980 </parameter>
1981 <parameter name="match_end">
1982 <parameter_description> return location for end of match
1983 </parameter_description>
1984 </parameter>
1985 <parameter name="limit">
1986 <parameter_description> location of last possible @match_start
1987 </parameter_description>
1988 </parameter>
1989 </parameters>
1990 <return> whether a match was found
1991 </return>
1992 </function>
1993
1994 <function name="gtk_button_get_image">
1995   <description>
1996     Gets the widget that is currenty set as the image of @button.
1997     This may have been explicitly set by set_image()
1998     or specified as a stock item to the constructor.
1999
2000     @newin2p6
2001
2002   </description>
2003   <parameters>
2004     <parameter name="button">
2005       <parameter_description> a #GtkButton
2006       </parameter_description>
2007     </parameter>
2008   </parameters>
2009   <return></return>
2010 </function>
2011
2012
2013 <function name="gtk_image_set_from_stock">
2014   <description>
2015     See the Image::Image(const Gtk::StockID&amp; stock_id, IconSize size) constructor for details.
2016   </description>
2017   <parameters>
2018     <parameter name="image">
2019       <parameter_description> a #GtkImage
2020       </parameter_description>
2021     </parameter>
2022     <parameter name="stock_id">
2023       <parameter_description> a stock icon name
2024       </parameter_description>
2025     </parameter>
2026     <parameter name="size">
2027       <parameter_description> a stock icon size
2028       </parameter_description>
2029     </parameter>
2030   </parameters>
2031   <return></return>
2032 </function>
2033
2034 <function name="gtk_icon_factory_add_default">
2035   <description>
2036     Adds an icon factory to the list of icon factories searched by
2037     gtk_style_lookup_icon_set(). This means that, for example,
2038     the Image::Image(const Gtk::StockID&amp; stock_id, IconSize size) constructor will be able to find icons in @factory.
2039     There will normally be an icon factory added for each library or
2040     application that comes with icons. The default icon factories
2041     can be overridden by themes.
2042   </description>
2043   <parameters>
2044     <parameter name="factory">
2045       <parameter_description> a #GtkIconFactory
2046       </parameter_description>
2047     </parameter>
2048   </parameters>
2049   <return></return>
2050 </function>
2051
2052 <function name="gtk_tool_button_set_stock_id">
2053   <description>
2054     Sets the name of the stock item. See the ToolButton::ToolButton(const Gtk::StockID&amp; stock_id, IconSize size) constructor.
2055     The stock_id property only has an effect if not
2056     overridden by &quot;label&quot; and &quot;icon_widget&quot; properties.
2057
2058     @newin2p4
2059
2060   </description>
2061   <parameters>
2062     <parameter name="button">
2063       <parameter_description> a #GtkToolButton
2064       </parameter_description>
2065     </parameter>
2066     <parameter name="stock_id">
2067       <parameter_description> a name of a stock item, or %NULL
2068       </parameter_description>
2069     </parameter>
2070   </parameters>
2071   <return></return>
2072 </function>
2073
2074 <function name="gtk_image_get_icon_name">
2075 <description>
2076 Gets the icon name and size being displayed by the #GtkImage.
2077 The storage type of the image must be %GTK_IMAGE_EMPTY or
2078 %GTK_IMAGE_ICON_NAME (see gtk_image_get_storage_type()).
2079
2080 Since: 2.6
2081
2082 </description>
2083 <parameters>
2084 <parameter name="image">
2085 <parameter_description> a #GtkImage
2086 </parameter_description>
2087 </parameter>
2088 <parameter name="icon_name">
2089 <parameter_description> place to store an icon name
2090 </parameter_description>
2091 </parameter>
2092 <parameter name="size">
2093 <parameter_description> place to store an icon size
2094 </parameter_description>
2095 </parameter>
2096 </parameters>
2097 <return></return>
2098 </function>
2099
2100 <function name="gtk_progress_bar_get_text">
2101 <description>
2102 Retrieves the text displayed superimposed on the progress bar,
2103 if any.
2104
2105
2106 </description>
2107 <parameters>
2108 <parameter name="pbar">
2109 <parameter_description> a #GtkProgressBar
2110 </parameter_description>
2111 </parameter>
2112 </parameters>
2113 <return> text.
2114 </return>
2115 </function>
2116
2117 <function name="gtk_color_button_get_title">
2118 <description>
2119 Gets the title of the color selection dialog.
2120
2121 Since: 2.4
2122 </description>
2123 <parameters>
2124 <parameter name="color_button">
2125 <parameter_description> a #GtkColorButton
2126 </parameter_description>
2127 </parameter>
2128 </parameters>
2129 <return>The title
2130 </return>
2131 </function>
2132
2133 <function name="gtk_file_chooser_get_current_folder">
2134 <description>
2135 Gets the current folder of @chooser as a local filename.
2136 See gtk_file_chooser_set_current_folder().
2137
2138
2139 </description>
2140 <parameters>
2141 <parameter name="chooser">
2142 <parameter_description> a #GtkFileChooser
2143 </parameter_description>
2144 </parameter>
2145 </parameters>
2146 <return> the full path of the current folder, possibly empty if the current
2147 path cannot be represented as a local filename.  This function may also return
2148 and empty string if the file chooser was unable to load the last folder that was
2149 requested from it; for example, as would be for calling
2150 gtk_file_chooser_set_current_folder() on a nonexistent folder.
2151
2152 Since: 2.4
2153 </return>
2154 </function>
2155
2156 <function name="gtk_file_chooser_list_shortcut_folders">
2157 <description>
2158 Queries the list of shortcut folders in the file chooser, as set by
2159 gtk_file_chooser_add_shortcut_folder().
2160
2161 Since: 2.4
2162 </description>
2163 <parameters>
2164 <parameter name="chooser">
2165 <parameter_description> a #GtkFileChooser
2166 </parameter_description>
2167 </parameter>
2168 </parameters>
2169 <return> A list of folder filenames, if there are any shortcut
2170 folders..
2171
2172
2173 </return>
2174 </function>
2175
2176 <function name="gtk_file_chooser_list_shortcut_folder_uris">
2177 <description>
2178 Queries the list of shortcut folders in the file chooser, as set by
2179 gtk_file_chooser_add_shortcut_folder_uri().
2180
2181
2182 </description>
2183 <parameters>
2184 <parameter name="chooser">
2185 <parameter_description> a #GtkFileChooser
2186 </parameter_description>
2187 </parameter>
2188 </parameters>
2189 <return> A list of folder URIs
2190
2191 Since: 2.4
2192 </return>
2193 </function>
2194
2195 <function name="gtk_file_chooser_list_filters">
2196 <description>
2197 Lists the current set of user-selectable filters; see
2198 gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
2199
2200
2201 </description>
2202 <parameters>
2203 <parameter name="chooser">
2204 <parameter_description> a #GtkFileChooser
2205 </parameter_description>
2206 </parameter>
2207 </parameters>
2208 <return> a list containing the current set of
2209 user selectable filters.
2210
2211 Since: 2.4
2212 </return>
2213 </function>
2214
2215
2216 <function name="gtk_file_chooser_get_uris">
2217 <description>
2218 Lists all the selected files and subfolders in the current folder of
2219 @chooser. The returned names are full absolute URIs.
2220
2221
2222 </description>
2223 <parameters>
2224 <parameter name="chooser">
2225 <parameter_description> a #GtkFileChooser
2226 </parameter_description>
2227 </parameter>
2228 </parameters>
2229 <return> a list containing the URIs of all selected
2230 files and subfolders in the current folder.
2231
2232 Since: 2.4
2233 </return>
2234 </function>
2235
2236
2237 <function name="gtk_file_chooser_get_filenames">
2238 <description>
2239 Lists all the selected files and subfolders in the current folder of
2240 @chooser. The returned names are full absolute paths. If files in the current
2241 folder cannot be represented as local filenames they will be ignored. (See
2242 gtk_file_chooser_get_uris())
2243
2244
2245 </description>
2246 <parameters>
2247 <parameter name="chooser">
2248 <parameter_description> a #GtkFileChooser
2249 </parameter_description>
2250 </parameter>
2251 </parameters>
2252 <return> a list containing the filenames of all selected
2253 files and subfolders in the current folder.
2254
2255 Since: 2.4
2256 </return>
2257 </function>
2258
2259 <function name="gtk_icon_theme_list_icons">
2260 <description>
2261 Lists a subset of icons in the current icon theme, by providing a context string.
2262 The set of values for the context string is system dependent,
2263 but will typically include such values as &apos;Applications&apos; and
2264 &apos;MimeTypes&apos;.
2265
2266 </description>
2267 <parameters>
2268 <parameter name="icon_theme">
2269 <parameter_description> a #GtkIconTheme
2270 </parameter_description>
2271 </parameter>
2272 <parameter name="context">
2273 <parameter_description> a string identifying a particular type of icon.
2274 </parameter_description>
2275 </parameter>
2276 </parameters>
2277 <return>  The names of all the
2278 icons in the theme.
2279
2280 Since: 2.4
2281 </return>
2282 </function>
2283
2284 <function name="gtk_widget_render_icon">
2285 <description>
2286 A convenience function that uses the theme engine and RC file
2287 settings for the widget to look up @stock_id and render it to
2288 a pixbuf. @stock_id should be a stock icon ID such as
2289 #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
2290 such as #GTK_ICON_SIZE_MENU. @detail should be a string that
2291 identifies the widget or code doing the rendering, so that
2292 theme engines can special-case rendering for that widget or code.
2293
2294 The pixels in the returned #GdkPixbuf are shared with the rest of
2295 the application and should not be modified. The pixbuf should be freed
2296 after use with g_object_unref().
2297
2298
2299 </description>
2300 <parameters>
2301 <parameter name="widget">
2302 <parameter_description> a #GtkWidget
2303 </parameter_description>
2304 </parameter>
2305 <parameter name="stock_id">
2306 <parameter_description> a stock ID
2307 </parameter_description>
2308 </parameter>
2309 <parameter name="size">
2310 <parameter_description> a stock size. A size of (GtkIconSize)-1 means render at
2311 the size of the source and don&apos;t scale (if there are multiple
2312 source sizes, GTK+ picks one of the available sizes).
2313 </parameter_description>
2314 </parameter>
2315 <parameter name="detail">
2316 <parameter_description> render detail to pass to theme engine
2317 </parameter_description>
2318 </parameter>
2319 </parameters>
2320 <return> a new pixbuf if the stock ID was known.
2321 </return>
2322 </function>
2323
2324 <function name="gtk_table_get_homogeneous">
2325 <description>
2326 Returns whether the table cells are all constrained to the same
2327 width and height. (See set_homogenous())
2328 </description>
2329 <parameters>
2330 <parameter name="table">
2331 <parameter_description> a #GtkTable
2332 </parameter_description>
2333 </parameter>
2334 </parameters>
2335 <return> %TRUE if the cells are all constrained to the same size
2336 </return>
2337 </function>
2338
2339
2340 <!-- I don't know what this GTK+ documentation means by "update its internal state". murrayc. -->
2341 <function name="gtk_widget_add_mnemonic_label">
2342 <description>
2343 Adds a widget to the list of mnemonic labels for
2344 this widget. (See gtk_widget_list_mnemonic_labels()). Note the
2345 list of mnemonic labels for the widget is cleared when the
2346 widget is destroyed, so the caller must make sure to update
2347 its internal state at this point as well.
2348
2349 Since: 2.4
2350
2351 </description>
2352 <parameters>
2353 <parameter name="widget">
2354 <parameter_description> a #GtkWidget
2355 </parameter_description>
2356 </parameter>
2357 <parameter name="label">
2358 <parameter_description> a #GtkWidget that acts as a mnemonic label for @widget.
2359 </parameter_description>
2360 </parameter>
2361 </parameters>
2362 <return></return>
2363 </function>
2364
2365
2366 <function name="gtk_container_remove">
2367 <description>
2368 Removes @widget from @container. @widget must be inside @container.
2369 If @widget is managed with Gtk::manage(), and you don&apos;t want to use @widget
2370 again then you should delete @widget, because there will no longer be any parent
2371 container to delete it automatically.
2372 </description>
2373 <parameters>
2374 <parameter name="container">
2375 <parameter_description> a #GtkContainer
2376 </parameter_description>
2377 </parameter>
2378 <parameter name="widget">
2379 <parameter_description> a current child of @container
2380 </parameter_description>
2381 </parameter>
2382 </parameters>
2383 <return></return>
2384 </function>
2385
2386 <function name="gtk_page_setup_to_key_file">
2387 <description>
2388 This function adds the page setup from @setup to @key_file.
2389
2390 Since: 2.12
2391
2392 </description>
2393 <parameters>
2394 <parameter name="setup">
2395 <parameter_description> a #GtkPageSetup
2396 </parameter_description>
2397 </parameter>
2398 <parameter name="key_file">
2399 <parameter_description> the Glib::KeyFile to save the page setup to
2400 </parameter_description>
2401 </parameter>
2402 <parameter name="group_name">
2403 <parameter_description> the group to add the settings to in @key_file.
2404 </parameter_description>
2405 </parameter>
2406 </parameters>
2407 <return></return>
2408 </function>
2409
2410 <function name="gtk_print_settings_to_key_file">
2411 <description>
2412 This function adds the print settings from @settings to @key_file.
2413
2414 Since: 2.12
2415
2416 </description>
2417 <parameters>
2418 <parameter name="settings">
2419 <parameter_description> a #GtkPrintSettings
2420 </parameter_description>
2421 </parameter>
2422 <parameter name="key_file">
2423 <parameter_description> the Glib::KeyFile to save the print settings to
2424 </parameter_description>
2425 </parameter>
2426 <parameter name="group_name">
2427 <parameter_description> the group to add the settings to in @key_file.
2428 </parameter_description>
2429 </parameter>
2430 </parameters>
2431 <return></return>
2432 </function>
2433
2434
2435 <function name="gtk_about_dialog_get_program_name">
2436 <description>
2437 Return value: The program name.
2438
2439 </description>
2440 <parameters>
2441 <parameter name="about">
2442 <parameter_description> a #GtkAboutDialog
2443 </parameter_description>
2444 </parameter>
2445 </parameters>
2446 <return> The program name.
2447
2448 Since: 2.12
2449 </return>
2450 </function>
2451
2452 <function name="gtk_about_dialog_get_website_label">
2453 <description>
2454 Return value: The label used for the website link.
2455
2456 </description>
2457 <parameters>
2458 <parameter name="about">
2459 <parameter_description> a #GtkAboutDialog
2460 </parameter_description>
2461 </parameter>
2462 </parameters>
2463 <return> The label used for the website link.
2464
2465 Since: 2.6
2466 </return>
2467 </function>
2468
2469
2470 <function name="gtk_entry_completion_get_completion_prefix">
2471 <description>
2472 Get the original text entered by the user that triggered
2473 the completion or an empty string if there&apos;s no completion ongoing.
2474
2475
2476 </description>
2477 <parameters>
2478 <parameter name="completion">
2479 <parameter_description> a #GtkEntryCompletion
2480 </parameter_description>
2481 </parameter>
2482 </parameters>
2483 <return> the prefix for the current completion
2484
2485 Since: 2.12
2486 </return>
2487 </function>
2488
2489
2490 <function name="gtk_icon_theme_choose_icon">
2491 <description>
2492 Looks up a named icon and returns a structure containing
2493 information such as the filename of the icon. The icon
2494 can then be rendered into a pixbuf using
2495 gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
2496 combines these two steps if all you need is the pixbuf.)
2497
2498 If @icon_names contains more than one name, this function
2499 tries them all in the given order before falling back to
2500 inherited icon themes.
2501
2502
2503 </description>
2504 <parameters>
2505 <parameter name="icon_theme">
2506 <parameter_description> a #GtkIconTheme
2507 </parameter_description>
2508 </parameter>
2509 <parameter name="icon_names">
2510 <parameter_description> array of icon names to lookup
2511 </parameter_description>
2512 </parameter>
2513 <parameter name="size">
2514 <parameter_description> desired icon size
2515 </parameter_description>
2516 </parameter>
2517 <parameter name="flags">
2518 <parameter_description> flags modifying the behavior of the icon lookup
2519 </parameter_description>
2520 </parameter>
2521 </parameters>
2522 <return> a #GtkIconInfo structure containing information
2523 about the icon. IconInfo::operator bool() will be false if the icon wasn&apos;t found -
2524 for instance, if (icon_info) { ... }.
2525
2526 Since: 2.12
2527 </return>
2528 </function>
2529
2530
2531 <function name="gtk_icon_theme_list_contexts">
2532 <description>
2533 Gets the list of contexts available within the current
2534 hierarchy of icon themes.
2535
2536
2537 </description>
2538 <parameters>
2539 <parameter name="icon_theme">
2540 <parameter_description> a #GtkIconTheme
2541 </parameter_description>
2542 </parameter>
2543 </parameters>
2544 <return> a list holding the names of all the
2545 contexts in the theme.
2546
2547 Since: 2.12
2548 </return>
2549 </function>
2550
2551
2552 <function name="gtk_icon_view_set_tooltip_cell">
2553 <description>
2554 Sets the tip area of @tooltip to the area which @cell occupies in
2555 the item pointed to by @path. See also Tooltip::set_tip_area().
2556
2557 Since: 2.12
2558
2559 </description>
2560 <parameters>
2561 <parameter name="icon_view">
2562 <parameter_description> a #GtkIconView
2563 </parameter_description>
2564 </parameter>
2565 <parameter name="tooltip">
2566 <parameter_description> a #GtkTooltip
2567 </parameter_description>
2568 </parameter>
2569 <parameter name="path">
2570 <parameter_description> a #GtkTreePath
2571 </parameter_description>
2572 </parameter>
2573 <parameter name="cell">
2574 <parameter_description> a #GtkCellRenderer.
2575 </parameter_description>
2576 </parameter>
2577 </parameters>
2578 <return></return>
2579 </function>
2580
2581
2582 <function name="gtk_icon_view_set_tooltip_item">
2583 <description>
2584 Sets the tip area of @tooltip to be the area covered by the item at @path.
2585 See also Tooltip::set_tip_area().
2586
2587 Since: 2.12
2588
2589 </description>
2590 <parameters>
2591 <parameter name="icon_view">
2592 <parameter_description> a #GtkIconView
2593 </parameter_description>
2594 </parameter>
2595 <parameter name="tooltip">
2596 <parameter_description> a #GtkTooltip
2597 </parameter_description>
2598 </parameter>
2599 <parameter name="path">
2600 <parameter_description> a #GtkTreePath
2601 </parameter_description>
2602 </parameter>
2603 </parameters>
2604 <return></return>
2605 </function>
2606
2607
2608 <function name="gtk_page_setup_to_file">
2609 <description>
2610 This function saves the information from @setup to @file_name.
2611 @throws Glib::FileError
2612
2613 </description>
2614 <parameters>
2615 <parameter name="setup">
2616 <parameter_description> a #GtkPageSetup
2617 </parameter_description>
2618 </parameter>
2619 <parameter name="file_name">
2620 <parameter_description> the file to save to
2621 </parameter_description>
2622 </parameter>
2623 </parameters>
2624 <return> %TRUE on success
2625
2626 Since: 2.12
2627 </return>
2628 </function>
2629
2630
2631 <function name="gtk_print_settings_to_file">
2632 <description>
2633 This function saves the print settings from @settings to @file_name.
2634 @throws FileError
2635
2636 </description>
2637 <parameters>
2638 <parameter name="settings">
2639 <parameter_description> a #GtkPrintSettings
2640 </parameter_description>
2641 </parameter>
2642 <parameter name="file_name">
2643 <parameter_description> the file to save to
2644 </parameter_description>
2645 </parameter>
2646 </parameters>
2647 <return> %TRUE on success
2648
2649 Since: 2.12
2650 </return>
2651 </function>
2652
2653
2654 <function name="gtk_printer_request_details">
2655 <description>
2656 Requests the printer details. When the details are available,
2657 the details_acquired signal will be emitted.
2658
2659 Since: 2.12
2660
2661 </description>
2662 <parameters>
2663 <parameter name="printer">
2664 <parameter_description> a #GtkPrinter
2665 </parameter_description>
2666 </parameter>
2667 </parameters>
2668 <return></return>
2669 </function>
2670
2671
2672 <function name="gtk_cell_layout_get_cells">
2673 <description>
2674 Return value: a list of cell renderers.
2675
2676 </description>
2677 <parameters>
2678 <parameter name="cell_layout">
2679 <parameter_description> a #GtkCellLayout
2680 </parameter_description>
2681 </parameter>
2682 </parameters>
2683 <return> a list of cell renderers.
2684
2685 Since: 2.12
2686 </return>
2687 </function>
2688
2689
2690 <function name="gtk_widget_error_bell">
2691 <description>
2692 Notifies the user about an input-related error on this widget.
2693 If the Gtk::Settings gtk-error-bell proeprty is true, it calls
2694 Gdk::Window::beep(), otherwise it does nothing.
2695
2696 Note that the effect of Gdk::Window::beep() can be configured in many
2697 ways, depending on the windowing backend and the desktop environment
2698 or window manager that is used.
2699
2700 Since: 2.12
2701
2702 </description>
2703 <parameters>
2704 <parameter name="widget">
2705 <parameter_description> a #GtkWidget
2706 </parameter_description>
2707 </parameter>
2708 </parameters>
2709 <return></return>
2710 </function>
2711
2712
2713 <function name="gtk_widget_get_tooltip_markup">
2714 <description>
2715 Gets the contents of the tooltip for @widget.
2716
2717
2718 </description>
2719 <parameters>
2720 <parameter name="widget">
2721 <parameter_description> a #GtkWidget
2722 </parameter_description>
2723 </parameter>
2724 </parameters>
2725 <return> the tooltip text.
2726
2727 Since: 2.12
2728 </return>
2729 </function>
2730
2731
2732 <function name="gtk_widget_get_tooltip_text">
2733 <description>
2734 Gets the contents of the tooltip for @widget.
2735
2736
2737 </description>
2738 <parameters>
2739 <parameter name="widget">
2740 <parameter_description> a #GtkWidget
2741 </parameter_description>
2742 </parameter>
2743 </parameters>
2744 <return> the tooltip text.
2745
2746 Since: 2.12
2747 </return>
2748 </function>
2749
2750 <function name="gtk_icon_theme_lookup_icon">
2751 <description>
2752 Looks up a named icon and returns a structure containing
2753 information such as the filename of the icon. The icon
2754 can then be rendered into a pixbuf using
2755 gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
2756 combines these two steps if all you need is the pixbuf.)
2757
2758
2759 </description>
2760 <parameters>
2761 <parameter name="icon_theme">
2762 <parameter_description> a #GtkIconTheme
2763 </parameter_description>
2764 </parameter>
2765 <parameter name="icon_name">
2766 <parameter_description> the name of the icon to lookup
2767 </parameter_description>
2768 </parameter>
2769 <parameter name="size">
2770 <parameter_description> desired icon size
2771 </parameter_description>
2772 </parameter>
2773 <parameter name="flags">
2774 <parameter_description> flags modifying the behavior of the icon lookup
2775 </parameter_description>
2776 </parameter>
2777 </parameters>
2778 <return> an IconInfo structure containing information
2779 about the icon. IconInfo::operator bool() will return false if the icon wasn&apos;t found.
2780 For instance, if (icon_info) { ... }.
2781
2782 Since: 2.4
2783 </return>
2784 </function>
2785
2786
2787 <function name="gtk_toolbar_set_icon_size">
2788 <description>
2789 This function sets the size of stock icons in the toolbar. You
2790 can call it both before you add the icons and after they&apos;ve been
2791 added. The size you set will override user preferences for the default
2792 icon size.
2793
2794 This should only be used for special-purpose toolbars, normal
2795 application toolbars should respect the user preferences for the
2796 size of icons.
2797
2798 Since: 2.12
2799 </description>
2800 <parameters>
2801 <parameter name="toolbar">
2802 <parameter_description> A #GtkToolbar
2803 </parameter_description>
2804 </parameter>
2805 <parameter name="icon_size">
2806 <parameter_description> The #GtkIconSize that stock icons in the toolbar shall have.
2807 </parameter_description>
2808 </parameter>
2809 </parameters>
2810 <return></return>
2811 </function>
2812
2813 <function name="gtk_toolbar_unset_icon_size">
2814 <description>
2815 Unsets toolbar icon size set with gtk_toolbar_set_icon_size(), so that
2816 user preferences will be used to determine the icon size.
2817
2818 Since: 2.12
2819 </description>
2820 <parameters>
2821 <parameter name="toolbar">
2822 <parameter_description> a #GtkToolbar
2823 </parameter_description>
2824 </parameter>
2825 </parameters>
2826 <return></return>
2827 </function>
2828
2829
2830
2831 </root>