path: root/vapi/metadata/Gtk-4.0.metadata

// Issues which can't (currently) be fixed through annotations alone,
// but may be some day.
////////////////////////////////////////////////////////////////////

*.event type="Gdk.Event"
*.*.event type="Gdk.Event"

// G-I doesn't support per-sybmol includes
* cheader_filename="gtk/gtk.h"
*Accessible cheader_filename="gtk/gtk.h,gtk/gtk-a11y.h"
IMContext cheader_filename="gtk/gtk.h,gtk/gtkimmodule.h"

// Causes vapigen issues, not sure why -- <union> without name

// G-I doesn't support structs
BindingSet struct=false
BindingEntry struct=false
BindingSignal struct=false
Border struct
FileFilterInfo struct=false
FixedChild struct=false
Requisition struct
TextIter struct
TreeIter struct

// Bug #636812: no support for annotating the type of a closure
AccelGroup
  .connect*.closure type="owned Gtk.AccelGroupActivate"
AccelLabel
  .set_accel_closure.accel_closure type="owned Gtk.AccelGroupActivate"

// Bug #: Virtual methods without invokers
EntryBuffer
  .get_text#virtual_method name="get_text_internal"
  .get_text#virtual_method.n_bytes out default=null
Range
  .get_range_border.* out
  .get_range_size_request.minimum out
  .get_range_size_request.natural out
TextView
  .create_buffer unowned=false skip=false
Widget
  .compute_expand#virtual_method.* out
  .dispatch_child_properties_changed.pspecs array array_length_idx=0
RecentChooser
  .get_recent_manager skip=false

// Bug #657202: Floating references
FileFilter
  .to_gvariant floating
PageSetup
  .to_gvariant floating
PaperSize
  .to_gvariant floating
PrintSettings
  .to_gvariant floating

// Arrays without length arguments
TreeStore
  .reorder skip=false

// Better deprecation notices
CellRenderer
  .get_size replacement="get_preferred_size"

// G-I cannot deprecate whole types

// G-I cannot handle returning non-boxed types
binding_set_by_class skip=false
ContainerClass
  .find_child_property skip=false

// G-I cannot handle variadic functions
*.*_valist skip=false
*.*_valist.args type="va_list"
*.*_valist.var_args type="va_list"
Builder
  .add_callback_symbols skip=false
CellArea
  .add_with_properties skip=false
  .cell_get skip=false
  .cell_set skip=false
Container
  .add_with_properties skip=false
  .child_get* skip=false
  .child_set* skip=false
Dialog
  .add_buttons skip=false
  .new_with_buttons skip=false
FileChooserDialog
  .new skip=false
InfoBar
  .add_buttons skip=false
  .new_with_buttons skip=false
ListStore
  .new skip=false sentinel="-1"
  .insert_with_values skip=false sentinel="-1"
  .set skip=false sentinel="-1"
MessageDialog
  .new skip=false printf_format
  .format_secondary_markup skip=false printf_format
  .format_secondary_text skip=false printf_format
  .new_with_markup skip=false printf_format
RecentChooserDialog
  .new skip=false
  .new_for_manager skip=false
Snapshot
  .append* skip=false
  .push* skip=false
StyleContext
  .get skip=false
TextBuffer
  .create_tag skip=false
  .insert_with_tags skip=false
  .insert_with_tags_by_name skip=false
TreePath
  .new_from_indices skip=false sentinel="-1"
TreeStore
  .new skip=false sentinel=""
  .insert_with_values skip=false sentinel="-1"
  .set skip=false sentinel="-1"
TreeView
  .insert_column_with_attributes skip=false
TreeViewColumn
  .set_attributes skip=false
  .new_with_attributes skip=false
Widget abstract=false
  .new skip=false
Actionable
  .set_action_target skip=false
CellLayout
  .set_attributes skip=false
TreeModel
  .get skip=false sentinel="-1"

// Abstract vs. virtual
CellRenderer
  .get_size#virtual_method abstract
TreeModel
  .iter_previous#virtual_method virtual
  .ref_node#virtual_method virtual
  .unref_node#virtual_method virtual

// Unregistered callback types
Builder
  .lookup_callback_symbol skip=false

// Bug #: Default values
CellAreaBox
  .pack_*.align default=false
  .pack_*.fixed default=true
  .pack_*.expand default=true
Editable
  .get_chars.start_pos default=0
  .get_chars.end_pos default=-1
EntryBuffer
  .new.initial_chars default=null
Gesture
  .get_point.x nullable default=null
  .get_point.y nullable default=null
Grid
  .attach*.width default=1
  .attach*.height default=1
IconInfo
  .load_symbolic*.success_color default=null
  .load_symbolic*.warning_color default=null
  .load_symbolic*.error_color default=null
  .load_symbolic*.was_symbolic default=null
  .*.cancellable default=null
Layout
  .new.* default=null
Menu
  .popup_at_*.trigger_event default=null
Notebook
  .append_page.tab_label default=null
  .prepend_page.tab_label default=null
ScaleButton
  .new.min default=0.0
  .new.max default=100.0
  .new.step default=2.0
  .new.icons default=null
TextBuffer
  .set_text.len default=-1
TextTag
  .new.name default=null
TextMark
  .new.left_gravity default=false
Window
  .new.type default=Gtk.WindowType.TOPLEVEL

// Ownership of out arguments
CellRenderer
  .get_preferred_size.minimum_size unowned=false
  .get_preferred_size.natural_size unowned=false
ComboBox
  .get_active_iter.iter unowned=false

// Structs as generic type arguments
binding_entry_add_signall.binding_args type="GLib.SList<Gtk.BindingArg?>"

// Subclasses conflicting with virtual methods with different signatures
CellAreaBox
  .pack_end name="pack_end_full"
  .pack_start name="pack_start_full"
FileFilter
  .get_name name="get_filter_name"
  .set_name name="set_filter_name"
RecentFilter
  .get_name name="get_filter_name"
  .set_name name="set_filter_name"

// Field ownership
RecentData
  .* unowned=false

// Bug #: Nullable properties & fields
ComboBox.active_id nullable
RecentData
  .display_name nullable
  .description nullable
RecentFilterInfo
  .uri nullable
  .display_name nullable
  .mime_type nullable
  .applications nullable
  .groups nullable

// Skipped for G-I, but usable from Vala
FlowBox
  .bind_model skip=false
  .bind_model.create_widget_func nullable
FlowBoxCreateWidgetFunc skip=false
  .item type="GLib.Object"
IMContextSimple
  .add_table skip=false
TreeSelection
  .get_select_function skip=false
  .get_user_data skip=false

// Symbol name conflicts
EntryCompletion
  .insert_prefix#method name="request_prefix_insertion"
Notebook
  .insert_page#virtual_method name="insert_page_menu"
  .insert_page#virtual_method.tab_label nullable
  .insert_page#virtual_method.menu_label nullable
  .insert_page_menu skip
PlacesSidebar
  .show_starred_location#signal name="on_show_starred_location"
TreeView
  .row_expanded#method name="is_row_expanded"
Widget
  .compute_expand#virtual_method name="compute_expand_internal"
  .draw#method name="draw_to_cairo_context"
Window
  .activate_default#method name="try_activate_default"
  .activate_focus#method name="try_activate_focus"
Editable
  .delete_text#method skip
  .insert_text#method skip

// time_t
RecentInfo
  .get_added type="time_t"
  .get_application_info.time_ type="time_t"
  .get_modified type="time_t"
  .get_visited type="time_t"

// Not sure what g-i was thinking
TreeModel
  .filter_new parent="Gtk.TreeModelFilter" name="new" symbol_type="constructor"
  .sort_new_with_model parent="Gtk.TreeModelSort" name="new_with_model" symbol_type="constructor"

// Vala-specific, not really bugs
/////////////////////////////////

// Backwards compatibility
AccelGroup
  .find type="Gtk.AccelKey*"
CssProvider
  .load_from_data name="load_from_buffer"
EntryBuffer
  .new.initial_chars type="uint8[]?" array_length_idx=1
  .emit_inserted_text.chars type="uint8[]" array_length_idx=2
  .insert_text.chars type="uint8[]" array_length_idx=2
  .set_text.chars type="uint8[]" array_length_idx=1
InfoBar
  .get_content_area type="unowned Gtk.Container"
ListStore
  .append return_void
  .move_after.iter ref
  .move_before.iter ref
  .prepend return_void
  .remove.iter ref
PaperSize
  .free destroys_instance
SelectionData
  .free destroys_instance
  .get_data skip=false
render_* parent="Gtk.StyleContext"
render_* symbol_type="method" instance_idx=0
TextBuffer
  .delete.start ref
  .delete.end ref
  .delete_interactive.start_iter ref
  .delete_interactive.end_iter ref
  .get_end_iter return_void
  .get_start_iter return_void
  .insert*.iter ref
  .insert_text.pos ref
  .insert_text#signal.location ref
TextView
  .get_iter_location return_void
  .get_visible_rect return_void
TreePath
  .free destroys_instance
  .get_indices skip
  .get_indices_with_depth name="get_indices"
tree_row_reference_reordered skip=false name="reordered" parent="Gtk.TreeRowReference"
TreeRowReference
  .free destroys_instance
TreeStore
  .move_after.iter ref
  .move_before.iter ref
  .remove.iter ref
TreeView
  .get_background_area return_void
  .get_cell_area return_void
  .get_visible_rect return_void
Widget
  .drag_*#method parent="Gtk" symbol_type="function"
  .get_allocation return_void
  .get_clip return_void
  .grab_add parent="Gtk" symbol_type="function"
  .grab_remove parent="Gtk" symbol_type="function"
  .intersect.intersection unowned=false nullable default=null
  .size_allocate return_void
WidgetPath
  .free destroys_instance
TreeModel
  .get_value return_void
  .rows_reordered skip
BindingArg
  .d.* skip
rc_property_parse_* skip
show_about_dialog skip=false
test_init skip=false

test_init.argvp unowned

@false skip
@true skip

*.*.string name="str"

// Forward upstream
///////////////////
GLArea
  .create_context skip=false
Notebook
  .create_window skip=false
PrintOperation
  .create_custom_widget skip=false

// Not completely sure
Button
  .get_label nullable
  .label nullable
  .set_label.label nullable
ComboBox
  .get_row_separator_func skip=false
Entry
  .populate_popup#signal.widget type="Gtk.Menu"
FileChooser
  .add_choice.options array nullable array_null_terminated
  .add_choice.option_labels array nullable array_null_terminated
FileChooserNative
  .accept_label nullable
  .cancel_label nullable
Menu
  .get_for_attach_widget type="unowned GLib.List<Gtk.Menu>"
  .popped_up.*_rect type="Gdk.Rectangle"
NativeDialog
  .title nullable
  .transient_for nullable
  .get_title nullable
  .get_transient_for nullable
  .set_title.title nullable
  .set_transient_for.parent nullable
Window
  .list_toplevels type="GLib.List<unowned Gtk.Window>"
  .set_focus#signal.object nullable
TreeModel
  .get_path nullable
  .iter_next.iter ref
  .iter_previous.iter ref
TreeView
  .insert_column_with_attributes.title nullable
TreeViewColumn
  .new_with_attributes.title nullable
TextView
  .populate_popup.popup type="Gtk.Menu"
TreeView
  .get_*_func skip=false

// Sure
binding_set_by_class.object_class type="GLib.ObjectClass"
*.ref unowned

// These delegate types don't have targets in the typedefs, but they
// get called with a target.
AccelGroupActivate skip

// Possible TODO
////////////////

// TreeViewColumn.title nullable // (plus all title params in TreeView and TreeViewColumn)