vapi/metadata/Gtk-3.0.metadata

   1 // Issues which can't (currently) be fixed through annotations alone,
   2 // but may be some day.
   3 ////////////////////////////////////////////////////////////////////
   4
   5 // G-I doesn't support per-sybmol includes
   6 * cheader_filename="gtk/gtk.h"
   7 *Accessible cheader_filename="gtk/gtk.h,gtk/gtk-a11y.h"
   8 IMContext cheader_filename="gtk/gtk.h,gtk/gtkimmodule.h"
   9 Plug cheader_filename="gtk/gtkx.h"
  10 Socket cheader_filename="gtk/gtkx.h"
  11
  12 // Causes vapigen issues, not sure why -- <union> without name
  13
  14 // G-I doesn't support structs
  15 BindingSet struct=false
  16 BindingEntry struct=false
  17 BindingSignal struct=false
  18 Border struct
  19 FileFilterInfo struct=false
  20 FixedChild struct=false
  21 Requisition struct
  22 TargetEntry struct
  23 TextIter struct
  24 TreeIter struct
  25
  26 // Hide dedicated constructors of former compact classes
  27 Border
  28   .new skip
  29 Requisition
  30   .new skip
  31 TargetEntry
  32   .new skip
  33
  34 // Bug #636812: no support for annotating the type of a closure
  35 AccelGroup
  36   .connect*.closure type="owned Gtk.AccelGroupActivate"
  37 AccelLabel
  38   .set_accel_closure.accel_closure type="owned Gtk.AccelGroupActivate"
  39
  40 // Bug #: Virtual methods without invokers
  41 Entry
  42   .get_frame_size.* out
  43   .get_text_area_size.* out
  44 EntryBuffer
  45   .get_text#virtual_method name="get_text_internal"
  46   .get_text#virtual_method.n_bytes out default=null
  47 Range
  48   .get_range_border.* out
  49   .get_range_size_request.minimum out
  50   .get_range_size_request.natural out
  51 RcStyle
  52   .create_rc_style unowned=false skip=false
  53   .create_style unowned=false skip=false
  54 TextView
  55   .create_buffer unowned=false skip=false
  56 Widget
  57   .adjust_size_allocation.*_size ref
  58   .adjust_size_allocation.allocated_pos ref
  59   .adjust_size_request.*_size ref
  60   .compute_expand#virtual_method.* out
  61   .dispatch_child_properties_changed.pspecs array array_length_idx=0
  62 RecentChooser
  63   .get_recent_manager skip=false
  64
  65 // Bug #657202: Floating references
  66 FileFilter
  67   .to_gvariant floating
  68 PageSetup
  69   .to_gvariant floating
  70 PaperSize
  71   .to_gvariant floating
  72 PrintSettings
  73   .to_gvariant floating
  74
  75 // Arrays without length arguments
  76 TreeStore
  77   .reorder skip=false
  78
  79 // Better deprecation notices
  80 Accessible
  81   .connect_widget_destroyed replacement="set_widget"
  82 Button
  83   .enter replacement="Gtk.Widget.enter_notify_event"
  84   .leave replacement="Gtk.Widget.leave_notify_event"
  85   .pressed replacement="Gtk.Widget.button_press_event"
  86   .released replacement="Gtk.Widget.button_release_event"
  87 CellRenderer
  88   .get_size replacement="get_preferred_size"
  89   .cell_background_gdk replacement="cell_background_rgba"
  90 CellRendererText
  91   .background_gdk replacement="background_rgba"
  92   .foreground_gdk replacement="foreground_rgba"
  93 CellView
  94   .set_background_color replacement="set_background_rgba"
  95   .background_gdk replacement="background_rgba"
  96 ColorButton
  97   .color replacement="rgba"
  98 ColorSelection
  99   .get_current_color replacement="get_current_rgba"
 100   .get_previous_color replacement="get_previous_rgba"
 101   .set_current_color replacement="set_current_rgba"
 102   .set_previous_color replacement="set_previous_rgba"
 103   .current_color replacement="current_rgba"
 104 MenuItem
 105   .get_right_justified replacement="Widget.get_hexpand and Widget.get_halign"
 106   .set_right_justified replacement="Widget.set_hexpand and Widget.set_halign"
 107 TextTag
 108   .background_gdk replacement="background_rgba"
 109   .foreground_gdk replacement="foreground_rgba"
 110   .paragraph_background_gdk replacement="paragraph_background_rgba"
 111 Widget
 112   .class_path replacement="get_path"
 113   .modify_fg replacement="override_color"
 114   .modify_bg replacement="override_background_color"
 115   .modify_text replacement="override_color"
 116   .modify_base replacement="override_background_color"
 117   .modify_font replacement="override_font"
 118   .modify_cursor replacement="override_cursor"
 119   .path replacement="get_path"
 120   .reset_rc_styles replacement="reset_style"
 121 draw_insertion_cursor replacement="render_insertion_cursor"
 122 paint_box replacement="render_background"
 123 paint_box_gap replacement="render_frame_gap"
 124 paint_expander replacement="render_expander"
 125 paint_extension replacement="render_extension"
 126 paint_shadow_gap replacement="render_frame"
 127 paint_spinner replacement="render_activity"
 128 paint_resize_grip replacement="render_handle"
 129
 130 // G-I cannot deprecate whole types
 131 Action deprecated_since="3.10" replacement="GLib.Action"
 132 ActionGroup deprecated_since="3.10"
 133 Alignment deprecated_since="3.14"
 134 FontSelection deprecated_since="3.2" replacement="FontChooserWidget"
 135 FontSelectionDialog deprecated_since="3.2" replacement="FontChooserDialog"
 136 Gradient deprecated_since="3.8"
 137 HandleBox deprecated_since="3.4"
 138 HBox deprecated_since="3.2" replacement="Box"
 139 HButtonBox deprecated_since="3.2" replacement="ButtonBox"
 140 HPaned deprecated_since="3.2" replacement="Paned"
 141 HScale deprecated_since="3.2" replacement="Scale"
 142 HScrollbar deprecated_since="3.2" replacement="Scrollbar"
 143 HSeparator deprecated_since="3.2" replacement="Separator"
 144 IconFactory deprecated_since="3.10" replacement="IconTheme"
 145 IconSet deprecated_since="3.10" replacement="IconTheme"
 146 IconSource deprecated_since="3.10" replacement="IconTheme"
 147 ImageMenuItem deprecated_since="3.10"
 148 Misc deprecated_since="3.14"
 149 NumerableIcon deprecated_since="3.14"
 150 RadioAction deprecated_since="3.10"
 151 StatusIcon deprecated_since="3.14"
 152 Style deprecated_since="3.0" replacement="StyleContext"
 153 Table deprecated_since="3.4" replacement="Grid"
 154 TearoffMenuItem deprecated_since="3.4"
 155 ToggleAction deprecated_since="3.10"
 156 UIManager deprecated_since="3.10"
 157 VBox deprecated_since="3.2" replacement="Box"
 158 VButtonBox deprecated_since="3.2" replacement="ButtonBox"
 159 VPaned deprecated_since="3.2" replacement="Paned"
 160 VScale deprecated_since="3.2" replacement="Scale"
 161 VScrollbar deprecated_since="3.2" replacement="Scrollbar"
 162 VSeparator deprecated_since="3.2" replacement="Separator"
 163 Activatable deprecated_since="3.10"
 164
 165 // G-I cannot handle returning non-boxed types
 166 binding_set_by_class skip=false
 167 ContainerClass
 168   .find_child_property skip=false
 169 get_option_group skip=false
 170
 171 // G-I cannot handle variadic functions
 172 *.*_valist skip=false
 173 *.*_valist.args type="va_list"
 174 *.*_valist.var_args type="va_list"
 175 Builder
 176   .add_callback_symbols skip=false
 177 CellArea
 178   .add_with_properties skip=false
 179   .cell_get skip=false
 180   .cell_set skip=false
 181 Container
 182   .add_with_properties skip=false
 183   .child_get* skip=false
 184   .child_set* skip=false
 185 Dialog
 186   .add_buttons skip=false
 187   .set_alternative_button_order skip=false sentinel="-1"
 188   .new_with_buttons skip=false
 189 FileChooserDialog
 190   .new skip=false
 191 InfoBar
 192   .add_buttons skip=false
 193   .new_with_buttons skip=false
 194 ListStore
 195   .new skip=false sentinel="-1"
 196   .insert_with_values skip=false sentinel="-1"
 197   .set skip=false sentinel="-1"
 198 MessageDialog
 199   .new skip=false printf_format
 200   .format_secondary_markup skip=false printf_format
 201   .format_secondary_text skip=false printf_format
 202   .new_with_markup skip=false printf_format
 203 RecentChooserDialog
 204   .new skip=false
 205   .new_for_manager skip=false
 206 Style
 207   .get skip=false
 208 StyleContext
 209   .get skip=false
 210   .get_style skip=false
 211 StyleProperties
 212   .set skip=false
 213 TextBuffer
 214   .create_tag skip=false
 215   .insert_with_tags skip=false
 216   .insert_with_tags_by_name skip=false
 217 ThemingEngine
 218   .get skip=false
 219   .get_style skip=false
 220   .get_style_property skip=false
 221 TreePath
 222   .new_from_indices skip=false sentinel="-1"
 223 TreeStore
 224   .new skip=false sentinel=""
 225   .insert_with_values skip=false sentinel="-1"
 226   .set skip=false sentinel="-1"
 227 TreeView
 228   .insert_column_with_attributes skip=false
 229 TreeViewColumn
 230   .set_attributes skip=false
 231   .new_with_attributes skip=false
 232 Widget
 233   .style_get skip=false
 234 Actionable
 235   .set_action_target skip=false
 236 CellLayout
 237   .set_attributes skip=false
 238 TreeModel
 239   .get skip=false sentinel="-1"
 240
 241 // Abstract vs. virtual
 242 CellRenderer
 243   .get_size#virtual_method abstract
 244   .render#virtual_method abstract
 245 TreeModel
 246   .iter_previous#virtual_method virtual
 247   .ref_node#virtual_method virtual
 248   .unref_node#virtual_method virtual
 249
 250 // G-I can't handle delegates w/o targets
 251 Clipboard
 252   .set_with_data skip=false
 253   .set_with_data.clear_func closure=-1
 254   .set_with_owner skip=false
 255 ColorSelection
 256   .set_change_palette_with_screen_hook skip=false
 257
 258 // Unregistered callback types
 259 Builder
 260   .lookup_callback_symbol skip=false
 261
 262 // Bug #: Default values
 263 Button
 264   .new_from_icon_name.size default=Gtk.IconSize.BUTTON
 265 Box
 266   .pack_*.expand default=true
 267   .pack_*.fill default=true
 268   .pack_*.padding default=0
 269 CellAreaBox
 270   .pack_*.align default=false
 271   .pack_*.fixed default=true
 272   .pack_*.expand default=true
 273 Editable
 274   .get_chars.start_pos default=0
 275   .get_chars.end_pos default=-1
 276 EntryBuffer
 277   .new.initial_chars default=null
 278 Gesture
 279   .get_point.x nullable default=null
 280   .get_point.y nullable default=null
 281 Grid
 282   .attach*.width default=1
 283   .attach*.height default=1
 284 IconInfo
 285   .load_symbolic*.success_color default=null
 286   .load_symbolic*.warning_color default=null
 287   .load_symbolic*.error_color default=null
 288   .load_symbolic*.was_symbolic default=null
 289   .*.cancellable default=null
 290 Layout
 291   .new.* default=null
 292 Menu
 293   .popup_at_*.trigger_event default=null
 294 Notebook
 295   .append_page.tab_label default=null
 296   .prepend_page.tab_label default=null
 297 ScaleButton
 298   .new.size type="Gtk.IconSize"
 299   .new.min default=0.0
 300   .new.max default=100.0
 301   .new.step default=2.0
 302   .new.icons default=null
 303 TextBuffer
 304   .set_text.len default=-1
 305 TextTag
 306   .new.name default=null
 307 TextMark
 308   .new.left_gravity default=false
 309 Widget
 310   .intersect.intersection default=null
 311 Window
 312   .new.type default=Gtk.WindowType.TOPLEVEL
 313
 314 // Ownership of out arguments
 315 CellRenderer
 316   .get_preferred_size.minimum_size unowned=false
 317   .get_preferred_size.natural_size unowned=false
 318 CellView
 319   .get_size_of_row.requisition unowned=false
 320 ComboBox
 321   .get_active_iter.iter unowned=false
 322
 323 // Structs as generic type arguments
 324 binding_entry_add_signall.binding_args type="GLib.SList<Gtk.BindingArg?>"
 325
 326 // Subclasses conflicting with virtual methods with different signatures
 327 CellAreaBox
 328   .pack_end name="pack_end_full"
 329   .pack_start name="pack_start_full"
 330 FileFilter
 331   .get_name name="get_filter_name"
 332   .set_name name="set_filter_name"
 333 RecentFilter
 334   .get_name name="get_filter_name"
 335   .set_name name="set_filter_name"
 336
 337 // Field ownership
 338 RecentData
 339   .* unowned=false
 340 TextAttributes
 341   .font unowned=false
 342   .union#union.font_features unowned=false
 343   .language unowned=false
 344   .tabs unowned=false
 345 TextAppearance
 346   .union#union.rgba unowned=false
 347
 348 // Bug #: Nullable properties & fields
 349 ComboBox.active_id nullable
 350 RecentData
 351   .display_name nullable
 352   .description nullable
 353 RecentFilterInfo
 354   .uri nullable
 355   .display_name nullable
 356   .mime_type nullable
 357   .applications nullable
 358   .groups nullable
 359
 360 // Bug #: element-type properties
 361 Settings.color_hash type="GLib.HashTable<string,Gdk.Color>"
 362
 363 // Skipped for G-I, but usable from Vala
 364 FlowBox
 365   .bind_model skip=false
 366   .bind_model.create_widget_func nullable
 367 FlowBoxCreateWidgetFunc skip=false
 368   .item type="GLib.Object"
 369 IMContextSimple
 370   .add_table skip=false
 371
 372 // Symbol name conflicts
 373 Container
 374   .forall#virtual_method skip
 375   .set_focus_child skip
 376 EntryCompletion
 377   .insert_prefix#method name="request_prefix_insertion"
 378 Notebook
 379   .insert_page#virtual_method name="insert_page_menu"
 380   .insert_page#virtual_method.tab_label nullable
 381   .insert_page#virtual_method.menu_label nullable
 382   .insert_page_menu skip
 383 ToolShell
 384   .get_icon_size#method skip
 385 TreeView
 386   .row_expanded#method name="is_row_expanded"
 387 Widget
 388   .compute_expand#virtual_method name="compute_expand_internal"
 389   .draw#method name="draw_to_cairo_context"
 390 Window
 391   .activate_default#method name="try_activate_default"
 392   .activate_focus#method name="try_activate_focus"
 393 Editable
 394   .delete_text#method skip
 395   .insert_text#method skip
 396
 397 // time_t
 398 RecentInfo
 399   .get_added type="time_t"
 400   .get_application_info.time_ type="time_t"
 401   .get_modified type="time_t"
 402   .get_visited type="time_t"
 403
 404 Stock skip
 405 STOCK_* name="STOCK_(.+)" parent="Gtk.Stock"
 406
 407 // Not sure what g-i was thinking
 408 NumerableIcon
 409   .new symbol_type="constructor"
 410   .new_with_style_context symbol_type="constructor"
 411 TreeModel
 412   .filter_new parent="Gtk.TreeModelFilter" name="new" symbol_type="constructor"
 413   .sort_new_with_model parent="Gtk.TreeModelSort" name="new_with_model" symbol_type="constructor"
 414
 415 // These aren't actually used publicly anywhere.
 416 TableChild skip
 417 TableRowCol skip
 418 TargetPair skip
 419 RcProperty skip
 420
 421 // Vala-specific, not really bugs
 422 /////////////////////////////////
 423
 424 // Keep properties non-abstract as before
 425 *#interface.*#property abstract=false
 426
 427 // Backwards compatibility
 428 AccelGroup
 429   .find type="Gtk.AccelKey*"
 430 Action
 431   .create_icon.icon_size type="Gtk.IconSize"
 432 ActionGroup
 433   .add_actions* skip=false
 434   .add_*_actions* skip=false
 435   .add_radio_actions.on_change type="Gtk.RadioActionCallback"
 436   .add_radio_actions_full.on_change type="owned Gtk.RadioActionCallback"
 437 Button
 438   .new_from_icon_name.size type="Gtk.IconSize"
 439 Clipboard
 440   .get_selection skip=false
 441 ClipboardRichTextReceivedFunc
 442   .text type="uint8[]?" array_length_idx=3
 443 ColorButton
 444   .get_color return_void
 445 ColorSelection
 446   .get_current_color return_void
 447   .get_previous_color return_void
 448 ColorSelectionDialog
 449   .get_color_selection type="unowned Gtk.ColorSelection"
 450 CssProvider
 451   .load_from_data name="load_from_buffer"
 452 Entry
 453   .get_text_area return_void
 454 EntryBuffer
 455   .new.initial_chars type="uint8[]?" array_length_idx=1
 456   .emit_inserted_text.chars type="uint8[]" array_length_idx=2
 457   .insert_text.chars type="uint8[]" array_length_idx=2
 458   .set_text.chars type="uint8[]" array_length_idx=1
 459 IconInfo
 460   .copy skip=false
 461   .free skip=false destroys_instance
 462 IconSet
 463   .get_sizes.sizes type="Gtk.IconSize[]"
 464   .render_icon*.size type="Gtk.IconSize"
 465 IconSource
 466   .get_size type="Gtk.IconSize"
 467   .set_size.size type="Gtk.IconSize"
 468 Image
 469   .*.size type="Gtk.IconSize"
 470 InfoBar
 471   .get_content_area type="unowned Gtk.Container"
 472 ListStore
 473   .append return_void
 474   .move_after.iter ref
 475   .move_before.iter ref
 476   .prepend return_void
 477   .remove.iter ref
 478 PaperSize
 479   .free destroys_instance
 480 PlacesSidebar
 481   .show_other_locations#signal name="show_other_locations_requested"
 482 SelectionData
 483   .free destroys_instance
 484   .get_data skip=false
 485 StatusIcon
 486   .position_menu skip
 487 Style
 488   .base unowned=false
 489   .bg unowned=false
 490   .dark unowned=false
 491   .fg unowned=false
 492   .light unowned=false
 493   .mid unowned=false
 494   .text unowned=false
 495   .text_aa unowned=false
 496   .copy skip
 497   .get_style_property return_void
 498 render_* parent="Gtk.StyleContext"
 499 render_* symbol_type="method" instance_idx=0
 500 render_icon_pixbuf.size type="Gtk.IconSize"
 501 StyleProperties
 502   .get skip=false
 503   .lookup_property skip=false
 504   .register_property skip=false
 505   .register_property.parse_func nullable
 506 TextBuffer
 507   .delete.start ref
 508   .delete.end ref
 509   .delete_interactive.start_iter ref
 510   .delete_interactive.end_iter ref
 511   .get_end_iter return_void
 512   .get_start_iter return_void
 513   .insert*.iter ref
 514   .insert_text.pos ref
 515   .insert_text#signal.location ref
 516 TextView
 517   .backward*.iter ref
 518   .forward*.iter ref
 519   .get_iter_location return_void
 520   .get_visible_rect return_void
 521   .move_visually.iter ref
 522 ThemingEngine
 523   .register_property skip=false
 524   .render_icon_pixbuf skip=false unowned=false
 525 ToolItem
 526   .get_icon_size type="Gtk.IconSize"
 527 ToolPalette
 528   .get_icon_size type="Gtk.IconSize"
 529   .set_icon_size.icon_size type="Gtk.IconSize"
 530 TreePath
 531   .free destroys_instance
 532   .get_indices_with_depth name="get_indices"
 533 tree_row_reference_reordered skip=false name="reordered" parent="Gtk.TreeRowReference"
 534 TreeRowReference
 535   .free destroys_instance
 536 TreeStore
 537   .move_after.iter ref
 538   .move_before.iter ref
 539   .remove.iter ref
 540 TreeView
 541   .get_background_area return_void
 542   .get_cell_area return_void
 543   .get_visible_rect return_void
 544 Widget
 545   .delete_event.event type="Gdk.EventAny"
 546   .destroy_event.event type="Gdk.EventAny"
 547   .drag_*#method parent="Gtk" symbol_type="function"
 548   .get_allocation return_void
 549   .get_child_requisition return_void
 550   .get_clip return_void
 551   .get_parent type="unowned Gtk.Container?"
 552   .grab_add parent="Gtk" symbol_type="function"
 553   .grab_remove parent="Gtk" symbol_type="function"
 554   .new skip
 555   .render_icon*.size type="Gtk.IconSize"
 556   .set_parent.parent type="Gtk.Container"
 557   .style_get_property.value ref
 558   .touch_event.event type="Gdk.EventTouch"
 559   .window skip
 560 WidgetPath
 561   .free destroys_instance
 562 WidgetClass
 563   .install_style_property_parser skip=false
 564 TreeModel
 565   .get_value return_void
 566 BindingArg
 567   .d#union.* skip
 568 StockItem
 569   .copy skip=false unowned=false
 570 TextIter
 571   .get_attributes.values out=false
 572 icon_size_*#function skip
 573 key_snooper_install skip=false
 574 rc_property_parse_* skip
 575 rc_scanner_new skip=false
 576 show_about_dialog skip=false
 577 test_create_widget skip=false
 578 test_display_button_window skip=false
 579 test_init skip=false
 580
 581 @false skip
 582 @true skip
 583
 584 init*.argv unowned
 585 parse_args.argv unowned
 586 test_init.argvp unowned
 587
 588 *.string name="str"
 589 *.*.string name="str"
 590
 591 // Forward upstream
 592 ///////////////////
 593 Widget
 594   .drag_dest_set.targets array_length_idx=3
 595   .drag_source_set.targets array_length_idx=3
 596
 597 // Not completely sure
 598 Button
 599   .get_label nullable
 600   .label nullable
 601   .set_label.label nullable
 602 ComboBox
 603   .get_row_separator_func skip=false
 604 Entry
 605   .populate_popup#signal.widget type="Gtk.Menu"
 606 FileChooserNative
 607   .accept_label nullable
 608   .cancel_label nullable
 609 Menu
 610   .get_for_attach_widget type="unowned GLib.List<Gtk.Menu>"
 611   .popped_up.*_rect type="Gdk.Rectangle"
 612 ModelButton
 613   .icon nullable
 614 NativeDialog
 615   .title nullable
 616   .transient_for nullable
 617   .get_title nullable
 618   .get_transient_for nullable
 619   .set_title.title nullable
 620   .set_transient_for.parent nullable
 621 RadioToolButton
 622   .get_group nullable
 623 Window
 624   .list_toplevels type="GLib.List<unowned Gtk.Window>"
 625   .set_focus#signal.object nullable
 626 TreeModel
 627   .get_path nullable
 628   .iter_next.iter ref
 629   .iter_previous.iter ref
 630 TreeView
 631   .insert_column_with_attributes.title nullable
 632 TreeViewColumn
 633   .new_with_attributes.title nullable
 634 TextView
 635   .populate_popup.popup type="Gtk.Menu"
 636 TreeView
 637   .get_*_func skip=false
 638 Viewport
 639   .get_*adjustment nullable
 640 VScale
 641   .new.adjustment nullable
 642 Widget
 643   .drag_begin.event nullable
 644   .intersect.intersection nullable unowned=false
 645
 646 // Sure
 647 binding_set_by_class.object_class type="GLib.ObjectClass"
 648 *.ref unowned
 649
 650 // These delegate types don't have targets in the typedefs, but they
 651 // get called with a target.
 652 AccelGroupActivate skip
 653
 654 // Possible TODO
 655 ////////////////
 656
 657 // TreeViewColumn.title nullable // (plus all title params in TreeView and TreeViewColumn)