3640 lines
188 KiB
HTML
3640 lines
188 KiB
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>GtkTreeModel: GTK+ 3 Reference Manual</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
||
<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="TreeWidget.html" title="Tree and List Widget Overview">
|
||
<link rel="next" href="GtkTreeSelection.html" title="GtkTreeSelection">
|
||
<meta name="generator" content="GTK-Doc V1.33.1 (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="#GtkTreeModel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||
<a href="#GtkTreeModel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
|
||
<a href="#GtkTreeModel.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_derived_interfaces"> <span class="dim">|</span>
|
||
<a href="#GtkTreeModel.derived-interfaces" class="shortcut">Known Derived Interfaces</a></span><span id="nav_implementations"> <span class="dim">|</span>
|
||
<a href="#GtkTreeModel.implementations" class="shortcut">Known Implementations</a></span><span id="nav_signals"> <span class="dim">|</span>
|
||
<a href="#GtkTreeModel.signals" class="shortcut">Signals</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="TreeWidget.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="n" href="GtkTreeSelection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
|
||
</tr></table>
|
||
<div class="refentry">
|
||
<a name="GtkTreeModel"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="GtkTreeModel.top_of_page"></a>GtkTreeModel</span></h2>
|
||
<p>GtkTreeModel — The tree interface used by GtkTreeView</p>
|
||
</td>
|
||
<td class="gallery_image" valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeModel.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">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<span class="c_punctuation">(</span><a class="link" href="GtkTreeModel.html#GtkTreeModelForeachFunc" title="GtkTreeModelForeachFunc ()">*GtkTreeModelForeachFunc</a><span class="c_punctuation">)</span> <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="GtkTreeModel.html#gtk-tree-path-new" title="gtk_tree_path_new ()">gtk_tree_path_new</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="GtkTreeModel.html#gtk-tree-path-new-from-string" title="gtk_tree_path_new_from_string ()">gtk_tree_path_new_from_string</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="GtkTreeModel.html#gtk-tree-path-new-from-indices" title="gtk_tree_path_new_from_indices ()">gtk_tree_path_new_from_indices</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="GtkTreeModel.html#gtk-tree-path-new-from-indicesv" title="gtk_tree_path_new_from_indicesv ()">gtk_tree_path_new_from_indicesv</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gchar</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-path-to-string" title="gtk_tree_path_to_string ()">gtk_tree_path_to_string</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="GtkTreeModel.html#gtk-tree-path-new-first" title="gtk_tree_path_new_first ()">gtk_tree_path_new_first</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="GtkTreeModel.html#gtk-tree-path-append-index" title="gtk_tree_path_append_index ()">gtk_tree_path_append_index</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="GtkTreeModel.html#gtk-tree-path-prepend-index" title="gtk_tree_path_prepend_index ()">gtk_tree_path_prepend_index</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gint</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-path-get-depth" title="gtk_tree_path_get_depth ()">gtk_tree_path_get_depth</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gint</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-path-get-indices" title="gtk_tree_path_get_indices ()">gtk_tree_path_get_indices</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gint</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-path-get-indices-with-depth" title="gtk_tree_path_get_indices_with_depth ()">gtk_tree_path_get_indices_with_depth</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="GtkTreeModel.html#gtk-tree-path-free" title="gtk_tree_path_free ()">gtk_tree_path_free</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="GtkTreeModel.html#gtk-tree-path-copy" title="gtk_tree_path_copy ()">gtk_tree_path_copy</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gint</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-path-compare" title="gtk_tree_path_compare ()">gtk_tree_path_compare</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="GtkTreeModel.html#gtk-tree-path-next" title="gtk_tree_path_next ()">gtk_tree_path_next</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-path-prev" title="gtk_tree_path_prev ()">gtk_tree_path_prev</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-path-up" title="gtk_tree_path_up ()">gtk_tree_path_up</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="GtkTreeModel.html#gtk-tree-path-down" title="gtk_tree_path_down ()">gtk_tree_path_down</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-path-is-ancestor" title="gtk_tree_path_is_ancestor ()">gtk_tree_path_is_ancestor</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-path-is-descendant" title="gtk_tree_path_is_descendant ()">gtk_tree_path_is_descendant</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="returnvalue">GtkTreeRowReference</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-new" title="gtk_tree_row_reference_new ()">gtk_tree_row_reference_new</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="returnvalue">GtkTreeRowReference</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-new-proxy" title="gtk_tree_row_reference_new_proxy ()">gtk_tree_row_reference_new_proxy</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="GtkTreeModel.html#gtk-tree-row-reference-get-model" title="gtk_tree_row_reference_get_model ()">gtk_tree_row_reference_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="GtkTreeModel.html#gtk-tree-row-reference-get-path" title="gtk_tree_row_reference_get_path ()">gtk_tree_row_reference_get_path</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-valid" title="gtk_tree_row_reference_valid ()">gtk_tree_row_reference_valid</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="GtkTreeModel.html#gtk-tree-row-reference-free" title="gtk_tree_row_reference_free ()">gtk_tree_row_reference_free</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="returnvalue">GtkTreeRowReference</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-copy" title="gtk_tree_row_reference_copy ()">gtk_tree_row_reference_copy</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="GtkTreeModel.html#gtk-tree-row-reference-inserted" title="gtk_tree_row_reference_inserted ()">gtk_tree_row_reference_inserted</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="GtkTreeModel.html#gtk-tree-row-reference-deleted" title="gtk_tree_row_reference_deleted ()">gtk_tree_row_reference_deleted</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="GtkTreeModel.html#gtk-tree-row-reference-reordered" title="gtk_tree_row_reference_reordered ()">gtk_tree_row_reference_reordered</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="returnvalue">GtkTreeIter</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-iter-copy" title="gtk_tree_iter_copy ()">gtk_tree_iter_copy</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="GtkTreeModel.html#gtk-tree-iter-free" title="gtk_tree_iter_free ()">gtk_tree_iter_free</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkTreeModel.html#GtkTreeModelFlags" title="enum GtkTreeModelFlags"><span class="returnvalue">GtkTreeModelFlags</span></a>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-get-flags" title="gtk_tree_model_get_flags ()">gtk_tree_model_get_flags</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gint</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-get-n-columns" title="gtk_tree_model_get_n_columns ()">gtk_tree_model_get_n_columns</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">GType</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-get-column-type" title="gtk_tree_model_get_column_type ()">gtk_tree_model_get_column_type</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-get-iter" title="gtk_tree_model_get_iter ()">gtk_tree_model_get_iter</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-get-iter-from-string" title="gtk_tree_model_get_iter_from_string ()">gtk_tree_model_get_iter_from_string</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-get-iter-first" title="gtk_tree_model_get_iter_first ()">gtk_tree_model_get_iter_first</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="GtkTreeModel.html#gtk-tree-model-get-path" title="gtk_tree_model_get_path ()">gtk_tree_model_get_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="GtkTreeModel.html#gtk-tree-model-get-value" title="gtk_tree_model_get_value ()">gtk_tree_model_get_value</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-iter-next" title="gtk_tree_model_iter_next ()">gtk_tree_model_iter_next</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-iter-previous" title="gtk_tree_model_iter_previous ()">gtk_tree_model_iter_previous</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-iter-children" title="gtk_tree_model_iter_children ()">gtk_tree_model_iter_children</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-iter-has-child" title="gtk_tree_model_iter_has_child ()">gtk_tree_model_iter_has_child</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gint</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-iter-n-children" title="gtk_tree_model_iter_n_children ()">gtk_tree_model_iter_n_children</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-iter-nth-child" title="gtk_tree_model_iter_nth_child ()">gtk_tree_model_iter_nth_child</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-iter-parent" title="gtk_tree_model_iter_parent ()">gtk_tree_model_iter_parent</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gchar</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-get-string-from-iter" title="gtk_tree_model_get_string_from_iter ()">gtk_tree_model_get_string_from_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="GtkTreeModel.html#gtk-tree-model-ref-node" title="gtk_tree_model_ref_node ()">gtk_tree_model_ref_node</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="GtkTreeModel.html#gtk-tree-model-unref-node" title="gtk_tree_model_unref_node ()">gtk_tree_model_unref_node</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="GtkTreeModel.html#gtk-tree-model-get" title="gtk_tree_model_get ()">gtk_tree_model_get</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="GtkTreeModel.html#gtk-tree-model-get-valist" title="gtk_tree_model_get_valist ()">gtk_tree_model_get_valist</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="GtkTreeModel.html#gtk-tree-model-foreach" title="gtk_tree_model_foreach ()">gtk_tree_model_foreach</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="GtkTreeModel.html#gtk-tree-model-row-changed" title="gtk_tree_model_row_changed ()">gtk_tree_model_row_changed</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="GtkTreeModel.html#gtk-tree-model-row-inserted" title="gtk_tree_model_row_inserted ()">gtk_tree_model_row_inserted</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="GtkTreeModel.html#gtk-tree-model-row-has-child-toggled" title="gtk_tree_model_row_has_child_toggled ()">gtk_tree_model_row_has_child_toggled</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="GtkTreeModel.html#gtk-tree-model-row-deleted" title="gtk_tree_model_row_deleted ()">gtk_tree_model_row_deleted</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="GtkTreeModel.html#gtk-tree-model-rows-reordered" title="gtk_tree_model_rows_reordered ()">gtk_tree_model_rows_reordered</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="GtkTreeModel.html#gtk-tree-model-rows-reordered-with-length" title="gtk_tree_model_rows_reordered_with_length ()">gtk_tree_model_rows_reordered_with_length</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeModel.signals"></a><h2>Signals</h2>
|
||
<div class="informaltable"><table class="informaltable" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="signal_proto_type">
|
||
<col width="300px" class="signal_proto_name">
|
||
<col width="200px" class="signal_proto_flags">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="signal_type"><span class="returnvalue">void</span></td>
|
||
<td class="signal_name"><a class="link" href="GtkTreeModel.html#GtkTreeModel-row-changed" title="The “row-changed” signal">row-changed</a></td>
|
||
<td class="signal_flags">Run Last</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="signal_type"><span class="returnvalue">void</span></td>
|
||
<td class="signal_name"><a class="link" href="GtkTreeModel.html#GtkTreeModel-row-deleted" title="The “row-deleted” signal">row-deleted</a></td>
|
||
<td class="signal_flags">Run First</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="signal_type"><span class="returnvalue">void</span></td>
|
||
<td class="signal_name"><a class="link" href="GtkTreeModel.html#GtkTreeModel-row-has-child-toggled" title="The “row-has-child-toggled” signal">row-has-child-toggled</a></td>
|
||
<td class="signal_flags">Run Last</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="signal_type"><span class="returnvalue">void</span></td>
|
||
<td class="signal_name"><a class="link" href="GtkTreeModel.html#GtkTreeModel-row-inserted" title="The “row-inserted” signal">row-inserted</a></td>
|
||
<td class="signal_flags">Run First</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="signal_type"><span class="returnvalue">void</span></td>
|
||
<td class="signal_name"><a class="link" href="GtkTreeModel.html#GtkTreeModel-rows-reordered" title="The “rows-reordered” signal">rows-reordered</a></td>
|
||
<td class="signal_flags">Run First</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<a name="GtkTreeIter"></a><a name="GtkTreePath"></a><div class="refsect1">
|
||
<a name="GtkTreeModel.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"> </td>
|
||
<td class="function_name"><a class="link" href="GtkTreeModel.html#GtkTreeModel-struct" title="GtkTreeModel">GtkTreeModel</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="datatype_keyword">struct</td>
|
||
<td class="function_name"><a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter">GtkTreeIter</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="datatype_keyword"> </td>
|
||
<td class="function_name"><a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath">GtkTreePath</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="datatype_keyword"> </td>
|
||
<td class="function_name"><a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference">GtkTreeRowReference</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="datatype_keyword">struct</td>
|
||
<td class="function_name"><a class="link" href="GtkTreeModel.html#GtkTreeModelIface" title="struct GtkTreeModelIface">GtkTreeModelIface</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="datatype_keyword">enum</td>
|
||
<td class="function_name"><a class="link" href="GtkTreeModel.html#GtkTreeModelFlags" title="enum GtkTreeModelFlags">GtkTreeModelFlags</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeModel.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
|
||
<span class="lineart">├──</span> GtkTreeIter
|
||
<span class="lineart">╰──</span> GtkTreePath
|
||
<a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
|
||
<span class="lineart">╰──</span> GtkTreeModel
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeModel.prerequisites"></a><h2>Prerequisites</h2>
|
||
<p>
|
||
GtkTreeModel requires
|
||
GObject.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeModel.derived-interfaces"></a><h2>Known Derived Interfaces</h2>
|
||
<p>
|
||
GtkTreeModel is required by
|
||
<a class="link" href="GtkTreeSortable.html" title="GtkTreeSortable">GtkTreeSortable</a>.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeModel.implementations"></a><h2>Known Implementations</h2>
|
||
<p>
|
||
GtkTreeModel is implemented by
|
||
<a class="link" href="GtkListStore.html" title="GtkListStore">GtkListStore</a>, <a class="link" href="GtkTreeModelFilter.html" title="GtkTreeModelFilter">GtkTreeModelFilter</a>, <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort">GtkTreeModelSort</a> and <a class="link" href="GtkTreeStore.html" title="GtkTreeStore">GtkTreeStore</a>.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeModel.includes"></a><h2>Includes</h2>
|
||
<pre class="synopsis">#include <gtk/gtk.h>
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeModel.description"></a><h2>Description</h2>
|
||
<p>The <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> interface defines a generic tree interface for
|
||
use by the <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> widget. It is an abstract interface, and
|
||
is designed to be usable with any appropriate data structure. The
|
||
programmer just has to implement this interface on their own data
|
||
type for it to be viewable by a <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> widget.</p>
|
||
<p>The model is represented as a hierarchical tree of strongly-typed,
|
||
columned data. In other words, the model can be seen as a tree where
|
||
every node has different values depending on which column is being
|
||
queried. The type of data found in a column is determined by using
|
||
the GType system (ie. <span class="type">G_TYPE_INT</span>, <span class="type">GTK_TYPE_BUTTON</span>, <span class="type">G_TYPE_POINTER</span>,
|
||
etc). The types are homogeneous per column across all nodes. It is
|
||
important to note that this interface only provides a way of examining
|
||
a model and observing changes. The implementation of each individual
|
||
model decides how and if changes are made.</p>
|
||
<p>In order to make life simpler for programmers who do not need to
|
||
write their own specialized model, two generic models are provided
|
||
— the <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> and the <a class="link" href="GtkListStore.html" title="GtkListStore"><span class="type">GtkListStore</span></a>. To use these, the
|
||
developer simply pushes data into these models as necessary. These
|
||
models provide the data structure as well as all appropriate tree
|
||
interfaces. As a result, implementing drag and drop, sorting, and
|
||
storing data is trivial. For the vast majority of trees and lists,
|
||
these two models are sufficient.</p>
|
||
<p>Models are accessed on a node/column level of granularity. One can
|
||
query for the value of a model at a certain node and a certain
|
||
column on that node. There are two structures used to reference a
|
||
particular node in a model. They are the <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> and
|
||
the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> (“iter” is short for iterator). Most of the
|
||
interface consists of operations on a <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a>.</p>
|
||
<p>A path is essentially a potential node. It is a location on a model
|
||
that may or may not actually correspond to a node on a specific
|
||
model. The <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> can be converted into either an
|
||
array of unsigned integers or a string. The string form is a list
|
||
of numbers separated by a colon. Each number refers to the offset
|
||
at that level. Thus, the path <code class="literal">0</code> refers to the root
|
||
node and the path <code class="literal">2:4</code> refers to the fifth child of
|
||
the third node.</p>
|
||
<p>By contrast, a <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> is a reference to a specific node on
|
||
a specific model. It is a generic struct with an integer and three
|
||
generic pointers. These are filled in by the model in a model-specific
|
||
way. One can convert a path to an iterator by calling
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-model-get-iter" title="gtk_tree_model_get_iter ()"><code class="function">gtk_tree_model_get_iter()</code></a>. These iterators are the primary way
|
||
of accessing a model and are similar to the iterators used by
|
||
<a class="link" href="GtkTextBuffer.html" title="GtkTextBuffer"><span class="type">GtkTextBuffer</span></a>. They are generally statically allocated on the
|
||
stack and only used for a short time. The model interface defines
|
||
a set of operations using them for navigating the model.</p>
|
||
<p>It is expected that models fill in the iterator with private data.
|
||
For example, the <a class="link" href="GtkListStore.html" title="GtkListStore"><span class="type">GtkListStore</span></a> model, which is internally a simple
|
||
linked list, stores a list node in one of the pointers. The
|
||
<a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a> stores an array and an offset in two of the
|
||
pointers. Additionally, there is an integer field. This field is
|
||
generally filled with a unique stamp per model. This stamp is for
|
||
catching errors resulting from using invalid iterators with a model.</p>
|
||
<p>The lifecycle of an iterator can be a little confusing at first.
|
||
Iterators are expected to always be valid for as long as the model
|
||
is unchanged (and doesn’t emit a signal). The model is considered
|
||
to own all outstanding iterators and nothing needs to be done to
|
||
free them from the user’s point of view. Additionally, some models
|
||
guarantee that an iterator is valid for as long as the node it refers
|
||
to is valid (most notably the <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> and <a class="link" href="GtkListStore.html" title="GtkListStore"><span class="type">GtkListStore</span></a>).
|
||
Although generally uninteresting, as one always has to allow for
|
||
the case where iterators do not persist beyond a signal, some very
|
||
important performance enhancements were made in the sort model.
|
||
As a result, the <a class="link" href="GtkTreeModel.html#GTK-TREE-MODEL-ITERS-PERSIST:CAPS"><span class="type">GTK_TREE_MODEL_ITERS_PERSIST</span></a> flag was added to
|
||
indicate this behavior.</p>
|
||
<p>To help show some common operation of a model, some examples are
|
||
provided. The first example shows three ways of getting the iter at
|
||
the location <code class="literal">3:2:5</code>. While the first method shown is
|
||
easier, the second is much more common, as you often get paths from
|
||
callbacks.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.3.12.3.13.11"></a><h4>Acquiring a <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</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="c1">// Three ways of getting the iter pointing to the location</span>
|
||
<span class="n">GtkTreePath</span><span class="w"> </span><span class="o">*</span><span class="n">path</span><span class="p">;</span><span class="w"></span>
|
||
<span class="n">GtkTreeIter</span><span class="w"> </span><span class="n">iter</span><span class="p">;</span><span class="w"></span>
|
||
<span class="n">GtkTreeIter</span><span class="w"> </span><span class="n">parent_iter</span><span class="p">;</span><span class="w"></span>
|
||
|
||
<span class="c1">// get the iterator from a string</span>
|
||
<span class="n">gtk_tree_model_get_iter_from_string</span><span class="w"> </span><span class="p">(</span><span class="n">model</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="o">&</span><span class="n">iter</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="s">"3:2:5"</span><span class="p">);</span><span class="w"></span>
|
||
|
||
<span class="c1">// get the iterator from a path</span>
|
||
<span class="n">path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">gtk_tree_path_new_from_string</span><span class="w"> </span><span class="p">(</span><span class="s">"3:2:5"</span><span class="p">);</span><span class="w"></span>
|
||
<span class="n">gtk_tree_model_get_iter</span><span class="w"> </span><span class="p">(</span><span class="n">model</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">iter</span><span class="p">,</span><span class="w"> </span><span class="n">path</span><span class="p">);</span><span class="w"></span>
|
||
<span class="n">gtk_tree_path_free</span><span class="w"> </span><span class="p">(</span><span class="n">path</span><span class="p">);</span><span class="w"></span>
|
||
|
||
<span class="c1">// walk the tree to find the iterator</span>
|
||
<span class="n">gtk_tree_model_iter_nth_child</span><span class="w"> </span><span class="p">(</span><span class="n">model</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">iter</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nb">NULL</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">);</span><span class="w"></span>
|
||
<span class="n">parent_iter</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">iter</span><span class="p">;</span><span class="w"></span>
|
||
<span class="n">gtk_tree_model_iter_nth_child</span><span class="w"> </span><span class="p">(</span><span class="n">model</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">iter</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="o">&</span><span class="n">parent_iter</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span><span class="w"></span>
|
||
<span class="n">parent_iter</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">iter</span><span class="p">;</span><span class="w"></span>
|
||
<span class="n">gtk_tree_model_iter_nth_child</span><span class="w"> </span><span class="p">(</span><span class="n">model</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">iter</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="o">&</span><span class="n">parent_iter</span><span class="p">,</span><span class="w"> </span><span class="mi">5</span><span class="p">);</span><span class="w"></span></pre></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<p></p>
|
||
<p>This second example shows a quick way of iterating through a list
|
||
and getting a string and an integer from each row. The
|
||
<code class="function">populate_model()</code> function used below is not
|
||
shown, as it is specific to the <a class="link" href="GtkListStore.html" title="GtkListStore"><span class="type">GtkListStore</span></a>. For information on
|
||
how to write such a function, see the <a class="link" href="GtkListStore.html" title="GtkListStore"><span class="type">GtkListStore</span></a> documentation.</p>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="id-1.3.12.3.13.12"></a><h4>Reading data from a <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</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
|
||
25
|
||
26
|
||
27
|
||
28
|
||
29
|
||
30
|
||
31
|
||
32
|
||
33
|
||
34
|
||
35
|
||
36
|
||
37
|
||
38
|
||
39
|
||
40
|
||
41
|
||
42
|
||
43
|
||
44
|
||
45
|
||
46
|
||
47</pre></td>
|
||
<td class="listing_code"><pre class="programlisting"><span class="k">enum</span><span class="w"></span>
|
||
<span class="p">{</span><span class="w"></span>
|
||
<span class="w"> </span><span class="n">STRING_COLUMN</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="n">INT_COLUMN</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="n">N_COLUMNS</span><span class="w"></span>
|
||
<span class="p">};</span><span class="w"></span>
|
||
|
||
<span class="p">...</span><span class="w"></span>
|
||
|
||
<span class="n">GtkTreeModel</span><span class="w"> </span><span class="o">*</span><span class="n">list_store</span><span class="p">;</span><span class="w"></span>
|
||
<span class="n">GtkTreeIter</span><span class="w"> </span><span class="n">iter</span><span class="p">;</span><span class="w"></span>
|
||
<span class="n">gboolean</span><span class="w"> </span><span class="n">valid</span><span class="p">;</span><span class="w"></span>
|
||
<span class="n">gint</span><span class="w"> </span><span class="n">row_count</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span><span class="w"></span>
|
||
|
||
<span class="c1">// make a new list_store</span>
|
||
<span class="n">list_store</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">gtk_list_store_new</span><span class="w"> </span><span class="p">(</span><span class="n">N_COLUMNS</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="n">G_TYPE_STRING</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="n">G_TYPE_INT</span><span class="p">);</span><span class="w"></span>
|
||
|
||
<span class="c1">// Fill the list store with data</span>
|
||
<span class="n">populate_model</span><span class="w"> </span><span class="p">(</span><span class="n">list_store</span><span class="p">);</span><span class="w"></span>
|
||
|
||
<span class="c1">// Get the first iter in the list, check it is valid and walk</span>
|
||
<span class="c1">// through the list, reading each row.</span>
|
||
|
||
<span class="n">valid</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">gtk_tree_model_get_iter_first</span><span class="w"> </span><span class="p">(</span><span class="n">list_store</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="o">&</span><span class="n">iter</span><span class="p">);</span><span class="w"></span>
|
||
<span class="k">while</span><span class="w"> </span><span class="p">(</span><span class="n">valid</span><span class="p">)</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p">{</span><span class="w"></span>
|
||
<span class="w"> </span><span class="n">gchar</span><span class="w"> </span><span class="o">*</span><span class="n">str_data</span><span class="p">;</span><span class="w"></span>
|
||
<span class="w"> </span><span class="n">gint</span><span class="w"> </span><span class="n">int_data</span><span class="p">;</span><span class="w"></span>
|
||
|
||
<span class="w"> </span><span class="c1">// Make sure you terminate calls to gtk_tree_model_get() with a “-1” value</span>
|
||
<span class="w"> </span><span class="n">gtk_tree_model_get</span><span class="w"> </span><span class="p">(</span><span class="n">list_store</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">iter</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="n">STRING_COLUMN</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">str_data</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="n">INT_COLUMN</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">int_data</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="mi">-1</span><span class="p">);</span><span class="w"></span>
|
||
|
||
<span class="w"> </span><span class="c1">// Do something with the data</span>
|
||
<span class="w"> </span><span class="n">g_print</span><span class="w"> </span><span class="p">(</span><span class="s">"Row %d: (%s,%d)</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="n">row_count</span><span class="p">,</span><span class="w"> </span><span class="n">str_data</span><span class="p">,</span><span class="w"> </span><span class="n">int_data</span><span class="p">);</span><span class="w"></span>
|
||
<span class="w"> </span><span class="n">g_free</span><span class="w"> </span><span class="p">(</span><span class="n">str_data</span><span class="p">);</span><span class="w"></span>
|
||
|
||
<span class="w"> </span><span class="n">valid</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">gtk_tree_model_iter_next</span><span class="w"> </span><span class="p">(</span><span class="n">list_store</span><span class="p">,</span><span class="w"></span>
|
||
<span class="w"> </span><span class="o">&</span><span class="n">iter</span><span class="p">);</span><span class="w"></span>
|
||
<span class="w"> </span><span class="n">row_count</span><span class="o">++</span><span class="p">;</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p">}</span><span class="w"></span></pre></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<p></p>
|
||
<p>The <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> interface contains two methods for reference
|
||
counting: <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> and <a class="link" href="GtkTreeModel.html#gtk-tree-model-unref-node" title="gtk_tree_model_unref_node ()"><code class="function">gtk_tree_model_unref_node()</code></a>.
|
||
These two methods are optional to implement. The reference counting
|
||
is meant as a way for views to let models know when nodes are being
|
||
displayed. <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> will take a reference on a node when it is
|
||
visible, which means the node is either in the toplevel or expanded.
|
||
Being displayed does not mean that the node is currently directly
|
||
visible to the user in the viewport. Based on this reference counting
|
||
scheme a caching model, for example, can decide whether or not to cache
|
||
a node based on the reference count. A file-system based model would
|
||
not want to keep the entire file hierarchy in memory, but just the
|
||
folders that are currently expanded in every current view.</p>
|
||
<p>When working with reference counting, the following rules must be taken
|
||
into account:</p>
|
||
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
|
||
<li class="listitem"><p>Never take a reference on a node without owning a reference on its parent.
|
||
This means that all parent nodes of a referenced node must be referenced
|
||
as well.</p></li>
|
||
<li class="listitem"><p>Outstanding references on a deleted node are not released. This is not
|
||
possible because the node has already been deleted by the time the
|
||
row-deleted signal is received.</p></li>
|
||
<li class="listitem"><p>Models are not obligated to emit a signal on rows of which none of its
|
||
siblings are referenced. To phrase this differently, signals are only
|
||
required for levels in which nodes are referenced. For the root level
|
||
however, signals must be emitted at all times (however the root level
|
||
is always referenced when any view is attached).</p></li>
|
||
</ul></div>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeModel.functions_details"></a><h2>Functions</h2>
|
||
<div class="refsect2">
|
||
<a name="GtkTreeModelForeachFunc"></a><h3>GtkTreeModelForeachFunc ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
<span class="c_punctuation">(</span>*GtkTreeModelForeachFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
|
||
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
|
||
<p>Type of the callback passed to <a class="link" href="GtkTreeModel.html#gtk-tree-model-foreach" title="gtk_tree_model_foreach ()"><code class="function">gtk_tree_model_foreach()</code></a> to
|
||
iterate over the rows in a tree model.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkTreeModelForeachFunc.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>model</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> being iterated</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>the current <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the current <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>data</p></td>
|
||
<td class="parameter_description"><p>The user data passed to <a class="link" href="GtkTreeModel.html#gtk-tree-model-foreach" title="gtk_tree_model_foreach ()"><code class="function">gtk_tree_model_foreach()</code></a>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="GtkTreeModelForeachFunc.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> to stop iterating, <code class="literal">FALSE</code> to continue</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-new"></a><h3>gtk_tree_path_new ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="returnvalue">GtkTreePath</span></a> *
|
||
gtk_tree_path_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||
<p>Creates a new <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a>.
|
||
This refers to a row.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-new.returns"></a><h4>Returns</h4>
|
||
<p> A newly created <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a>.</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-new-from-string"></a><h3>gtk_tree_path_new_from_string ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="returnvalue">GtkTreePath</span></a> *
|
||
gtk_tree_path_new_from_string (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
|
||
<p>Creates a new <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> initialized to <em class="parameter"><code>path</code></em>
|
||
.</p>
|
||
<p><em class="parameter"><code>path</code></em>
|
||
is expected to be a colon separated list of numbers.
|
||
For example, the string “10:4:0” would create a path of depth
|
||
3 pointing to the 11th child of the root node, the 5th
|
||
child of that 11th child, and the 1st child of that 5th child.
|
||
If an invalid path string is passed in, <code class="literal">NULL</code> is returned.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-new-from-string.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>path</p></td>
|
||
<td class="parameter_description"><p>The string representation of a path</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-new-from-string.returns"></a><h4>Returns</h4>
|
||
<p> A newly-created <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a>, or <code class="literal">NULL</code></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-new-from-indices"></a><h3>gtk_tree_path_new_from_indices ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="returnvalue">GtkTreePath</span></a> *
|
||
gtk_tree_path_new_from_indices (<em class="parameter"><code><span class="type">gint</span> first_index</code></em>,
|
||
<em class="parameter"><code>...</code></em>);</pre>
|
||
<p>Creates a new path with <em class="parameter"><code>first_index</code></em>
|
||
and <em class="parameter"><code>varargs</code></em>
|
||
as indices.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-new-from-indices.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>first_index</p></td>
|
||
<td class="parameter_description"><p>first integer</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>...</p></td>
|
||
<td class="parameter_description"><p>list of integers terminated by -1</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-new-from-indices.returns"></a><h4>Returns</h4>
|
||
<p> A newly created <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p>
|
||
</div>
|
||
<p class="since">Since: 2.2</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-new-from-indicesv"></a><h3>gtk_tree_path_new_from_indicesv ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="returnvalue">GtkTreePath</span></a> *
|
||
gtk_tree_path_new_from_indicesv (<em class="parameter"><code><span class="type">gint</span> *indices</code></em>,
|
||
<em class="parameter"><code><span class="type">gsize</span> length</code></em>);</pre>
|
||
<p>Creates a new path with the given <em class="parameter"><code>indices</code></em>
|
||
array of <em class="parameter"><code>length</code></em>
|
||
.</p>
|
||
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> gtk_tree_path_new_from_indices]</span></p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-new-from-indicesv.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>indices</p></td>
|
||
<td class="parameter_description"><p>array of indices. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>length</p></td>
|
||
<td class="parameter_description"><p>length of <em class="parameter"><code>indices</code></em>
|
||
array</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-new-from-indicesv.returns"></a><h4>Returns</h4>
|
||
<p> A newly created <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-12.html#api-index-3.12">3.12</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-to-string"></a><h3>gtk_tree_path_to_string ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gchar</span> *
|
||
gtk_tree_path_to_string (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Generates a string representation of the path.</p>
|
||
<p>This string is a “:” separated list of numbers.
|
||
For example, “4:10:0:3” would be an acceptable
|
||
return value for this string.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-to-string.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>path</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-to-string.returns"></a><h4>Returns</h4>
|
||
<p> A newly-allocated string.
|
||
Must be freed with <code class="function">g_free()</code>.</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-new-first"></a><h3>gtk_tree_path_new_first ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="returnvalue">GtkTreePath</span></a> *
|
||
gtk_tree_path_new_first (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||
<p>Creates a new <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a>.</p>
|
||
<p>The string representation of this path is “0”.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-new-first.returns"></a><h4>Returns</h4>
|
||
<p> A new <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-append-index"></a><h3>gtk_tree_path_append_index ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_path_append_index (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> index_</code></em>);</pre>
|
||
<p>Appends a new index to a path.</p>
|
||
<p>As a result, the depth of the path is increased.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-append-index.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>index_</p></td>
|
||
<td class="parameter_description"><p>the index</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-prepend-index"></a><h3>gtk_tree_path_prepend_index ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_path_prepend_index (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> index_</code></em>);</pre>
|
||
<p>Prepends a new index to a path.</p>
|
||
<p>As a result, the depth of the path is increased.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-prepend-index.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>index_</p></td>
|
||
<td class="parameter_description"><p>the index</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-get-depth"></a><h3>gtk_tree_path_get_depth ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gint</span>
|
||
gtk_tree_path_get_depth (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Returns the current depth of <em class="parameter"><code>path</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-get-depth.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-get-depth.returns"></a><h4>Returns</h4>
|
||
<p> The depth of <em class="parameter"><code>path</code></em>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-get-indices"></a><h3>gtk_tree_path_get_indices ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gint</span> *
|
||
gtk_tree_path_get_indices (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Returns the current indices of <em class="parameter"><code>path</code></em>
|
||
.</p>
|
||
<p>This is an array of integers, each representing a node in a tree.
|
||
This value should not be freed.</p>
|
||
<p>The length of the array can be obtained with <a class="link" href="GtkTreeModel.html#gtk-tree-path-get-depth" title="gtk_tree_path_get_depth ()"><code class="function">gtk_tree_path_get_depth()</code></a>.</p>
|
||
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-get-indices.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-get-indices.returns"></a><h4>Returns</h4>
|
||
<p> The current indices, or <code class="literal">NULL</code></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-get-indices-with-depth"></a><h3>gtk_tree_path_get_indices_with_depth ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gint</span> *
|
||
gtk_tree_path_get_indices_with_depth (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> *depth</code></em>);</pre>
|
||
<p>Returns the current indices of <em class="parameter"><code>path</code></em>
|
||
.</p>
|
||
<p>This is an array of integers, each representing a node in a tree.
|
||
It also returns the number of elements in the array.
|
||
The array should not be freed.</p>
|
||
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> gtk_tree_path_get_indices]</span></p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-get-indices-with-depth.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>depth</p></td>
|
||
<td class="parameter_description"><p>return location for number of elements
|
||
returned in the integer array, or <code class="literal">NULL</code>. </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>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-get-indices-with-depth.returns"></a><h4>Returns</h4>
|
||
<p>The current
|
||
indices, or <code class="literal">NULL</code>. </p>
|
||
<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=depth][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-free"></a><h3>gtk_tree_path_free ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_path_free (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Frees <em class="parameter"><code>path</code></em>
|
||
. If <em class="parameter"><code>path</code></em>
|
||
is <code class="literal">NULL</code>, it simply returns.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-free.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-copy"></a><h3>gtk_tree_path_copy ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="returnvalue">GtkTreePath</span></a> *
|
||
gtk_tree_path_copy (<em class="parameter"><code>const <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Creates a new <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> as a copy of <em class="parameter"><code>path</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-copy.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-copy.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-compare"></a><h3>gtk_tree_path_compare ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gint</span>
|
||
gtk_tree_path_compare (<em class="parameter"><code>const <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *a</code></em>,
|
||
<em class="parameter"><code>const <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *b</code></em>);</pre>
|
||
<p>Compares two paths.</p>
|
||
<p>If <em class="parameter"><code>a</code></em>
|
||
appears before <em class="parameter"><code>b</code></em>
|
||
in a tree, then -1 is returned.
|
||
If <em class="parameter"><code>b</code></em>
|
||
appears before <em class="parameter"><code>a</code></em>
|
||
, then 1 is returned.
|
||
If the two nodes are equal, then 0 is returned.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-compare.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>a</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>b</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> to compare with</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-compare.returns"></a><h4>Returns</h4>
|
||
<p> the relative positions of <em class="parameter"><code>a</code></em>
|
||
and <em class="parameter"><code>b</code></em>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-next"></a><h3>gtk_tree_path_next ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_path_next (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Moves the <em class="parameter"><code>path</code></em>
|
||
to point to the next node at the current depth.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-next.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-prev"></a><h3>gtk_tree_path_prev ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_path_prev (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Moves the <em class="parameter"><code>path</code></em>
|
||
to point to the previous node at the
|
||
current depth, if it exists.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-prev.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-prev.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>path</code></em>
|
||
has a previous node, and
|
||
the move was made</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-up"></a><h3>gtk_tree_path_up ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_path_up (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Moves the <em class="parameter"><code>path</code></em>
|
||
to point to its parent node, if it has a parent.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-up.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-up.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>path</code></em>
|
||
has a parent, and the move was made</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-down"></a><h3>gtk_tree_path_down ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_path_down (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Moves <em class="parameter"><code>path</code></em>
|
||
to point to the first child of the current path.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-down.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-is-ancestor"></a><h3>gtk_tree_path_is_ancestor ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_path_is_ancestor (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *descendant</code></em>);</pre>
|
||
<p>Returns <code class="literal">TRUE</code> if <em class="parameter"><code>descendant</code></em>
|
||
is a descendant of <em class="parameter"><code>path</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-is-ancestor.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>descendant</p></td>
|
||
<td class="parameter_description"><p>another <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-is-ancestor.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>descendant</code></em>
|
||
is contained inside <em class="parameter"><code>path</code></em>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-path-is-descendant"></a><h3>gtk_tree_path_is_descendant ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_path_is_descendant (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *ancestor</code></em>);</pre>
|
||
<p>Returns <code class="literal">TRUE</code> if <em class="parameter"><code>path</code></em>
|
||
is a descendant of <em class="parameter"><code>ancestor</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-is-descendant.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>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>ancestor</p></td>
|
||
<td class="parameter_description"><p>another <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-path-is-descendant.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>ancestor</code></em>
|
||
contains <em class="parameter"><code>path</code></em>
|
||
somewhere below it</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-row-reference-new"></a><h3>gtk_tree_row_reference_new ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="returnvalue">GtkTreeRowReference</span></a> *
|
||
gtk_tree_row_reference_new (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Creates a row reference based on <em class="parameter"><code>path</code></em>
|
||
.</p>
|
||
<p>This reference will keep pointing to the node pointed to
|
||
by <em class="parameter"><code>path</code></em>
|
||
, so long as it exists. Any changes that occur on <em class="parameter"><code>model</code></em>
|
||
are
|
||
propagated, and the path is updated appropriately. If
|
||
<em class="parameter"><code>path</code></em>
|
||
isn’t a valid path in <em class="parameter"><code>model</code></em>
|
||
, then <code class="literal">NULL</code> is returned.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-new.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>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>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a valid <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> to monitor</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-new.returns"></a><h4>Returns</h4>
|
||
<p> a newly allocated <a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a>, or <code class="literal">NULL</code></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-row-reference-new-proxy"></a><h3>gtk_tree_row_reference_new_proxy ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="returnvalue">GtkTreeRowReference</span></a> *
|
||
gtk_tree_row_reference_new_proxy (<em class="parameter"><code><span class="type">GObject</span> *proxy</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>You do not need to use this function.</p>
|
||
<p>Creates a row reference based on <em class="parameter"><code>path</code></em>
|
||
.</p>
|
||
<p>This reference will keep pointing to the node pointed to
|
||
by <em class="parameter"><code>path</code></em>
|
||
, so long as it exists. If <em class="parameter"><code>path</code></em>
|
||
isn’t a valid
|
||
path in <em class="parameter"><code>model</code></em>
|
||
, then <code class="literal">NULL</code> is returned. However, unlike
|
||
references created with <a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-new" title="gtk_tree_row_reference_new ()"><code class="function">gtk_tree_row_reference_new()</code></a>, it
|
||
does not listen to the model for changes. The creator of
|
||
the row reference must do this explicitly using
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-inserted" title="gtk_tree_row_reference_inserted ()"><code class="function">gtk_tree_row_reference_inserted()</code></a>, <a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-deleted" title="gtk_tree_row_reference_deleted ()"><code class="function">gtk_tree_row_reference_deleted()</code></a>,
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-reordered" title="gtk_tree_row_reference_reordered ()"><code class="function">gtk_tree_row_reference_reordered()</code></a>.</p>
|
||
<p>These functions must be called exactly once per proxy when the
|
||
corresponding signal on the model is emitted. This single call
|
||
updates all row references for that proxy. Since built-in GTK+
|
||
objects like <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> already use this mechanism internally,
|
||
using them as the proxy object will produce unpredictable results.
|
||
Further more, passing the same object as <em class="parameter"><code>model</code></em>
|
||
and <em class="parameter"><code>proxy</code></em>
|
||
|
||
doesn’t work for reasons of internal implementation.</p>
|
||
<p>This type of row reference is primarily meant by structures that
|
||
need to carefully monitor exactly when a row reference updates
|
||
itself, and is not generally needed by most applications.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-new-proxy.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>proxy</p></td>
|
||
<td class="parameter_description"><p>a proxy <span class="type">GObject</span></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>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>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a valid <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> to monitor</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-new-proxy.returns"></a><h4>Returns</h4>
|
||
<p> a newly allocated <a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a>, or <code class="literal">NULL</code></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-row-reference-get-model"></a><h3>gtk_tree_row_reference_get_model ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="returnvalue">GtkTreeModel</span></a> *
|
||
gtk_tree_row_reference_get_model (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a> *reference</code></em>);</pre>
|
||
<p>Returns the model that the row reference is monitoring.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-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>reference</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-get-model.returns"></a><h4>Returns</h4>
|
||
<p>the model. </p>
|
||
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
|
||
</div>
|
||
<p class="since">Since: 2.8</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-row-reference-get-path"></a><h3>gtk_tree_row_reference_get_path ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="returnvalue">GtkTreePath</span></a> *
|
||
gtk_tree_row_reference_get_path (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a> *reference</code></em>);</pre>
|
||
<p>Returns a path that the row reference currently points to,
|
||
or <code class="literal">NULL</code> if the path pointed to is no longer valid.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-get-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>reference</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-get-path.returns"></a><h4>Returns</h4>
|
||
<p>a current path, or <code class="literal">NULL</code>. </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="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-row-reference-valid"></a><h3>gtk_tree_row_reference_valid ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_row_reference_valid (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a> *reference</code></em>);</pre>
|
||
<p>Returns <code class="literal">TRUE</code> if the <em class="parameter"><code>reference</code></em>
|
||
is non-<code class="literal">NULL</code> and refers to
|
||
a current valid path.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-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>reference</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a>, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-valid.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>reference</code></em>
|
||
points to a valid path</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-row-reference-free"></a><h3>gtk_tree_row_reference_free ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_row_reference_free (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a> *reference</code></em>);</pre>
|
||
<p>Free’s <em class="parameter"><code>reference</code></em>
|
||
. <em class="parameter"><code>reference</code></em>
|
||
may be <code class="literal">NULL</code></p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-free.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>reference</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a>, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-row-reference-copy"></a><h3>gtk_tree_row_reference_copy ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="returnvalue">GtkTreeRowReference</span></a> *
|
||
gtk_tree_row_reference_copy (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a> *reference</code></em>);</pre>
|
||
<p>Copies a <a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-copy.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>reference</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-copy.returns"></a><h4>Returns</h4>
|
||
<p> a copy of <em class="parameter"><code>reference</code></em>
|
||
</p>
|
||
</div>
|
||
<p class="since">Since: 2.2</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-row-reference-inserted"></a><h3>gtk_tree_row_reference_inserted ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_row_reference_inserted (<em class="parameter"><code><span class="type">GObject</span> *proxy</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Lets a set of row reference created by
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-new-proxy" title="gtk_tree_row_reference_new_proxy ()"><code class="function">gtk_tree_row_reference_new_proxy()</code></a> know that the
|
||
model emitted the <a class="link" href="GtkTreeModel.html#GtkTreeModel-row-inserted" title="The “row-inserted” signal"><span class="type">“row-inserted”</span></a> signal.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-inserted.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>proxy</p></td>
|
||
<td class="parameter_description"><p>a <span class="type">GObject</span></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>the row position that was inserted</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-row-reference-deleted"></a><h3>gtk_tree_row_reference_deleted ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_row_reference_deleted (<em class="parameter"><code><span class="type">GObject</span> *proxy</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Lets a set of row reference created by
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-new-proxy" title="gtk_tree_row_reference_new_proxy ()"><code class="function">gtk_tree_row_reference_new_proxy()</code></a> know that the
|
||
model emitted the <a class="link" href="GtkTreeModel.html#GtkTreeModel-row-deleted" title="The “row-deleted” signal"><span class="type">“row-deleted”</span></a> signal.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-deleted.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>proxy</p></td>
|
||
<td class="parameter_description"><p>a <span class="type">GObject</span></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>the path position that was deleted</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-row-reference-reordered"></a><h3>gtk_tree_row_reference_reordered ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_row_reference_reordered (<em class="parameter"><code><span class="type">GObject</span> *proxy</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> *new_order</code></em>);</pre>
|
||
<p>Lets a set of row reference created by
|
||
<a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-new-proxy" title="gtk_tree_row_reference_new_proxy ()"><code class="function">gtk_tree_row_reference_new_proxy()</code></a> know that the
|
||
model emitted the <a class="link" href="GtkTreeModel.html#GtkTreeModel-rows-reordered" title="The “rows-reordered” signal"><span class="type">“rows-reordered”</span></a> signal.</p>
|
||
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-row-reference-reordered.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>proxy</p></td>
|
||
<td class="parameter_description"><p>a <span class="type">GObject</span></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>the parent path of the reordered signal</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the iter pointing to the parent of the reordered</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>new_order</p></td>
|
||
<td class="parameter_description"><p>the new order of rows. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-iter-copy"></a><h3>gtk_tree_iter_copy ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="returnvalue">GtkTreeIter</span></a> *
|
||
gtk_tree_iter_copy (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Creates a dynamically allocated tree iterator as a copy of <em class="parameter"><code>iter</code></em>
|
||
.</p>
|
||
<p>This function is not intended for use in applications,
|
||
because you can just copy the structs by value
|
||
(<code class="literal">GtkTreeIter new_iter = iter;</code>).
|
||
You must free this iter with <a class="link" href="GtkTreeModel.html#gtk-tree-iter-free" title="gtk_tree_iter_free ()"><code class="function">gtk_tree_iter_free()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-iter-copy.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>iter</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct 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-iter-copy.returns"></a><h4>Returns</h4>
|
||
<p> a newly-allocated copy of <em class="parameter"><code>iter</code></em>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-iter-free"></a><h3>gtk_tree_iter_free ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_iter_free (<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Frees an iterator that has been allocated by <a class="link" href="GtkTreeModel.html#gtk-tree-iter-copy" title="gtk_tree_iter_copy ()"><code class="function">gtk_tree_iter_copy()</code></a>.</p>
|
||
<p>This function is mainly used for language bindings.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-iter-free.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>iter</p></td>
|
||
<td class="parameter_description"><p>a dynamically allocated tree iterator</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-get-flags"></a><h3>gtk_tree_model_get_flags ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreeModelFlags" title="enum GtkTreeModelFlags"><span class="returnvalue">GtkTreeModelFlags</span></a>
|
||
gtk_tree_model_get_flags (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>);</pre>
|
||
<p>Returns a set of flags supported by this interface.</p>
|
||
<p>The flags are a bitwise combination of <a class="link" href="GtkTreeModel.html#GtkTreeModelFlags" title="enum GtkTreeModelFlags"><span class="type">GtkTreeModelFlags</span></a>.
|
||
The flags supported should not change during the lifetime
|
||
of the <em class="parameter"><code>tree_model</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-flags.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="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-get-flags.returns"></a><h4>Returns</h4>
|
||
<p> the flags supported by this interface</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-get-n-columns"></a><h3>gtk_tree_model_get_n_columns ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gint</span>
|
||
gtk_tree_model_get_n_columns (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>);</pre>
|
||
<p>Returns the number of columns supported by <em class="parameter"><code>tree_model</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-n-columns.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="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-get-n-columns.returns"></a><h4>Returns</h4>
|
||
<p> the number of columns</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-get-column-type"></a><h3>gtk_tree_model_get_column_type ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">GType</span>
|
||
gtk_tree_model_get_column_type (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> index_</code></em>);</pre>
|
||
<p>Returns the type of the column.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-column-type.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>index_</p></td>
|
||
<td class="parameter_description"><p>the column index</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-column-type.returns"></a><h4>Returns</h4>
|
||
<p> the type of the column</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-get-iter"></a><h3>gtk_tree_model_get_iter ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_model_get_iter (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Sets <em class="parameter"><code>iter</code></em>
|
||
to a valid iterator pointing to <em class="parameter"><code>path</code></em>
|
||
. If <em class="parameter"><code>path</code></em>
|
||
does
|
||
not exist, <em class="parameter"><code>iter</code></em>
|
||
is set to an invalid iterator and <code class="literal">FALSE</code> is returned.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-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</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>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the uninitialized <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct 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>path</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-iter.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em>
|
||
was set</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-get-iter-from-string"></a><h3>gtk_tree_model_get_iter_from_string ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_model_get_iter_from_string (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *path_string</code></em>);</pre>
|
||
<p>Sets <em class="parameter"><code>iter</code></em>
|
||
to a valid iterator pointing to <em class="parameter"><code>path_string</code></em>
|
||
, if it
|
||
exists. Otherwise, <em class="parameter"><code>iter</code></em>
|
||
is left invalid and <code class="literal">FALSE</code> is returned.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-iter-from-string.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>an uninitialized <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct 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>path_string</p></td>
|
||
<td class="parameter_description"><p>a string representation of a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-iter-from-string.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em>
|
||
was set</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-get-iter-first"></a><h3>gtk_tree_model_get_iter_first ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_model_get_iter_first (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Initializes <em class="parameter"><code>iter</code></em>
|
||
with the first iterator in the tree
|
||
(the one at the path "0") and returns <code class="literal">TRUE</code>. Returns
|
||
<code class="literal">FALSE</code> if the tree is empty.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-iter-first.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the uninitialized <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct 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>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-iter-first.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em>
|
||
was set</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-get-path"></a><h3>gtk_tree_model_get_path ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="returnvalue">GtkTreePath</span></a> *
|
||
gtk_tree_model_get_path (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Returns a newly-created <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> referenced by <em class="parameter"><code>iter</code></em>
|
||
.</p>
|
||
<p>This path should be freed with <a class="link" href="GtkTreeModel.html#gtk-tree-path-free" title="gtk_tree_path_free ()"><code class="function">gtk_tree_path_free()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-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</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>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct 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-get-path.returns"></a><h4>Returns</h4>
|
||
<p> a newly-created <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-get-value"></a><h3>gtk_tree_model_get_value ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_model_get_value (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> column</code></em>,
|
||
<em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
|
||
<p>Initializes and sets <em class="parameter"><code>value</code></em>
|
||
to that at <em class="parameter"><code>column</code></em>
|
||
.</p>
|
||
<p>When done with <em class="parameter"><code>value</code></em>
|
||
, <code class="function">g_value_unset()</code> needs to be called
|
||
to free any allocated memory.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-value.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>column</p></td>
|
||
<td class="parameter_description"><p>the column to lookup the value at</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>value</p></td>
|
||
<td class="parameter_description"><p>an empty <span class="type">GValue</span> to set. </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>][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-iter-next"></a><h3>gtk_tree_model_iter_next ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_model_iter_next (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Sets <em class="parameter"><code>iter</code></em>
|
||
to point to the node following it at the current level.</p>
|
||
<p>If there is no next <em class="parameter"><code>iter</code></em>
|
||
, <code class="literal">FALSE</code> is returned and <em class="parameter"><code>iter</code></em>
|
||
is set
|
||
to be invalid.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-next.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-next.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em>
|
||
has been changed to the next node</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-iter-previous"></a><h3>gtk_tree_model_iter_previous ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_model_iter_previous (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Sets <em class="parameter"><code>iter</code></em>
|
||
to point to the previous node at the current level.</p>
|
||
<p>If there is no previous <em class="parameter"><code>iter</code></em>
|
||
, <code class="literal">FALSE</code> is returned and <em class="parameter"><code>iter</code></em>
|
||
is
|
||
set to be invalid.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-previous.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-previous.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em>
|
||
has been changed to the previous node</p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-iter-children"></a><h3>gtk_tree_model_iter_children ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_model_iter_children (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *parent</code></em>);</pre>
|
||
<p>Sets <em class="parameter"><code>iter</code></em>
|
||
to point to the first child of <em class="parameter"><code>parent</code></em>
|
||
.</p>
|
||
<p>If <em class="parameter"><code>parent</code></em>
|
||
has no children, <code class="literal">FALSE</code> is returned and <em class="parameter"><code>iter</code></em>
|
||
is
|
||
set to be invalid. <em class="parameter"><code>parent</code></em>
|
||
will remain a valid node after this
|
||
function has been called.</p>
|
||
<p>If <em class="parameter"><code>parent</code></em>
|
||
is <code class="literal">NULL</code> returns the first node, equivalent to
|
||
<code class="literal">gtk_tree_model_get_iter_first (tree_model, iter);</code></p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-children.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the new <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> to be set to the child. </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>parent</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a>, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-children.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em>
|
||
has been set to the first child</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-iter-has-child"></a><h3>gtk_tree_model_iter_has_child ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_model_iter_has_child (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Returns <code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em>
|
||
has children, <code class="literal">FALSE</code> otherwise.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-has-child.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> to test for children</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-has-child.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em>
|
||
has children</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-iter-n-children"></a><h3>gtk_tree_model_iter_n_children ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gint</span>
|
||
gtk_tree_model_iter_n_children (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Returns the number of children that <em class="parameter"><code>iter</code></em>
|
||
has.</p>
|
||
<p>As a special case, if <em class="parameter"><code>iter</code></em>
|
||
is <code class="literal">NULL</code>, then the number
|
||
of toplevel nodes is returned.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-n-children.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a>, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-n-children.returns"></a><h4>Returns</h4>
|
||
<p> the number of children of <em class="parameter"><code>iter</code></em>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-iter-nth-child"></a><h3>gtk_tree_model_iter_nth_child ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_model_iter_nth_child (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *parent</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> n</code></em>);</pre>
|
||
<p>Sets <em class="parameter"><code>iter</code></em>
|
||
to be the child of <em class="parameter"><code>parent</code></em>
|
||
, using the given index.</p>
|
||
<p>The first index is 0. If <em class="parameter"><code>n</code></em>
|
||
is too big, or <em class="parameter"><code>parent</code></em>
|
||
has no children,
|
||
<em class="parameter"><code>iter</code></em>
|
||
is set to an invalid iterator and <code class="literal">FALSE</code> is returned. <em class="parameter"><code>parent</code></em>
|
||
|
||
will remain a valid node after this function has been called. As a
|
||
special case, if <em class="parameter"><code>parent</code></em>
|
||
is <code class="literal">NULL</code>, then the <em class="parameter"><code>n</code></em>
|
||
-th root node
|
||
is set.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-nth-child.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> to set to the nth child. </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>parent</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> to get the child from, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>n</p></td>
|
||
<td class="parameter_description"><p>the index of the desired child</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-nth-child.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code>, if <em class="parameter"><code>parent</code></em>
|
||
has an <em class="parameter"><code>n</code></em>
|
||
-th child</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-iter-parent"></a><h3>gtk_tree_model_iter_parent ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_model_iter_parent (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *child</code></em>);</pre>
|
||
<p>Sets <em class="parameter"><code>iter</code></em>
|
||
to be the parent of <em class="parameter"><code>child</code></em>
|
||
.</p>
|
||
<p>If <em class="parameter"><code>child</code></em>
|
||
is at the toplevel, and doesn’t have a parent, then
|
||
<em class="parameter"><code>iter</code></em>
|
||
is set to an invalid iterator and <code class="literal">FALSE</code> is returned.
|
||
<em class="parameter"><code>child</code></em>
|
||
will remain a valid node after this function has been
|
||
called.</p>
|
||
<p><em class="parameter"><code>iter</code></em>
|
||
will be initialized before the lookup is performed, so <em class="parameter"><code>child</code></em>
|
||
|
||
and <em class="parameter"><code>iter</code></em>
|
||
cannot point to the same memory location.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-iter-parent.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the new <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> to set to the parent. </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</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct 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-iter-parent.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em>
|
||
is set to the parent of <em class="parameter"><code>child</code></em>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-get-string-from-iter"></a><h3>gtk_tree_model_get_string_from_iter ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gchar</span> *
|
||
gtk_tree_model_get_string_from_iter (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Generates a string representation of the iter.</p>
|
||
<p>This string is a “:” separated list of numbers.
|
||
For example, “4:10:0:3” would be an acceptable
|
||
return value for this string.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-string-from-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</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>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct 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-get-string-from-iter.returns"></a><h4>Returns</h4>
|
||
<p> a newly-allocated string.
|
||
Must be freed with <code class="function">g_free()</code>.</p>
|
||
</div>
|
||
<p class="since">Since: 2.2</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-ref-node"></a><h3>gtk_tree_model_ref_node ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_model_ref_node (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Lets the tree ref the node.</p>
|
||
<p>This is an optional method for models to implement.
|
||
To be more specific, models may ignore this call as it exists
|
||
primarily for performance reasons.</p>
|
||
<p>This function is primarily meant as a way for views to let
|
||
caching models know when nodes are being displayed (and hence,
|
||
whether or not to cache that node). Being displayed means a node
|
||
is in an expanded branch, regardless of whether the node is currently
|
||
visible in the viewport. For example, a file-system based model
|
||
would not want to keep the entire file-hierarchy in memory,
|
||
just the sections that are currently being displayed by
|
||
every current view.</p>
|
||
<p>A model should be expected to be able to get an iter independent
|
||
of its reffed state.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-ref-node.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-unref-node"></a><h3>gtk_tree_model_unref_node ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_model_unref_node (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Lets the tree unref the node.</p>
|
||
<p>This is an optional method for models to implement.
|
||
To be more specific, models may ignore this call as it exists
|
||
primarily for performance reasons. For more information on what
|
||
this means, see <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>.</p>
|
||
<p>Please note that nodes that are deleted are not unreffed.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-unref-node.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-get"></a><h3>gtk_tree_model_get ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_model_get (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
|
||
<em class="parameter"><code>...</code></em>);</pre>
|
||
<p>Gets the value of one or more cells in the row referenced by <em class="parameter"><code>iter</code></em>
|
||
.
|
||
The variable argument list should contain integer column numbers,
|
||
each column number followed by a place to store the value being
|
||
retrieved. The list is terminated by a -1. For example, to get a
|
||
value from column 0 with type <code class="literal">G_TYPE_STRING</code>, you would
|
||
write: <code class="literal">gtk_tree_model_get (model, iter, 0, &amp;place_string_here, -1)</code>,
|
||
where <code class="literal">place_string_here</code> is a <span class="type">gchararray</span>
|
||
to be filled with the string.</p>
|
||
<p>Returned values with type <code class="literal">G_TYPE_OBJECT</code> have to be unreferenced,
|
||
values with type <code class="literal">G_TYPE_STRING</code> or <code class="literal">G_TYPE_BOXED</code> have to be freed.
|
||
Other values are passed by value.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</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 row in <em class="parameter"><code>tree_model</code></em>
|
||
</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>...</p></td>
|
||
<td class="parameter_description"><p>pairs of column number and value return locations,
|
||
terminated by -1</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-get-valist"></a><h3>gtk_tree_model_get_valist ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_model_get_valist (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
|
||
<em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
|
||
<p>See <a class="link" href="GtkTreeModel.html#gtk-tree-model-get" title="gtk_tree_model_get ()"><code class="function">gtk_tree_model_get()</code></a>, this version takes a va_list
|
||
for language bindings to use.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-get-valist.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</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 row in <em class="parameter"><code>tree_model</code></em>
|
||
</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>var_args</p></td>
|
||
<td class="parameter_description"><p>va_list of column/return location pairs</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-foreach"></a><h3>gtk_tree_model_foreach ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_model_foreach (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeModelForeachFunc" title="GtkTreeModelForeachFunc ()"><span class="type">GtkTreeModelForeachFunc</span></a> func</code></em>,
|
||
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
|
||
<p>Calls func on each node in model in a depth-first fashion.</p>
|
||
<p>If <em class="parameter"><code>func</code></em>
|
||
returns <code class="literal">TRUE</code>, then the tree ceases to be walked,
|
||
and <a class="link" href="GtkTreeModel.html#gtk-tree-model-foreach" title="gtk_tree_model_foreach ()"><code class="function">gtk_tree_model_foreach()</code></a> returns.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-foreach.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>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>
|
||
<tr>
|
||
<td class="parameter_name"><p>func</p></td>
|
||
<td class="parameter_description"><p>a function to be called on each row. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data to passed to <em class="parameter"><code>func</code></em>
|
||
</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-row-changed"></a><h3>gtk_tree_model_row_changed ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_model_row_changed (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Emits the <a class="link" href="GtkTreeModel.html#GtkTreeModel-row-changed" title="The “row-changed” signal"><span class="type">“row-changed”</span></a> signal on <em class="parameter"><code>tree_model</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-row-changed.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> pointing to the changed row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>a valid <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to the changed row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-row-inserted"></a><h3>gtk_tree_model_row_inserted ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_model_row_inserted (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Emits the <a class="link" href="GtkTreeModel.html#GtkTreeModel-row-inserted" title="The “row-inserted” signal"><span class="type">“row-inserted”</span></a> signal on <em class="parameter"><code>tree_model</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-row-inserted.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> pointing to the inserted row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>a valid <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to the inserted row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-row-has-child-toggled"></a><h3>gtk_tree_model_row_has_child_toggled ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_model_row_has_child_toggled (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Emits the <a class="link" href="GtkTreeModel.html#GtkTreeModel-row-has-child-toggled" title="The “row-has-child-toggled” signal"><span class="type">“row-has-child-toggled”</span></a> signal on
|
||
<em class="parameter"><code>tree_model</code></em>
|
||
. This should be called by models after the child
|
||
state of a node changes.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-row-has-child-toggled.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> pointing to the changed row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>a valid <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to the changed row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-row-deleted"></a><h3>gtk_tree_model_row_deleted ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_model_row_deleted (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
|
||
<p>Emits the <a class="link" href="GtkTreeModel.html#GtkTreeModel-row-deleted" title="The “row-deleted” signal"><span class="type">“row-deleted”</span></a> signal on <em class="parameter"><code>tree_model</code></em>
|
||
.</p>
|
||
<p>This should be called by models after a row has been removed.
|
||
The location pointed to by <em class="parameter"><code>path</code></em>
|
||
should be the location that
|
||
the row previously was at. It may not be a valid location anymore.</p>
|
||
<p>Nodes that are deleted are not unreffed, this means that any
|
||
outstanding references on the deleted node should not be released.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-row-deleted.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> pointing to the previous location of
|
||
the deleted row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-rows-reordered"></a><h3>gtk_tree_model_rows_reordered ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_model_rows_reordered (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> *new_order</code></em>);</pre>
|
||
<p>Emits the <a class="link" href="GtkTreeModel.html#GtkTreeModel-rows-reordered" title="The “rows-reordered” signal"><span class="type">“rows-reordered”</span></a> signal on <em class="parameter"><code>tree_model</code></em>
|
||
.</p>
|
||
<p>This should be called by models when their rows have been
|
||
reordered.</p>
|
||
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-rows-reordered.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> pointing to the tree node whose children
|
||
have been reordered</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>a valid <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to the node whose children
|
||
have been reordered, or <code class="literal">NULL</code> if the depth of <em class="parameter"><code>path</code></em>
|
||
is 0</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>new_order</p></td>
|
||
<td class="parameter_description"><p>an array of integers mapping the current position of
|
||
each child to its old position before the re-ordering,
|
||
i.e. <em class="parameter"><code>new_order</code></em>
|
||
<code class="literal">[newpos] = oldpos</code></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-model-rows-reordered-with-length"></a><h3>gtk_tree_model_rows_reordered_with_length ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_model_rows_reordered_with_length
|
||
(<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> *new_order</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> length</code></em>);</pre>
|
||
<p>Emits the <a class="link" href="GtkTreeModel.html#GtkTreeModel-rows-reordered" title="The “rows-reordered” signal"><span class="type">“rows-reordered”</span></a> signal on <em class="parameter"><code>tree_model</code></em>
|
||
.</p>
|
||
<p>This should be called by models when their rows have been
|
||
reordered.</p>
|
||
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> gtk_tree_model_rows_reordered]</span></p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-model-rows-reordered-with-length.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="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> pointing to the tree node whose children
|
||
have been reordered</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>a valid <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to the node
|
||
whose children have been reordered, or <code class="literal">NULL</code> if the depth
|
||
of <em class="parameter"><code>path</code></em>
|
||
is 0. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>new_order</p></td>
|
||
<td class="parameter_description"><p>an array of integers
|
||
mapping the current position of each child to its old
|
||
position before the re-ordering,
|
||
i.e. <em class="parameter"><code>new_order</code></em>
|
||
<code class="literal">[newpos] = oldpos</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>length</p></td>
|
||
<td class="parameter_description"><p>length of <em class="parameter"><code>new_order</code></em>
|
||
array</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeModel.other_details"></a><h2>Types and Values</h2>
|
||
<div class="refsect2">
|
||
<a name="GtkTreeModel-struct"></a><h3>GtkTreeModel</h3>
|
||
<pre class="programlisting">typedef struct _GtkTreeModel GtkTreeModel;</pre>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkTreeIter-struct"></a><h3>struct GtkTreeIter</h3>
|
||
<pre class="programlisting">struct GtkTreeIter {
|
||
gint stamp;
|
||
gpointer user_data;
|
||
gpointer user_data2;
|
||
gpointer user_data3;
|
||
};
|
||
</pre>
|
||
<p>The <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> is the primary structure
|
||
for accessing a <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a>. Models are expected to put a unique
|
||
integer in the <em class="parameter"><code>stamp</code></em>
|
||
member, and put
|
||
model-specific data in the three <em class="parameter"><code>user_data</code></em>
|
||
|
||
members.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkTreeIter.members"></a><h4>Members</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="300px" class="struct_members_name">
|
||
<col class="struct_members_description">
|
||
<col width="200px" class="struct_members_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GtkTreeIter-struct.stamp"></a>stamp</code></em>;</p></td>
|
||
<td class="struct_member_description"><p>a unique stamp to catch invalid iterators</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><span class="type">gpointer</span> <em class="structfield"><code><a name="GtkTreeIter-struct.user-data"></a>user_data</code></em>;</p></td>
|
||
<td class="struct_member_description"><p>model-specific data</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><span class="type">gpointer</span> <em class="structfield"><code><a name="GtkTreeIter-struct.user-data2"></a>user_data2</code></em>;</p></td>
|
||
<td class="struct_member_description"><p>model-specific data</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><span class="type">gpointer</span> <em class="structfield"><code><a name="GtkTreeIter-struct.user-data3"></a>user_data3</code></em>;</p></td>
|
||
<td class="struct_member_description"><p>model-specific data</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkTreePath-struct"></a><h3>GtkTreePath</h3>
|
||
<pre class="programlisting">typedef struct _GtkTreePath GtkTreePath;</pre>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkTreeRowReference"></a><h3>GtkTreeRowReference</h3>
|
||
<pre class="programlisting">typedef struct _GtkTreeRowReference GtkTreeRowReference;</pre>
|
||
<p>A GtkTreeRowReference tracks model changes so that it always refers to the
|
||
same row (a <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> refers to a position, not a fixed row). Create a
|
||
new GtkTreeRowReference with <a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-new" title="gtk_tree_row_reference_new ()"><code class="function">gtk_tree_row_reference_new()</code></a>.</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkTreeModelIface"></a><h3>struct GtkTreeModelIface</h3>
|
||
<pre class="programlisting">struct GtkTreeModelIface {
|
||
/* Signals */
|
||
void (* row_changed) (GtkTreeModel *tree_model,
|
||
GtkTreePath *path,
|
||
GtkTreeIter *iter);
|
||
void (* row_inserted) (GtkTreeModel *tree_model,
|
||
GtkTreePath *path,
|
||
GtkTreeIter *iter);
|
||
void (* row_has_child_toggled) (GtkTreeModel *tree_model,
|
||
GtkTreePath *path,
|
||
GtkTreeIter *iter);
|
||
void (* row_deleted) (GtkTreeModel *tree_model,
|
||
GtkTreePath *path);
|
||
void (* rows_reordered) (GtkTreeModel *tree_model,
|
||
GtkTreePath *path,
|
||
GtkTreeIter *iter,
|
||
gint *new_order);
|
||
|
||
/* Virtual Table */
|
||
GtkTreeModelFlags (* get_flags) (GtkTreeModel *tree_model);
|
||
|
||
gint (* get_n_columns) (GtkTreeModel *tree_model);
|
||
GType (* get_column_type) (GtkTreeModel *tree_model,
|
||
gint index_);
|
||
gboolean (* get_iter) (GtkTreeModel *tree_model,
|
||
GtkTreeIter *iter,
|
||
GtkTreePath *path);
|
||
GtkTreePath *(* get_path) (GtkTreeModel *tree_model,
|
||
GtkTreeIter *iter);
|
||
void (* get_value) (GtkTreeModel *tree_model,
|
||
GtkTreeIter *iter,
|
||
gint column,
|
||
GValue *value);
|
||
gboolean (* iter_next) (GtkTreeModel *tree_model,
|
||
GtkTreeIter *iter);
|
||
gboolean (* iter_previous) (GtkTreeModel *tree_model,
|
||
GtkTreeIter *iter);
|
||
gboolean (* iter_children) (GtkTreeModel *tree_model,
|
||
GtkTreeIter *iter,
|
||
GtkTreeIter *parent);
|
||
gboolean (* iter_has_child) (GtkTreeModel *tree_model,
|
||
GtkTreeIter *iter);
|
||
gint (* iter_n_children) (GtkTreeModel *tree_model,
|
||
GtkTreeIter *iter);
|
||
gboolean (* iter_nth_child) (GtkTreeModel *tree_model,
|
||
GtkTreeIter *iter,
|
||
GtkTreeIter *parent,
|
||
gint n);
|
||
gboolean (* iter_parent) (GtkTreeModel *tree_model,
|
||
GtkTreeIter *iter,
|
||
GtkTreeIter *child);
|
||
void (* ref_node) (GtkTreeModel *tree_model,
|
||
GtkTreeIter *iter);
|
||
void (* unref_node) (GtkTreeModel *tree_model,
|
||
GtkTreeIter *iter);
|
||
};
|
||
</pre>
|
||
<div class="refsect3">
|
||
<a name="GtkTreeModelIface.members"></a><h4>Members</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="300px" class="struct_members_name">
|
||
<col class="struct_members_description">
|
||
<col width="200px" class="struct_members_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.row-changed"></a>row_changed</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Signal emitted when a row in the model has changed.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.row-inserted"></a>row_inserted</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Signal emitted when a new row has been inserted in
|
||
the model.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.row-has-child-toggled"></a>row_has_child_toggled</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Signal emitted when a row has gotten the
|
||
first child row or lost its last child row.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.row-deleted"></a>row_deleted</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Signal emitted when a row has been deleted.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.rows-reordered"></a>rows_reordered</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Signal emitted when the children of a node in the
|
||
GtkTreeModel have been reordered.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.get-flags"></a>get_flags</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Get <a class="link" href="GtkTreeModel.html#GtkTreeModelFlags" title="enum GtkTreeModelFlags"><span class="type">GtkTreeModelFlags</span></a> supported by this interface.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.get-n-columns"></a>get_n_columns</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Get the number of columns supported by the model.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.get-column-type"></a>get_column_type</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Get the type of the column.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.get-iter"></a>get_iter</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Sets iter to a valid iterator pointing to path.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.get-path"></a>get_path</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Gets a newly-created <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> referenced by iter.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.get-value"></a>get_value</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Initializes and sets value to that at column.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.iter-next"></a>iter_next</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Sets iter to point to the node following it at the
|
||
current level.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.iter-previous"></a>iter_previous</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Sets iter to point to the previous node at the
|
||
current level.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.iter-children"></a>iter_children</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Sets iter to point to the first child of parent.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.iter-has-child"></a>iter_has_child</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p><code class="literal">TRUE</code> if iter has children, <code class="literal">FALSE</code> otherwise.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.iter-n-children"></a>iter_n_children</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Gets the number of children that iter has.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.iter-nth-child"></a>iter_nth_child</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Sets iter to be the child of parent, using the
|
||
given index.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.iter-parent"></a>iter_parent</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Sets iter to be the parent of child.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.ref-node"></a>ref_node</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Lets the tree ref the node.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkTreeModelIface.unref-node"></a>unref_node</code></em> ()</p></td>
|
||
<td class="struct_member_description"><p>Lets the tree unref the node.</p></td>
|
||
<td class="struct_member_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkTreeModelFlags"></a><h3>enum GtkTreeModelFlags</h3>
|
||
<p>These flags indicate various properties of a <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a>.</p>
|
||
<p>They are returned by <a class="link" href="GtkTreeModel.html#gtk-tree-model-get-flags" title="gtk_tree_model_get_flags ()"><code class="function">gtk_tree_model_get_flags()</code></a>, and must be
|
||
static for the lifetime of the object. A more complete description
|
||
of <a class="link" href="GtkTreeModel.html#GTK-TREE-MODEL-ITERS-PERSIST:CAPS"><span class="type">GTK_TREE_MODEL_ITERS_PERSIST</span></a> can be found in the overview of
|
||
this section.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkTreeModelFlags.members"></a><h4>Members</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="300px" class="enum_members_name">
|
||
<col class="enum_members_description">
|
||
<col width="200px" class="enum_members_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="enum_member_name"><p><a name="GTK-TREE-MODEL-ITERS-PERSIST:CAPS"></a>GTK_TREE_MODEL_ITERS_PERSIST</p></td>
|
||
<td class="enum_member_description">
|
||
<p>iterators survive all signals
|
||
emitted by the tree</p>
|
||
</td>
|
||
<td class="enum_member_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="enum_member_name"><p><a name="GTK-TREE-MODEL-LIST-ONLY:CAPS"></a>GTK_TREE_MODEL_LIST_ONLY</p></td>
|
||
<td class="enum_member_description">
|
||
<p>the model is a list only, and never
|
||
has children</p>
|
||
</td>
|
||
<td class="enum_member_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeModel.signal-details"></a><h2>Signal Details</h2>
|
||
<div class="refsect2">
|
||
<a name="GtkTreeModel-row-changed"></a><h3>The <code class="literal">“row-changed”</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
user_function (<a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model,
|
||
<a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path,
|
||
<a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter,
|
||
<span class="type">gpointer</span> user_data)</pre>
|
||
<p>This signal is emitted when a row in the model has changed.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkTreeModel-row-changed.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>the <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> on which the signal is emitted</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> identifying the changed row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>a valid <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to the changed row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p>Flags: Run Last</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkTreeModel-row-deleted"></a><h3>The <code class="literal">“row-deleted”</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
user_function (<a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model,
|
||
<a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path,
|
||
<span class="type">gpointer</span> user_data)</pre>
|
||
<p>This signal is emitted when a row has been deleted.</p>
|
||
<p>Note that no iterator is passed to the signal handler,
|
||
since the row is already deleted.</p>
|
||
<p>This should be called by models after a row has been removed.
|
||
The location pointed to by <em class="parameter"><code>path</code></em>
|
||
should be the location that
|
||
the row previously was at. It may not be a valid location anymore.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkTreeModel-row-deleted.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>the <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> on which the signal is emitted</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> identifying the row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p>Flags: Run First</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkTreeModel-row-has-child-toggled"></a><h3>The <code class="literal">“row-has-child-toggled”</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
user_function (<a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model,
|
||
<a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path,
|
||
<a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter,
|
||
<span class="type">gpointer</span> user_data)</pre>
|
||
<p>This signal is emitted when a row has gotten the first child
|
||
row or lost its last child row.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkTreeModel-row-has-child-toggled.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>the <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> on which the signal is emitted</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> identifying the row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>a valid <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to the row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p>Flags: Run Last</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkTreeModel-row-inserted"></a><h3>The <code class="literal">“row-inserted”</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
user_function (<a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model,
|
||
<a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path,
|
||
<a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter,
|
||
<span class="type">gpointer</span> user_data)</pre>
|
||
<p>This signal is emitted when a new row has been inserted in
|
||
the model.</p>
|
||
<p>Note that the row may still be empty at this point, since
|
||
it is a common pattern to first insert an empty row, and
|
||
then fill it with the desired values.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkTreeModel-row-inserted.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>the <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> on which the signal is emitted</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> identifying the new row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>a valid <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to the new row</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p>Flags: Run First</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkTreeModel-rows-reordered"></a><h3>The <code class="literal">“rows-reordered”</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
user_function (<a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *tree_model,
|
||
<a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path,
|
||
<a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter,
|
||
<span class="type">gpointer</span> new_order,
|
||
<span class="type">gpointer</span> user_data)</pre>
|
||
<p>This signal is emitted when the children of a node in the
|
||
<a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> have been reordered.</p>
|
||
<p>Note that this signal is not emitted
|
||
when rows are reordered by DND, since this is implemented
|
||
by removing and then reinserting the row.</p>
|
||
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
|
||
<div class="refsect3">
|
||
<a name="GtkTreeModel-rows-reordered.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>the <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> on which the signal is emitted</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>path</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeModel.html#GtkTreePath-struct" title="GtkTreePath"><span class="type">GtkTreePath</span></a> identifying the tree node whose children
|
||
have been reordered</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>a valid <a class="link" href="GtkTreeModel.html#GtkTreeIter-struct" title="struct GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to the node whose children
|
||
have been reordered, or <code class="literal">NULL</code> if the depth of <em class="parameter"><code>path</code></em>
|
||
is 0</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>new_order</p></td>
|
||
<td class="parameter_description"><p>an array of integers mapping the current position
|
||
of each child to its old position before the re-ordering,
|
||
i.e. <em class="parameter"><code>new_order</code></em>
|
||
<code class="literal">[newpos] = oldpos</code></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p>Flags: Run First</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeModel.see-also"></a><h2>See Also</h2>
|
||
<p><a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a>, <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a>, <a class="link" href="GtkListStore.html" title="GtkListStore"><span class="type">GtkListStore</span></a>,
|
||
<a class="link" href="gtk3-GtkTreeView-drag-and-drop.html" title="GtkTreeView drag-and-drop">GtkTreeView drag-and-drop</a>
|
||
<a class="link" href="GtkTreeSortable.html" title="GtkTreeSortable"><span class="type">GtkTreeSortable</span></a></p>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>Generated by GTK-Doc V1.33.1</div>
|
||
</body>
|
||
</html> |