<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>gtkmm: Gtk::TreeModelSort Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1TreeModelSort.html">TreeModelSort</a>
</div>
</div>
<div class="contents">
<h1>Gtk::TreeModelSort Class Reference<br/>
<small>
[<a class="el" href="group__TreeView.html">TreeView Classes</a>]</small>
</h1><!-- doxytag: class="Gtk::TreeModelSort" --><!-- doxytag: inherits="Glib::Object,Gtk::TreeModel,Gtk::TreeSortable" -->
<p>A wrapper which makes an underlying <a class="el" href="classGtk_1_1TreeModel.html" title="This class defines a generic tree interface for use by the Gtk::TreeView widget.">Gtk::TreeModel</a> sortable. <a href="#_details">More...</a></p>
<p>Inherits <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html">Glib::Object</a>, <a class="el" href="classGtk_1_1TreeModel.html">Gtk::TreeModel</a>, and <a class="el" href="classGtk_1_1TreeSortable.html">Gtk::TreeSortable</a>.</p>
<div class="dynheader">
Collaboration diagram for Gtk::TreeModelSort:</div>
<div class="dynsection">
<div class="center"><img src="classGtk_1_1TreeModelSort__coll__graph.png" border="0" usemap="#Gtk_1_1TreeModelSort_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1TreeModelSort_coll__map" id="Gtk_1_1TreeModelSort_coll__map">
<area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="5,160,96,189"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="51,83,171,112"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="120,160,224,189"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="57,5,164,35"/><area shape="rect" href="classGtk_1_1TreeModel.html" title="This class defines a generic tree interface for use by the Gtk::TreeView widget." alt="" coords="88,237,197,267"/><area shape="rect" href="classGtk_1_1TreeSortable.html" title="Gtk::TreeSortable" alt="" coords="221,237,344,267"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGtk_1_1TreeModelSort-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#aca0581609d17bbe87171d5635e415a43">~TreeModelSort</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkTreeModelSort* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#a29ab164c823754b5a6c9a8a9dcb8d393">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a29ab164c823754b5a6c9a8a9dcb8d393"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkTreeModelSort* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#a46201ea3130b92a85b2cf8d839f59659">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a46201ea3130b92a85b2cf8d839f59659"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkTreeModelSort* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#a1702cc8e424b716604f282dab2bd00da">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#a1702cc8e424b716604f282dab2bd00da"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TreeModel.html">TreeModel</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#a461d21594a22ee599da259723696d2f0">get_model</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the model the <a class="el" href="classGtk_1_1TreeModelSort.html" title="A wrapper which makes an underlying Gtk::TreeModel sortable.">Gtk::TreeModelSort</a> is sorting. <a href="#a461d21594a22ee599da259723696d2f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGtk_1_1TreeModel.html">TreeModel</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#a908baf50265d85dedf1c0dd075bfdfc8">get_model</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the model the <a class="el" href="classGtk_1_1TreeModelSort.html" title="A wrapper which makes an underlying Gtk::TreeModel sortable.">Gtk::TreeModelSort</a> is sorting. <a href="#a908baf50265d85dedf1c0dd075bfdfc8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1TreePath.html">Path</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#ac60f6b4459fe01569b07898354df2ae6">convert_child_path_to_path</a> (const <a class="el" href="classGtk_1_1TreePath.html">Path</a>& child_path) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts <em>child_path</em> to a path relative to <em>tree_model_sort</em>. <a href="#ac60f6b4459fe01569b07898354df2ae6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1TreeIter.html">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#a7548e9e7e93d39e0cd25bfd8a6cc4cd2">convert_child_iter_to_iter</a> (const <a class="el" href="classGtk_1_1TreeIter.html">iterator</a>& child_iter) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets an iterator that points to the sorted row that corresponds to the child row pointed at by child_iter. <a href="#a7548e9e7e93d39e0cd25bfd8a6cc4cd2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1TreePath.html">Path</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#aef6eb67a15f93d03de184389048cb8bd">convert_path_to_child_path</a> (const <a class="el" href="classGtk_1_1TreePath.html">Path</a>& sorted_path) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts <em>sorted_path</em> to a path on the child model of <em>tree_model_sort</em>. <a href="#aef6eb67a15f93d03de184389048cb8bd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1TreeIter.html">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#a81aff697f035af5000c08f47cb7dfd38">convert_iter_to_child_iter</a> (const <a class="el" href="classGtk_1_1TreeIter.html">iterator</a>& sorted_iter) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets an iterator that points to the child row that corresponds to the sorted row pointed at by sorted_iter. <a href="#a81aff697f035af5000c08f47cb7dfd38"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#acbfdf9cf2b2a9fa020ef1c0baddf2b67">reset_default_sort_func</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This resets the default sort function to be in the 'unsorted' state. <a href="#acbfdf9cf2b2a9fa020ef1c0baddf2b67"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#a485b2b2193d6a5eba854380b66c5ae37">clear_cache</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function should almost never be called. <a href="#a485b2b2193d6a5eba854380b66c5ae37"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#a39cd337bbff15cec06a4f115bddc2355">iter_is_valid</a> (const <a class="el" href="classGtk_1_1TreeIter.html">iterator</a>& iter) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><warning>This function is slow. <a href="#a39cd337bbff15cec06a4f115bddc2355"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
< <a class="el" href="classGtk_1_1TreeModelSort.html">TreeModelSort</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#a935e3e841454ca8f5356a89939c78b39">create</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TreeModel.html">TreeModel</a> >& model)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#a0ea72bb50b9191a2d5f96aace894c034">TreeModelSort</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TreeModel.html">TreeModel</a> >& model)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#a07c28af5bc27e1548449b71c130c26f0">set_value_impl</a> (const <a class="el" href="classGtk_1_1TreeIter.html">iterator</a>& row, int column, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ValueBase.html">Glib::ValueBase</a>&<a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01156.html#ga1c9e781d8d15a3814a601f471797c825">value</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Override and implement this in a derived <a class="el" href="classGtk_1_1TreeModel.html" title="This class defines a generic tree interface for use by the Gtk::TreeView widget.">TreeModel</a> class, so that Row::operator() and <a class="el" href="classGtk_1_1TreeRow.html#ae25785fc6de538f6dd632bb434a5f2ff" title="Sets the value of this column of this row.">Row::set_value()</a> work. <a href="#a07c28af5bc27e1548449b71c130c26f0"></a><br/></td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TreeModelSort.html">Gtk::TreeModelSort</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#aa305e93baaa6d6067930b3e9381e841a">wrap</a> (GtkTreeModelSort* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#aa305e93baaa6d6067930b3e9381e841a"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A wrapper which makes an underlying <a class="el" href="classGtk_1_1TreeModel.html" title="This class defines a generic tree interface for use by the Gtk::TreeView widget.">Gtk::TreeModel</a> sortable. </p>
<p>The <a class="el" href="classGtk_1_1TreeModelSort.html" title="A wrapper which makes an underlying Gtk::TreeModel sortable.">TreeModelSort</a> is a model which implements the <a class="el" href="classGtk_1_1TreeSortable.html">TreeSortable</a> 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 <a class="el" href="classGtk_1_1TreeModelSort.html" title="A wrapper which makes an underlying Gtk::TreeModel sortable.">TreeModelSort</a> is not guaranteed to be stable.</p>
<p>For instance, you might create two <a class="el" href="classGtk_1_1TreeView.html" title="The TreeView widget displays the model (Gtk::TreeModel) data and allows the user...">TreeView</a> widgets each with a view of the same data. If the model is wrapped by a <a class="el" href="classGtk_1_1TreeModelSort.html" title="A wrapper which makes an underlying Gtk::TreeModel sortable.">TreeModelSort</a> then the two TreeViews can each sort their view of the data without affecting the other. By contrast, if we simply put the same model in each widget, then sorting the first would sort the second. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aca0581609d17bbe87171d5635e415a43"></a><!-- doxytag: member="Gtk::TreeModelSort::~TreeModelSort" ref="aca0581609d17bbe87171d5635e415a43" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gtk::TreeModelSort::~TreeModelSort </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0ea72bb50b9191a2d5f96aace894c034"></a><!-- doxytag: member="Gtk::TreeModelSort::TreeModelSort" ref="a0ea72bb50b9191a2d5f96aace894c034" args="(const Glib::RefPtr< TreeModel > &model)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::TreeModelSort::TreeModelSort </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TreeModel.html">TreeModel</a> >& </td>
<td class="paramname"> <em>model</em></td>
<td> ) </td>
<td><code> [explicit, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a485b2b2193d6a5eba854380b66c5ae37"></a><!-- doxytag: member="Gtk::TreeModelSort::clear_cache" ref="a485b2b2193d6a5eba854380b66c5ae37" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::TreeModelSort::clear_cache </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function should almost never be called. </p>
<p>It clears the <em>tree_model_sort</em> 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. </p>
</div>
</div>
<a class="anchor" id="a7548e9e7e93d39e0cd25bfd8a6cc4cd2"></a><!-- doxytag: member="Gtk::TreeModelSort::convert_child_iter_to_iter" ref="a7548e9e7e93d39e0cd25bfd8a6cc4cd2" args="(const iterator &child_iter) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1TreeIter.html">iterator</a> Gtk::TreeModelSort::convert_child_iter_to_iter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1TreeIter.html">iterator</a>& </td>
<td class="paramname"> <em>child_iter</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets an iterator that points to the sorted row that corresponds to the child row pointed at by child_iter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>child_iter</em> </td><td>A valid iterator pointing to a row on the child model. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A valid iterator that points to the row in this sorted model. </dd></dl>
</div>
</div>
<a class="anchor" id="ac60f6b4459fe01569b07898354df2ae6"></a><!-- doxytag: member="Gtk::TreeModelSort::convert_child_path_to_path" ref="ac60f6b4459fe01569b07898354df2ae6" args="(const Path &child_path) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1TreePath.html">Path</a> Gtk::TreeModelSort::convert_child_path_to_path </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1TreePath.html">Path</a>& </td>
<td class="paramname"> <em>child_path</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Converts <em>child_path</em> to a path relative to <em>tree_model_sort</em>. </p>
<p>That is, <em>child_path</em> points to a path in the child model. The returned path will point to the same row in the sorted model. If <em>child_path</em> isn't a valid path on the child model, then <code>0</code> is returned. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>child_path</em> </td><td>A <a class="el" href="classGtk_1_1TreePath.html" title="A path is essentially a potential node.">Gtk::TreePath</a> to convert. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly allocated <a class="el" href="classGtk_1_1TreePath.html" title="A path is essentially a potential node.">Gtk::TreePath</a>, or <code>0</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a81aff697f035af5000c08f47cb7dfd38"></a><!-- doxytag: member="Gtk::TreeModelSort::convert_iter_to_child_iter" ref="a81aff697f035af5000c08f47cb7dfd38" args="(const iterator &sorted_iter) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1TreeIter.html">iterator</a> Gtk::TreeModelSort::convert_iter_to_child_iter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1TreeIter.html">iterator</a>& </td>
<td class="paramname"> <em>sorted_iter</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets an iterator that points to the child row that corresponds to the sorted row pointed at by sorted_iter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sorted_iter</em> </td><td>A valid iterator pointing to a row on the sorted model. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A valid iterator that points to the row in the child model. </dd></dl>
</div>
</div>
<a class="anchor" id="aef6eb67a15f93d03de184389048cb8bd"></a><!-- doxytag: member="Gtk::TreeModelSort::convert_path_to_child_path" ref="aef6eb67a15f93d03de184389048cb8bd" args="(const Path &sorted_path) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1TreePath.html">Path</a> Gtk::TreeModelSort::convert_path_to_child_path </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1TreePath.html">Path</a>& </td>
<td class="paramname"> <em>sorted_path</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Converts <em>sorted_path</em> to a path on the child model of <em>tree_model_sort</em>. </p>
<p>That is, <em>sorted_path</em> points to a location in <em>tree_model_sort</em>. The returned path will point to the same location in the model not being sorted. If <em>sorted_path</em> does not point to a location in the child model, <code>0</code> is returned. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sorted_path</em> </td><td>A <a class="el" href="classGtk_1_1TreePath.html" title="A path is essentially a potential node.">Gtk::TreePath</a> to convert. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly allocated <a class="el" href="classGtk_1_1TreePath.html" title="A path is essentially a potential node.">Gtk::TreePath</a>, or <code>0</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a935e3e841454ca8f5356a89939c78b39"></a><!-- doxytag: member="Gtk::TreeModelSort::create" ref="a935e3e841454ca8f5356a89939c78b39" args="(const Glib::RefPtr< TreeModel > &model)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1TreeModelSort.html">TreeModelSort</a>> Gtk::TreeModelSort::create </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TreeModel.html">TreeModel</a> >& </td>
<td class="paramname"> <em>model</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a908baf50265d85dedf1c0dd075bfdfc8"></a><!-- doxytag: member="Gtk::TreeModelSort::get_model" ref="a908baf50265d85dedf1c0dd075bfdfc8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGtk_1_1TreeModel.html">TreeModel</a>> Gtk::TreeModelSort::get_model </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the model the <a class="el" href="classGtk_1_1TreeModelSort.html" title="A wrapper which makes an underlying Gtk::TreeModel sortable.">Gtk::TreeModelSort</a> is sorting. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The "child model" being sorted. </dd></dl>
</div>
</div>
<a class="anchor" id="a461d21594a22ee599da259723696d2f0"></a><!-- doxytag: member="Gtk::TreeModelSort::get_model" ref="a461d21594a22ee599da259723696d2f0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1TreeModel.html">TreeModel</a>> Gtk::TreeModelSort::get_model </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the model the <a class="el" href="classGtk_1_1TreeModelSort.html" title="A wrapper which makes an underlying Gtk::TreeModel sortable.">Gtk::TreeModelSort</a> is sorting. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The "child model" being sorted. </dd></dl>
</div>
</div>
<a class="anchor" id="a46201ea3130b92a85b2cf8d839f59659"></a><!-- doxytag: member="Gtk::TreeModelSort::gobj" ref="a46201ea3130b92a85b2cf8d839f59659" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkTreeModelSort* Gtk::TreeModelSort::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1TreeModel.html#ae6a7c63aca59b5904beef977753558c2">Gtk::TreeModel</a>.</p>
</div>
</div>
<a class="anchor" id="a29ab164c823754b5a6c9a8a9dcb8d393"></a><!-- doxytag: member="Gtk::TreeModelSort::gobj" ref="a29ab164c823754b5a6c9a8a9dcb8d393" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkTreeModelSort* Gtk::TreeModelSort::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1TreeModel.html#a190c8fd4588b844696e36e5c12966b4b">Gtk::TreeModel</a>.</p>
</div>
</div>
<a class="anchor" id="a1702cc8e424b716604f282dab2bd00da"></a><!-- doxytag: member="Gtk::TreeModelSort::gobj_copy" ref="a1702cc8e424b716604f282dab2bd00da" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkTreeModelSort* Gtk::TreeModelSort::gobj_copy </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>
</div>
</div>
<a class="anchor" id="a39cd337bbff15cec06a4f115bddc2355"></a><!-- doxytag: member="Gtk::TreeModelSort::iter_is_valid" ref="a39cd337bbff15cec06a4f115bddc2355" args="(const iterator &iter) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::TreeModelSort::iter_is_valid </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1TreeIter.html">iterator</a>& </td>
<td class="paramname"> <em>iter</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><warning>This function is slow. </p>
<p>Only use it for debugging and/or testing purposes. </p>
<p></warning></p>
<p>Checks if the given iter is a valid iter for this <a class="el" href="classGtk_1_1TreeModelSort.html" title="A wrapper which makes an underlying Gtk::TreeModel sortable.">Gtk::TreeModelSort</a>.</p>
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000105">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>iter</em> </td><td>A <a class="el" href="classGtk_1_1TreeIter.html" title="A Gtk::TreeModel::iterator is a reference to a specific node on a specific model...">Gtk::TreeIter</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the iter is valid, <code>false</code> if the iter is invalid. </dd></dl>
<p>Reimplemented from <a class="el" href="classGtk_1_1TreeModel.html#aa5c6526633d0fa8a78fd3d14d1fbd6cf">Gtk::TreeModel</a>.</p>
</div>
</div>
<a class="anchor" id="acbfdf9cf2b2a9fa020ef1c0baddf2b67"></a><!-- doxytag: member="Gtk::TreeModelSort::reset_default_sort_func" ref="acbfdf9cf2b2a9fa020ef1c0baddf2b67" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::TreeModelSort::reset_default_sort_func </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This resets the default sort function to be in the 'unsorted' state. </p>
<p>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 <a class="el" href="classGtk_1_1TreeModelSort.html" title="A wrapper which makes an underlying Gtk::TreeModel sortable.">Gtk::TreeModelSort</a> is in 'unsorted' state. </p>
</div>
</div>
<a class="anchor" id="a07c28af5bc27e1548449b71c130c26f0"></a><!-- doxytag: member="Gtk::TreeModelSort::set_value_impl" ref="a07c28af5bc27e1548449b71c130c26f0" args="(const iterator &row, int column, const Glib::ValueBase &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gtk::TreeModelSort::set_value_impl </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1TreeIter.html">iterator</a>& </td>
<td class="paramname"> <em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ValueBase.html">Glib::ValueBase</a> & </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Override and implement this in a derived <a class="el" href="classGtk_1_1TreeModel.html" title="This class defines a generic tree interface for use by the Gtk::TreeView widget.">TreeModel</a> class, so that Row::operator() and <a class="el" href="classGtk_1_1TreeRow.html#ae25785fc6de538f6dd632bb434a5f2ff" title="Sets the value of this column of this row.">Row::set_value()</a> work. </p>
<p>You can probably just implement this by calling set_value_vfunc(). Your implementation of <a class="el" href="classGtk_1_1TreeModelSort.html#a07c28af5bc27e1548449b71c130c26f0" title="Override and implement this in a derived TreeModel class, so that Row::operator()...">set_value_impl()</a> should also call <a class="el" href="classGtk_1_1TreeModel.html#a8f06ebb80f930bb780eab62aac748df2" title="Emits the "row-changed" signal on tree_model.">row_changed()</a> after changing the value. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1TreeModel.html#a26cf070eadb8e242bcf2b57f7e6d7d9e">Gtk::TreeModel</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="aa305e93baaa6d6067930b3e9381e841a"></a><!-- doxytag: member="Gtk::TreeModelSort::wrap" ref="aa305e93baaa6d6067930b3e9381e841a" args="(GtkTreeModelSort *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TreeModelSort.html">Gtk::TreeModelSort</a> > wrap </td>
<td>(</td>
<td class="paramtype">GtkTreeModelSort * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gtkmm/treemodelsort.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:22:06 2010 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
22e237efd6851989a23adf3360bb53d0
>
files
>
781
