:right-sidebar: True TreeModel =================================================================== .. currentmodule:: gi.repository.Gtk .. deprecated:: 4.10 Use :obj:`~gi.repository.Gio.ListModel` instead .. class:: TreeModel(*args, **kwargs) :no-contents-entry: Implementations: :class:`~gi.repository.Gtk.ListStore`, :class:`~gi.repository.Gtk.TreeModelFilter`, :class:`~gi.repository.Gtk.TreeModelSort`, :class:`~gi.repository.Gtk.TreeStore` The tree interface used by GtkTreeView The ``GtkTreeModel`` interface defines a generic tree interface for use by the ``GtkTreeView`` widget. It is an abstract interface, and is designed to be usable with any appropriate data structure. The programmer just has to implement this interface on their own data type for it to be viewable by a ``GtkTreeView`` widget. The model is represented as a hierarchical tree of strongly-typed, columned data. In other words, the model can be seen as a tree where every node has different values depending on which column is being queried. The type of data found in a column is determined by using the GType system (ie. :obj:`int`, ``%GTK_TYPE_BUTTON``, ``%G_TYPE_POINTER``, etc). The types are homogeneous per column across all nodes. It is important to note that this interface only provides a way of examining a model and observing changes. The implementation of each individual model decides how and if changes are made. In order to make life simpler for programmers who do not need to write their own specialized model, two generic models are provided — the ``GtkTreeStore`` and the ``GtkListStore``. To use these, the developer simply pushes data into these models as necessary. These models provide the data structure as well as all appropriate tree interfaces. As a result, implementing drag and drop, sorting, and storing data is trivial. For the vast majority of trees and lists, these two models are sufficient. Models are accessed on a node/column level of granularity. One can query for the value of a model at a certain node and a certain column on that node. There are two structures used to reference a particular node in a model. They are the :obj:`~gi.repository.Gtk.TreePath` and the :obj:`~gi.repository.Gtk.TreeIter` (“iter” is short for iterator). Most of the interface consists of operations on a :obj:`~gi.repository.Gtk.TreeIter`. A path is essentially a potential node. It is a location on a model that may or may not actually correspond to a node on a specific model. A :obj:`~gi.repository.Gtk.TreePath` can be converted into either an array of unsigned integers or a string. The string form is a list of numbers separated by a colon. Each number refers to the offset at that level. Thus, the path ``0`` refers to the root node and the path ``2:4`` refers to the fifth child of the third node. By contrast, a :obj:`~gi.repository.Gtk.TreeIter` is a reference to a specific node on a specific model. It is a generic struct with an integer and three generic pointers. These are filled in by the model in a model-specific way. One can convert a path to an iterator by calling :func:`~gi.repository.Gtk.TreeModel.get_iter`. These iterators are the primary way of accessing a model and are similar to the iterators used by ``GtkTextBuffer``. They are generally statically allocated on the stack and only used for a short time. The model interface defines a set of operations using them for navigating the model. It is expected that models fill in the iterator with private data. For example, the ``GtkListStore`` model, which is internally a simple linked list, stores a list node in one of the pointers. The ``GtkTreeModel``Sort stores an array and an offset in two of the pointers. Additionally, there is an integer field. This field is generally filled with a unique stamp per model. This stamp is for catching errors resulting from using invalid iterators with a model. The lifecycle of an iterator can be a little confusing at first. Iterators are expected to always be valid for as long as the model is unchanged (and doesn’t emit a signal). The model is considered to own all outstanding iterators and nothing needs to be done to free them from the user’s point of view. Additionally, some models guarantee that an iterator is valid for as long as the node it refers to is valid (most notably the ``GtkTreeStore`` and ``GtkListStore``). Although generally uninteresting, as one always has to allow for the case where iterators do not persist beyond a signal, some very important performance enhancements were made in the sort model. As a result, the :const:`~gi.repository.Gtk.TreeModelFlags.ITERS_PERSIST` flag was added to indicate this behavior. To help show some common operation of a model, some examples are provided. The first example shows three ways of getting the iter at the location ``3:2:5``. While the first method shown is easier, the second is much more common, as you often get paths from callbacks. Acquiring a ``GtkTreeIter`` --------------------------- .. code-block:: c :dedent: // Three ways of getting the iter pointing to the location GtkTreePath *path; GtkTreeIter iter; GtkTreeIter parent_iter; // get the iterator from a string gtk_tree_model_get_iter_from_string (model, &iter, "3:2:5"); // get the iterator from a path path = gtk_tree_path_new_from_string ("3:2:5"); gtk_tree_model_get_iter (model, &iter, path); gtk_tree_path_free (path); // walk the tree to find the iterator gtk_tree_model_iter_nth_child (model, &iter, NULL, 3); parent_iter = iter; gtk_tree_model_iter_nth_child (model, &iter, &parent_iter, 2); parent_iter = iter; gtk_tree_model_iter_nth_child (model, &iter, &parent_iter, 5); This second example shows a quick way of iterating through a list and getting a string and an integer from each row. The populate_model() function used below is not shown, as it is specific to the ``GtkListStore``. For information on how to write such a function, see the ``GtkListStore`` documentation. Reading data from a ``GtkTreeModel`` ------------------------------------ .. code-block:: c :dedent: enum { STRING_COLUMN, INT_COLUMN, N_COLUMNS }; ... GtkTreeModel *list_store; GtkTreeIter iter; gboolean valid; int row_count = 0; // make a new list_store list_store = gtk_list_store_new (N_COLUMNS, G_TYPE_STRING, G_TYPE_INT); // Fill the list store with data populate_model (list_store); // Get the first iter in the list, check it is valid and walk // through the list, reading each row. valid = gtk_tree_model_get_iter_first (list_store, &iter); while (valid) { char *str_data; int int_data; // Make sure you terminate calls to :func:`~gi.repository.Gtk.TreeModel.get` with a “-1” value gtk_tree_model_get (list_store, &iter, STRING_COLUMN, &str_data, INT_COLUMN, &int_data, -1); // Do something with the data g_print ("Row ``%d``: (``%s``,``%d``)\n", row_count, str_data, int_data); g_free (str_data); valid = gtk_tree_model_iter_next (list_store, &iter); row_count++; } The ``GtkTreeModel`` interface contains two methods for reference counting: :func:`~gi.repository.Gtk.TreeModel.ref_node` and :func:`~gi.repository.Gtk.TreeModel.unref_node`. These two methods are optional to implement. The reference counting is meant as a way for views to let models know when nodes are being displayed. ``GtkTreeView`` will take a reference on a node when it is visible, which means the node is either in the toplevel or expanded. Being displayed does not mean that the node is currently directly visible to the user in the viewport. Based on this reference counting scheme a caching model, for example, can decide whether or not to cache a node based on the reference count. A file-system based model would not want to keep the entire file hierarchy in memory, but just the folders that are currently expanded in every current view. When working with reference counting, the following rules must be taken into account: - Never take a reference on a node without owning a reference on its parent. This means that all parent nodes of a referenced node must be referenced as well. - Outstanding references on a deleted node are not released. This is not possible because the node has already been deleted by the time the row-deleted signal is received. - Models are not obligated to emit a signal on rows of which none of its siblings are referenced. To phrase this differently, signals are only required for levels in which nodes are referenced. For the root level however, signals must be emitted at all times (however the root level is always referenced when any view is attached). Methods ------- .. rst-class:: interim-class .. class:: TreeModel :no-index: .. method:: filter_new(root: ~gi.repository.Gtk.TreePath | None = None) -> ~gi.repository.Gtk.TreeModel Creates a new ``GtkTreeModel``, with ``child_model`` as the child_model and ``root`` as the virtual root. .. deprecated:: 4.10 Please do not use it in newly written code :param root: A ``GtkTreePath`` .. method:: foreach(func: ~typing.Callable[[...], bool], *user_data: ~typing.Any) -> None Calls ``func`` on each node in model in a depth-first fashion. If ``func`` returns :const:`True`, then the tree ceases to be walked, and :func:`~gi.repository.Gtk.TreeModel.foreach` returns. .. deprecated:: 4.10 Please do not use it in newly written code :param func: a function to be called on each row :param user_data: user data to passed to ``func`` .. method:: get(treeiter, *columns) Gets the value of one or more cells in the row referenced by ``iter``. The variable argument list should contain integer column numbers, each column number followed by a place to store the value being retrieved. The list is terminated by a -1. For example, to get a value from column 0 with type :obj:`str`, you would write: `gtk_tree_model_get (model, iter, 0, &place_string_here, -1)`, where ``place_string_here`` is a ``gchararray`` to be filled with the string. Returned values with type :obj:`object` have to be unreferenced, values with type :obj:`str` or ``Boxed`` have to be freed. Other values are passed by value. .. deprecated:: 4.10 Please do not use it in newly written code :param treeiter: :param columns: .. method:: get_column_type(index_: int) -> type Returns the type of the column. .. deprecated:: 4.10 Please do not use it in newly written code :param index_: the column index .. method:: get_flags() -> ~gi.repository.Gtk.TreeModelFlags 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``. .. deprecated:: 4.10 Please do not use it in newly written code .. method:: get_iter(path) Sets ``iter`` to a valid iterator pointing to ``path``. If ``path`` does not exist, ``iter`` is set to an invalid iterator and :const:`False` is returned. .. deprecated:: 4.10 Please do not use it in newly written code :param path: the ``GtkTreePath`` .. method:: get_iter_first() -> tuple[bool, ~gi.repository.Gtk.TreeIter] Initializes ``iter`` with the first iterator in the tree (the one at the path "0"). Returns :const:`False` if the tree is empty, :const:`True` otherwise. .. deprecated:: 4.10 Please do not use it in newly written code .. method:: get_iter_from_string(path_string: str) -> tuple[bool, ~gi.repository.Gtk.TreeIter] Sets ``iter`` to a valid iterator pointing to ``path_string``, if it exists. Otherwise, ``iter`` is left invalid and :const:`False` is returned. .. deprecated:: 4.10 Please do not use it in newly written code :param path_string: a string representation of a ``GtkTreePath`` .. method:: get_n_columns() -> int Returns the number of columns supported by ``tree_model``. .. deprecated:: 4.10 Please do not use it in newly written code .. method:: get_path(iter: ~gi.repository.Gtk.TreeIter) -> ~gi.repository.Gtk.TreePath Returns a newly-created ``GtkTreePath`` referenced by ``iter``. This path should be freed with :func:`~gi.repository.Gtk.TreePath.free`. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: the ``GtkTreeIter`` .. method:: get_string_from_iter(iter: ~gi.repository.Gtk.TreeIter) -> str | None 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. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: a ``GtkTreeIter`` .. method:: get_value(iter: ~gi.repository.Gtk.TreeIter, column: int) -> ~typing.Any Initializes and sets ``value`` to that at ``column``. When done with ``value``, :func:`~gi.repository.GObject.Value.unset` needs to be called to free any allocated memory. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: the ``GtkTreeIter`` :param column: the column to lookup the value at .. method:: iter_children(parent: ~gi.repository.Gtk.TreeIter | None = None) -> tuple[bool, ~gi.repository.Gtk.TreeIter] Sets ``iter`` to point to the first child of ``parent``. If ``parent`` has no children, :const:`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 :const:`None` returns the first node, equivalent to `gtk_tree_model_get_iter_first (tree_model, iter);` .. deprecated:: 4.10 Please do not use it in newly written code :param parent: the ``GtkTreeIter`` .. method:: iter_has_child(iter: ~gi.repository.Gtk.TreeIter) -> bool Returns :const:`True` if ``iter`` has children, :const:`False` otherwise. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: the ``GtkTreeIter`` to test for children .. method:: iter_n_children(iter: ~gi.repository.Gtk.TreeIter | None = None) -> int Returns the number of children that ``iter`` has. As a special case, if ``iter`` is :const:`None`, then the number of toplevel nodes is returned. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: the ``GtkTreeIter`` .. method:: iter_next(aiter) Sets ``iter`` to point to the node following it at the current level. If there is no next ``iter``, :const:`False` is returned and ``iter`` is set to be invalid. .. deprecated:: 4.10 Please do not use it in newly written code :param aiter: .. method:: iter_nth_child(parent: ~gi.repository.Gtk.TreeIter | None, n: int) -> tuple[bool, ~gi.repository.Gtk.TreeIter] 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 :const:`False` is returned. ``parent`` will remain a valid node after this function has been called. As a special case, if ``parent`` is :const:`None`, then the ``n``-th root node is set. .. deprecated:: 4.10 Please do not use it in newly written code :param parent: the ``GtkTreeIter`` to get the child from :param n: the index of the desired child .. method:: iter_parent(child: ~gi.repository.Gtk.TreeIter) -> tuple[bool, ~gi.repository.Gtk.TreeIter] 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 :const:`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. .. deprecated:: 4.10 Please do not use it in newly written code :param child: the ``GtkTreeIter`` .. method:: iter_previous(aiter) Sets ``iter`` to point to the previous node at the current level. If there is no previous ``iter``, :const:`False` is returned and ``iter`` is set to be invalid. .. deprecated:: 4.10 Please do not use it in newly written code :param aiter: .. method:: row_changed(path, iter) Emits the ::row-changed signal on ``tree_model``. See :obj:`~gi.repository.Gtk.TreeModel.signals.row_changed`. .. deprecated:: 4.10 Please do not use it in newly written code :param path: a ``GtkTreePath`` pointing to the changed row :param iter: a valid ``GtkTreeIter`` pointing to the changed row .. method:: row_deleted(path) Emits the ::row-deleted signal on ``tree_model``. See :obj:`~gi.repository.Gtk.TreeModel.signals.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. .. deprecated:: 4.10 Please do not use it in newly written code :param path: a ``GtkTreePath`` pointing to the previous location of the deleted row .. method:: row_has_child_toggled(path, iter) Emits the ::row-has-child-toggled signal on ``tree_model``. See :obj:`~gi.repository.Gtk.TreeModel.signals.row_has_child_toggled`. This should be called by models after the child state of a node changes. .. deprecated:: 4.10 Please do not use it in newly written code :param path: a ``GtkTreePath`` pointing to the changed row :param iter: a valid ``GtkTreeIter`` pointing to the changed row .. method:: row_inserted(path, iter) Emits the ::row-inserted signal on ``tree_model``. See :obj:`~gi.repository.Gtk.TreeModel.signals.row_inserted`. .. deprecated:: 4.10 Please do not use it in newly written code :param path: a ``GtkTreePath`` pointing to the inserted row :param iter: a valid ``GtkTreeIter`` pointing to the inserted row .. method:: rows_reordered(path, iter, new_order) Emits the ::rows-reordered signal on ``tree_model``. See :obj:`~gi.repository.Gtk.TreeModel.signals.rows_reordered`. This should be called by models when their rows have been reordered. .. deprecated:: 4.10 Please do not use it in newly written code :param path: a ``GtkTreePath`` pointing to the tree node whose children have been reordered :param iter: a valid ``GtkTreeIter`` pointing to the node whose children have been reordered, or :const:`None` if the depth of ``path`` is 0 :param new_order: an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. ``new_order```[newpos] = oldpos` .. method:: set_row(treeiter, row) :param treeiter: :param row: .. method:: sort_new_with_model() Signals ------- .. rst-class:: interim-class .. class:: TreeModel.signals :no-index: .. method:: row_changed(path: ~gi.repository.Gtk.TreePath, iter: ~gi.repository.Gtk.TreeIter) -> None This signal is emitted when a row in the model has changed. :param path: a ``GtkTreePath`` identifying the changed row :param iter: a valid ``GtkTreeIter`` pointing to the changed row .. method:: row_deleted(path: ~gi.repository.Gtk.TreePath) -> None This signal is emitted when a row has been deleted. Note that no iterator is passed to the signal handler, since the row is already 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. :param path: a ``GtkTreePath`` identifying the row .. method:: row_has_child_toggled(path: ~gi.repository.Gtk.TreePath, iter: ~gi.repository.Gtk.TreeIter) -> None This signal is emitted when a row has gotten the first child row or lost its last child row. :param path: a ``GtkTreePath`` identifying the row :param iter: a valid ``GtkTreeIter`` pointing to the row .. method:: row_inserted(path: ~gi.repository.Gtk.TreePath, iter: ~gi.repository.Gtk.TreeIter) -> None This signal is emitted when a new row has been inserted in the model. Note that the row may still be empty at this point, since it is a common pattern to first insert an empty row, and then fill it with the desired values. :param path: a ``GtkTreePath`` identifying the new row :param iter: a valid ``GtkTreeIter`` pointing to the new row Virtual Methods --------------- .. rst-class:: interim-class .. class:: TreeModel :no-index: .. method:: do_get_column_type(index_: int) -> type Returns the type of the column. .. deprecated:: 4.10 Please do not use it in newly written code :param index_: the column index .. method:: do_get_flags() -> ~gi.repository.Gtk.TreeModelFlags 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``. .. deprecated:: 4.10 Please do not use it in newly written code .. method:: do_get_iter(path: ~gi.repository.Gtk.TreePath) -> tuple[bool, ~gi.repository.Gtk.TreeIter] Sets ``iter`` to a valid iterator pointing to ``path``. If ``path`` does not exist, ``iter`` is set to an invalid iterator and :const:`False` is returned. .. deprecated:: 4.10 Please do not use it in newly written code :param path: the ``GtkTreePath`` .. method:: do_get_n_columns() -> int Returns the number of columns supported by ``tree_model``. .. deprecated:: 4.10 Please do not use it in newly written code .. method:: do_get_path(iter: ~gi.repository.Gtk.TreeIter) -> ~gi.repository.Gtk.TreePath Returns a newly-created ``GtkTreePath`` referenced by ``iter``. This path should be freed with :func:`~gi.repository.Gtk.TreePath.free`. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: the ``GtkTreeIter`` .. method:: do_get_value(iter: ~gi.repository.Gtk.TreeIter, column: int) -> ~typing.Any Initializes and sets ``value`` to that at ``column``. When done with ``value``, :func:`~gi.repository.GObject.Value.unset` needs to be called to free any allocated memory. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: the ``GtkTreeIter`` :param column: the column to lookup the value at .. method:: do_iter_children(parent: ~gi.repository.Gtk.TreeIter | None = None) -> tuple[bool, ~gi.repository.Gtk.TreeIter] Sets ``iter`` to point to the first child of ``parent``. If ``parent`` has no children, :const:`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 :const:`None` returns the first node, equivalent to `gtk_tree_model_get_iter_first (tree_model, iter);` .. deprecated:: 4.10 Please do not use it in newly written code :param parent: the ``GtkTreeIter`` .. method:: do_iter_has_child(iter: ~gi.repository.Gtk.TreeIter) -> bool Returns :const:`True` if ``iter`` has children, :const:`False` otherwise. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: the ``GtkTreeIter`` to test for children .. method:: do_iter_n_children(iter: ~gi.repository.Gtk.TreeIter | None = None) -> int Returns the number of children that ``iter`` has. As a special case, if ``iter`` is :const:`None`, then the number of toplevel nodes is returned. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: the ``GtkTreeIter`` .. method:: do_iter_next(iter: ~gi.repository.Gtk.TreeIter) -> bool Sets ``iter`` to point to the node following it at the current level. If there is no next ``iter``, :const:`False` is returned and ``iter`` is set to be invalid. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: the ``GtkTreeIter`` .. method:: do_iter_nth_child(parent: ~gi.repository.Gtk.TreeIter | None, n: int) -> tuple[bool, ~gi.repository.Gtk.TreeIter] 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 :const:`False` is returned. ``parent`` will remain a valid node after this function has been called. As a special case, if ``parent`` is :const:`None`, then the ``n``-th root node is set. .. deprecated:: 4.10 Please do not use it in newly written code :param parent: the ``GtkTreeIter`` to get the child from :param n: the index of the desired child .. method:: do_iter_parent(child: ~gi.repository.Gtk.TreeIter) -> tuple[bool, ~gi.repository.Gtk.TreeIter] 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 :const:`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. .. deprecated:: 4.10 Please do not use it in newly written code :param child: the ``GtkTreeIter`` .. method:: do_iter_previous(iter: ~gi.repository.Gtk.TreeIter) -> bool Sets ``iter`` to point to the previous node at the current level. If there is no previous ``iter``, :const:`False` is returned and ``iter`` is set to be invalid. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: the ``GtkTreeIter`` .. method:: do_ref_node(iter: ~gi.repository.Gtk.TreeIter) -> None 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. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: the ``GtkTreeIter`` .. method:: do_row_changed(path: ~gi.repository.Gtk.TreePath, iter: ~gi.repository.Gtk.TreeIter) -> None Emits the ::row-changed signal on ``tree_model``. See :obj:`~gi.repository.Gtk.TreeModel.signals.row_changed`. .. deprecated:: 4.10 Please do not use it in newly written code :param path: a ``GtkTreePath`` pointing to the changed row :param iter: a valid ``GtkTreeIter`` pointing to the changed row .. method:: do_row_deleted(path: ~gi.repository.Gtk.TreePath) -> None Emits the ::row-deleted signal on ``tree_model``. See :obj:`~gi.repository.Gtk.TreeModel.signals.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. .. deprecated:: 4.10 Please do not use it in newly written code :param path: a ``GtkTreePath`` pointing to the previous location of the deleted row .. method:: do_row_has_child_toggled(path: ~gi.repository.Gtk.TreePath, iter: ~gi.repository.Gtk.TreeIter) -> None Emits the ::row-has-child-toggled signal on ``tree_model``. See :obj:`~gi.repository.Gtk.TreeModel.signals.row_has_child_toggled`. This should be called by models after the child state of a node changes. .. deprecated:: 4.10 Please do not use it in newly written code :param path: a ``GtkTreePath`` pointing to the changed row :param iter: a valid ``GtkTreeIter`` pointing to the changed row .. method:: do_row_inserted(path: ~gi.repository.Gtk.TreePath, iter: ~gi.repository.Gtk.TreeIter) -> None Emits the ::row-inserted signal on ``tree_model``. See :obj:`~gi.repository.Gtk.TreeModel.signals.row_inserted`. .. deprecated:: 4.10 Please do not use it in newly written code :param path: a ``GtkTreePath`` pointing to the inserted row :param iter: a valid ``GtkTreeIter`` pointing to the inserted row .. method:: do_unref_node(iter: ~gi.repository.Gtk.TreeIter) -> None 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 :func:`~gi.repository.Gtk.TreeModel.ref_node`. Please note that nodes that are deleted are not unreffed. .. deprecated:: 4.10 Please do not use it in newly written code :param iter: the ``GtkTreeIter``