TreeView

Deprecated since version 4.10: Use ListView for lists, and ColumnView for tabular lists

class TreeView(**properties: Any)

Superclasses: Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, Buildable, ConstraintTarget, Scrollable

A widget for displaying both trees and lists

Widget that displays any object that implements the TreeModel interface.

Please refer to the tree widget conceptual overview 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:

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 convert_widget_to_bin_window_coords (and vice versa), for the latter convert_bin_window_to_tree_coords (and vice versa).

GtkTreeView as GtkBuildable

The GtkTreeView implementation of the GtkBuildable interface accepts TreeViewColumn objects as <child> elements and exposes the internal TreeSelection in UI definitions.

An example of a UI definition fragment with GtkTreeView:

<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

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

class TreeView
classmethod new() → Widget

Creates a new GtkTreeView widget.

Deprecated since version 4.10: Use ListView or ColumnView instead

classmethod new_with_model(model: TreeModel) → Widget

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

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

model – the model.

Methods

class TreeView
append_column(column: 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 since version 4.10: Use ListView or ColumnView instead

Parameters:

column – The GtkTreeViewColumn to add.

collapse_all() → None

Recursively collapses all visible, expanded nodes in tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

collapse_row(path: TreePath) → bool

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

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

path – path to a row in the tree_view

columns_autosize() → None

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

Deprecated since version 4.10: Use ListView or ColumnView instead

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 since version 4.10: Use ListView or ColumnView instead

Parameters:

  • bx – X coordinate relative to bin_window

  • by – Y coordinate relative to bin_window

convert_bin_window_to_widget_coords(bx: int, by: int) → tuple[int, int]

Converts bin_window coordinates to widget relative coordinates.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • bx – bin_window X coordinate

  • by – bin_window Y coordinate

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 since version 4.10: Use ListView or ColumnView instead

Parameters:

  • tx – tree X coordinate

  • ty – tree Y coordinate

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 since version 4.10: Use ListView or ColumnView instead

Parameters:

  • tx – X coordinate relative to the tree

  • ty – Y coordinate relative to the tree

convert_widget_to_bin_window_coords(wx: int, wy: int) → tuple[int, int]

Converts widget coordinates to coordinates for the bin_window.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • wx – X coordinate relative to the widget

  • wy – Y coordinate relative to the widget

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 since version 4.10: Use ListView or ColumnView instead

Parameters:

  • wx – X coordinate relative to the widget

  • wy – Y coordinate relative to the widget

create_row_drag_icon(path: TreePath) → Paintable | None

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

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

path – a GtkTreePath in tree_view

enable_model_drag_dest(formats: ContentFormats, actions: DragAction) → None

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

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • formats – the target formats that the drag will support

  • actions – the bitmask of possible actions for a drag from this widget

enable_model_drag_source(start_button_mask: ModifierType, formats: ContentFormats, actions: DragAction) → None

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

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • start_button_mask – Mask of allowed buttons to start drag

  • formats – the target formats that the drag will support

  • actions – the bitmask of possible actions for a drag from this widget

expand_all() → None

Recursively expands all nodes in the tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

expand_row(path: TreePath, open_all: bool) → bool

Opens the row so its children are visible.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • path – path to a row

  • open_all – whether to recursively expand, or just expand immediate children

expand_to_path(path: TreePath) → None

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

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

path – path to a row.

get_activate_on_single_click() → bool

Gets the setting set by set_activate_on_single_click().

Deprecated since version 4.10: Use ListView or ColumnView instead

get_background_area(path: TreePath | None = None, column: TreeViewColumn | None = None) → 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 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 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 get_cell_area(), which returns only the cell itself, excluding surrounding borders and the tree expander area.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • path – a GtkTreePath for the row, or None to get only horizontal coordinates

  • column – a GtkTreeViewColumn for the column, or None to get only vertical coordinates

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 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 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 since version 4.10: Use ListView or ColumnView instead

Parameters:

  • path – a GtkTreePath for the row, or None to get only horizontal coordinates

  • column – a GtkTreeViewColumn for the column, or None to get only vertical coordinates

get_column(n: int) → TreeViewColumn | None

Gets the GtkTreeViewColumn at the given position in the tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

n – The position of the column, counting from 0.

get_columns() → list[TreeViewColumn]

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

Deprecated since version 4.10: Use ListView or ColumnView instead

get_cursor() → tuple[TreePath, 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 None. If no column currently has focus, then *focus_column will be None.

The returned GtkTreePath must be freed with free() when you are done with it.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_dest_row_at_pos(drag_x: int, drag_y: int) → tuple[bool, TreePath, 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 False if tree_view is not realized or does not have a model.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • drag_x – the position to determine the destination row for

  • drag_y – the position to determine the destination row for

get_drag_dest_row() → tuple[TreePath, TreeViewDropPosition]

Gets information about the row that is highlighted for feedback.

Deprecated since version 4.10: Use ListView or ColumnView instead

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

Deprecated since version 4.10: Use ListView or ColumnView instead

get_enable_tree_lines() → bool

Returns whether or not tree lines are drawn in tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_expander_column() → TreeViewColumn | None

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

Deprecated since version 4.10: Use ListView or ColumnView instead

get_fixed_height_mode() → bool

Returns whether fixed height mode is turned on for tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_grid_lines() → TreeViewGridLines

Returns which grid lines are enabled in tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_headers_clickable() → bool

Returns whether all header columns are clickable.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_headers_visible() → bool

Returns True if the headers on the tree_view are visible.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_hover_expand() → bool

Returns whether hover expansion mode is turned on for tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_hover_selection() → bool

Returns whether hover selection mode is turned on for tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_level_indentation() → int

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

Deprecated since version 4.10: Use ListView or ColumnView instead

get_model() → TreeModel | None

Returns the model the GtkTreeView is based on. Returns None if the model is unset.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_n_columns() → int

Queries the number of columns in the given tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_path_at_pos(x: int, y: int) → tuple[bool, TreePath, 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 convert_widget_to_bin_window_coords(). It is primarily for things like popup menus. If path is non-None, then it will be filled with the GtkTreePath at that point. This path should be freed with free(). If column is non-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 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 convert_widget_to_bin_window_coords().

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • x – The x position to be identified (relative to bin_window).

  • y – The y position to be identified (relative to bin_window).

get_reorderable() → bool

Retrieves whether the user can reorder the tree via drag-and-drop. See set_reorderable().

Deprecated since version 4.10: Use ListView or ColumnView instead

get_rubber_banding() → bool

Returns whether rubber banding is turned on for tree_view. If the selection mode is MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_search_column() → int

Gets the column searched on by the interactive search code.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_search_entry() → 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, None will be returned.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_selection() → TreeSelection

Gets the GtkTreeSelection associated with tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_show_expanders() → bool

Returns whether or not expanders are drawn in tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

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 since version 4.10: Use ListView or ColumnView instead

get_tooltip_context(x: int, y: int, keyboard_tip: bool) → tuple[bool, TreeModel, TreePath, 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 (True) or not (False) for mouse tooltips. For keyboard tooltips the row returned will be the cursor row. When 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 False.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • x – the x coordinate (relative to widget coordinates)

  • y – the y coordinate (relative to widget coordinates)

  • keyboard_tip – whether this is a keyboard tooltip or not

get_visible_range() → tuple[bool, TreePath, 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 free() after use.

Deprecated since version 4.10: Use ListView or ColumnView instead

get_visible_rect() → Rectangle

Fills visible_rect with the currently-visible region of the buffer, in tree coordinates. Convert to bin_window coordinates with 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 since version 4.10: Use ListView or ColumnView instead

insert_column(column: 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 since version 4.10: Use ListView or ColumnView instead

Parameters:

  • column – The GtkTreeViewColumn to be inserted.

  • position – The position to insert column in.

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 since version 4.10: Use ListView or ColumnView instead

Parameters:

  • position – The position to insert the new column in

  • title – The title to set the header to

  • cell – The GtkCellRenderer

  • kwargs

insert_column_with_data_func(position: int, title: str, cell: CellRenderer, func: Callable[[...], None], *data: 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 set_cell_data_func(), 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 since version 4.10: Use ListView or ColumnView instead

Parameters:

  • position – Position to insert, -1 for append

  • title – column title

  • cell – cell renderer for column

  • func – function to set attributes of cell renderer

  • data – data for func

is_blank_at_pos(x: int, y: int) → tuple[bool, TreePath, 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 convert_widget_to_bin_window_coords().

For converting widget coordinates (eg. the ones you get from GtkWidget::query-tooltip), please see convert_widget_to_bin_window_coords().

The path, column, cell_x and cell_y arguments will be filled in likewise as for get_path_at_pos(). Please see get_path_at_pos() for more information.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • x – The x position to be identified (relative to bin_window)

  • y – The y position to be identified (relative to bin_window)

is_rubber_banding_active() → bool

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

Deprecated since version 4.10: Use ListView or ColumnView instead

map_expanded_rows(func: Callable[[...], None], *data: Any) → None

Calls func on all expanded rows.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • func – A function to be called

  • data – User data to be passed to the function.

move_column_after(column: TreeViewColumn, base_column: TreeViewColumn | None = None) → None

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

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • column – The GtkTreeViewColumn to be moved.

  • base_column – The GtkTreeViewColumn to be moved relative to

remove_column(column: TreeViewColumn) → int

Removes column from tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

column – The GtkTreeViewColumn to remove.

row_activated(path: TreePath, column: TreeViewColumn | None = None) → None

Activates the cell determined by path and column.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • path – The GtkTreePath to be activated.

  • column – The GtkTreeViewColumn to be activated.

row_expanded(path: TreePath) → bool

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

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

path – A GtkTreePath to test expansion state.

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 None, then no horizontal scrolling occurs. Likewise, if path is None no vertical scrolling occurs. At a minimum, one of column or path need to be non-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 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 since version 4.10: Use ListView or ColumnView instead

Parameters:

  • path – The path of the row to move to

  • column – The GtkTreeViewColumn to move horizontally to

  • use_align – whether to use alignment arguments, or False.

  • row_align – The vertical alignment of the row specified by path.

  • col_align – The horizontal alignment of the column specified by column.

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 scroll_to_cell().

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

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • tree_x – X coordinate of new top-left pixel of visible area, or -1

  • tree_y – Y coordinate of new top-left pixel of visible area, or -1

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 since version 4.10: Use ListView or ColumnView instead

Parameters:

single – True to emit row-activated on a single click

set_column_drag_function(func: Callable[[...], bool] | None = None, *user_data: 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 None, then they indicate an edge. If func is set to be None, then tree_view reverts to the default behavior of allowing all columns to be dropped everywhere.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • func – A function to determine which columns are reorderable

  • user_data – User data to be passed to func

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 None, then focus is given to the column specified by it. Additionally, if focus_column is specified, and start_editing is 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 since version 4.10: Use ListView or ColumnView instead

Parameters:

  • path – A GtkTreePath

  • column

  • start_editing – True if the specified cell should start being edited.

set_cursor_on_cell(path: TreePath, focus_column: TreeViewColumn | None, focus_cell: 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 None, then focus is given to the column specified by it. If focus_column and focus_cell are not 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 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 since version 4.10: Use ListView or ColumnView instead

Parameters:

  • path – A GtkTreePath

  • focus_column – A GtkTreeViewColumn

  • focus_cell – A GtkCellRenderer

  • start_editing – True if the specified cell should start being edited.

set_drag_dest_row(path: TreePath | None, pos: TreeViewDropPosition) → None

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

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • path – The path of the row to highlight

  • pos – Specifies whether to drop before, after or into the row

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 False, the user can still initiate a search using the “start-interactive-search” key binding.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

enable_search – True, if the user can search interactively

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 since version 4.10: Use ListView or ColumnView instead

Parameters:

enabled – True to enable tree line drawing, False otherwise.

set_expander_column(column: TreeViewColumn | None = None) → None

Sets the column to draw the expander arrow at. It must be in tree_view. If column is 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 since version 4.10: Use ListView or ColumnView instead

Parameters:

column – None, or the column to draw the expander arrow at.

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 FIXED.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

enable – True to enable fixed height mode

set_grid_lines(grid_lines: TreeViewGridLines) → None

Sets which grid lines to draw in tree_view.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

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

set_headers_clickable(setting: bool) → None

Allow the column title buttons to be clicked.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

setting – True if the columns are clickable.

set_headers_visible(headers_visible: bool) → None

Sets the visibility state of the headers.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

headers_visible – True if the headers are visible

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 since version 4.10: Use ListView or ColumnView instead

Parameters:

expand – True to enable hover selection mode

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 SINGLE and BROWSE.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

hover – True to enable hover selection mode

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 since version 4.10: Use ListView or ColumnView instead

Parameters:

indentation – the amount, in pixels, of extra indentation in tree_view.

set_model(model: 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 None, then it will unset the old model.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

model – The model.

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 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 since version 4.10: Use ListView or ColumnView instead

Parameters:

reorderable – True, if the tree can be reordered.

set_row_separator_func(func: Callable[[...], bool] | None = None, *data: 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 None, no separators are drawn. This is the default value.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • func – a ``GtkTreeView``RowSeparatorFunc

  • data – user data to pass to func

set_rubber_banding(enable: bool) → None

Enables or disables rubber banding in tree_view. If the selection mode is MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

enable – True to enable rubber banding

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 since version 4.10: Use ListView or ColumnView instead

Parameters:

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

set_search_entry(entry: 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 None for entry will make the interactive search code use the built-in popup entry again.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

entry – the entry the interactive search code of tree_view should use

set_search_equal_func(search_equal_func: Callable[[...], bool], *search_user_data: Any) → None

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

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • search_equal_func – the compare function to use during the search

  • search_user_data – user data to pass to search_equal_func

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 set_level_indentation(). This does not have any visible effects for lists.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

enabled – True to enable expander drawing, False otherwise.

set_tooltip_cell(tooltip: Tooltip, path: TreePath | None = None, column: TreeViewColumn | None = None, cell: 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 None and column is set, the tip area will be set to the full area covered by column. See also 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 set_tooltip_column() for a simpler alternative.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • tooltip – a GtkTooltip

  • path – a GtkTreePath

  • column – a GtkTreeViewColumn

  • cell – a GtkCellRenderer

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 True and tree_view will connect a GtkWidget::query-tooltip signal handler.

Note that the signal handler sets the text with set_markup(), so &, <, etc have to be escaped in the text.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

column – an integer, which is a valid column number for tree_view’s model

set_tooltip_row(tooltip: Tooltip, path: TreePath) → None

Sets the tip area of tooltip to be the area covered by the row at path. See also set_tooltip_column() for a simpler alternative. See also set_tip_area().

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • tooltip – a GtkTooltip

  • path – a GtkTreePath

unset_rows_drag_dest() → None

Undoes the effect of enable_model_drag_dest(). Calling this method sets GtkTreeView:reorderable to False.

Deprecated since version 4.10: Use ListView or ColumnView instead

unset_rows_drag_source() → None

Undoes the effect of enable_model_drag_source(). Calling this method sets GtkTreeView:reorderable to False.

Deprecated since version 4.10: Use ListView or ColumnView instead

Properties

class TreeView
props.activate_on_single_click: bool

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

props.enable_grid_lines: TreeViewGridLines
props.enable_tree_lines: bool
props.expander_column: TreeViewColumn
props.fixed_height_mode: bool

Setting the ::fixed-height-mode property to 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 set_fixed_height_mode() for more information on this option.

props.headers_clickable: bool
props.headers_visible: bool
props.hover_expand: 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.

props.hover_selection: 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 SINGLE and BROWSE.

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

props.level_indentation: int

Extra indentation for each level.

props.model: TreeModel
props.reorderable: bool
props.rubber_banding: bool
props.search_column: int
props.show_expanders: bool

True if the view has expanders.

props.tooltip_column: int

Signals

class TreeView.signals
columns_changed() → None

The number of columns of the treeview has changed.

cursor_changed() → None

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

expand_collapse_cursor_row(object: bool, p0: bool, p1: bool) → bool
Parameters:

  • object

  • p0

  • p1

move_cursor(step: MovementStep, direction: int, extend: bool, modify: bool) → bool

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

Applications should not connect to it, but may emit it with signal_emit_by_name() if they need to control the cursor programmatically. In contrast to set_cursor() and set_cursor_on_cell() when moving horizontally GtkTreeView::move-cursor does not reset the current selection.

Parameters:
row_activated(path: TreePath, column: TreeViewColumn | None = None) → None

The “row-activated” signal is emitted when the method row_activated is called.

This signal is emitted when the user double-clicks a treeview row with the activate_on_single_click property set to False, or when the user single-clicks a row when that property set to True.

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

For selection handling refer to the tree widget conceptual overview as well as GtkTreeSelection.

Parameters:

  • path – the GtkTreePath for the activated row

  • column – the GtkTreeViewColumn in which the activation occurred

row_collapsed(iter: TreeIter, path: TreePath) → None

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

Parameters:

  • iter – the tree iter of the collapsed row

  • path – a tree path that points to the row

row_expanded(iter: TreeIter, path: TreePath) → None

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

Parameters:

  • iter – the tree iter of the expanded row

  • path – a tree path that points to the row

select_all() → bool
select_cursor_parent() → bool
select_cursor_row(object: bool) → bool
Parameters:

object

test_collapse_row(iter: TreeIter, path: 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.

Parameters:

  • iter – the tree iter of the row to collapse

  • path – a tree path that points to the row

test_expand_row(iter: TreeIter, path: 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.

Parameters:

  • iter – the tree iter of the row to expand

  • path – a tree path that points to the row

toggle_cursor_row() → bool
unselect_all() → bool

Virtual Methods

class TreeView
do_columns_changed() → None
do_cursor_changed() → None
do_expand_collapse_cursor_row(logical: bool, expand: bool, open_all: bool) → bool
Parameters:

  • logical

  • expand

  • open_all

do_move_cursor(step: MovementStep, count: int, extend: bool, modify: bool) → bool
Parameters:

  • step

  • count

  • extend

  • modify

do_row_activated(path: TreePath, column: TreeViewColumn | None = None) → None

Activates the cell determined by path and column.

Deprecated since version 4.10: Use ListView or ColumnView instead

Parameters:

  • path – The GtkTreePath to be activated.

  • column – The GtkTreeViewColumn to be activated.

do_row_collapsed(iter: TreeIter, path: TreePath) → None
Parameters:

  • iter

  • path

do_row_expanded(iter: TreeIter, path: TreePath) → None
Parameters:

  • iter

  • path

do_select_all() → bool
do_select_cursor_parent() → bool
do_select_cursor_row(start_editing: bool) → bool
Parameters:

start_editing

do_test_collapse_row(iter: TreeIter, path: TreePath) → bool
Parameters:

  • iter

  • path

do_test_expand_row(iter: TreeIter, path: TreePath) → bool
Parameters:

  • iter

  • path

do_toggle_cursor_row() → bool
do_unselect_all() → bool

Fields

class TreeView
parent_instance