@gtkx/ffi 0.1.44 → 0.1.46

package/dist/generated/gtk/tree-store.js

@@ -4,6 +4,39 @@ import { TreePath } from "./tree-path.js";
 import { TreeModel } from "./tree-model.js";
 import * as GObject from "../gobject/index.js";
 import * as Gdk from "../gdk/index.js";
+/**
+ * A tree-like data structure that can be used with the [class@Gtk.TreeView].
+ *
+ * The `GtkTreeStore` object is a list model for use with a `GtkTreeView`
+ * widget. It implements the [iface@Gtk.TreeModel] interface, and consequently,
+ * can use all of the methods available there. It also implements the
+ * [iface@Gtk.TreeSortable] interface so it can be sorted by the view.
+ * Finally, it also implements the tree [drag][iface@Gtk.TreeDragSource]
+ * and [drop][iface@Gtk.TreeDragDest] interfaces.
+ *
+ * `GtkTreeStore` is deprecated since GTK 4.10, and should not be used in newly
+ * written code. You should use [class@Gtk.TreeListModel] for a tree-like model
+ * object.
+ *
+ * ## GtkTreeStore as GtkBuildable
+ *
+ * The GtkTreeStore implementation of the `GtkBuildable` interface allows
+ * to specify the model columns with a `<columns>` element that may contain
+ * multiple `<column>` elements, each specifying one model column. The “type”
+ * attribute specifies the data type for the column.
+ *
+ * An example of a UI Definition fragment for a tree store:
+ *
+ * ```xml
+ * <object class="GtkTreeStore">
+ * <columns>
+ * <column type="gchararray"/>
+ * <column type="gchararray"/>
+ * <column type="gint"/>
+ * </columns>
+ * </object>
+ * ```
+ */
 export class TreeStore extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -24,6 +57,18 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Appends a new row to @tree_store.
+     *
+     * If `parent` is non-%NULL, then it will append the new row after the last
+     * child of @parent, otherwise it will append a row to the top level.
+     *
+     * The `iter` parameter will be changed to point to this new row. The row will
+     * be empty after this function is called. To fill in values, you need to call
+     * gtk_tree_store_set() or gtk_tree_store_set_value().
+     * @param iter - An unset `GtkTreeIter` to set to the appended row
+     * @param parent - A valid `GtkTreeIter`
+     */
     append(iter, parent) {
         call("libgtk-4.so.1", "gtk_tree_store_append", [
             {
@@ -53,6 +98,9 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes all rows from @tree_store
+     */
     clear() {
         call("libgtk-4.so.1", "gtk_tree_store_clear", [
             {
@@ -61,6 +109,22 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Creates a new row at @position.
+     *
+     * If parent is non-%NULL, then the row will be made a child of @parent.
+     * Otherwise, the row will be created at the toplevel.
+     *
+     * If `position` is `-1` or is larger than the number of rows at that level,
+     * then the new row will be inserted to the end of the list.
+     *
+     * The `iter` parameter will be changed to point to this new row. The row
+     * will be empty after this function is called. To fill in values, you
+     * need to call gtk_tree_store_set() or gtk_tree_store_set_value().
+     * @param iter - An unset `GtkTreeIter` to set to the new row
+     * @param parent - A valid `GtkTreeIter`
+     * @param position - position to insert the new row, or -1 for last
+     */
     insert(iter, position, parent) {
         call("libgtk-4.so.1", "gtk_tree_store_insert", [
             {
@@ -94,6 +158,24 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Inserts a new row after @sibling.
+     *
+     * If `sibling` is %NULL, then the row will be prepended to @parent’s children.
+     *
+     * If `parent` and `sibling` are %NULL, then the row will be prepended to the
+     * toplevel.
+     *
+     * If both `sibling` and `parent` are set, then `parent` must be the parent
+     * of @sibling. When `sibling` is set, `parent` is optional.
+     *
+     * The `iter` parameter will be changed to point to this new row. The row will
+     * be empty after this function is called. To fill in values, you need to call
+     * gtk_tree_store_set() or gtk_tree_store_set_value().
+     * @param iter - An unset `GtkTreeIter` to set to the new row
+     * @param parent - A valid `GtkTreeIter`
+     * @param sibling - A valid `GtkTreeIter`
+     */
     insertAfter(iter, parent, sibling) {
         call("libgtk-4.so.1", "gtk_tree_store_insert_after", [
             {
@@ -133,6 +215,24 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Inserts a new row before @sibling.
+     *
+     * If `sibling` is %NULL, then the row will be appended to @parent’s children.
+     *
+     * If `parent` and `sibling` are %NULL, then the row will be appended to the
+     * toplevel.
+     *
+     * If both `sibling` and `parent` are set, then `parent` must be the parent
+     * of @sibling. When `sibling` is set, `parent` is optional.
+     *
+     * The `iter` parameter will be changed to point to this new row. The row will
+     * be empty after this function is called. To fill in values, you need to call
+     * gtk_tree_store_set() or gtk_tree_store_set_value().
+     * @param iter - An unset `GtkTreeIter` to set to the new row
+     * @param parent - A valid `GtkTreeIter`
+     * @param sibling - A valid `GtkTreeIter`
+     */
     insertBefore(iter, parent, sibling) {
         call("libgtk-4.so.1", "gtk_tree_store_insert_before", [
             {
@@ -172,6 +272,18 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * A variant of gtk_tree_store_insert_with_values() which takes
+     * the columns and values as two arrays, instead of varargs.
+     *
+     * This function is mainly intended for language bindings.
+     * @param iter - An unset `GtkTreeIter` to set the new row
+     * @param parent - A valid `GtkTreeIter`
+     * @param position - position to insert the new row, or -1 for last
+     * @param columns - an array of column numbers
+     * @param values - an array of GValues
+     * @param nValues - the length of the `columns` and `values` arrays
+     */
     insertWithValuesv(position, columns, values, nValues, iter, parent) {
         call("libgtk-4.so.1", "gtk_tree_store_insert_with_valuesv", [
             {
@@ -228,6 +340,11 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Checks if `iter` is an ancestor of @descendant.
+     * @param iter - A valid `GtkTreeIter`
+     * @param descendant - A valid `GtkTreeIter`
+     */
     isAncestor(iter, descendant) {
         return call("libgtk-4.so.1", "gtk_tree_store_is_ancestor", [
             {
@@ -254,6 +371,13 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the depth of the position pointed by the iterator
+     *
+     * The depth will be 0 for anything on the root level, 1 for anything down
+     * a level, etc.
+     * @param iter - A valid `GtkTreeIter`
+     */
     iterDepth(iter) {
         return call("libgtk-4.so.1", "gtk_tree_store_iter_depth", [
             {
@@ -271,6 +395,13 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Checks if the given iter is a valid iter for this `GtkTreeStore`.
+     *
+     * This function is slow. Only use it for debugging and/or testing
+     * purposes.
+     * @param iter - the iterator to check
+     */
     iterIsValid(iter) {
         return call("libgtk-4.so.1", "gtk_tree_store_iter_is_valid", [
             {
@@ -288,6 +419,17 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Moves `iter` in `tree_store` to the position after @position.
+     *
+     * `iter` and `position` should be in the same level.
+     *
+     * Note that this function only works with unsorted stores.
+     *
+     * If `position` is %NULL, `iter` will be moved to the start of the level.
+     * @param iter - A `GtkTreeIter`.
+     * @param position - A `GtkTreeIter`.
+     */
     moveAfter(iter, position) {
         call("libgtk-4.so.1", "gtk_tree_store_move_after", [
             {
@@ -315,6 +457,17 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Moves `iter` in `tree_store` to the position before @position.
+     *
+     * `iter` and `position` should be in the same level.
+     *
+     * Note that this function only works with unsorted stores.
+     *
+     * If `position` is %NULL, `iter` will be moved to the end of the level.
+     * @param iter - A `GtkTreeIter`
+     * @param position - A `GtkTreeIter`
+     */
     moveBefore(iter, position) {
         call("libgtk-4.so.1", "gtk_tree_store_move_before", [
             {
@@ -342,6 +495,17 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Prepends a new row to @tree_store.
+     *
+     * If `parent` is non-%NULL, then it will prepend the new row before the first
+     * child of @parent, otherwise it will prepend a row to the top level. The
+     * `iter` parameter will be changed to point to this new row.  The row will
+     * be empty after this function is called. To fill in values, you need to
+     * call gtk_tree_store_set() or gtk_tree_store_set_value().
+     * @param iter - An unset `GtkTreeIter` to set to the prepended row
+     * @param parent - A valid `GtkTreeIter`
+     */
     prepend(iter, parent) {
         call("libgtk-4.so.1", "gtk_tree_store_prepend", [
             {
@@ -371,6 +535,13 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes `iter` from @tree_store.
+     *
+     * After being removed, `iter` is set to the next valid row at that level, or
+     * invalidated if it previously pointed to the last one.
+     * @param iter - A valid `GtkTreeIter`
+     */
     remove(iter) {
         return call("libgtk-4.so.1", "gtk_tree_store_remove", [
             {
@@ -388,6 +559,19 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets the type of the columns in a tree store.
+     *
+     * This function is meant primarily for types that inherit from
+     * `GtkTreeStore`, and should only be used when constructing a new
+     * `GtkTreeStore`.
+     *
+     * This functions cannot be called after a row has been added,
+     * or a method on the `GtkTreeModel` interface is called on the
+     * tree store.
+     * @param nColumns - Number of columns for the tree store
+     * @param types - An array of `GType` types, one for each column
+     */
     setColumnTypes(nColumns, types) {
         call("libgtk-4.so.1", "gtk_tree_store_set_column_types", [
             {
@@ -407,6 +591,15 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the data in the cell specified by `iter` and @column.
+     *
+     * The type of `value` must be convertible to the type of the
+     * column.
+     * @param iter - A valid `GtkTreeIter` for the row being modified
+     * @param column - column number to modify
+     * @param value - new value for the cell
+     */
     setValue(iter, column, value) {
         call("libgtk-4.so.1", "gtk_tree_store_set_value", [
             {
@@ -437,6 +630,18 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * A variant of gtk_tree_store_set_valist() which takes
+     * the columns and values as two arrays, instead of using variadic
+     * arguments.
+     *
+     * This function is mainly intended for language bindings or in case
+     * the number of columns to change is not known until run-time.
+     * @param iter - A valid `GtkTreeIter` for the row being modified
+     * @param columns - an array of column numbers
+     * @param values - an array of GValues
+     * @param nValues - the length of the `columns` and `values` arrays
+     */
     setValuesv(iter, columns, values, nValues) {
         call("libgtk-4.so.1", "gtk_tree_store_set_valuesv", [
             {
@@ -476,6 +681,13 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Swaps `a` and `b` in the same level of @tree_store.
+     *
+     * Note that this function only works with unsorted stores.
+     * @param a - A `GtkTreeIter`.
+     * @param b - Another `GtkTreeIter`.
+     */
     swap(a, b) {
         call("libgtk-4.so.1", "gtk_tree_store_swap", [
             {
@@ -502,6 +714,12 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the ID of the `buildable` object.
+     *
+     * `GtkBuilder` sets the name based on the ID attribute
+     * of the `<object>` tag used to construct the @buildable.
+     */
     getBuildableId() {
         return call("libgtk-4.so.1", "gtk_buildable_get_buildable_id", [
             {
@@ -510,6 +728,16 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Asks the `GtkTreeDragDest` to insert a row before the path @dest,
+     * deriving the contents of the row from @value. If `dest` is
+     * outside the tree so that inserting before it is impossible, %FALSE
+     * will be returned. Also, %FALSE may be returned if the new row is
+     * not created for some model-specific reason.  Should robustly handle
+     * a `dest` no longer found in the model!
+     * @param dest - row to drop in front of
+     * @param value - data to drop
+     */
     dragDataReceived(dest, value) {
         return call("libgtk-4.so.1", "gtk_tree_drag_dest_drag_data_received", [
             {
@@ -536,6 +764,15 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Determines whether a drop is possible before the given @dest_path,
+     * at the same depth as @dest_path. i.e., can we drop the data in
+     * `value` at that location. `dest_path` does not have to
+     * exist; the return value will almost certainly be %FALSE if the
+     * parent of `dest_path` doesn’t exist, though.
+     * @param destPath - destination row
+     * @param value - the data being dropped
+     */
     rowDropPossible(destPath, value) {
         return call("libgtk-4.so.1", "gtk_tree_drag_dest_row_drop_possible", [
             {
@@ -562,6 +799,14 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Asks the `GtkTreeDragSource` to delete the row at @path, because
+     * it was moved somewhere else via drag-and-drop. Returns %FALSE
+     * if the deletion fails because `path` no longer exists, or for
+     * some model-specific reason. Should robustly handle a `path` no
+     * longer found in the model!
+     * @param path - row that was being dragged
+     */
     dragDataDelete(path) {
         return call("libgtk-4.so.1", "gtk_tree_drag_source_drag_data_delete", [
             {
@@ -579,6 +824,12 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Asks the `GtkTreeDragSource` to return a `GdkContentProvider` representing
+     * the row at @path. Should robustly handle a `path` no
+     * longer found in the model!
+     * @param path - row that was dragged
+     */
     dragDataGet(path) {
         const ptr = call("libgtk-4.so.1", "gtk_tree_drag_source_drag_data_get", [
             {
@@ -599,6 +850,12 @@ export class TreeStore extends GObject.GObject {
             return null;
         return getObject(ptr, Gdk.ContentProvider);
     }
+    /**
+     * Asks the `GtkTreeDragSource` whether a particular row can be used as
+     * the source of a DND operation. If the source doesn’t implement
+     * this interface, the row is assumed draggable.
+     * @param path - row on which user is initiating a drag
+     */
     rowDraggable(path) {
         return call("libgtk-4.so.1", "gtk_tree_drag_source_row_draggable", [
             {
@@ -616,6 +873,11 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Creates a new `GtkTreeModel`, with `child_model` as the child_model
+     * and `root` as the virtual root.
+     * @param root - A `GtkTreePath`
+     */
     filterNew(root) {
         const ptr = call("libgtk-4.so.1", "gtk_tree_model_filter_new", [
             {
@@ -635,6 +897,14 @@ export class TreeStore extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, TreeModel);
     }
+    /**
+     * Calls `func` on each node in model in a depth-first fashion.
+     *
+     * If `func` returns %TRUE, then the tree ceases to be walked,
+     * and gtk_tree_model_foreach() returns.
+     * @param func - a function to be called on each row
+     * @param userData - user data to passed to @func
+     */
     foreach(func, userData) {
         call("libgtk-4.so.1", "gtk_tree_model_foreach", [
             {
@@ -652,6 +922,10 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Returns the type of the column.
+     * @param index_ - the column index
+     */
     getColumnType(index_) {
         return call("libgtk-4.so.1", "gtk_tree_model_get_column_type", [
             {
@@ -664,6 +938,13 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "int", size: 64, unsigned: true });
     }
+    /**
+     * Returns a set of flags supported by this interface.
+     *
+     * The flags are a bitwise combination of `GtkTreeModel`Flags.
+     * The flags supported should not change during the lifetime
+     * of the @tree_model.
+     */
     getFlags() {
         return call("libgtk-4.so.1", "gtk_tree_model_get_flags", [
             {
@@ -672,6 +953,14 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Sets `iter` to a valid iterator pointing to @path.
+     *
+     * If `path` does not exist, `iter` is set to an invalid
+     * iterator and %FALSE is returned.
+     * @param iter - the uninitialized `GtkTreeIter`
+     * @param path - the `GtkTreePath`
+     */
     getIter(iter, path) {
         return call("libgtk-4.so.1", "gtk_tree_model_get_iter", [
             {
@@ -700,6 +989,13 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Initializes `iter` with the first iterator in the tree
+     * (the one at the path "0").
+     *
+     * Returns %FALSE if the tree is empty, %TRUE otherwise.
+     * @param iter - the uninitialized `GtkTreeIter`
+     */
     getIterFirst(iter) {
         return call("libgtk-4.so.1", "gtk_tree_model_get_iter_first", [
             {
@@ -719,6 +1015,14 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets `iter` to a valid iterator pointing to @path_string, if it
+     * exists.
+     *
+     * Otherwise, `iter` is left invalid and %FALSE is returned.
+     * @param iter - an uninitialized `GtkTreeIter`
+     * @param pathString - a string representation of a `GtkTreePath`
+     */
     getIterFromString(iter, pathString) {
         return call("libgtk-4.so.1", "gtk_tree_model_get_iter_from_string", [
             {
@@ -742,6 +1046,9 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the number of columns supported by @tree_model.
+     */
     getNColumns() {
         return call("libgtk-4.so.1", "gtk_tree_model_get_n_columns", [
             {
@@ -750,6 +1057,12 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns a newly-created `GtkTreePath` referenced by @iter.
+     *
+     * This path should be freed with gtk_tree_path_free().
+     * @param iter - the `GtkTreeIter`
+     */
     getPath(iter) {
         const ptr = call("libgtk-4.so.1", "gtk_tree_model_get_path", [
             {
@@ -773,6 +1086,14 @@ export class TreeStore extends GObject.GObject {
         });
         return getObject(ptr, TreePath);
     }
+    /**
+     * Generates a string representation of the iter.
+     *
+     * This string is a “:” separated list of numbers.
+     * For example, “4:10:0:3” would be an acceptable
+     * return value for this string.
+     * @param iter - a `GtkTreeIter`
+     */
     getStringFromIter(iter) {
         return call("libgtk-4.so.1", "gtk_tree_model_get_string_from_iter", [
             {
@@ -790,6 +1111,15 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "string" });
     }
+    /**
+     * Initializes and sets `value` to that at @column.
+     *
+     * When done with @value, g_value_unset() needs to be called
+     * to free any allocated memory.
+     * @param iter - the `GtkTreeIter`
+     * @param column - the column to lookup the value at
+     * @param value - an empty `GValue` to set
+     */
     getValue(iter, column, value) {
         call("libgtk-4.so.1", "gtk_tree_model_get_value", [
             {
@@ -822,6 +1152,18 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets `iter` to point to the first child of @parent.
+     *
+     * If `parent` has no children, %FALSE is returned and `iter` is
+     * set to be invalid. `parent` will remain a valid node after this
+     * function has been called.
+     *
+     * If `parent` is %NULL returns the first node, equivalent to
+     * `gtk_tree_model_get_iter_first (tree_model, iter);`
+     * @param iter - the new `GtkTreeIter` to be set to the child
+     * @param parent - the `GtkTreeIter`
+     */
     iterChildren(iter, parent) {
         return call("libgtk-4.so.1", "gtk_tree_model_iter_children", [
             {
@@ -851,6 +1193,10 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns %TRUE if `iter` has children, %FALSE otherwise.
+     * @param iter - the `GtkTreeIter` to test for children
+     */
     iterHasChild(iter) {
         return call("libgtk-4.so.1", "gtk_tree_model_iter_has_child", [
             {
@@ -868,6 +1214,13 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the number of children that `iter` has.
+     *
+     * As a special case, if `iter` is %NULL, then the number
+     * of toplevel nodes is returned.
+     * @param iter - the `GtkTreeIter`
+     */
     iterNChildren(iter) {
         return call("libgtk-4.so.1", "gtk_tree_model_iter_n_children", [
             {
@@ -886,6 +1239,13 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Sets `iter` to point to the node following it at the current level.
+     *
+     * If there is no next @iter, %FALSE is returned and `iter` is set
+     * to be invalid.
+     * @param iter - the `GtkTreeIter`
+     */
     iterNext(iter) {
         return call("libgtk-4.so.1", "gtk_tree_model_iter_next", [
             {
@@ -903,6 +1263,17 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets `iter` to be the child of @parent, using the given index.
+     *
+     * The first index is 0. If `n` is too big, or `parent` has no children,
+     * `iter` is set to an invalid iterator and %FALSE is returned. `parent` will remain a valid node after this function has been called. As a
+     * special case, if `parent` is %NULL, then the @n-th root node
+     * is set.
+     * @param iter - the `GtkTreeIter` to set to the nth child
+     * @param parent - the `GtkTreeIter` to get the child from
+     * @param n - the index of the desired child
+     */
     iterNthChild(iter, n, parent) {
         return call("libgtk-4.so.1", "gtk_tree_model_iter_nth_child", [
             {
@@ -936,6 +1307,18 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets `iter` to be the parent of @child.
+     *
+     * If `child` is at the toplevel, and doesn’t have a parent, then
+     * `iter` is set to an invalid iterator and %FALSE is returned.
+     * `child` will remain a valid node after this function has been
+     * called.
+     *
+     * `iter` will be initialized before the lookup is performed, so `child` and `iter` cannot point to the same memory location.
+     * @param iter - the new `GtkTreeIter` to set to the parent
+     * @param child - the `GtkTreeIter`
+     */
     iterParent(iter, child) {
         return call("libgtk-4.so.1", "gtk_tree_model_iter_parent", [
             {
@@ -964,6 +1347,13 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets `iter` to point to the previous node at the current level.
+     *
+     * If there is no previous @iter, %FALSE is returned and `iter` is
+     * set to be invalid.
+     * @param iter - the `GtkTreeIter`
+     */
     iterPrevious(iter) {
         return call("libgtk-4.so.1", "gtk_tree_model_iter_previous", [
             {
@@ -981,6 +1371,26 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Lets the tree ref the node.
+     *
+     * This is an optional method for models to implement.
+     * To be more specific, models may ignore this call as it exists
+     * primarily for performance reasons.
+     *
+     * This function is primarily meant as a way for views to let
+     * caching models know when nodes are being displayed (and hence,
+     * whether or not to cache that node). Being displayed means a node
+     * is in an expanded branch, regardless of whether the node is currently
+     * visible in the viewport. For example, a file-system based model
+     * would not want to keep the entire file-hierarchy in memory,
+     * just the sections that are currently being displayed by
+     * every current view.
+     *
+     * A model should be expected to be able to get an iter independent
+     * of its reffed state.
+     * @param iter - the `GtkTreeIter`
+     */
     refNode(iter) {
         call("libgtk-4.so.1", "gtk_tree_model_ref_node", [
             {
@@ -998,6 +1408,13 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Emits the ::row-changed signal on @tree_model.
+     *
+     * See [signal@Gtk.TreeModel::row-changed].
+     * @param path - a `GtkTreePath` pointing to the changed row
+     * @param iter - a valid `GtkTreeIter` pointing to the changed row
+     */
     rowChanged(path, iter) {
         call("libgtk-4.so.1", "gtk_tree_model_row_changed", [
             {
@@ -1024,6 +1441,19 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Emits the ::row-deleted signal on @tree_model.
+     *
+     * See [signal@Gtk.TreeModel::row-deleted].
+     *
+     * This should be called by models after a row has been removed.
+     * The location pointed to by `path` should be the location that
+     * the row previously was at. It may not be a valid location anymore.
+     *
+     * Nodes that are deleted are not unreffed, this means that any
+     * outstanding references on the deleted node should not be released.
+     * @param path - a `GtkTreePath` pointing to the previous location of
+     */
     rowDeleted(path) {
         call("libgtk-4.so.1", "gtk_tree_model_row_deleted", [
             {
@@ -1041,6 +1471,16 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Emits the ::row-has-child-toggled signal on @tree_model.
+     *
+     * See [signal@Gtk.TreeModel::row-has-child-toggled].
+     *
+     * This should be called by models after the child
+     * state of a node changes.
+     * @param path - a `GtkTreePath` pointing to the changed row
+     * @param iter - a valid `GtkTreeIter` pointing to the changed row
+     */
     rowHasChildToggled(path, iter) {
         call("libgtk-4.so.1", "gtk_tree_model_row_has_child_toggled", [
             {
@@ -1067,6 +1507,13 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Emits the ::row-inserted signal on @tree_model.
+     *
+     * See [signal@Gtk.TreeModel::row-inserted].
+     * @param path - a `GtkTreePath` pointing to the inserted row
+     * @param iter - a valid `GtkTreeIter` pointing to the inserted row
+     */
     rowInserted(path, iter) {
         call("libgtk-4.so.1", "gtk_tree_model_row_inserted", [
             {
@@ -1093,6 +1540,18 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Emits the ::rows-reordered signal on @tree_model.
+     *
+     * See [signal@Gtk.TreeModel::rows-reordered].
+     *
+     * This should be called by models when their rows have been
+     * reordered.
+     * @param path - a `GtkTreePath` pointing to the tree node whose children
+     * @param iter - a valid `GtkTreeIter` pointing to the node
+     * @param newOrder - an array of integers
+     * @param length - length of `new_order` array
+     */
     rowsReorderedWithLength(path, newOrder, length, iter) {
         call("libgtk-4.so.1", "gtk_tree_model_rows_reordered_with_length", [
             {
@@ -1131,6 +1590,17 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Lets the tree unref the node.
+     *
+     * This is an optional method for models to implement.
+     * To be more specific, models may ignore this call as it exists
+     * primarily for performance reasons. For more information on what
+     * this means, see gtk_tree_model_ref_node().
+     *
+     * Please note that nodes that are deleted are not unreffed.
+     * @param iter - the `GtkTreeIter`
+     */
     unrefNode(iter) {
         call("libgtk-4.so.1", "gtk_tree_model_unref_node", [
             {
@@ -1148,6 +1618,14 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Fills in `sort_column_id` and `order` with the current sort column and the
+     * order. It returns %TRUE unless the `sort_column_id` is
+     * %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or
+     * %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID.
+     * @param sortColumnId - The sort column id to be filled in
+     * @param order - The `GtkSortType` to be filled in
+     */
     getSortColumnId(sortColumnId, order) {
         return call("libgtk-4.so.1", "gtk_tree_sortable_get_sort_column_id", [
             {
@@ -1170,6 +1648,11 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns %TRUE if the model has a default sort function. This is used
+     * primarily by GtkTreeViewColumns in order to determine if a model can
+     * go back to the default state, or not.
+     */
     hasDefaultSortFunc() {
         return call("libgtk-4.so.1", "gtk_tree_sortable_has_default_sort_func", [
             {
@@ -1178,6 +1661,19 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets the default comparison function used when sorting to be @sort_func.
+     * If the current sort column id of `sortable` is
+     * %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using
+     * this function.
+     *
+     * If `sort_func` is %NULL, then there will be no default comparison function.
+     * This means that once the model  has been sorted, it can’t go back to the
+     * default state. In this case, when the current sort column id of `sortable` is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted.
+     * @param sortFunc - The comparison function
+     * @param userData - User data to pass to @sort_func
+     * @param destroy - Destroy notifier of @user_data
+     */
     setDefaultSortFunc(sortFunc, userData, destroy) {
         call("libgtk-4.so.1", "gtk_tree_sortable_set_default_sort_func", [
             {
@@ -1200,6 +1696,19 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the current sort column to be @sort_column_id. The `sortable` will
+     * resort itself to reflect this change, after emitting a
+     * `GtkTreeSortable::sort-column-changed` signal. `sort_column_id` may either be
+     * a regular column id, or one of the following special values:
+     *
+     * - %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID: the default sort function
+     * will be used, if it is set
+     *
+     * - %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID: no sorting will occur
+     * @param sortColumnId - the sort column id to set
+     * @param order - The sort order of the column
+     */
     setSortColumnId(sortColumnId, order) {
         call("libgtk-4.so.1", "gtk_tree_sortable_set_sort_column_id", [
             {
@@ -1216,6 +1725,15 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the comparison function used when sorting to be @sort_func. If the
+     * current sort column id of `sortable` is the same as @sort_column_id, then
+     * the model will sort using this function.
+     * @param sortColumnId - the sort column id to set the function for
+     * @param sortFunc - The comparison function
+     * @param userData - User data to pass to @sort_func
+     * @param destroy - Destroy notifier of @user_data
+     */
     setSortFunc(sortColumnId, sortFunc, userData, destroy) {
         call("libgtk-4.so.1", "gtk_tree_sortable_set_sort_func", [
             {
@@ -1242,6 +1760,9 @@ export class TreeStore extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Emits a `GtkTreeSortable::sort-column-changed` signal on @sortable.
+     */
     sortColumnChanged() {
         call("libgtk-4.so.1", "gtk_tree_sortable_sort_column_changed", [
             {