<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>gtkmm 2.4: Gtk::TreeModelSort Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../index.html">Main Page</a>
<a href="group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html"> Namespaces</a>
<a href="../../tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- begin main content -->
<div id="content">
<!-- Generated by Doxygen 1.5.1 -->
<div class="nav">
<a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1TreeModelSort.html">TreeModelSort</a></div>
<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" -->Inheritance diagram for Gtk::TreeModelSort:<p><center><img src="classGtk_1_1TreeModelSort__inherit__graph.png" border="0" usemap="#Gtk_1_1TreeModelSort__inherit__map" alt="Inheritance graph"></center>
<map name="Gtk_1_1TreeModelSort__inherit__map">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Object.html" shape="rect" coords="5,161,99,188" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html" shape="rect" coords="52,84,177,110" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Interface.html" shape="rect" coords="123,161,232,188" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classsigc_1_1trackable.html" shape="rect" coords="59,6,171,33" alt="">
<area href="classGtk_1_1TreeModel.html" shape="rect" coords="89,238,204,265" alt="">
<area href="classGtk_1_1TreeSortable.html" shape="rect" coords="228,238,359,265" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classGtk_1_1TreeModelSort-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
A wrapper which makes an underlying <a class="el" href="classGtk_1_1TreeModel.html">Gtk::TreeModel</a> sortable.
<p>
The <a class="el" href="classGtk_1_1TreeModelSort.html">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">TreeModelSort</a> is not guaranteed to be stable.<p>
For instance, you might create two <a class="el" href="classGtk_1_1TreeView.html">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">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>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#485b2b2193d6a5eba854380b66c5ae37">clear_cache</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function should almost never be called. <a href="#485b2b2193d6a5eba854380b66c5ae37"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#55eb24744217b0a98a23ecdd3e825352">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="#55eb24744217b0a98a23ecdd3e825352"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#3302e796920afbe28677e5795176ade2">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="#3302e796920afbe28677e5795176ade2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#1e3a51e8748e55304f43604694bdfe86">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="#1e3a51e8748e55304f43604694bdfe86"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#3a853126043a71b6aa961b3f191de5e3">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="#3a853126043a71b6aa961b3f191de5e3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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#72bbca514e4b81e3da453c758c9c9ffd">get_model</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return value: the "child model" being sorted. <a href="#72bbca514e4b81e3da453c758c9c9ffd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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#461d21594a22ee599da259723696d2f0">get_model</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return value: the "child model" being sorted. <a href="#461d21594a22ee599da259723696d2f0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GtkTreeModelSort* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#75ae9bbd40f461c1b77d46482442f0d0">gobj</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#75ae9bbd40f461c1b77d46482442f0d0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GtkTreeModelSort* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#29ab164c823754b5a6c9a8a9dcb8d393">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#29ab164c823754b5a6c9a8a9dcb8d393"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GtkTreeModelSort* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#1702cc8e424b716604f282dab2bd00da">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="#1702cc8e424b716604f282dab2bd00da"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#39cd337bbff15cec06a4f115bddc2355">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="#39cd337bbff15cec06a4f115bddc2355"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#cbfdf9cf2b2a9fa020ef1c0baddf2b67">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="#cbfdf9cf2b2a9fa020ef1c0baddf2b67"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#ca0581609d17bbe87171d5635e415a43">~TreeModelSort</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1TreeModelSort.html">TreeModelSort</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#935e3e841454ca8f5356a89939c78b39">create</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#07c28af5bc27e1548449b71c130c26f0">set_value_impl</a> (const <a class="el" href="classGtk_1_1TreeIter.html">iterator</a>& row, int column, const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ValueBase.html">Glib::ValueBase</a>& value)</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">TreeModel</a> class, so that Row::operator() and Row::set_value() work. <a href="#07c28af5bc27e1548449b71c130c26f0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelSort.html#0ea72bb50b9191a2d5f96aace894c034">TreeModelSort</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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#a305e93baaa6d6067930b3e9381e841a">wrap</a> (GtkTreeModelSort* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a305e93baaa6d6067930b3e9381e841a"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ca0581609d17bbe87171d5635e415a43"></a><!-- doxytag: member="Gtk::TreeModelSort::~TreeModelSort" ref="ca0581609d17bbe87171d5635e415a43" 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 width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0ea72bb50b9191a2d5f96aace894c034"></a><!-- doxytag: member="Gtk::TreeModelSort::TreeModelSort" ref="0ea72bb50b9191a2d5f96aace894c034" 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" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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 width="100%"><code> [explicit, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="485b2b2193d6a5eba854380b66c5ae37"></a><!-- doxytag: member="Gtk::TreeModelSort::clear_cache" ref="485b2b2193d6a5eba854380b66c5ae37" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function should almost never be called.
<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.
</div>
</div><p>
<a class="anchor" name="55eb24744217b0a98a23ecdd3e825352"></a><!-- doxytag: member="Gtk::TreeModelSort::convert_child_iter_to_iter" ref="55eb24744217b0a98a23ecdd3e825352" 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 width="100%"> 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 compact><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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A valid iterator that points to the row in this sorted model. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3302e796920afbe28677e5795176ade2"></a><!-- doxytag: member="Gtk::TreeModelSort::convert_child_path_to_path" ref="3302e796920afbe28677e5795176ade2" 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 width="100%"> 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>
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. <dl compact><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">Gtk::TreePath</a> to convert. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A newly allocated <a class="el" href="classGtk_1_1TreePath.html">Gtk::TreePath</a>, or <code>0</code>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="1e3a51e8748e55304f43604694bdfe86"></a><!-- doxytag: member="Gtk::TreeModelSort::convert_iter_to_child_iter" ref="1e3a51e8748e55304f43604694bdfe86" 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 width="100%"> 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 compact><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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A valid iterator that points to the row in the child model. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3a853126043a71b6aa961b3f191de5e3"></a><!-- doxytag: member="Gtk::TreeModelSort::convert_path_to_child_path" ref="3a853126043a71b6aa961b3f191de5e3" 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 width="100%"> 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>
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. <dl compact><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">Gtk::TreePath</a> to convert. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A newly allocated <a class="el" href="classGtk_1_1TreePath.html">Gtk::TreePath</a>, or <code>0</code>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="935e3e841454ca8f5356a89939c78b39"></a><!-- doxytag: member="Gtk::TreeModelSort::create" ref="935e3e841454ca8f5356a89939c78b39" args="(const Glib::RefPtr< TreeModel > &model)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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 width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="72bbca514e4b81e3da453c758c9c9ffd"></a><!-- doxytag: member="Gtk::TreeModelSort::get_model" ref="72bbca514e4b81e3da453c758c9c9ffd" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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 width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return value: the "child model" being sorted.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The "child model" being sorted. </dd></dl>
</div>
</div><p>
<a class="anchor" name="461d21594a22ee599da259723696d2f0"></a><!-- doxytag: member="Gtk::TreeModelSort::get_model" ref="461d21594a22ee599da259723696d2f0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return value: the "child model" being sorted.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The "child model" being sorted. </dd></dl>
</div>
</div><p>
<a class="anchor" name="75ae9bbd40f461c1b77d46482442f0d0"></a><!-- doxytag: member="Gtk::TreeModelSort::gobj" ref="75ae9bbd40f461c1b77d46482442f0d0" 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 width="100%"> 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#a079daabf7bce79b25482f4c97f77bff">Gtk::TreeModel</a>.
</div>
</div><p>
<a class="anchor" name="29ab164c823754b5a6c9a8a9dcb8d393"></a><!-- doxytag: member="Gtk::TreeModelSort::gobj" ref="29ab164c823754b5a6c9a8a9dcb8d393" 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 width="100%"><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#190c8fd4588b844696e36e5c12966b4b">Gtk::TreeModel</a>.
</div>
</div><p>
<a class="anchor" name="1702cc8e424b716604f282dab2bd00da"></a><!-- doxytag: member="Gtk::TreeModelSort::gobj_copy" ref="1702cc8e424b716604f282dab2bd00da" 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 width="100%"></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><p>
<a class="anchor" name="39cd337bbff15cec06a4f115bddc2355"></a><!-- doxytag: member="Gtk::TreeModelSort::iter_is_valid" ref="39cd337bbff15cec06a4f115bddc2355" 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 width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<warning> This function is slow.
<p>
Only use it for debugging and/or testing purposes. </warning><p>
Checks if the given iter is a valid iter for this <a class="el" href="classGtk_1_1TreeModelSort.html">Gtk::TreeModelSort</a>. <dl compact><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">Gtk::TreeIter</a>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if the iter is valid, <code>false</code> if the iter is invalid.</dd></dl>
<dl compact><dt><b><a class="el" href="newin2p2s.html#_newin2p2s000105">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
<p>
Reimplemented from <a class="el" href="classGtk_1_1TreeModel.html#a5c6526633d0fa8a78fd3d14d1fbd6cf">Gtk::TreeModel</a>.
</div>
</div><p>
<a class="anchor" name="cbfdf9cf2b2a9fa020ef1c0baddf2b67"></a><!-- doxytag: member="Gtk::TreeModelSort::reset_default_sort_func" ref="cbfdf9cf2b2a9fa020ef1c0baddf2b67" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This resets the default sort function to be in the 'unsorted' state.
<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">Gtk::TreeModelSort</a> is in 'unsorted' state.
</div>
</div><p>
<a class="anchor" name="07c28af5bc27e1548449b71c130c26f0"></a><!-- doxytag: member="Gtk::TreeModelSort::set_value_impl" ref="07c28af5bc27e1548449b71c130c26f0" 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" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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 width="100%"><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">TreeModel</a> class, so that Row::operator() and Row::set_value() work.
<p>
You can probably just implement this by calling set_value_vfunc(). Your implementation of <a class="el" href="classGtk_1_1TreeModelSort.html#07c28af5bc27e1548449b71c130c26f0">set_value_impl()</a> should also call set_row_changed() after changing the value.
<p>
Reimplemented from <a class="el" href="classGtk_1_1TreeModel.html#26cf070eadb8e242bcf2b57f7e6d7d9e">Gtk::TreeModel</a>.
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="a305e93baaa6d6067930b3e9381e841a"></a><!-- doxytag: member="Gtk::TreeModelSort::wrap" ref="a305e93baaa6d6067930b3e9381e841a" args="(GtkTreeModelSort *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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 width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.
<p>
<dl compact><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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="treemodelsort_8h.html">treemodelsort.h</a></ul>
</div>
<!-- end main content -->
<hr><address><small>
Generated for gtkmm 2.4 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.1 © 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
9411cff4bc6d4e61b29ae81cd24665af
>
files
>
792
