Class: Gtk::TreeModelSort

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Instance Method Summary collapse

Instance Method Details

#clear_cachenil

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.

Returns:

  • (nil)

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

Parameters:

  • sort_iter (Gtk::TreeIter)

    An uninitialized Gtk::TreeIter.

  • child_iter (Gtk::TreeIter)

    A valid Gtk::TreeIter pointing to a row on the child model

Returns:

  • (TrueClass)

    true, if sort_iter was set, i.e. if sort_iter is a

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

Parameters:

  • child_path (Gtk::TreePath)

    A Gtk::TreePath to convert

Returns:

  • (Gtk::TreePath)

    A newly allocated Gtk::TreePath, or nil

#convert_iter_to_child_iter(child_iter, sorted_iter) ⇒ nil

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

Parameters:

  • child_iter (Gtk::TreeIter)

    An uninitialized Gtk::TreeIter

  • sorted_iter (Gtk::TreeIter)

    A valid Gtk::TreeIter pointing to a row on tree_model_sort.

Returns:

  • (nil)

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

Parameters:

  • sorted_path (Gtk::TreePath)

    A Gtk::TreePath to convert

Returns:

  • (Gtk::TreePath)

    A newly allocated Gtk::TreePath, or nil

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

Parameters:

  • iter (Gtk::TreeIter)

    A Gtk::TreeIter.

Returns:

  • (TrueClass)

    true if the iter is valid, false if the iter is invalid.

#modelGtk::TreeModel

Returns model.

Returns:

#model=(model) ⇒ Gtk::TreeModel

Parameters:

Returns:

#new_with_model(child_model) ⇒ Gtk::TreeModelSort

Creates a new Gtk::TreeModelSort, with child_model as the child model.

Parameters:

Returns:

#reset_default_sort_funcnil

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.

Returns:

  • (nil)