:right-sidebar: True

TreeModelFilter
===================================================================

.. currentmodule:: gi.repository.Gtk





.. deprecated:: 4.10

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



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


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



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



:Constructors:

::

    TreeModelFilter(**properties)





Methods
-------

.. rst-class:: interim-class

.. class:: TreeModelFilter
   :no-index:


   .. method:: clear_cache() -> None

      This function should almost never be called. It clears the ``filter``
      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 filtered 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 ``filter_iter`` to point to the row in ``filter`` that corresponds to the
      row pointed at by ``child_iter``.  If ``filter_iter`` was not set, :const:`False` is
      returned.






      .. 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 ``filter``. That is, ``child_path``
      points to a path in the child model. The rerturned path will point to the
      same row in the filtered model. If ``child_path`` isn’t a valid path on the
      child model or points to a row which is not visible in ``filter``, 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(filter_iter: ~gi.repository.Gtk.TreeIter) -> ~gi.repository.Gtk.TreeIter

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






      .. deprecated:: 4.10

         Please do not use it in newly written code




      :param filter_iter: A valid ``GtkTreeIter`` pointing to a row on ``filter``.





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

      Converts ``filter_path`` to a path on the child model of ``filter``. That is,
      ``filter_path`` points to a location in ``filter``. The returned path will
      point to the same location in the model not being filtered. If ``filter_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 filter_path: A ``GtkTreePath`` to convert.





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

      Returns a pointer to the child model of ``filter``.






      .. deprecated:: 4.10

         Please do not use it in newly written code







   .. method:: refilter() -> None

      Emits ::row_changed for each row in the child model, which causes
      the filter to re-evaluate whether a row is visible or not.






      .. deprecated:: 4.10

         Please do not use it in newly written code







   .. method:: set_modify_func(types: ~typing.Sequence[type], func: ~typing.Callable[[...], ~typing.Any], *data: ~typing.Any) -> None

      With the ``n_columns`` and ``types`` parameters, you give an array of column
      types for this model (which will be exposed to the parent model/view).
      The ``func``, ``data`` and ``destroy`` parameters are for specifying the modify
      function. The modify function will get called for each
      data access, the goal of the modify function is to return the data which
      should be displayed at the location specified using the parameters of the
      modify function.

      Note that :func:`~gi.repository.Gtk.TreeModelFilter.set_modify_func`
      can only be called once for a given filter model.






      .. deprecated:: 4.10

         Please do not use it in newly written code




      :param types: The ``GType``'s of the columns.


      :param func: A ``GtkTreeModelFilterModifyFunc``


      :param data: User data to pass to the modify function





   .. method:: set_value(iter, column, value)

      






      :param iter: 

      :param column: 

      :param value: 




   .. method:: set_visible_column(column: int) -> None

      Sets ``column`` of the child_model to be the column where ``filter`` should
      look for visibility information. ``columns`` should be a column of type
      :obj:`bool`, where :const:`True` means that a row is visible, and :const:`False`
      if not.

      Note that :func:`~gi.repository.Gtk.TreeModelFilter.set_visible_func` or
      :func:`~gi.repository.Gtk.TreeModelFilter.set_visible_column` can only be called
      once for a given filter model.






      .. deprecated:: 4.10

         Please do not use it in newly written code




      :param column: A ``int`` which is the column containing the visible information





   .. method:: set_visible_func(func, data=None)

      Sets the visible function used when filtering the ``filter`` to be ``func``.
      The function should return :const:`True` if the given row should be visible and
      :const:`False` otherwise.

      If the condition calculated by the function changes over time (e.g.
      because it depends on some global parameters), you must call
      :func:`~gi.repository.Gtk.TreeModelFilter.refilter` to keep the visibility information
      of the model up-to-date.

      Note that ``func`` is called whenever a row is inserted, when it may still
      be empty. The visible function should therefore take special care of empty
      rows, like in the example below.


      .. code-block:: C
         :dedent:

         static gboolean
         visible_func (GtkTreeModel *model,
                       GtkTreeIter  *iter,
                       gpointer      data)
         {
           // Visible if row is non-empty and first column is “HI”
           char *str;
           gboolean visible = FALSE;
         
           gtk_tree_model_get (model, iter, 0, &str, -1);
           if (str && strcmp (str, "HI") == 0)
             visible = TRUE;
           g_free (str);
         
           return visible;
         }


      Note that :func:`~gi.repository.Gtk.TreeModelFilter.set_visible_func` or
      :func:`~gi.repository.Gtk.TreeModelFilter.set_visible_column` can only be called
      once for a given filter model.






      .. deprecated:: 4.10

         Please do not use it in newly written code




      :param func: A ``GtkTreeModelFilterVisibleFunc``, the visible function


      :param data: User data to pass to the visible function









Properties
----------

.. rst-class:: interim-class

.. class:: TreeModelFilter
   :no-index:
   

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

      






   .. attribute:: props.virtual_root
      :type: ~gi.repository.Gtk.TreePath

      












Virtual Methods
---------------

.. rst-class:: interim-class

.. class:: TreeModelFilter
   :no-index:
   

   .. method:: do_modify(child_model: ~gi.repository.Gtk.TreeModel, iter: ~gi.repository.Gtk.TreeIter, value: ~typing.Any, column: int) -> None

      






      :param child_model: 

      :param iter: 

      :param value: 

      :param column: 




   .. method:: do_visible(child_model: ~gi.repository.Gtk.TreeModel, iter: ~gi.repository.Gtk.TreeIter) -> bool

      






      :param child_model: 

      :param iter: 








Fields
------

.. rst-class:: interim-class

.. class:: TreeModelFilter
   :no-index:
   

   .. attribute:: parent

      






   .. attribute:: priv