<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - Class GtkTreeModelSort</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GtkTreeModelFilter.html">Previous: Class GtkTreeModelFilter</a></li>
<li class="next"><a href="gtk_GtkTreePath.html">Next: Class GtkTreePath</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">10.132</span>Class GtkTreeModelSort</h1><p class="brief">A GtkTreeModel which makes an underlying tree model sortable </p>
<pre class="prototype">Class GtkTreeModelSort( child_model )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">child_model</td><td class="content"> A GtkTreeModel </td></tr>
</tbody>
</table>
<p>The GtkTreeModelSort is a model which implements the GtkTreeSortable interface. It does not hold any data itself, but rather is created with a child model and proxies its data. It has identical column types to this child model, and the changes in the child are propagated. The primary purpose of this model is to provide a way to sort a different model without modifying it. Note that the sort function used by GtkTreeModelSort is not guaranteed to be stable. </p>
<p>[...] </p>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</td></tr>
<tr><td><a href="#clear_cache">clear_cache</a></td><td>This function should almost never be called. </td></tr>
<tr><td><a href="#convert_child_iter_to_iter">convert_child_iter_to_iter</a></td><td>Returns an iterator pointing to the row in tree_model_sort that corresponds to the row pointed at by child_iter. </td></tr>
<tr><td><a href="#convert_child_path_to_path">convert_child_path_to_path</a></td><td>Converts child_path to a path relative to the tree-model-sort. </td></tr>
<tr><td><a href="#convert_iter_to_child_iter">convert_iter_to_child_iter</a></td><td>Returns an iterator pointing to the row pointed to by sorted_iter. </td></tr>
<tr><td><a href="#convert_path_to_child_path">convert_path_to_child_path</a></td><td>Converts sorted_path to a path on the child model of tree_model_sort. </td></tr>
<tr><td><a href="#get_model">get_model</a></td><td>Returns the model the GtkTreeModelSort is sorting. </td></tr>
<tr><td><a href="#iter_is_valid">iter_is_valid</a></td><td>Checks if the given iter is a valid iter for this GtkTreeModelSort. </td></tr>
<tr><td><a href="#reset_default_sort_func">reset_default_sort_func</a></td><td>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. </td></tr>
</tbody>
</table>
<h2>Methods</h2><h3><a name="clear_cache">clear_cache</a></h3><p class="brief">This function should almost never be called. </p>
<pre class="prototype">GtkTreeModelSort.clear_cache()</pre>
<p>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. </p>
<h3><a name="convert_child_iter_to_iter">convert_child_iter_to_iter</a></h3><p class="brief">Returns an iterator pointing to the row in tree_model_sort that corresponds to the row pointed at by child_iter. </p>
<pre class="prototype">GtkTreeModelSort.convert_child_iter_to_iter( child_iter )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">child_iter</td><td class="content"> A valid GtkTreeIter pointing to a row on the child model </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">a valid GtkTreeIter to a visible row in the child model, or Nil </td></tr>
</tbody>
</table>
<h3><a name="convert_child_path_to_path">convert_child_path_to_path</a></h3><p class="brief">Converts child_path to a path relative to the tree-model-sort. </p>
<pre class="prototype">GtkTreeModelSort.convert_child_path_to_path( child_path )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">child_path</td><td class="content"> A GtkTreePath to convert </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">A newly allocated GtkTreePath, or NULL </td></tr>
</tbody>
</table>
<p>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 NULL is returned. </p>
<h3><a name="convert_iter_to_child_iter">convert_iter_to_child_iter</a></h3><p class="brief">Returns an iterator pointing to the row pointed to by sorted_iter. </p>
<pre class="prototype">GtkTreeModelSort.convert_iter_to_child_iter( sorted_iter )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">sorted_iter</td><td class="content"> A valid GtkTreeIter pointing to a row on tree_model_sort. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">a GtkTreeIter </td></tr>
</tbody>
</table>
<h3><a name="convert_path_to_child_path">convert_path_to_child_path</a></h3><p class="brief">Converts sorted_path to a path on the child model of tree_model_sort. </p>
<pre class="prototype">GtkTreeModelSort.convert_path_to_child_path( sorted_path )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">sorted_path</td><td class="content"> A GtkTreePath to convert </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">A GtkTreePath, or NULL </td></tr>
</tbody>
</table>
<p>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, NULL is returned. </p>
<h3><a name="get_model">get_model</a></h3><p class="brief">Returns the model the GtkTreeModelSort is sorting. </p>
<pre class="prototype">GtkTreeModelSort.get_model()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">the "child model" being sorted (GtkTreeModel). </td></tr>
</tbody>
</table>
<h3><a name="iter_is_valid">iter_is_valid</a></h3><p class="brief">Checks if the given iter is a valid iter for this GtkTreeModelSort. </p>
<pre class="prototype">GtkTreeModelSort.iter_is_valid( iter )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">iter</td><td class="content"> A GtkTreeIter. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">TRUE if the iter is valid, FALSE if the iter is invalid. </td></tr>
</tbody>
</table>
<p>Warning: This function is slow. Only use it for debugging and/or testing purposes. </p>
<h3><a name="reset_default_sort_func">reset_default_sort_func</a></h3><p class="brief">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. </p>
<pre class="prototype">GtkTreeModelSort.reset_default_sort_func()</pre>
</div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GtkTreeModelFilter.html">Previous: Class GtkTreeModelFilter</a></li>
<li class="next"><a href="gtk_GtkTreePath.html">Next: Class GtkTreePath</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
