Gtk.TreeView¶

class — extends Widget, Accessible, Buildable, ConstraintTarget, Scrollable

:::warning Deprecated since 4.10 This API is deprecated. :::

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:

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

new¶

@classmethod
def new(cls) -> Widget

:::warning Deprecated since 4.10 This API is deprecated. :::

Creates a new GtkTreeView widget.

new_with_model¶

@classmethod
def new_with_model(cls, model: TreeModel) -> Widget

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

model — the model.

Methods¶

append_column¶

def append_column(self, column: TreeViewColumn) -> int

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

column — The GtkTreeViewColumn to add.

collapse_all¶

def collapse_all(self) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Recursively collapses all visible, expanded nodes in tree_view.

collapse_row¶

def collapse_row(self, path: TreePath) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

path — path to a row in the tree_view

columns_autosize¶

def columns_autosize(self) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

convert_bin_window_to_tree_coords¶

def convert_bin_window_to_tree_coords(self, bx: int, by: int) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

bx — X coordinate relative to bin_window
by — Y coordinate relative to bin_window

convert_bin_window_to_widget_coords¶

def convert_bin_window_to_widget_coords(self, bx: int, by: int) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

Converts bin_window coordinates to widget relative coordinates.

Parameters:

bx — bin_window X coordinate
by — bin_window Y coordinate

convert_tree_to_bin_window_coords¶

def convert_tree_to_bin_window_coords(self, tx: int, ty: int) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

tx — tree X coordinate
ty — tree Y coordinate

convert_tree_to_widget_coords¶

def convert_tree_to_widget_coords(self, tx: int, ty: int) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

tx — X coordinate relative to the tree
ty — Y coordinate relative to the tree

convert_widget_to_bin_window_coords¶

def convert_widget_to_bin_window_coords(self, wx: int, wy: int) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

Converts widget coordinates to coordinates for the bin_window.

Parameters:

wx — X coordinate relative to the widget
wy — Y coordinate relative to the widget

convert_widget_to_tree_coords¶

def convert_widget_to_tree_coords(self, wx: int, wy: int) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

wx — X coordinate relative to the widget
wy — Y coordinate relative to the widget

create_row_drag_icon¶

def create_row_drag_icon(self, path: TreePath) -> Gdk.Paintable | None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

path — a GtkTreePath in tree_view

enable_model_drag_dest¶

def enable_model_drag_dest(self, formats: Gdk.ContentFormats, actions: Gdk.DragAction | int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

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¶

def enable_model_drag_source(self, start_button_mask: Gdk.ModifierType | int, formats: Gdk.ContentFormats, actions: Gdk.DragAction | int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

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¶

def expand_all(self) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Recursively expands all nodes in the tree_view.

expand_row¶

def expand_row(self, path: TreePath, open_all: bool) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Opens the row so its children are visible.

Parameters:

path — path to a row
open_all — whether to recursively expand, or just expand immediate children

expand_to_path¶

def expand_to_path(self, path: TreePath) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

path — path to a row.

get_activate_on_single_click¶

def get_activate_on_single_click(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Gets the setting set by TreeView.set_activate_on_single_click.

get_background_area¶

def get_background_area(self, path: TreePath | None = ..., column: TreeViewColumn | None = ...) -> Gdk.Rectangle

:::warning Deprecated since 4.10 This API is deprecated. :::

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 TreeView.get_cell_area, which returns only the cell itself, excluding surrounding borders and the tree expander area.

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¶

def get_cell_area(self, path: TreePath | None = ..., column: TreeViewColumn | None = ...) -> Gdk.Rectangle

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

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¶

def get_column(self, n: int) -> TreeViewColumn | None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

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

get_columns¶

def get_columns(self) -> list[TreeViewColumn]

:::warning Deprecated since 4.10 This API is deprecated. :::

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

get_cursor¶

def get_cursor(self) -> tuple[TreePath, TreeViewColumn]

:::warning Deprecated since 4.10 This API is deprecated. :::

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 TreePath.free when you are done with it.

get_dest_row_at_pos¶

def get_dest_row_at_pos(self, drag_x: int, drag_y: int) -> tuple[bool, TreePath, TreeViewDropPosition | int]

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

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¶

def get_drag_dest_row(self) -> tuple[TreePath, TreeViewDropPosition | int]

:::warning Deprecated since 4.10 This API is deprecated. :::

Gets information about the row that is highlighted for feedback.

get_enable_search¶

def get_enable_search(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

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

get_enable_tree_lines¶

def get_enable_tree_lines(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns whether or not tree lines are drawn in tree_view.

get_expander_column¶

def get_expander_column(self) -> TreeViewColumn | None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

get_fixed_height_mode¶

def get_fixed_height_mode(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns whether fixed height mode is turned on for tree_view.

get_grid_lines¶

def get_grid_lines(self) -> TreeViewGridLines

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns which grid lines are enabled in tree_view.

get_headers_clickable¶

def get_headers_clickable(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns whether all header columns are clickable.

get_headers_visible¶

def get_headers_visible(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns True if the headers on the tree_view are visible.

get_hover_expand¶

def get_hover_expand(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns whether hover expansion mode is turned on for tree_view.

get_hover_selection¶

def get_hover_selection(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns whether hover selection mode is turned on for tree_view.

get_level_indentation¶

def get_level_indentation(self) -> int

:::warning Deprecated since 4.10 This API is deprecated. :::

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

get_model¶

def get_model(self) -> TreeModel | None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

get_n_columns¶

def get_n_columns(self) -> int

:::warning Deprecated since 4.10 This API is deprecated. :::

Queries the number of columns in the given tree_view.

get_path_at_pos¶

def get_path_at_pos(self, x: int, y: int) -> tuple[bool, TreePath, TreeViewColumn, int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

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 TreeView.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 TreePath.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 TreeView.convert_widget_to_bin_window_coords.

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¶

def get_reorderable(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

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

get_rubber_banding¶

def get_rubber_banding(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

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

get_search_column¶

def get_search_column(self) -> int

:::warning Deprecated since 4.10 This API is deprecated. :::

Gets the column searched on by the interactive search code.

get_search_entry¶

def get_search_entry(self) -> Editable | None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

get_selection¶

def get_selection(self) -> TreeSelection

:::warning Deprecated since 4.10 This API is deprecated. :::

Gets the GtkTreeSelection associated with tree_view.

get_show_expanders¶

def get_show_expanders(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns whether or not expanders are drawn in tree_view.

def get_tooltip_column(self) -> int

:::warning Deprecated since 4.10 This API is deprecated. :::

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

def get_tooltip_context(self, x: int, y: int, keyboard_tip: bool) -> tuple[bool, TreeModel, TreePath, TreeIter]

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

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¶

def get_visible_range(self) -> tuple[bool, TreePath, TreePath]

:::warning Deprecated since 4.10 This API is deprecated. :::

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 TreePath.free after use.

get_visible_rect¶

def get_visible_rect(self) -> Gdk.Rectangle

:::warning Deprecated since 4.10 This API is deprecated. :::

Fills visible_rect with the currently-visible region of the buffer, in tree coordinates. Convert to bin_window coordinates with 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.

insert_column¶

def insert_column(self, column: TreeViewColumn, position: int) -> int

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

column — The GtkTreeViewColumn to be inserted.
position — The position to insert column in.

insert_column_with_data_func¶

def insert_column_with_data_func(self, position: int, title: str, cell: CellRenderer, func: TreeCellDataFunc) -> int

:::warning Deprecated since 4.10 This API is deprecated. :::

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 TreeViewColumn.set_cell_data_func, 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.

Parameters:

position — Position to insert, -1 for append
title — column title
cell — cell renderer for column
func — function to set attributes of cell renderer

is_blank_at_pos¶

def is_blank_at_pos(self, x: int, y: int) -> tuple[bool, TreePath, TreeViewColumn, int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

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 TreeView.convert_widget_to_bin_window_coords.

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

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

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¶

def is_rubber_banding_active(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

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

map_expanded_rows¶

def map_expanded_rows(self, func: TreeViewMappingFunc) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Calls func on all expanded rows.

Parameters:

func — A function to be called

move_column_after¶

def move_column_after(self, column: TreeViewColumn, base_column: TreeViewColumn | None = ...) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

column — The GtkTreeViewColumn to be moved.
base_column — The GtkTreeViewColumn to be moved relative to

remove_column¶

def remove_column(self, column: TreeViewColumn) -> int

:::warning Deprecated since 4.10 This API is deprecated. :::

Removes column from tree_view.

Parameters:

column — The GtkTreeViewColumn to remove.

row_activated¶

def row_activated(self, path: TreePath, column: TreeViewColumn | None = ...) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Activates the cell determined by path and column.

Parameters:

path — The GtkTreePath to be activated.
column — The GtkTreeViewColumn to be activated.

row_expanded¶

def row_expanded(self, path: TreePath) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

path — A GtkTreePath to test expansion state.

scroll_to_cell¶

def scroll_to_cell(self, path: TreePath | None, column: TreeViewColumn | None, use_align: bool, row_align: float, col_align: float) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

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¶

def scroll_to_point(self, tree_x: int, tree_y: int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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 TreeView.scroll_to_cell.

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

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¶

def set_activate_on_single_click(self, single: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

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

set_column_drag_function¶

def set_column_drag_function(self, func: TreeViewColumnDropFunc | None = ...) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

func — A function to determine which columns are reorderable

set_cursor¶

def set_cursor(self, path: TreePath, focus_column: TreeViewColumn | None, start_editing: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

path — A GtkTreePath
focus_column — A GtkTreeViewColumn
start_editing — True if the specified cell should start being edited.

set_cursor_on_cell¶

def set_cursor_on_cell(self, path: TreePath, focus_column: TreeViewColumn | None, focus_cell: CellRenderer | None, start_editing: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

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¶

def set_drag_dest_row(self, path: TreePath | None, pos: TreeViewDropPosition | int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

path — The path of the row to highlight
pos — Specifies whether to drop before, after or into the row

set_enable_search¶

def set_enable_search(self, enable_search: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

enable_search — True, if the user can search interactively

set_enable_tree_lines¶

def set_enable_tree_lines(self, enabled: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

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

set_expander_column¶

def set_expander_column(self, column: TreeViewColumn | None = ...) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

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

set_fixed_height_mode¶

def set_fixed_height_mode(self, enable: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

enable — True to enable fixed height mode

set_grid_lines¶

def set_grid_lines(self, grid_lines: TreeViewGridLines | int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Sets which grid lines to draw in tree_view.

Parameters:

grid_lines — a GtkTreeViewGridLines value indicating which grid lines to enable.

set_headers_clickable¶

def set_headers_clickable(self, setting: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Allow the column title buttons to be clicked.

Parameters:

setting — True if the columns are clickable.

set_headers_visible¶

def set_headers_visible(self, headers_visible: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Sets the visibility state of the headers.

Parameters:

headers_visible — True if the headers are visible

set_hover_expand¶

def set_hover_expand(self, expand: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

expand — True to enable hover selection mode

set_hover_selection¶

def set_hover_selection(self, hover: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

hover — True to enable hover selection mode

set_level_indentation¶

def set_level_indentation(self, indentation: int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

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

set_model¶

def set_model(self, model: TreeModel | None = ...) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

model — The model.

set_reorderable¶

def set_reorderable(self, reorderable: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

reorderable — True, if the tree can be reordered.

set_row_separator_func¶

def set_row_separator_func(self, func: TreeViewRowSeparatorFunc | None = ...) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

func — a GtkTreeViewRowSeparatorFunc

set_rubber_banding¶

def set_rubber_banding(self, enable: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

enable — True to enable rubber banding

set_search_column¶

def set_search_column(self, column: int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

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

set_search_entry¶

def set_search_entry(self, entry: Editable | None = ...) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

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

set_search_equal_func¶

def set_search_equal_func(self, search_equal_func: TreeViewSearchEqualFunc) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

search_equal_func — the compare function to use during the search

set_show_expanders¶

def set_show_expanders(self, enabled: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

enabled — True to enable expander drawing, False otherwise.

def set_tooltip_cell(self, tooltip: Tooltip, path: TreePath | None = ..., column: TreeViewColumn | None = ..., cell: CellRenderer | None = ...) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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 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 TreeView.set_tooltip_column for a simpler alternative.

Parameters:

tooltip — a GtkTooltip
path — a GtkTreePath
column — a GtkTreeViewColumn
cell — a GtkCellRenderer

def set_tooltip_column(self, column: int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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 Tooltip.set_markup, so &, <, etc have to be escaped in the text.

Parameters:

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

def set_tooltip_row(self, tooltip: Tooltip, path: TreePath) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

tooltip — a GtkTooltip
path — a GtkTreePath

unset_rows_drag_dest¶

def unset_rows_drag_dest(self) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

unset_rows_drag_source¶

def unset_rows_drag_source(self) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Virtual methods¶

do_columns_changed¶

def do_columns_changed(self) -> None

do_cursor_changed¶

def do_cursor_changed(self) -> None

do_expand_collapse_cursor_row¶

def do_expand_collapse_cursor_row(self, logical: bool, expand: bool, open_all: bool) -> bool

do_move_cursor¶

def do_move_cursor(self, step: MovementStep | int, count: int, extend: bool, modify: bool) -> bool

do_row_activated¶

def do_row_activated(self, path: TreePath, column: TreeViewColumn | None = ...) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Activates the cell determined by path and column.

Parameters:

path — The GtkTreePath to be activated.
column — The GtkTreeViewColumn to be activated.

do_row_collapsed¶

def do_row_collapsed(self, iter: TreeIter, path: TreePath) -> None

do_row_expanded¶

def do_row_expanded(self, iter: TreeIter, path: TreePath) -> None

do_select_all¶

def do_select_all(self) -> bool

do_select_cursor_parent¶

def do_select_cursor_parent(self) -> bool

do_select_cursor_row¶

def do_select_cursor_row(self, start_editing: bool) -> bool

do_start_interactive_search¶

def do_start_interactive_search(self) -> bool

do_test_collapse_row¶

def do_test_collapse_row(self, iter: TreeIter, path: TreePath) -> bool

do_test_expand_row¶

def do_test_expand_row(self, iter: TreeIter, path: TreePath) -> bool

do_toggle_cursor_row¶

def do_toggle_cursor_row(self) -> bool

do_unselect_all¶

def do_unselect_all(self) -> bool

Properties¶

activate_on_single_click¶

activate_on_single_click: bool  # read/write

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

enable_grid_lines¶

enable_grid_lines: TreeViewGridLines | int  # read/write

enable_search¶

enable_search: bool  # read/write

enable_tree_lines¶

enable_tree_lines: bool  # read/write

expander_column¶

expander_column: TreeViewColumn  # read/write

fixed_height_mode¶

fixed_height_mode: bool  # read/write

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 TreeView.set_fixed_height_mode for more information on this option.

headers_clickable¶

headers_clickable: bool  # read/write

headers_visible¶

headers_visible: bool  # read/write

hover_expand¶

hover_expand: bool  # read/write

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.

hover_selection¶

hover_selection: bool  # read/write

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

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

level_indentation¶

level_indentation: int  # read/write

Extra indentation for each level.

model¶

model: TreeModel  # read/write

reorderable¶

reorderable: bool  # read/write

rubber_banding¶

rubber_banding: bool  # read/write

search_column¶

search_column: int  # read/write

show_expanders¶

show_expanders: bool  # read/write

True if the view has expanders.

tooltip_column: int  # read/write

Signals¶

columns-changed¶

def on_columns_changed(self) -> None: ...

The number of columns of the treeview has changed.

cursor-changed¶

def on_cursor_changed(self) -> None: ...

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

expand-collapse-cursor-row¶

def on_expand_collapse_cursor_row(self, object: bool, p0: bool, p1: bool) -> bool: ...

move-cursor¶

def on_move_cursor(self, step: MovementStep, direction: int, extend: bool, modify: bool) -> bool: ...

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

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

row-activated¶

def on_row_activated(self, path: TreePath, column: TreeViewColumn | None) -> None: ...

The "row-activated" signal is emitted when the method TreeView.row_activated is called.

This signal is emitted when the user double-clicks a treeview row with the TreeView.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: <kbd>Space</kbd>, <kbd>Shift</kbd>+<kbd>Space</kbd>, <kbd>Return</kbd> or <kbd>Enter</kbd> is pressed.

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

row-collapsed¶

def on_row_collapsed(self, iter: TreeIter, path: TreePath) -> None: ...

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

row-expanded¶

def on_row_expanded(self, iter: TreeIter, path: TreePath) -> None: ...

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

select-all¶

def on_select_all(self) -> bool: ...

select-cursor-parent¶

def on_select_cursor_parent(self) -> bool: ...

select-cursor-row¶

def on_select_cursor_row(self, object: bool) -> bool: ...

start-interactive-search¶

def on_start_interactive_search(self) -> bool: ...

test-collapse-row¶

def on_test_collapse_row(self, 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.

test-expand-row¶

def on_test_expand_row(self, 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.

toggle-cursor-row¶

def on_toggle_cursor_row(self) -> bool: ...

unselect-all¶

def on_unselect_all(self) -> bool: ...

Gtk.TreeView¶

Coordinate systems in GtkTreeView API¶

GtkTreeView as GtkBuildable¶

CSS nodes¶

Constructors¶

new¶

new_with_model¶

Methods¶

append_column¶

collapse_all¶

collapse_row¶

columns_autosize¶

convert_bin_window_to_tree_coords¶

convert_bin_window_to_widget_coords¶

convert_tree_to_bin_window_coords¶

convert_tree_to_widget_coords¶

convert_widget_to_bin_window_coords¶

convert_widget_to_tree_coords¶

create_row_drag_icon¶

enable_model_drag_dest¶

enable_model_drag_source¶

expand_all¶

expand_row¶

expand_to_path¶

get_activate_on_single_click¶

get_background_area¶

get_cell_area¶

get_column¶

get_columns¶

get_cursor¶

get_dest_row_at_pos¶

get_drag_dest_row¶

get_enable_search¶

get_enable_tree_lines¶

get_expander_column¶

get_fixed_height_mode¶

get_grid_lines¶

get_headers_clickable¶

get_headers_visible¶

get_hover_expand¶

get_hover_selection¶

get_level_indentation¶

get_model¶

get_n_columns¶

get_path_at_pos¶

get_reorderable¶

get_rubber_banding¶

get_search_column¶

get_search_entry¶

get_selection¶

get_show_expanders¶

get_tooltip_column¶

get_tooltip_context¶

get_visible_range¶

get_visible_rect¶

insert_column¶

insert_column_with_data_func¶

is_blank_at_pos¶

is_rubber_banding_active¶

map_expanded_rows¶

move_column_after¶

remove_column¶

row_activated¶

row_expanded¶

scroll_to_cell¶

scroll_to_point¶

set_activate_on_single_click¶

set_column_drag_function¶

set_cursor¶

set_cursor_on_cell¶

set_drag_dest_row¶

set_enable_search¶

set_enable_tree_lines¶

set_expander_column¶

set_fixed_height_mode¶

set_grid_lines¶

set_headers_clickable¶

set_headers_visible¶

set_hover_expand¶

set_hover_selection¶

`GtkTreeView` as `GtkBuildable`¶