Class: Gtk::TreeModelSort
- Inherits:
-
Object
- Object
- Gtk::TreeModelSort
- Defined in:
- (unknown)
Instance Method Summary collapse
-
#clear_cache ⇒ nil
This function should almost never be called.
-
#convert_child_iter_to_iter(sort_iter, child_iter) ⇒ TrueClass
Sets sort_iter to point to the row in tree_model_sort that corresponds to the row pointed at by child_iter.
-
#convert_child_path_to_path(child_path) ⇒ Gtk::TreePath
Converts child_path to a path relative to tree_model_sort.
-
#convert_iter_to_child_iter(child_iter, sorted_iter) ⇒ nil
Sets child_iter to point to the row pointed to by sorted_iter.
-
#convert_path_to_child_path(sorted_path) ⇒ Gtk::TreePath
Converts sorted_path to a path on the child model of tree_model_sort.
-
#iter_is_valid(iter) ⇒ TrueClass
> This function is slow.
-
#model ⇒ Gtk::TreeModel
Model.
- #model=(model) ⇒ Gtk::TreeModel
-
#new_with_model(child_model) ⇒ Gtk::TreeModelSort
Creates a new Gtk::TreeModelSort, with child_model as the child model.
-
#reset_default_sort_func ⇒ nil
This resets the default sort function to be in the “unsorted” state.
Instance Method Details
#clear_cache ⇒ nil
This function should almost never be called. It clears the tree_model_sort of any cached iterators that haven’t been reffed with gtk_tree_model_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.
#convert_child_iter_to_iter(sort_iter, child_iter) ⇒ TrueClass
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. valid iterator pointer to a visible row in the child model.
#convert_child_path_to_path(child_path) ⇒ Gtk::TreePath
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 nil is returned.
#convert_iter_to_child_iter(child_iter, sorted_iter) ⇒ nil
Sets child_iter to point to the row pointed to by sorted_iter.
#convert_path_to_child_path(sorted_path) ⇒ Gtk::TreePath
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, nil is returned.
#iter_is_valid(iter) ⇒ TrueClass
> This function is slow. Only use it for debugging and/or testing > purposes.
Checks if the given iter is a valid iter for this Gtk::TreeModelSort.
#model ⇒ Gtk::TreeModel
Returns model.
#model=(model) ⇒ Gtk::TreeModel
#new_with_model(child_model) ⇒ Gtk::TreeModelSort
Creates a new Gtk::TreeModelSort, with child_model as the child model.
#reset_default_sort_func ⇒ nil
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 Gtk::TreeModelSort is in “unsorted” state.