:right-sidebar: True

TreeView
===================================================================

.. currentmodule:: gi.repository.Gtk





.. deprecated:: 4.10

   Use :obj:`~gi.repository.Gtk.ListView` for lists, and :obj:`~gi.repository.Gtk.ColumnView`
   for tabular lists



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


Superclasses: :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`, :class:`~gi.repository.Gtk.Scrollable`



A widget for displaying both trees and lists

Widget that displays any object that implements the :obj:`~gi.repository.Gtk.TreeModel` interface.

Please refer to the `tree widget conceptual overview <section-tree-widget.html>`_
for an overview of all the objects and data types related to the tree
widget and how they work together.

Coordinate systems in GtkTreeView API
-------------------------------------

Several different coordinate systems are exposed in the ``GtkTreeView`` API.
These are:


.. image:: https://docs.gtk.org/gtk4/tree-view-coordinates.png



- Widget coordinates: Coordinates relative to the widget (usually ``widget->window``).

- Bin window coordinates: Coordinates relative to the window that GtkTreeView renders to.

- Tree coordinates: Coordinates relative to the entire scrollable area of GtkTreeView. These
  coordinates start at (0, 0) for row 0 of the tree.

Several functions are available for converting between the different
coordinate systems.  The most common translations are between widget and bin
window coordinates and between bin window and tree coordinates. For the
former you can use :obj:`~gi.repository.Gtk.TreeView.convert_widget_to_bin_window_coords`
(and vice versa), for the latter :obj:`~gi.repository.Gtk.TreeView.convert_bin_window_to_tree_coords`
(and vice versa).

``GtkTreeView`` as ``GtkBuildable``
-----------------------------------

The ``GtkTreeView`` implementation of the ``GtkBuildable`` interface accepts
:obj:`~gi.repository.Gtk.TreeViewColumn` objects as ``<child>`` elements and exposes the
internal :obj:`~gi.repository.Gtk.TreeSelection` in UI definitions.

An example of a UI definition fragment with ``GtkTreeView``:


.. code-block::
   :dedent:

   <object class="GtkTreeView" id="treeview">
     <property name="model">liststore1</property>
     <child>
       <object class="GtkTreeViewColumn" id="test-column">
         <property name="title">Test</property>
         <child>
           <object class="GtkCellRendererText" id="test-renderer"/>
           <attributes>
             <attribute name="text">1</attribute>
           </attributes>
         </child>
       </object>
     </child>
     <child internal-child="selection">
       <object class="GtkTreeSelection" id="selection">
         <signal name="changed" handler="on_treeview_selection_changed"/>
       </object>
     </child>
   </object>


CSS nodes
---------


.. code-block::
   :dedent:

   treeview.view
   ├── header
   │   ├── button
   │   │   ╰── [sort-indicator]
   ┊   ┊
   │   ╰── button
   │       ╰── [sort-indicator]
   │
   ├── [rubberband]
   ╰── [dndtarget]


``GtkTreeView`` has a main CSS node with name ``treeview`` and style class ``.view``.
It has a subnode with name ``header``, which is the parent for all the column
header widgets' CSS nodes.

Each column header consists of a ``button``, which among other content, has a
child with name ``sort-indicator``, which carries the ``.ascending`` or ``.descending``
style classes when the column header should show a sort indicator. The CSS
is expected to provide a suitable image using the ``-gtk-icon-source`` property.

For rubberband selection, a subnode with name ``rubberband`` is used.

For the drop target location during DND, a subnode with name ``dndtarget`` is used.



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

.. rst-class:: interim-class

.. class:: TreeView
   :no-index:


   .. classmethod:: new() -> ~gi.repository.Gtk.Widget

      Creates a new ``GtkTreeView`` widget.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. classmethod:: new_with_model(model: ~gi.repository.Gtk.TreeModel) -> ~gi.repository.Gtk.Widget

      Creates a new ``GtkTreeView`` widget with the model initialized to ``model``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param model: the model.









Methods
-------

.. rst-class:: interim-class

.. class:: TreeView
   :no-index:


   .. method:: append_column(column: ~gi.repository.Gtk.TreeViewColumn) -> int

      Appends ``column`` to the list of columns. If ``tree_view`` has “fixed_height”
      mode enabled, then ``column`` must have its “sizing” property set to be
      GTK_TREE_VIEW_COLUMN_FIXED.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param column: The ``GtkTreeViewColumn`` to add.





   .. method:: collapse_all() -> None

      Recursively collapses all visible, expanded nodes in ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: collapse_row(path: ~gi.repository.Gtk.TreePath) -> bool

      Collapses a row (hides its child rows, if they exist).






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: path to a row in the ``tree_view``





   .. method:: columns_autosize() -> None

      Resizes all columns to their optimal width. Only works after the
      treeview has been realized.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: convert_bin_window_to_tree_coords(bx: int, by: int) -> tuple[int, int]

      Converts bin_window coordinates to coordinates for the
      tree (the full scrollable area of the tree).






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param bx: X coordinate relative to bin_window


      :param by: Y coordinate relative to bin_window





   .. method:: convert_bin_window_to_widget_coords(bx: int, by: int) -> tuple[int, int]

      Converts bin_window coordinates to widget relative coordinates.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param bx: bin_window X coordinate


      :param by: bin_window Y coordinate





   .. method:: convert_tree_to_bin_window_coords(tx: int, ty: int) -> tuple[int, int]

      Converts tree coordinates (coordinates in full scrollable area of the tree)
      to bin_window coordinates.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param tx: tree X coordinate


      :param ty: tree Y coordinate





   .. method:: convert_tree_to_widget_coords(tx: int, ty: int) -> tuple[int, int]

      Converts tree coordinates (coordinates in full scrollable area of the tree)
      to widget coordinates.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param tx: X coordinate relative to the tree


      :param ty: Y coordinate relative to the tree





   .. method:: convert_widget_to_bin_window_coords(wx: int, wy: int) -> tuple[int, int]

      Converts widget coordinates to coordinates for the bin_window.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param wx: X coordinate relative to the widget


      :param wy: Y coordinate relative to the widget





   .. method:: convert_widget_to_tree_coords(wx: int, wy: int) -> tuple[int, int]

      Converts widget coordinates to coordinates for the
      tree (the full scrollable area of the tree).






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param wx: X coordinate relative to the widget


      :param wy: Y coordinate relative to the widget





   .. method:: create_row_drag_icon(path: ~gi.repository.Gtk.TreePath) -> ~gi.repository.Gdk.Paintable | None

      Creates a ``cairo_surface_t`` representation of the row at ``path``.
      This image is used for a drag icon.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: a ``GtkTreePath`` in ``tree_view``





   .. method:: enable_model_drag_dest(formats: ~gi.repository.Gdk.ContentFormats, actions: ~gi.repository.Gdk.DragAction) -> None

      Turns ``tree_view`` into a drop destination for automatic DND. Calling
      this method sets ``GtkTreeView``:reorderable to :const:`False`.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param formats: the target formats that the drag will support


      :param actions: the bitmask of possible actions for a drag from this
         widget





   .. method:: enable_model_drag_source(start_button_mask: ~gi.repository.Gdk.ModifierType, formats: ~gi.repository.Gdk.ContentFormats, actions: ~gi.repository.Gdk.DragAction) -> None

      Turns ``tree_view`` into a drag source for automatic DND. Calling this
      method sets ``GtkTreeView``:reorderable to :const:`False`.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param start_button_mask: Mask of allowed buttons to start drag


      :param formats: the target formats that the drag will support


      :param actions: the bitmask of possible actions for a drag from this
         widget





   .. method:: expand_all() -> None

      Recursively expands all nodes in the ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: expand_row(path: ~gi.repository.Gtk.TreePath, open_all: bool) -> bool

      Opens the row so its children are visible.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: path to a row


      :param open_all: whether to recursively expand, or just expand immediate children





   .. method:: expand_to_path(path: ~gi.repository.Gtk.TreePath) -> None

      Expands the row at ``path``. This will also expand all parent rows of
      ``path`` as necessary.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: path to a row.





   .. method:: get_activate_on_single_click() -> bool

      Gets the setting set by :func:`~gi.repository.Gtk.TreeView.set_activate_on_single_click`.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_background_area(path: ~gi.repository.Gtk.TreePath | None = None, column: ~gi.repository.Gtk.TreeViewColumn | None = None) -> ~gi.repository.Gdk.Rectangle

      Fills the bounding rectangle in bin_window coordinates for the cell at the
      row specified by ``path`` and the column specified by ``column``.  If ``path`` is
      :const:`None`, or points to a node not found in the tree, the ``y`` and ``height`` fields of
      the rectangle will be filled with 0. If ``column`` is :const:`None`, the ``x`` and ``width``
      fields will be filled with 0.  The returned rectangle is equivalent to the
      ``background_area`` passed to gtk_cell_renderer_render().  These background
      areas tile to cover the entire bin window.  Contrast with the ``cell_area``,
      returned by :func:`~gi.repository.Gtk.TreeView.get_cell_area`, which returns only the cell
      itself, excluding surrounding borders and the tree expander area.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: a ``GtkTreePath`` for the row, or :const:`None` to get only horizontal coordinates


      :param column: a ``GtkTreeViewColumn`` for the column, or :const:`None` to get only vertical coordinates





   .. method:: get_cell_area(path, column=None)

      Fills the bounding rectangle in bin_window coordinates for the cell at the
      row specified by ``path`` and the column specified by ``column``.  If ``path`` is
      :const:`None`, or points to a path not currently displayed, the ``y`` and ``height`` fields
      of the rectangle will be filled with 0. If ``column`` is :const:`None`, the ``x`` and ``width``
      fields will be filled with 0.  The sum of all cell rects does not cover the
      entire tree; there are extra pixels in between rows, for example. The
      returned rectangle is equivalent to the ``cell_area`` passed to
      gtk_cell_renderer_render().  This function is only valid if ``tree_view`` is
      realized.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: a ``GtkTreePath`` for the row, or :const:`None` to get only horizontal coordinates


      :param column: a ``GtkTreeViewColumn`` for the column, or :const:`None` to get only vertical coordinates





   .. method:: get_column(n: int) -> ~gi.repository.Gtk.TreeViewColumn | None

      Gets the ``GtkTreeViewColumn`` at the given position in the ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param n: The position of the column, counting from 0.





   .. method:: get_columns() -> list[~gi.repository.Gtk.TreeViewColumn]

      Returns a ``GList`` of all the ``GtkTreeViewColumn``'s currently in ``tree_view``.
      The returned list must be freed with g_list_free ().






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_cursor() -> tuple[~gi.repository.Gtk.TreePath, ~gi.repository.Gtk.TreeViewColumn]

      Fills in ``path`` and ``focus_column`` with the current path and focus column.  If
      the cursor isn’t currently set, then *``path`` will be :const:`None`.  If no column
      currently has focus, then *``focus_column`` will be :const:`None`.

      The returned ``GtkTreePath`` must be freed with :func:`~gi.repository.Gtk.TreePath.free` when
      you are done with it.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_dest_row_at_pos(drag_x: int, drag_y: int) -> tuple[bool, ~gi.repository.Gtk.TreePath, ~gi.repository.Gtk.TreeViewDropPosition]

      Determines the destination row for a given position.  ``drag_x`` and
      ``drag_y`` are expected to be in widget coordinates.  This function is only
      meaningful if ``tree_view`` is realized.  Therefore this function will always
      return :const:`False` if ``tree_view`` is not realized or does not have a model.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param drag_x: the position to determine the destination row for


      :param drag_y: the position to determine the destination row for





   .. method:: get_drag_dest_row() -> tuple[~gi.repository.Gtk.TreePath, ~gi.repository.Gtk.TreeViewDropPosition]

      Gets information about the row that is highlighted for feedback.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_enable_search() -> bool

      Returns whether or not the tree allows to start interactive searching
      by typing in text.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_enable_tree_lines() -> bool

      Returns whether or not tree lines are drawn in ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_expander_column() -> ~gi.repository.Gtk.TreeViewColumn | None

      Returns the column that is the current expander column,
      or :const:`None` if none has been set.
      This column has the expander arrow drawn next to it.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_fixed_height_mode() -> bool

      Returns whether fixed height mode is turned on for ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_grid_lines() -> ~gi.repository.Gtk.TreeViewGridLines

      Returns which grid lines are enabled in ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_headers_clickable() -> bool

      Returns whether all header columns are clickable.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_headers_visible() -> bool

      Returns :const:`True` if the headers on the ``tree_view`` are visible.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_hover_expand() -> bool

      Returns whether hover expansion mode is turned on for ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_hover_selection() -> bool

      Returns whether hover selection mode is turned on for ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_level_indentation() -> int

      Returns the amount, in pixels, of extra indentation for child levels
      in ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







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

      Returns the model the ``GtkTreeView`` is based on.  Returns :const:`None` if the
      model is unset.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_n_columns() -> int

      Queries the number of columns in the given ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_path_at_pos(x: int, y: int) -> tuple[bool, ~gi.repository.Gtk.TreePath, ~gi.repository.Gtk.TreeViewColumn, int, int]

      Finds the path at the point (``x``, ``y``), relative to bin_window coordinates.
      That is, ``x`` and ``y`` are relative to an events coordinates. Widget-relative
      coordinates must be converted using
      :func:`~gi.repository.Gtk.TreeView.convert_widget_to_bin_window_coords`. It is primarily for
      things like popup menus. If ``path`` is non-:const:`None`, then it will be filled
      with the ``GtkTreePath`` at that point.  This path should be freed with
      :func:`~gi.repository.Gtk.TreePath.free`.  If ``column`` is non-:const:`None`, then it will be filled
      with the column at that point.  ``cell_x`` and ``cell_y`` return the coordinates
      relative to the cell background (i.e. the ``background_area`` passed to
      gtk_cell_renderer_render()).  This function is only meaningful if
      ``tree_view`` is realized.  Therefore this function will always return :const:`False`
      if ``tree_view`` is not realized or does not have a model.

      For converting widget coordinates (eg. the ones you get from
      GtkWidget::query-tooltip), please see
      :func:`~gi.repository.Gtk.TreeView.convert_widget_to_bin_window_coords`.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param x: The x position to be identified (relative to bin_window).


      :param y: The y position to be identified (relative to bin_window).





   .. method:: get_reorderable() -> bool

      Retrieves whether the user can reorder the tree via drag-and-drop. See
      :func:`~gi.repository.Gtk.TreeView.set_reorderable`.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_rubber_banding() -> bool

      Returns whether rubber banding is turned on for ``tree_view``.  If the
      selection mode is :const:`~gi.repository.Gtk.SelectionMode.MULTIPLE`, rubber banding will allow the
      user to select multiple rows by dragging the mouse.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_search_column() -> int

      Gets the column searched on by the interactive search code.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_search_entry() -> ~gi.repository.Gtk.Editable | None

      Returns the ``GtkEntry`` which is currently in use as interactive search
      entry for ``tree_view``.  In case the built-in entry is being used, :const:`None`
      will be returned.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_selection() -> ~gi.repository.Gtk.TreeSelection

      Gets the ``GtkTreeSelection`` associated with ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_show_expanders() -> bool

      Returns whether or not expanders are drawn in ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_tooltip_column() -> int

      Returns the column of ``tree_view``’s model which is being used for
      displaying tooltips on ``tree_view``’s rows.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_tooltip_context(x: int, y: int, keyboard_tip: bool) -> tuple[bool, ~gi.repository.Gtk.TreeModel, ~gi.repository.Gtk.TreePath, ~gi.repository.Gtk.TreeIter]

      This function is supposed to be used in a ::query-tooltip
      signal handler for ``GtkTreeView``. The ``x``, ``y`` and ``keyboard_tip`` values
      which are received in the signal handler, should be passed to this
      function without modification.

      The return value indicates whether there is a tree view row at the given
      coordinates (:const:`True`) or not (:const:`False`) for mouse tooltips. For keyboard
      tooltips the row returned will be the cursor row. When :const:`True`, then any of
      ``model``, ``path`` and ``iter`` which have been provided will be set to point to
      that row and the corresponding model. ``x`` and ``y`` will always be converted
      to be relative to ``tree_view``’s bin_window if ``keyboard_tooltip`` is :const:`False`.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param x: the x coordinate (relative to widget coordinates)


      :param y: the y coordinate (relative to widget coordinates)


      :param keyboard_tip: whether this is a keyboard tooltip or not





   .. method:: get_visible_range() -> tuple[bool, ~gi.repository.Gtk.TreePath, ~gi.repository.Gtk.TreePath]

      Sets ``start_path`` and ``end_path`` to be the first and last visible path.
      Note that there may be invisible paths in between.

      The paths should be freed with :func:`~gi.repository.Gtk.TreePath.free` after use.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: get_visible_rect() -> ~gi.repository.Gdk.Rectangle

      Fills ``visible_rect`` with the currently-visible region of the
      buffer, in tree coordinates. Convert to bin_window coordinates with
      :func:`~gi.repository.Gtk.TreeView.convert_tree_to_bin_window_coords`.
      Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire
      scrollable area of the tree.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: insert_column(column: ~gi.repository.Gtk.TreeViewColumn, position: int) -> int

      This inserts the ``column`` into the ``tree_view`` at ``position``.  If ``position`` is

      -1, then the column is inserted at the end. If ``tree_view`` has
      “fixed_height” mode enabled, then ``column`` must have its “sizing” property
      set to be GTK_TREE_VIEW_COLUMN_FIXED.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param column: The ``GtkTreeViewColumn`` to be inserted.


      :param position: The position to insert ``column`` in.





   .. method:: insert_column_with_attributes(position, title, cell, **kwargs)

      Creates a new ``GtkTreeViewColumn`` and inserts it into the ``tree_view`` at
      ``position``.  If ``position`` is -1, then the newly created column is inserted at
      the end.  The column is initialized with the attributes given. If ``tree_view``
      has “fixed_height” mode enabled, then the new column will have its sizing
      property set to be GTK_TREE_VIEW_COLUMN_FIXED.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param position: The position to insert the new column in


      :param title: The title to set the header to


      :param cell: The ``GtkCellRenderer``


      :param kwargs: 




   .. method:: insert_column_with_data_func(position: int, title: str, cell: ~gi.repository.Gtk.CellRenderer, func: ~typing.Callable[[...], None], *data: ~typing.Any) -> int

      Convenience function that inserts a new column into the ``GtkTreeView``
      with the given cell renderer and a ``GtkTreeCellDataFunc`` to set cell renderer
      attributes (normally using data from the model). See also
      :func:`~gi.repository.Gtk.TreeViewColumn.set_cell_data_func`, :func:`~gi.repository.Gtk.TreeViewColumn.pack_start`.
      If ``tree_view`` has “fixed_height” mode enabled, then the new column will have its
      “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param position: Position to insert, -1 for append


      :param title: column title


      :param cell: cell renderer for column


      :param func: function to set attributes of cell renderer


      :param data: data for ``func``





   .. method:: is_blank_at_pos(x: int, y: int) -> tuple[bool, ~gi.repository.Gtk.TreePath, ~gi.repository.Gtk.TreeViewColumn, int, int]

      Determine whether the point (``x``, ``y``) in ``tree_view`` is blank, that is no
      cell content nor an expander arrow is drawn at the location. If so, the
      location can be considered as the background. You might wish to take
      special action on clicks on the background, such as clearing a current
      selection, having a custom context menu or starting rubber banding.

      The ``x`` and ``y`` coordinate that are provided must be relative to bin_window
      coordinates.  Widget-relative coordinates must be converted using
      :func:`~gi.repository.Gtk.TreeView.convert_widget_to_bin_window_coords`.

      For converting widget coordinates (eg. the ones you get from
      GtkWidget::query-tooltip), please see
      :func:`~gi.repository.Gtk.TreeView.convert_widget_to_bin_window_coords`.

      The ``path``, ``column``, ``cell_x`` and ``cell_y`` arguments will be filled in
      likewise as for :func:`~gi.repository.Gtk.TreeView.get_path_at_pos`.  Please see
      :func:`~gi.repository.Gtk.TreeView.get_path_at_pos` for more information.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param x: The x position to be identified (relative to bin_window)


      :param y: The y position to be identified (relative to bin_window)





   .. method:: is_rubber_banding_active() -> bool

      Returns whether a rubber banding operation is currently being done
      in ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: map_expanded_rows(func: ~typing.Callable[[...], None], *data: ~typing.Any) -> None

      Calls ``func`` on all expanded rows.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param func: A function to be called


      :param data: User data to be passed to the function.





   .. method:: move_column_after(column: ~gi.repository.Gtk.TreeViewColumn, base_column: ~gi.repository.Gtk.TreeViewColumn | None = None) -> None

      Moves ``column`` to be after to ``base_column``.  If ``base_column`` is :const:`None`, then
      ``column`` is placed in the first position.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param column: The ``GtkTreeViewColumn`` to be moved.


      :param base_column: The ``GtkTreeViewColumn`` to be moved relative to





   .. method:: remove_column(column: ~gi.repository.Gtk.TreeViewColumn) -> int

      Removes ``column`` from ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param column: The ``GtkTreeViewColumn`` to remove.





   .. method:: row_activated(path: ~gi.repository.Gtk.TreePath, column: ~gi.repository.Gtk.TreeViewColumn | None = None) -> None

      Activates the cell determined by ``path`` and ``column``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: The ``GtkTreePath`` to be activated.


      :param column: The ``GtkTreeViewColumn`` to be activated.





   .. method:: row_expanded(path: ~gi.repository.Gtk.TreePath) -> bool

      Returns :const:`True` if the node pointed to by ``path`` is expanded in ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: A ``GtkTreePath`` to test expansion state.





   .. method:: scroll_to_cell(path, column=None, use_align=False, row_align=0.0, col_align=0.0)

      Moves the alignments of ``tree_view`` to the position specified by ``column`` and
      ``path``.  If ``column`` is :const:`None`, then no horizontal scrolling occurs.  Likewise,
      if ``path`` is :const:`None` no vertical scrolling occurs.  At a minimum, one of ``column``
      or ``path`` need to be non-:const:`None`.  ``row_align`` determines where the row is
      placed, and ``col_align`` determines where ``column`` is placed.  Both are expected
      to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means
      right/bottom alignment, 0.5 means center.

      If ``use_align`` is :const:`False`, then the alignment arguments are ignored, and the
      tree does the minimum amount of work to scroll the cell onto the screen.
      This means that the cell will be scrolled to the edge closest to its current
      position.  If the cell is currently visible on the screen, nothing is done.

      This function only works if the model is set, and ``path`` is a valid row on the
      model.  If the model changes before the ``tree_view`` is realized, the centered
      path will be modified to reflect this change.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: The path of the row to move to


      :param column: The ``GtkTreeViewColumn`` to move horizontally to


      :param use_align: whether to use alignment arguments, or :const:`False`.


      :param row_align: The vertical alignment of the row specified by ``path``.


      :param col_align: The horizontal alignment of the column specified by ``column``.





   .. method:: scroll_to_point(tree_x: int, tree_y: int) -> None

      Scrolls the tree view such that the top-left corner of the visible
      area is ``tree_x``, ``tree_y``, where ``tree_x`` and ``tree_y`` are specified
      in tree coordinates.  The ``tree_view`` must be realized before
      this function is called.  If it isn't, you probably want to be
      using :func:`~gi.repository.Gtk.TreeView.scroll_to_cell`.

      If either ``tree_x`` or ``tree_y`` are -1, then that direction isn’t scrolled.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param tree_x: X coordinate of new top-left pixel of visible area, or -1


      :param tree_y: Y coordinate of new top-left pixel of visible area, or -1





   .. method:: set_activate_on_single_click(single: bool) -> None

      Cause the ``GtkTreeView``::row-activated signal to be emitted
      on a single click instead of a double click.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param single: :const:`True` to emit row-activated on a single click





   .. method:: set_column_drag_function(func: ~typing.Callable[[...], bool] | None = None, *user_data: ~typing.Any) -> None

      Sets a user function for determining where a column may be dropped when
      dragged.  This function is called on every column pair in turn at the
      beginning of a column drag to determine where a drop can take place.  The
      arguments passed to ``func`` are: the ``tree_view``, the ``GtkTreeViewColumn`` being
      dragged, the two ``GtkTreeViewColumn``'s determining the drop spot, and
      ``user_data``.  If either of the ``GtkTreeViewColumn`` arguments for the drop spot
      are :const:`None`, then they indicate an edge.  If ``func`` is set to be :const:`None`, then
      ``tree_view`` reverts to the default behavior of allowing all columns to be
      dropped everywhere.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param func: A function to determine which columns are reorderable


      :param user_data: User data to be passed to ``func``





   .. method:: set_cursor(path, column=None, start_editing=False)

      Sets the current keyboard focus to be at ``path``, and selects it.  This is
      useful when you want to focus the user’s attention on a particular row.  If
      ``focus_column`` is not :const:`None`, then focus is given to the column specified by
      it. Additionally, if ``focus_column`` is specified, and ``start_editing`` is
      :const:`True`, then editing should be started in the specified cell.
      This function is often followed by ``gtk_widget_grab_focus`` (``tree_view``)
      in order to give keyboard focus to the widget.  Please note that editing
      can only happen when the widget is realized.

      If ``path`` is invalid for ``model``, the current cursor (if any) will be unset
      and the function will return without failing.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: A ``GtkTreePath``


      :param column: 

      :param start_editing: :const:`True` if the specified cell should start being edited.





   .. method:: set_cursor_on_cell(path: ~gi.repository.Gtk.TreePath, focus_column: ~gi.repository.Gtk.TreeViewColumn | None, focus_cell: ~gi.repository.Gtk.CellRenderer | None, start_editing: bool) -> None

      Sets the current keyboard focus to be at ``path``, and selects it.  This is
      useful when you want to focus the user’s attention on a particular row.  If
      ``focus_column`` is not :const:`None`, then focus is given to the column specified by
      it. If ``focus_column`` and ``focus_cell`` are not :const:`None`, and ``focus_column``
      contains 2 or more editable or activatable cells, then focus is given to
      the cell specified by ``focus_cell``. Additionally, if ``focus_column`` is
      specified, and ``start_editing`` is :const:`True`, then editing should be started in
      the specified cell.  This function is often followed by
      ``gtk_widget_grab_focus`` (``tree_view``) in order to give keyboard focus to the
      widget.  Please note that editing can only happen when the widget is
      realized.

      If ``path`` is invalid for ``model``, the current cursor (if any) will be unset
      and the function will return without failing.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: A ``GtkTreePath``


      :param focus_column: A ``GtkTreeViewColumn``


      :param focus_cell: A ``GtkCellRenderer``


      :param start_editing: :const:`True` if the specified cell should start being edited.





   .. method:: set_drag_dest_row(path: ~gi.repository.Gtk.TreePath | None, pos: ~gi.repository.Gtk.TreeViewDropPosition) -> None

      Sets the row that is highlighted for feedback.
      If ``path`` is :const:`None`, an existing highlight is removed.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: The path of the row to highlight


      :param pos: Specifies whether to drop before, after or into the row





   .. method:: set_enable_search(enable_search: bool) -> None

      If ``enable_search`` is set, then the user can type in text to search through
      the tree interactively (this is sometimes called "typeahead find").

      Note that even if this is :const:`False`, the user can still initiate a search
      using the “start-interactive-search” key binding.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param enable_search: :const:`True`, if the user can search interactively





   .. method:: set_enable_tree_lines(enabled: bool) -> None

      Sets whether to draw lines interconnecting the expanders in ``tree_view``.
      This does not have any visible effects for lists.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param enabled: :const:`True` to enable tree line drawing, :const:`False` otherwise.





   .. method:: set_expander_column(column: ~gi.repository.Gtk.TreeViewColumn | None = None) -> None

      Sets the column to draw the expander arrow at. It must be in ``tree_view``.
      If ``column`` is :const:`None`, then the expander arrow is always at the first
      visible column.

      If you do not want expander arrow to appear in your tree, set the
      expander column to a hidden column.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param column: :const:`None`, or the column to draw the expander arrow at.





   .. method:: set_fixed_height_mode(enable: bool) -> None

      Enables or disables the fixed height mode of ``tree_view``.
      Fixed height mode speeds up ``GtkTreeView`` by assuming that all
      rows have the same height.
      Only enable this option if all rows are the same height and all
      columns are of type :const:`~gi.repository.Gtk.TreeViewColumnSizing.FIXED`.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param enable: :const:`True` to enable fixed height mode





   .. method:: set_grid_lines(grid_lines: ~gi.repository.Gtk.TreeViewGridLines) -> None

      Sets which grid lines to draw in ``tree_view``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param grid_lines: a ``GtkTreeView``GridLines value indicating which grid lines to
         enable.





   .. method:: set_headers_clickable(setting: bool) -> None

      Allow the column title buttons to be clicked.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param setting: :const:`True` if the columns are clickable.





   .. method:: set_headers_visible(headers_visible: bool) -> None

      Sets the visibility state of the headers.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param headers_visible: :const:`True` if the headers are visible





   .. method:: set_hover_expand(expand: bool) -> None

      Enables or disables the hover expansion mode of ``tree_view``.
      Hover expansion makes rows expand or collapse if the pointer
      moves over them.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param expand: :const:`True` to enable hover selection mode





   .. method:: set_hover_selection(hover: bool) -> None

      Enables or disables the hover selection mode of ``tree_view``.
      Hover selection makes the selected row follow the pointer.
      Currently, this works only for the selection modes
      :const:`~gi.repository.Gtk.SelectionMode.SINGLE` and :const:`~gi.repository.Gtk.SelectionMode.BROWSE`.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param hover: :const:`True` to enable hover selection mode





   .. method:: set_level_indentation(indentation: int) -> None

      Sets the amount of extra indentation for child levels to use in ``tree_view``
      in addition to the default indentation.  The value should be specified in
      pixels, a value of 0 disables this feature and in this case only the default
      indentation will be used.
      This does not have any visible effects for lists.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param indentation: the amount, in pixels, of extra indentation in ``tree_view``.





   .. method:: set_model(model: ~gi.repository.Gtk.TreeModel | None = None) -> None

      Sets the model for a ``GtkTreeView``.  If the ``tree_view`` already has a model
      set, it will remove it before setting the new model.  If ``model`` is :const:`None`,
      then it will unset the old model.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param model: The model.





   .. method:: set_reorderable(reorderable: bool) -> None

      This function is a convenience function to allow you to reorder
      models that support the ``GtkTreeDragSourceIface`` and the
      ``GtkTreeDragDestIface``.  Both ``GtkTreeStore`` and ``GtkListStore`` support
      these.  If ``reorderable`` is :const:`True`, then the user can reorder the
      model by dragging and dropping rows. The developer can listen to
      these changes by connecting to the model’s ``GtkTreeModel::row-inserted``
      and ``GtkTreeModel::row-deleted`` signals. The reordering is implemented
      by setting up the tree view as a drag source and destination.
      Therefore, drag and drop can not be used in a reorderable view for any
      other purpose.

      This function does not give you any degree of control over the order -- any
      reordering is allowed.  If more control is needed, you should probably
      handle drag and drop manually.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param reorderable: :const:`True`, if the tree can be reordered.





   .. method:: set_row_separator_func(func: ~typing.Callable[[...], bool] | None = None, *data: ~typing.Any) -> None

      Sets the row separator function, which is used to determine
      whether a row should be drawn as a separator. If the row separator
      function is :const:`None`, no separators are drawn. This is the default value.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param func: a ``GtkTreeView``RowSeparatorFunc


      :param data: user data to pass to ``func``





   .. method:: set_rubber_banding(enable: bool) -> None

      Enables or disables rubber banding in ``tree_view``.  If the selection mode
      is :const:`~gi.repository.Gtk.SelectionMode.MULTIPLE`, rubber banding will allow the user to select
      multiple rows by dragging the mouse.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param enable: :const:`True` to enable rubber banding





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

      Sets ``column`` as the column where the interactive search code should
      search in for the current model.

      If the search column is set, users can use the “start-interactive-search”
      key binding to bring up search popup. The enable-search property controls
      whether simply typing text will also start an interactive search.

      Note that ``column`` refers to a column of the current model. The search
      column is reset to -1 when the model is changed.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param column: the column of the model to search in, or -1 to disable searching





   .. method:: set_search_entry(entry: ~gi.repository.Gtk.Editable | None = None) -> None

      Sets the entry which the interactive search code will use for this
      ``tree_view``.  This is useful when you want to provide a search entry
      in our interface at all time at a fixed position.  Passing :const:`None` for
      ``entry`` will make the interactive search code use the built-in popup
      entry again.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param entry: the entry the interactive search code of ``tree_view`` should use





   .. method:: set_search_equal_func(search_equal_func: ~typing.Callable[[...], bool], *search_user_data: ~typing.Any) -> None

      Sets the compare function for the interactive search capabilities; note
      that somewhat like strcmp() returning 0 for equality
      ``GtkTreeView``SearchEqualFunc returns :const:`False` on matches.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param search_equal_func: the compare function to use during the search


      :param search_user_data: user data to pass to ``search_equal_func``





   .. method:: set_show_expanders(enabled: bool) -> None

      Sets whether to draw and enable expanders and indent child rows in
      ``tree_view``.  When disabled there will be no expanders visible in trees
      and there will be no way to expand and collapse rows by default.  Also
      note that hiding the expanders will disable the default indentation.  You
      can set a custom indentation in this case using
      :func:`~gi.repository.Gtk.TreeView.set_level_indentation`.
      This does not have any visible effects for lists.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param enabled: :const:`True` to enable expander drawing, :const:`False` otherwise.





   .. method:: set_tooltip_cell(tooltip: ~gi.repository.Gtk.Tooltip, path: ~gi.repository.Gtk.TreePath | None = None, column: ~gi.repository.Gtk.TreeViewColumn | None = None, cell: ~gi.repository.Gtk.CellRenderer | None = None) -> None

      Sets the tip area of ``tooltip`` to the area ``path``, ``column`` and ``cell`` have
      in common.  For example if ``path`` is :const:`None` and ``column`` is set, the tip
      area will be set to the full area covered by ``column``.  See also
      :func:`~gi.repository.Gtk.Tooltip.set_tip_area`.

      Note that if ``path`` is not specified and ``cell`` is set and part of a column
      containing the expander, the tooltip might not show and hide at the correct
      position.  In such cases ``path`` must be set to the current node under the
      mouse cursor for this function to operate correctly.

      See also :func:`~gi.repository.Gtk.TreeView.set_tooltip_column` for a simpler alternative.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param tooltip: a ``GtkTooltip``


      :param path: a ``GtkTreePath``


      :param column: a ``GtkTreeViewColumn``


      :param cell: a ``GtkCellRenderer``





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

      If you only plan to have simple (text-only) tooltips on full rows, you
      can use this function to have ``GtkTreeView`` handle these automatically
      for you. ``column`` should be set to the column in ``tree_view``’s model
      containing the tooltip texts, or -1 to disable this feature.

      When enabled, ``GtkWidget:has-tooltip`` will be set to :const:`True` and
      ``tree_view`` will connect a ``GtkWidget::query-tooltip`` signal handler.

      Note that the signal handler sets the text with :func:`~gi.repository.Gtk.Tooltip.set_markup`,
      so &, <, etc have to be escaped in the text.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param column: an integer, which is a valid column number for ``tree_view``’s model





   .. method:: set_tooltip_row(tooltip: ~gi.repository.Gtk.Tooltip, path: ~gi.repository.Gtk.TreePath) -> None

      Sets the tip area of ``tooltip`` to be the area covered by the row at ``path``.
      See also :func:`~gi.repository.Gtk.TreeView.set_tooltip_column` for a simpler alternative.
      See also :func:`~gi.repository.Gtk.Tooltip.set_tip_area`.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param tooltip: a ``GtkTooltip``


      :param path: a ``GtkTreePath``





   .. method:: unset_rows_drag_dest() -> None

      Undoes the effect of
      :func:`~gi.repository.Gtk.TreeView.enable_model_drag_dest`. Calling this method sets
      ``GtkTreeView``:reorderable to :const:`False`.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead







   .. method:: unset_rows_drag_source() -> None

      Undoes the effect of
      :func:`~gi.repository.Gtk.TreeView.enable_model_drag_source`. Calling this method sets
      ``GtkTreeView``:reorderable to :const:`False`.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead











Properties
----------

.. rst-class:: interim-class

.. class:: TreeView
   :no-index:
   

   .. attribute:: props.activate_on_single_click
      :type: bool

      The activate-on-single-click property specifies whether the "row-activated" signal
      will be emitted after a single click.







   .. attribute:: props.enable_grid_lines
      :type: ~gi.repository.Gtk.TreeViewGridLines

      






   .. attribute:: props.enable_search
      :type: bool

      






   .. attribute:: props.enable_tree_lines
      :type: bool

      






   .. attribute:: props.expander_column
      :type: ~gi.repository.Gtk.TreeViewColumn

      






   .. attribute:: props.fixed_height_mode
      :type: bool

      Setting the ::fixed-height-mode property to :const:`True` speeds up
      ``GtkTreeView`` by assuming that all rows have the same height.
      Only enable this option if all rows are the same height.
      Please see :func:`~gi.repository.Gtk.TreeView.set_fixed_height_mode` for more
      information on this option.







   .. attribute:: props.headers_clickable
      :type: bool

      






   .. attribute:: props.headers_visible
      :type: bool

      






   .. attribute:: props.hover_expand
      :type: bool

      Enables or disables the hover expansion mode of ``tree_view``.
      Hover expansion makes rows expand or collapse if the pointer moves
      over them.

      This mode is primarily intended for treeviews in popups, e.g.
      in ``GtkComboBox`` or ``GtkEntryCompletion``.







   .. attribute:: props.hover_selection
      :type: bool

      Enables or disables the hover selection mode of ``tree_view``.
      Hover selection makes the selected row follow the pointer.
      Currently, this works only for the selection modes
      :const:`~gi.repository.Gtk.SelectionMode.SINGLE` and :const:`~gi.repository.Gtk.SelectionMode.BROWSE`.

      This mode is primarily intended for treeviews in popups, e.g.
      in ``GtkComboBox`` or ``GtkEntryCompletion``.







   .. attribute:: props.level_indentation
      :type: int

      Extra indentation for each level.







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

      






   .. attribute:: props.reorderable
      :type: bool

      






   .. attribute:: props.rubber_banding
      :type: bool

      






   .. attribute:: props.search_column
      :type: int

      






   .. attribute:: props.show_expanders
      :type: bool

      :const:`True` if the view has expanders.







   .. attribute:: props.tooltip_column
      :type: int

      










Signals
-------

.. rst-class:: interim-class

.. class:: TreeView.signals
   :no-index:
   

   .. method:: columns_changed() -> None

      The number of columns of the treeview has changed.










   .. method:: cursor_changed() -> None

      The position of the cursor (focused cell) has changed.










   .. method:: expand_collapse_cursor_row(object: bool, p0: bool, p1: bool) -> bool

      






      :param object: 

      :param p0: 

      :param p1: 




   .. method:: move_cursor(step: ~gi.repository.Gtk.MovementStep, direction: int, extend: bool, modify: bool) -> bool

      The ``GtkTreeView``::move-cursor signal is a [keybinding
      signal]:obj:`~gi.repository.Gtk.SignalAction` which gets emitted when the user
      presses one of the cursor keys.

      Applications should not connect to it, but may emit it with
      :func:`~gi.repository.GObject.signal_emit_by_name` if they need to control the cursor
      programmatically. In contrast to :func:`~gi.repository.Gtk.TreeView.set_cursor` and
      :func:`~gi.repository.Gtk.TreeView.set_cursor_on_cell` when moving horizontally
      ``GtkTreeView``::move-cursor does not reset the current selection.







      :param step: the granularity of the move, as a ``GtkMovementStep``.
         :const:`~gi.repository.Gtk.MovementStep.LOGICAL_POSITIONS`, :const:`~gi.repository.Gtk.MovementStep.VISUAL_POSITIONS`,
         :const:`~gi.repository.Gtk.MovementStep.DISPLAY_LINES`, :const:`~gi.repository.Gtk.MovementStep.PAGES` and
         :const:`~gi.repository.Gtk.MovementStep.BUFFER_ENDS` are supported.
         :const:`~gi.repository.Gtk.MovementStep.LOGICAL_POSITIONS` and :const:`~gi.repository.Gtk.MovementStep.VISUAL_POSITIONS`
         are treated identically.


      :param direction: the direction to move: +1 to move forwards; -1 to move
         backwards. The resulting movement is undefined for all other values.


      :param extend: whether to extend the selection


      :param modify: whether to modify the selection





   .. method:: row_activated(path: ~gi.repository.Gtk.TreePath, column: ~gi.repository.Gtk.TreeViewColumn | None = None) -> None

      The "row-activated" signal is emitted when the method
      :obj:`~gi.repository.Gtk.TreeView.row_activated` is called.

      This signal is emitted when the user double-clicks a treeview row with the
      :obj:`~gi.repository.Gtk.TreeView.props.activate_on_single_click` property set to :const:`False`,
      or when the user single-clicks a row when that property set to :const:`True`.

      This signal is also emitted when a non-editable row is selected and one
      of the keys: :kbd:`Space`, :kbd:`Shift`+:kbd:`Space`,
      :kbd:`Return` or :kbd:`Enter` is pressed.

      For selection handling refer to the
      `tree widget conceptual overview <section-tree-widget.html>`_
      as well as ``GtkTreeSelection``.







      :param path: the ``GtkTreePath`` for the activated row


      :param column: the ``GtkTreeViewColumn`` in which the activation occurred





   .. method:: row_collapsed(iter: ~gi.repository.Gtk.TreeIter, path: ~gi.repository.Gtk.TreePath) -> None

      The given row has been collapsed (child nodes are hidden).







      :param iter: the tree iter of the collapsed row


      :param path: a tree path that points to the row





   .. method:: row_expanded(iter: ~gi.repository.Gtk.TreeIter, path: ~gi.repository.Gtk.TreePath) -> None

      The given row has been expanded (child nodes are shown).







      :param iter: the tree iter of the expanded row


      :param path: a tree path that points to the row





   .. method:: select_all() -> bool

      









   .. method:: select_cursor_parent() -> bool

      









   .. method:: select_cursor_row(object: bool) -> bool

      






      :param object: 




   .. method:: start_interactive_search() -> bool

      









   .. method:: test_collapse_row(iter: ~gi.repository.Gtk.TreeIter, path: ~gi.repository.Gtk.TreePath) -> bool

      The given row is about to be collapsed (hide its children nodes). Use this
      signal if you need to control the collapsibility of individual rows.







      :param iter: the tree iter of the row to collapse


      :param path: a tree path that points to the row





   .. method:: test_expand_row(iter: ~gi.repository.Gtk.TreeIter, path: ~gi.repository.Gtk.TreePath) -> bool

      The given row is about to be expanded (show its children nodes). Use this
      signal if you need to control the expandability of individual rows.







      :param iter: the tree iter of the row to expand


      :param path: a tree path that points to the row





   .. method:: toggle_cursor_row() -> bool

      









   .. method:: unselect_all() -> bool

      













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

.. rst-class:: interim-class

.. class:: TreeView
   :no-index:
   

   .. method:: do_columns_changed() -> None

      









   .. method:: do_cursor_changed() -> None

      









   .. method:: do_expand_collapse_cursor_row(logical: bool, expand: bool, open_all: bool) -> bool

      






      :param logical: 

      :param expand: 

      :param open_all: 




   .. method:: do_move_cursor(step: ~gi.repository.Gtk.MovementStep, count: int, extend: bool, modify: bool) -> bool

      






      :param step: 

      :param count: 

      :param extend: 

      :param modify: 




   .. method:: do_row_activated(path: ~gi.repository.Gtk.TreePath, column: ~gi.repository.Gtk.TreeViewColumn | None = None) -> None

      Activates the cell determined by ``path`` and ``column``.






      .. deprecated:: 4.10

         Use :obj:`~gi.repository.Gtk.ListView` or :obj:`~gi.repository.Gtk.ColumnView` instead




      :param path: The ``GtkTreePath`` to be activated.


      :param column: The ``GtkTreeViewColumn`` to be activated.





   .. method:: do_row_collapsed(iter: ~gi.repository.Gtk.TreeIter, path: ~gi.repository.Gtk.TreePath) -> None

      






      :param iter: 

      :param path: 




   .. method:: do_row_expanded(iter: ~gi.repository.Gtk.TreeIter, path: ~gi.repository.Gtk.TreePath) -> None

      






      :param iter: 

      :param path: 




   .. method:: do_select_all() -> bool

      









   .. method:: do_select_cursor_parent() -> bool

      









   .. method:: do_select_cursor_row(start_editing: bool) -> bool

      






      :param start_editing: 




   .. method:: do_start_interactive_search() -> bool

      









   .. method:: do_test_collapse_row(iter: ~gi.repository.Gtk.TreeIter, path: ~gi.repository.Gtk.TreePath) -> bool

      






      :param iter: 

      :param path: 




   .. method:: do_test_expand_row(iter: ~gi.repository.Gtk.TreeIter, path: ~gi.repository.Gtk.TreePath) -> bool

      






      :param iter: 

      :param path: 




   .. method:: do_toggle_cursor_row() -> bool

      









   .. method:: do_unselect_all() -> bool

      













Fields
------

.. rst-class:: interim-class

.. class:: TreeView
   :no-index:
   

   .. attribute:: parent_instance