:right-sidebar: True

TreeModelSort
===================================================================

.. currentmodule:: gi.repository.Gtk





.. deprecated:: 4.10

   Use :obj:`~gi.repository.Gtk.SortListModel` instead



.. class:: TreeModelSort(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gtk.TreeDragSource`, :class:`~gi.repository.Gtk.TreeModel`, :class:`~gi.repository.Gtk.TreeSortable`



:Constructors:

::

    TreeModelSort(**properties)
    new_with_model(child_model:Gtk.TreeModel) -> Gtk.TreeModelSort



Constructors
------------

.. rst-class:: interim-class

.. class:: TreeModelSort
   :no-index:


   .. classmethod:: new_with_model(child_model: ~gi.repository.Gtk.TreeModel) -> ~gi.repository.Gtk.TreeModelSort

      Creates a new ``GtkTreeModelSort``, with ``child_model`` as the child model.







      :param child_model: A ``GtkTreeModel``









Methods
-------

.. rst-class:: interim-class

.. class:: TreeModelSort
   :no-index:


   .. method:: clear_cache() -> None

      This function should almost never be called.  It clears the ``tree_model_sort``
      of any cached iterators that haven’t been reffed with
      :func:`~gi.repository.Gtk.TreeModel.ref_node`.  This might be useful if the child model being
      sorted is static (and doesn’t change often) and there has been a lot of
      unreffed access to nodes.  As a side effect of this function, all unreffed
      iters will be invalid.






      .. deprecated:: 4.10

         Please do not use it in newly written code







   .. method:: convert_child_iter_to_iter(child_iter: ~gi.repository.Gtk.TreeIter) -> tuple[bool, ~gi.repository.Gtk.TreeIter]

      Sets ``sort_iter`` to point to the row in ``tree_model_sort`` that corresponds to
      the row pointed at by ``child_iter``.  If ``sort_iter`` was not set, :const:`False`
      is returned.  Note: a boolean is only returned since 2.14.






      .. deprecated:: 4.10

         Please do not use it in newly written code




      :param child_iter: A valid ``GtkTreeIter`` pointing to a row on the child model





   .. method:: convert_child_path_to_path(child_path: ~gi.repository.Gtk.TreePath) -> ~gi.repository.Gtk.TreePath | None

      Converts ``child_path`` to a path relative to ``tree_model_sort``.  That is,
      ``child_path`` points to a path in the child model.  The returned path will
      point to the same row in the sorted model.  If ``child_path`` isn’t a valid
      path on the child model, then :const:`None` is returned.






      .. deprecated:: 4.10

         Please do not use it in newly written code




      :param child_path: A ``GtkTreePath`` to convert





   .. method:: convert_iter_to_child_iter(sorted_iter: ~gi.repository.Gtk.TreeIter) -> ~gi.repository.Gtk.TreeIter

      Sets ``child_iter`` to point to the row pointed to by ``sorted_iter``.






      .. deprecated:: 4.10

         Please do not use it in newly written code




      :param sorted_iter: A valid ``GtkTreeIter`` pointing to a row on ``tree_model_sort``.





   .. method:: convert_path_to_child_path(sorted_path: ~gi.repository.Gtk.TreePath) -> ~gi.repository.Gtk.TreePath | None

      Converts ``sorted_path`` to a path on the child model of ``tree_model_sort``.
      That is, ``sorted_path`` points to a location in ``tree_model_sort``.  The
      returned path will point to the same location in the model not being
      sorted.  If ``sorted_path`` does not point to a location in the child model,
      :const:`None` is returned.






      .. deprecated:: 4.10

         Please do not use it in newly written code




      :param sorted_path: A ``GtkTreePath`` to convert





   .. method:: get_model() -> ~gi.repository.Gtk.TreeModel

      Returns the model the ``GtkTreeModelSort`` is sorting.










   .. method:: iter_is_valid(iter: ~gi.repository.Gtk.TreeIter) -> bool

      > This function is slow. Only use it for debugging and/or testing
      > purposes.

      Checks if the given iter is a valid iter for this ``GtkTreeModelSort``.






      .. deprecated:: 4.10

         Please do not use it in newly written code




      :param iter: A ``GtkTreeIter``





   .. method:: reset_default_sort_func() -> None

      This resets the default sort function to be in the “unsorted” state.  That
      is, it is in the same order as the child model. It will re-sort the model
      to be in the same order as the child model only if the ``GtkTreeModelSort``
      is in “unsorted” state.






      .. deprecated:: 4.10

         Please do not use it in newly written code











Properties
----------

.. rst-class:: interim-class

.. class:: TreeModelSort
   :no-index:
   

   .. attribute:: props.model
      :type: ~gi.repository.Gtk.TreeModel

      














Fields
------

.. rst-class:: interim-class

.. class:: TreeModelSort
   :no-index:
   

   .. attribute:: parent

      






   .. attribute:: priv