TreeModelSort

Deprecated since version 4.10: Use SortListModel instead

class TreeModelSort(**properties: Any)

Superclasses: Object

Implemented Interfaces: TreeDragSource, TreeModel, TreeSortable

Constructors:

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

Constructors

class TreeModelSort

classmethod new_with_model(child_model: TreeModel) → TreeModelSort

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

Parameters:: child_model – A GtkTreeModel

Methods

class TreeModelSort

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

Deprecated since version 4.10: Please do not use it in newly written code

convert_child_iter_to_iter(child_iter: TreeIter) → tuple[bool, TreeIter]

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

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:: child_iter – A valid GtkTreeIter pointing to a row on the child model

convert_child_path_to_path(child_path: TreePath) → TreePath | None

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

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:: child_path – A GtkTreePath to convert

convert_iter_to_child_iter(sorted_iter: TreeIter) → TreeIter

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

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:: sorted_iter – A valid GtkTreeIter pointing to a row on tree_model_sort.

convert_path_to_child_path(sorted_path: TreePath) → TreePath | None

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

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:: sorted_path – A GtkTreePath to convert

get_model() → TreeModel: Returns the model the GtkTreeModelSort is sorting.

iter_is_valid(iter: TreeIter) → bool

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

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

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:: iter – A GtkTreeIter

reset_default_sort_func() → None: This resets the default sort function to be in the “unsorted” state. That is, it is in the same order as the child model. It will re-sort the model to be in the same order as the child model only if the GtkTreeModelSort is in “unsorted” state.

Deprecated since version 4.10: Please do not use it in newly written code

Properties

class TreeModelSort

props.model: TreeModel

Fields

class TreeModelSort

parent

priv

TreeModelSort