⚝
One Hat Cyber Team
⚝
Your IP:
216.73.216.10
Server IP:
157.245.101.34
Server:
Linux skvinfotech-website 5.4.0-131-generic #147-Ubuntu SMP Fri Oct 14 17:07:22 UTC 2022 x86_64
Server Software:
Apache/2.4.41 (Ubuntu)
PHP Version:
7.4.33
Buat File
|
Buat Folder
Eksekusi
Dir :
~
/
proc
/
self
/
root
/
usr
/
share
/
doc
/
libgtk-3-dev
/
gtk3
/
View File Name :
GtkTreeModelSort.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>GtkTreeModelSort: GTK+ 3 Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="index.html" title="GTK+ 3 Reference Manual"> <link rel="up" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets"> <link rel="prev" href="GtkTreeSortable.html" title="GtkTreeSortable"> <link rel="next" href="GtkTreeModelFilter.html" title="GtkTreeModelFilter"> <meta name="generator" content="GTK-Doc V1.32 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> <td width="100%" align="left" class="shortcuts"> <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> <a href="#GtkTreeModelSort.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> <a href="#GtkTreeModelSort.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> <a href="#GtkTreeModelSort.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> <a href="#GtkTreeModelSort.properties" class="shortcut">Properties</a></span> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="TreeWidgetObjects.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> <td><a accesskey="p" href="GtkTreeSortable.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="GtkTreeModelFilter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="GtkTreeModelSort"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="GtkTreeModelSort.top_of_page"></a>GtkTreeModelSort</span></h2> <p>GtkTreeModelSort — A GtkTreeModel which makes an underlying tree model sortable</p> </td> <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> <a name="GtkTreeModelSort.functions"></a><h2>Functions</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="functions_proto_type"> <col class="functions_proto_name"> </colgroup> <tbody> <tr> <td class="function_type"> <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="returnvalue">GtkTreeModel</span></a> * </td> <td class="function_name"> <a class="link" href="GtkTreeModelSort.html#gtk-tree-model-sort-new-with-model" title="gtk_tree_model_sort_new_with_model ()">gtk_tree_model_sort_new_with_model</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="returnvalue">GtkTreeModel</span></a> * </td> <td class="function_name"> <a class="link" href="GtkTreeModelSort.html#gtk-tree-model-sort-get-model" title="gtk_tree_model_sort_get_model ()">gtk_tree_model_sort_get_model</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="returnvalue">GtkTreePath</span></a> * </td> <td class="function_name"> <a class="link" href="GtkTreeModelSort.html#gtk-tree-model-sort-convert-child-path-to-path" title="gtk_tree_model_sort_convert_child_path_to_path ()">gtk_tree_model_sort_convert_child_path_to_path</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="GtkTreeModelSort.html#gtk-tree-model-sort-convert-child-iter-to-iter" title="gtk_tree_model_sort_convert_child_iter_to_iter ()">gtk_tree_model_sort_convert_child_iter_to_iter</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="returnvalue">GtkTreePath</span></a> * </td> <td class="function_name"> <a class="link" href="GtkTreeModelSort.html#gtk-tree-model-sort-convert-path-to-child-path" title="gtk_tree_model_sort_convert_path_to_child_path ()">gtk_tree_model_sort_convert_path_to_child_path</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">void</span> </td> <td class="function_name"> <a class="link" href="GtkTreeModelSort.html#gtk-tree-model-sort-convert-iter-to-child-iter" title="gtk_tree_model_sort_convert_iter_to_child_iter ()">gtk_tree_model_sort_convert_iter_to_child_iter</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">void</span> </td> <td class="function_name"> <a class="link" href="GtkTreeModelSort.html#gtk-tree-model-sort-reset-default-sort-func" title="gtk_tree_model_sort_reset_default_sort_func ()">gtk_tree_model_sort_reset_default_sort_func</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">void</span> </td> <td class="function_name"> <a class="link" href="GtkTreeModelSort.html#gtk-tree-model-sort-clear-cache" title="gtk_tree_model_sort_clear_cache ()">gtk_tree_model_sort_clear_cache</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="GtkTreeModelSort.html#gtk-tree-model-sort-iter-is-valid" title="gtk_tree_model_sort_iter_is_valid ()">gtk_tree_model_sort_iter_is_valid</a> <span class="c_punctuation">()</span> </td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="GtkTreeModelSort.properties"></a><h2>Properties</h2> <div class="informaltable"><table class="informaltable" border="0"> <colgroup> <col width="150px" class="properties_type"> <col width="300px" class="properties_name"> <col width="200px" class="properties_flags"> </colgroup> <tbody><tr> <td class="property_type"> <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *</td> <td class="property_name"><a class="link" href="GtkTreeModelSort.html#GtkTreeModelSort--model" title="The “model” property">model</a></td> <td class="property_flags">Read / Write / Construct Only</td> </tr></tbody> </table></div> </div> <div class="refsect1"> <a name="GtkTreeModelSort.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="other_proto_type"> <col class="other_proto_name"> </colgroup> <tbody><tr> <td class="datatype_keyword">struct</td> <td class="function_name"><a class="link" href="GtkTreeModelSort.html#GtkTreeModelSort-struct" title="struct GtkTreeModelSort">GtkTreeModelSort</a></td> </tr></tbody> </table></div> </div> <div class="refsect1"> <a name="GtkTreeModelSort.object-hierarchy"></a><h2>Object Hierarchy</h2> <pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> <span class="lineart">╰──</span> GtkTreeModelSort </pre> </div> <div class="refsect1"> <a name="GtkTreeModelSort.implemented-interfaces"></a><h2>Implemented Interfaces</h2> <p> GtkTreeModelSort implements <a class="link" href="GtkTreeModel.html" title="GtkTreeModel">GtkTreeModel</a>, <a class="link" href="GtkTreeSortable.html" title="GtkTreeSortable">GtkTreeSortable</a> and <a class="link" href="gtk3-GtkTreeView-drag-and-drop.html#GtkTreeDragSource">GtkTreeDragSource</a>.</p> </div> <div class="refsect1"> <a name="GtkTreeModelSort.includes"></a><h2>Includes</h2> <pre class="synopsis">#include <gtk/gtk.h> </pre> </div> <div class="refsect1"> <a name="GtkTreeModelSort.description"></a><h2>Description</h2> <p>The <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> is a model which implements the <a class="link" href="GtkTreeSortable.html" title="GtkTreeSortable"><span class="type">GtkTreeSortable</span></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="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> is not guaranteed to be stable.</p> <p>The use of this is best demonstrated through an example. In the following sample code we create two <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> widgets each with a view of the same data. As the model is wrapped here by a <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a>, the two <a href="GtkTreeView.html#GtkTreeView-struct"><span class="type">GtkTreeViews</span></a> 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> <div class="refsect3"> <a name="id-1.3.12.11.9.4"></a><h4>Using a <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> </h4> <div class="informalexample"> <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="listing_lines" align="right"><pre>1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24</pre></td> <td class="listing_code"><pre class="programlisting"><span class="p">{</span> <span class="n">GtkTreeView</span> <span class="o">*</span><span class="n">tree_view1</span><span class="p">;</span> <span class="n">GtkTreeView</span> <span class="o">*</span><span class="n">tree_view2</span><span class="p">;</span> <span class="n">GtkTreeModel</span> <span class="o">*</span><span class="n">sort_model1</span><span class="p">;</span> <span class="n">GtkTreeModel</span> <span class="o">*</span><span class="n">sort_model2</span><span class="p">;</span> <span class="n">GtkTreeModel</span> <span class="o">*</span><span class="n">child_model</span><span class="p">;</span> <span class="c1">// get the child model</span> <span class="n">child_model</span> <span class="o">=</span> <span class="n">get_my_model</span> <span class="p">();</span> <span class="c1">// Create the first tree</span> <span class="n">sort_model1</span> <span class="o">=</span> <span class="n">gtk_tree_model_sort_new_with_model</span> <span class="p">(</span><span class="n">child_model</span><span class="p">);</span> <span class="n">tree_view1</span> <span class="o">=</span> <span class="n">gtk_tree_view_new_with_model</span> <span class="p">(</span><span class="n">sort_model1</span><span class="p">);</span> <span class="c1">// Create the second tree</span> <span class="n">sort_model2</span> <span class="o">=</span> <span class="n">gtk_tree_model_sort_new_with_model</span> <span class="p">(</span><span class="n">child_model</span><span class="p">);</span> <span class="n">tree_view2</span> <span class="o">=</span> <span class="n">gtk_tree_view_new_with_model</span> <span class="p">(</span><span class="n">sort_model2</span><span class="p">);</span> <span class="c1">// Now we can sort the two models independently</span> <span class="n">gtk_tree_sortable_set_sort_column_id</span> <span class="p">(</span><span class="n">GTK_TREE_SORTABLE</span> <span class="p">(</span><span class="n">sort_model1</span><span class="p">),</span> <span class="n">COLUMN_1</span><span class="p">,</span> <span class="n">GTK_SORT_ASCENDING</span><span class="p">);</span> <span class="n">gtk_tree_sortable_set_sort_column_id</span> <span class="p">(</span><span class="n">GTK_TREE_SORTABLE</span> <span class="p">(</span><span class="n">sort_model2</span><span class="p">),</span> <span class="n">COLUMN_1</span><span class="p">,</span> <span class="n">GTK_SORT_DESCENDING</span><span class="p">);</span> <span class="p">}</span></pre></td> </tr> </tbody> </table> </div> <p></p> <p>To demonstrate how to access the underlying child model from the sort model, the next example will be a callback for the <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> <a class="link" href="GtkTreeSelection.html#GtkTreeSelection-changed" title="The “changed” signal"><span class="type">“changed”</span></a> signal. In this callback, we get a string from COLUMN_1 of the model. We then modify the string, find the same selected row on the child model, and change the row there.</p> </div> <div class="refsect3"> <a name="id-1.3.12.11.9.5"></a><h4>Accessing the child model of in a selection changed callback</h4> <div class="informalexample"> <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="listing_lines" align="right"><pre>1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39</pre></td> <td class="listing_code"><pre class="programlisting"><span class="kt">void</span> <span class="nf">selection_changed</span> <span class="p">(</span><span class="n">GtkTreeSelection</span> <span class="o">*</span><span class="n">selection</span><span class="p">,</span> <span class="n">gpointer</span> <span class="n">data</span><span class="p">)</span> <span class="p">{</span> <span class="n">GtkTreeModel</span> <span class="o">*</span><span class="n">sort_model</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span> <span class="n">GtkTreeModel</span> <span class="o">*</span><span class="n">child_model</span><span class="p">;</span> <span class="n">GtkTreeIter</span> <span class="n">sort_iter</span><span class="p">;</span> <span class="n">GtkTreeIter</span> <span class="n">child_iter</span><span class="p">;</span> <span class="kt">char</span> <span class="o">*</span><span class="n">some_data</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span> <span class="kt">char</span> <span class="o">*</span><span class="n">modified_data</span><span class="p">;</span> <span class="c1">// Get the current selected row and the model.</span> <span class="k">if</span> <span class="p">(</span><span class="o">!</span> <span class="n">gtk_tree_selection_get_selected</span> <span class="p">(</span><span class="n">selection</span><span class="p">,</span> <span class="o">&</span><span class="n">sort_model</span><span class="p">,</span> <span class="o">&</span><span class="n">sort_iter</span><span class="p">))</span> <span class="k">return</span><span class="p">;</span> <span class="c1">// Look up the current value on the selected row and get</span> <span class="c1">// a new value to change it to.</span> <span class="n">gtk_tree_model_get</span> <span class="p">(</span><span class="n">GTK_TREE_MODEL</span> <span class="p">(</span><span class="n">sort_model</span><span class="p">),</span> <span class="o">&</span><span class="n">sort_iter</span><span class="p">,</span> <span class="n">COLUMN_1</span><span class="p">,</span> <span class="o">&</span><span class="n">some_data</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">);</span> <span class="n">modified_data</span> <span class="o">=</span> <span class="n">change_the_data</span> <span class="p">(</span><span class="n">some_data</span><span class="p">);</span> <span class="n">g_free</span> <span class="p">(</span><span class="n">some_data</span><span class="p">);</span> <span class="c1">// Get an iterator on the child model, instead of the sort model.</span> <span class="n">gtk_tree_model_sort_convert_iter_to_child_iter</span> <span class="p">(</span><span class="n">GTK_TREE_MODEL_SORT</span> <span class="p">(</span><span class="n">sort_model</span><span class="p">),</span> <span class="o">&</span><span class="n">child_iter</span><span class="p">,</span> <span class="o">&</span><span class="n">sort_iter</span><span class="p">);</span> <span class="c1">// Get the child model and change the value of the row. In this</span> <span class="c1">// example, the child model is a GtkListStore. It could be any other</span> <span class="c1">// type of model, though.</span> <span class="n">child_model</span> <span class="o">=</span> <span class="n">gtk_tree_model_sort_get_model</span> <span class="p">(</span><span class="n">GTK_TREE_MODEL_SORT</span> <span class="p">(</span><span class="n">sort_model</span><span class="p">));</span> <span class="n">gtk_list_store_set</span> <span class="p">(</span><span class="n">GTK_LIST_STORE</span> <span class="p">(</span><span class="n">child_model</span><span class="p">),</span> <span class="o">&</span><span class="n">child_iter</span><span class="p">,</span> <span class="n">COLUMN_1</span><span class="p">,</span> <span class="o">&</span><span class="n">modified_data</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">);</span> <span class="n">g_free</span> <span class="p">(</span><span class="n">modified_data</span><span class="p">);</span> <span class="p">}</span></pre></td> </tr> </tbody> </table> </div> <p></p> </div> </div> <div class="refsect1"> <a name="GtkTreeModelSort.functions_details"></a><h2>Functions</h2> <div class="refsect2"> <a name="gtk-tree-model-sort-new-with-model"></a><h3>gtk_tree_model_sort_new_with_model ()</h3> <pre class="programlisting"><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="returnvalue">GtkTreeModel</span></a> * gtk_tree_model_sort_new_with_model (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *child_model</code></em>);</pre> <p>Creates a new <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a>, with <em class="parameter"><code>child_model</code></em> as the child model.</p> <p><span class="annotation">[<acronym title="This symbol is a constructor, not a static method."><span class="acronym">constructor</span></acronym>]</span></p> <div class="refsect3"> <a name="gtk-tree-model-sort-new-with-model.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>child_model</p></td> <td class="parameter_description"><p>A <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-tree-model-sort-new-with-model.returns"></a><h4>Returns</h4> <p>A new <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a>. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gtk.TreeModelSort]</span></p> </div> </div> <hr> <div class="refsect2"> <a name="gtk-tree-model-sort-get-model"></a><h3>gtk_tree_model_sort_get_model ()</h3> <pre class="programlisting"><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="returnvalue">GtkTreeModel</span></a> * gtk_tree_model_sort_get_model (<em class="parameter"><code><a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> *tree_model</code></em>);</pre> <p>Returns the model the <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> is sorting.</p> <div class="refsect3"> <a name="gtk-tree-model-sort-get-model.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>tree_model</p></td> <td class="parameter_description"><p>a <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-tree-model-sort-get-model.returns"></a><h4>Returns</h4> <p>the "child model" being sorted. </p> <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> <hr> <div class="refsect2"> <a name="gtk-tree-model-sort-convert-child-path-to-path"></a><h3>gtk_tree_model_sort_convert_child_path_to_path ()</h3> <pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="returnvalue">GtkTreePath</span></a> * gtk_tree_model_sort_convert_child_path_to_path (<em class="parameter"><code><a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> *tree_model_sort</code></em>, <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *child_path</code></em>);</pre> <p>Converts <em class="parameter"><code>child_path</code></em> to a path relative to <em class="parameter"><code>tree_model_sort</code></em> . That is, <em class="parameter"><code>child_path</code></em> points to a path in the child model. The returned path will point to the same row in the sorted model. If <em class="parameter"><code>child_path</code></em> isn’t a valid path on the child model, then <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.</p> <div class="refsect3"> <a name="gtk-tree-model-sort-convert-child-path-to-path.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>tree_model_sort</p></td> <td class="parameter_description"><p>A <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>child_path</p></td> <td class="parameter_description"><p>A <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> to convert</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-tree-model-sort-convert-child-path-to-path.returns"></a><h4>Returns</h4> <p>A newly allocated <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p> <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> </div> <hr> <div class="refsect2"> <a name="gtk-tree-model-sort-convert-child-iter-to-iter"></a><h3>gtk_tree_model_sort_convert_child_iter_to_iter ()</h3> <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_tree_model_sort_convert_child_iter_to_iter (<em class="parameter"><code><a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> *tree_model_sort</code></em>, <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *sort_iter</code></em>, <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *child_iter</code></em>);</pre> <p>Sets <em class="parameter"><code>sort_iter</code></em> to point to the row in <em class="parameter"><code>tree_model_sort</code></em> that corresponds to the row pointed at by <em class="parameter"><code>child_iter</code></em> . If <em class="parameter"><code>sort_iter</code></em> was not set, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned. Note: a boolean is only returned since 2.14.</p> <div class="refsect3"> <a name="gtk-tree-model-sort-convert-child-iter-to-iter.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>tree_model_sort</p></td> <td class="parameter_description"><p>A <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>sort_iter</p></td> <td class="parameter_description"><p>An uninitialized <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a>. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> </tr> <tr> <td class="parameter_name"><p>child_iter</p></td> <td class="parameter_description"><p>A valid <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to a row on the child model</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-tree-model-sort-convert-child-iter-to-iter.returns"></a><h4>Returns</h4> <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if <em class="parameter"><code>sort_iter</code></em> was set, i.e. if <em class="parameter"><code>sort_iter</code></em> is a valid iterator pointer to a visible row in the child model.</p> </div> </div> <hr> <div class="refsect2"> <a name="gtk-tree-model-sort-convert-path-to-child-path"></a><h3>gtk_tree_model_sort_convert_path_to_child_path ()</h3> <pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="returnvalue">GtkTreePath</span></a> * gtk_tree_model_sort_convert_path_to_child_path (<em class="parameter"><code><a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> *tree_model_sort</code></em>, <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *sorted_path</code></em>);</pre> <p>Converts <em class="parameter"><code>sorted_path</code></em> to a path on the child model of <em class="parameter"><code>tree_model_sort</code></em> . That is, <em class="parameter"><code>sorted_path</code></em> points to a location in <em class="parameter"><code>tree_model_sort</code></em> . The returned path will point to the same location in the model not being sorted. If <em class="parameter"><code>sorted_path</code></em> does not point to a location in the child model, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.</p> <div class="refsect3"> <a name="gtk-tree-model-sort-convert-path-to-child-path.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>tree_model_sort</p></td> <td class="parameter_description"><p>A <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>sorted_path</p></td> <td class="parameter_description"><p>A <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> to convert</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-tree-model-sort-convert-path-to-child-path.returns"></a><h4>Returns</h4> <p>A newly allocated <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p> <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> </div> <hr> <div class="refsect2"> <a name="gtk-tree-model-sort-convert-iter-to-child-iter"></a><h3>gtk_tree_model_sort_convert_iter_to_child_iter ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> gtk_tree_model_sort_convert_iter_to_child_iter (<em class="parameter"><code><a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> *tree_model_sort</code></em>, <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *child_iter</code></em>, <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *sorted_iter</code></em>);</pre> <p>Sets <em class="parameter"><code>child_iter</code></em> to point to the row pointed to by <em class="parameter"><code>sorted_iter</code></em> .</p> <div class="refsect3"> <a name="gtk-tree-model-sort-convert-iter-to-child-iter.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>tree_model_sort</p></td> <td class="parameter_description"><p>A <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>child_iter</p></td> <td class="parameter_description"><p>An uninitialized <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a>. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> </tr> <tr> <td class="parameter_name"><p>sorted_iter</p></td> <td class="parameter_description"><p>A valid <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to a row on <em class="parameter"><code>tree_model_sort</code></em> .</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> </div> <hr> <div class="refsect2"> <a name="gtk-tree-model-sort-reset-default-sort-func"></a><h3>gtk_tree_model_sort_reset_default_sort_func ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> gtk_tree_model_sort_reset_default_sort_func (<em class="parameter"><code><a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> *tree_model_sort</code></em>);</pre> <p>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 <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> is in “unsorted” state.</p> <div class="refsect3"> <a name="gtk-tree-model-sort-reset-default-sort-func.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>tree_model_sort</p></td> <td class="parameter_description"><p>A <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> </div> <hr> <div class="refsect2"> <a name="gtk-tree-model-sort-clear-cache"></a><h3>gtk_tree_model_sort_clear_cache ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> gtk_tree_model_sort_clear_cache (<em class="parameter"><code><a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> *tree_model_sort</code></em>);</pre> <p>This function should almost never be called. It clears the <em class="parameter"><code>tree_model_sort</code></em> of any cached iterators that haven’t been reffed with <a class="link" href="GtkTreeModel.html#gtk-tree-model-ref-node" title="gtk_tree_model_ref_node ()"><code class="function">gtk_tree_model_ref_node()</code></a>. 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 class="refsect3"> <a name="gtk-tree-model-sort-clear-cache.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>tree_model_sort</p></td> <td class="parameter_description"><p>A <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> </div> <hr> <div class="refsect2"> <a name="gtk-tree-model-sort-iter-is-valid"></a><h3>gtk_tree_model_sort_iter_is_valid ()</h3> <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_tree_model_sort_iter_is_valid (<em class="parameter"><code><a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> *tree_model_sort</code></em>, <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre> <div class="blockquote"><blockquote class="blockquote"><p>This function is slow. Only use it for debugging and/or testing purposes.</p></blockquote></div> <p>Checks if the given iter is a valid iter for this <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a>.</p> <div class="refsect3"> <a name="gtk-tree-model-sort-iter-is-valid.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>tree_model_sort</p></td> <td class="parameter_description"><p>A <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a>.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>iter</p></td> <td class="parameter_description"><p>A <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a>.</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-tree-model-sort-iter-is-valid.returns"></a><h4>Returns</h4> <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the iter is valid, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the iter is invalid.</p> </div> <p class="since">Since: 2.2</p> </div> </div> <div class="refsect1"> <a name="GtkTreeModelSort.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> <a name="GtkTreeModelSort-struct"></a><h3>struct GtkTreeModelSort</h3> <pre class="programlisting">struct GtkTreeModelSort;</pre> </div> </div> <div class="refsect1"> <a name="GtkTreeModelSort.property-details"></a><h2>Property Details</h2> <div class="refsect2"> <a name="GtkTreeModelSort--model"></a><h3>The <code class="literal">“model”</code> property</h3> <pre class="programlisting"> “model” <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *</pre> <p>The model for the TreeModelSort to sort.</p> <p>Owner: GtkTreeModelSort</p> <p>Flags: Read / Write / Construct Only</p> </div> </div> <div class="refsect1"> <a name="GtkTreeModelSort.see-also"></a><h2>See Also</h2> <p><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a>, <a class="link" href="GtkListStore.html" title="GtkListStore"><span class="type">GtkListStore</span></a>, <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a>, <a class="link" href="GtkTreeSortable.html" title="GtkTreeSortable"><span class="type">GtkTreeSortable</span></a>, <a class="link" href="GtkTreeModelFilter.html" title="GtkTreeModelFilter"><span class="type">GtkTreeModelFilter</span></a></p> </div> </div> <div class="footer"> <hr>Generated by GTK-Doc V1.32</div> </body> </html>