1389 lines
75 KiB
HTML
1389 lines
75 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>GtkTreeStore: 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="GtkListStore.html" title="GtkListStore">
|
||
<link rel="next" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
|
||
<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="#GtkTreeStore.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||
<a href="#GtkTreeStore.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
|
||
<a href="#GtkTreeStore.implemented-interfaces" class="shortcut">Implemented Interfaces</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="GtkListStore.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="n" href="MenusAndCombos.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
|
||
</tr></table>
|
||
<div class="refentry">
|
||
<a name="GtkTreeStore"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="GtkTreeStore.top_of_page"></a>GtkTreeStore</span></h2>
|
||
<p>GtkTreeStore — A tree-like data structure that can be used with the GtkTreeView</p>
|
||
</td>
|
||
<td class="gallery_image" valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeStore.functions"></a><h2>Functions</h2>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="functions_proto_type">
|
||
<col class="functions_proto_name">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="returnvalue">GtkTreeStore</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeStore.html#gtk-tree-store-new" title="gtk_tree_store_new ()">gtk_tree_store_new</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="returnvalue">GtkTreeStore</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkTreeStore.html#gtk-tree-store-newv" title="gtk_tree_store_newv ()">gtk_tree_store_newv</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="GtkTreeStore.html#gtk-tree-store-set-column-types" title="gtk_tree_store_set_column_types ()">gtk_tree_store_set_column_types</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="GtkTreeStore.html#gtk-tree-store-set-value" title="gtk_tree_store_set_value ()">gtk_tree_store_set_value</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="GtkTreeStore.html#gtk-tree-store-set" title="gtk_tree_store_set ()">gtk_tree_store_set</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="GtkTreeStore.html#gtk-tree-store-set-valist" title="gtk_tree_store_set_valist ()">gtk_tree_store_set_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="GtkTreeStore.html#gtk-tree-store-set-valuesv" title="gtk_tree_store_set_valuesv ()">gtk_tree_store_set_valuesv</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="GtkTreeStore.html#gtk-tree-store-remove" title="gtk_tree_store_remove ()">gtk_tree_store_remove</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="GtkTreeStore.html#gtk-tree-store-insert" title="gtk_tree_store_insert ()">gtk_tree_store_insert</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="GtkTreeStore.html#gtk-tree-store-insert-before" title="gtk_tree_store_insert_before ()">gtk_tree_store_insert_before</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="GtkTreeStore.html#gtk-tree-store-insert-after" title="gtk_tree_store_insert_after ()">gtk_tree_store_insert_after</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="GtkTreeStore.html#gtk-tree-store-insert-with-values" title="gtk_tree_store_insert_with_values ()">gtk_tree_store_insert_with_values</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="GtkTreeStore.html#gtk-tree-store-insert-with-valuesv" title="gtk_tree_store_insert_with_valuesv ()">gtk_tree_store_insert_with_valuesv</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="GtkTreeStore.html#gtk-tree-store-prepend" title="gtk_tree_store_prepend ()">gtk_tree_store_prepend</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="GtkTreeStore.html#gtk-tree-store-append" title="gtk_tree_store_append ()">gtk_tree_store_append</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="GtkTreeStore.html#gtk-tree-store-is-ancestor" title="gtk_tree_store_is_ancestor ()">gtk_tree_store_is_ancestor</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="GtkTreeStore.html#gtk-tree-store-iter-depth" title="gtk_tree_store_iter_depth ()">gtk_tree_store_iter_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="GtkTreeStore.html#gtk-tree-store-clear" title="gtk_tree_store_clear ()">gtk_tree_store_clear</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="GtkTreeStore.html#gtk-tree-store-iter-is-valid" title="gtk_tree_store_iter_is_valid ()">gtk_tree_store_iter_is_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="GtkTreeStore.html#gtk-tree-store-reorder" title="gtk_tree_store_reorder ()">gtk_tree_store_reorder</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="GtkTreeStore.html#gtk-tree-store-swap" title="gtk_tree_store_swap ()">gtk_tree_store_swap</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="GtkTreeStore.html#gtk-tree-store-move-before" title="gtk_tree_store_move_before ()">gtk_tree_store_move_before</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="GtkTreeStore.html#gtk-tree-store-move-after" title="gtk_tree_store_move_after ()">gtk_tree_store_move_after</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeStore.other"></a><h2>Types and Values</h2>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="other_proto_type">
|
||
<col class="other_proto_name">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="datatype_keyword">struct</td>
|
||
<td class="function_name"><a class="link" href="GtkTreeStore.html#GtkTreeStore-struct" title="struct GtkTreeStore">GtkTreeStore</a></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeStore.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||
<pre class="screen"> GObject
|
||
<span class="lineart">╰──</span> GtkTreeStore
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeStore.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
|
||
<p>
|
||
GtkTreeStore implements
|
||
<a class="link" href="GtkTreeModel.html" title="GtkTreeModel">GtkTreeModel</a>, <a class="link" href="gtk3-GtkTreeView-drag-and-drop.html#GtkTreeDragSource">GtkTreeDragSource</a>, <a class="link" href="gtk3-GtkTreeView-drag-and-drop.html#GtkTreeDragDest">GtkTreeDragDest</a>, <a class="link" href="GtkTreeSortable.html" title="GtkTreeSortable">GtkTreeSortable</a> and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeStore.includes"></a><h2>Includes</h2>
|
||
<pre class="synopsis">#include <gtk/gtk.h>
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeStore.description"></a><h2>Description</h2>
|
||
<p>The <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> object is a list model for use with a <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a>
|
||
widget. It implements the <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> interface, and consequentially,
|
||
can use all of the methods available there. It also implements the
|
||
<a class="link" href="GtkTreeSortable.html" title="GtkTreeSortable"><span class="type">GtkTreeSortable</span></a> interface so it can be sorted by the view. Finally,
|
||
it also implements the tree
|
||
<a class="link" href="gtk3-GtkTreeView-drag-and-drop.html" title="GtkTreeView drag-and-drop">drag and drop</a>
|
||
interfaces.</p>
|
||
<div class="refsect2">
|
||
<a name="id-1.3.12.28.8.3"></a><h3>GtkTreeStore as GtkBuildable</h3>
|
||
<p>The GtkTreeStore implementation of the <a class="link" href="GtkBuildable.html" title="GtkBuildable"><span class="type">GtkBuildable</span></a> interface allows
|
||
to specify the model columns with a <columns> element that may contain
|
||
multiple <column> elements, each specifying one model column. The “type”
|
||
attribute specifies the data type for the column.</p>
|
||
<p>An example of a UI Definition fragment for a tree store:</p>
|
||
<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</pre></td>
|
||
<td class="listing_code"><pre class="programlisting"><span class="o"><</span><span class="n">object</span> <span class="n">class</span><span class="o">=</span><span class="s">"GtkTreeStore"</span><span class="o">></span>
|
||
<span class="o"><</span><span class="n">columns</span><span class="o">></span>
|
||
<span class="o"><</span><span class="n">column</span> <span class="n">type</span><span class="o">=</span><span class="s">"gchararray"</span><span class="o">/></span>
|
||
<span class="o"><</span><span class="n">column</span> <span class="n">type</span><span class="o">=</span><span class="s">"gchararray"</span><span class="o">/></span>
|
||
<span class="o"><</span><span class="n">column</span> <span class="n">type</span><span class="o">=</span><span class="s">"gint"</span><span class="o">/></span>
|
||
<span class="o"></</span><span class="n">columns</span><span class="o">></span>
|
||
<span class="o"></</span><span class="n">object</span><span class="o">></span></pre></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<p></p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeStore.functions_details"></a><h2>Functions</h2>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-new"></a><h3>gtk_tree_store_new ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="returnvalue">GtkTreeStore</span></a> *
|
||
gtk_tree_store_new (<em class="parameter"><code><span class="type">gint</span> n_columns</code></em>,
|
||
<em class="parameter"><code>...</code></em>);</pre>
|
||
<p>Creates a new tree store as with <em class="parameter"><code>n_columns</code></em>
|
||
columns each of the types passed
|
||
in. Note that only types derived from standard GObject fundamental types
|
||
are supported.</p>
|
||
<p>As an example, <code class="literal">gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
|
||
GDK_TYPE_PIXBUF);</code> will create a new <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> with three columns, of type
|
||
<span class="type">gint</span>, <span class="type">gchararray</span>, and <span class="type">GdkPixbuf</span> respectively.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-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>n_columns</p></td>
|
||
<td class="parameter_description"><p>number of columns in the tree store</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>...</p></td>
|
||
<td class="parameter_description"><p>all <span class="type">GType</span> types for the columns, from first to last</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-new.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-newv"></a><h3>gtk_tree_store_newv ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="returnvalue">GtkTreeStore</span></a> *
|
||
gtk_tree_store_newv (<em class="parameter"><code><span class="type">gint</span> n_columns</code></em>,
|
||
<em class="parameter"><code><span class="type">GType</span> *types</code></em>);</pre>
|
||
<p>Non vararg creation function. Used primarily by language bindings.</p>
|
||
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> gtk_tree_store_new]</span></p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-newv.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>n_columns</p></td>
|
||
<td class="parameter_description"><p>number of columns in the tree store</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>types</p></td>
|
||
<td class="parameter_description"><p>an array of <span class="type">GType</span> types for the columns, from first to last. </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=n_columns]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-newv.returns"></a><h4>Returns</h4>
|
||
<p>a new <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a>. </p>
|
||
<p><span class="annotation">[<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-store-set-column-types"></a><h3>gtk_tree_store_set_column_types ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_set_column_types (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> n_columns</code></em>,
|
||
<em class="parameter"><code><span class="type">GType</span> *types</code></em>);</pre>
|
||
<p>This function is meant primarily for <span class="type">GObjects</span> that inherit from
|
||
<a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a>, and should only be used when constructing a new
|
||
<a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a>. It will not function after a row has been added,
|
||
or a method on the <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> interface is called.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-set-column-types.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>n_columns</p></td>
|
||
<td class="parameter_description"><p>Number of columns for the tree store</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>types</p></td>
|
||
<td class="parameter_description"><p>An array of <span class="type">GType</span> types, one for each column. </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=n_columns]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-set-value"></a><h3>gtk_tree_store_set_value ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_set_value (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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>Sets the data in the cell specified by <em class="parameter"><code>iter</code></em>
|
||
and <em class="parameter"><code>column</code></em>
|
||
.
|
||
The type of <em class="parameter"><code>value</code></em>
|
||
must be convertible to the type of the
|
||
column.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-set-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_store</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 valid <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> for the row being modified</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>column</p></td>
|
||
<td class="parameter_description"><p>column number to modify</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>value</p></td>
|
||
<td class="parameter_description"><p>new value for the cell</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-set"></a><h3>gtk_tree_store_set ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_set (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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>Sets 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 the value to be set.
|
||
The list is terminated by a -1. For example, to set column 0 with type
|
||
<code class="literal">G_TYPE_STRING</code> to “Foo”, you would write
|
||
<code class="literal">gtk_tree_store_set (store, iter, 0, "Foo", -1)</code>.</p>
|
||
<p>The value will be referenced by the store if it is a <code class="literal">G_TYPE_OBJECT</code>, and it
|
||
will be copied if it is a <code class="literal">G_TYPE_STRING</code> or <code class="literal">G_TYPE_BOXED</code>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-set.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 valid <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> for the row being modified</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, terminated with -1</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-set-valist"></a><h3>gtk_tree_store_set_valist ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_set_valist (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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="GtkTreeStore.html#gtk-tree-store-set" title="gtk_tree_store_set ()"><code class="function">gtk_tree_store_set()</code></a>; this version takes a va_list for
|
||
use by language bindings.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-set-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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 valid <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> for the row being modified</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/value pairs</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-set-valuesv"></a><h3>gtk_tree_store_set_valuesv ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_set_valuesv (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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> *columns</code></em>,
|
||
<em class="parameter"><code><span class="type">GValue</span> *values</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> n_values</code></em>);</pre>
|
||
<p>A variant of <a class="link" href="GtkTreeStore.html#gtk-tree-store-set-valist" title="gtk_tree_store_set_valist ()"><code class="function">gtk_tree_store_set_valist()</code></a> which takes
|
||
the columns and values as two arrays, instead of varargs. This
|
||
function is mainly intended for language bindings or in case
|
||
the number of columns to change is not known until run-time.</p>
|
||
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> gtk_tree_store_set]</span></p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-set-valuesv.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 valid <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> for the row being modified</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>columns</p></td>
|
||
<td class="parameter_description"><p>an array of column numbers. </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=n_values]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>values</p></td>
|
||
<td class="parameter_description"><p>an array of GValues. </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=n_values]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>n_values</p></td>
|
||
<td class="parameter_description"><p>the length of the <em class="parameter"><code>columns</code></em>
|
||
and <em class="parameter"><code>values</code></em>
|
||
arrays</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.12</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-remove"></a><h3>gtk_tree_store_remove ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_store_remove (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>Removes <em class="parameter"><code>iter</code></em>
|
||
from <em class="parameter"><code>tree_store</code></em>
|
||
. After being removed, <em class="parameter"><code>iter</code></em>
|
||
is set to the
|
||
next valid row at that level, or invalidated if it previously pointed to the
|
||
last one.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-remove.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 valid <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-remove.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em>
|
||
is still valid, <code class="literal">FALSE</code> if not.</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-insert"></a><h3>gtk_tree_store_insert ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_insert (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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> position</code></em>);</pre>
|
||
<p>Creates a new row at <em class="parameter"><code>position</code></em>
|
||
. If parent is non-<code class="literal">NULL</code>, then the row will be
|
||
made a child of <em class="parameter"><code>parent</code></em>
|
||
. Otherwise, the row will be created at the toplevel.
|
||
If <em class="parameter"><code>position</code></em>
|
||
is -1 or is larger than the number of rows at that level, then
|
||
the new row will be inserted to the end of the list. <em class="parameter"><code>iter</code></em>
|
||
will be changed
|
||
to point to this new row. The row will be empty after this function is
|
||
called. To fill in values, you need to call <a class="link" href="GtkTreeStore.html#gtk-tree-store-set" title="gtk_tree_store_set ()"><code class="function">gtk_tree_store_set()</code></a> or
|
||
<a class="link" href="GtkTreeStore.html#gtk-tree-store-set-value" title="gtk_tree_store_set_value ()"><code class="function">gtk_tree_store_set_value()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-insert.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 unset <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> to set to the new row. </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>A valid <a class="link" href="GtkTreeModel.html#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>
|
||
<tr>
|
||
<td class="parameter_name"><p>position</p></td>
|
||
<td class="parameter_description"><p>position to insert the new row, or -1 for last</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-insert-before"></a><h3>gtk_tree_store_insert_before ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_insert_before (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *sibling</code></em>);</pre>
|
||
<p>Inserts a new row before <em class="parameter"><code>sibling</code></em>
|
||
. If <em class="parameter"><code>sibling</code></em>
|
||
is <code class="literal">NULL</code>, then the row will
|
||
be appended to <em class="parameter"><code>parent</code></em>
|
||
’s children. If <em class="parameter"><code>parent</code></em>
|
||
and <em class="parameter"><code>sibling</code></em>
|
||
are <code class="literal">NULL</code>, then
|
||
the row will be appended to the toplevel. If both <em class="parameter"><code>sibling</code></em>
|
||
and <em class="parameter"><code>parent</code></em>
|
||
are
|
||
set, then <em class="parameter"><code>parent</code></em>
|
||
must be the parent of <em class="parameter"><code>sibling</code></em>
|
||
. When <em class="parameter"><code>sibling</code></em>
|
||
is set,
|
||
<em class="parameter"><code>parent</code></em>
|
||
is optional.</p>
|
||
<p><em class="parameter"><code>iter</code></em>
|
||
will be changed to point to this new row. The row will be empty after
|
||
this function is called. To fill in values, you need to call
|
||
<a class="link" href="GtkTreeStore.html#gtk-tree-store-set" title="gtk_tree_store_set ()"><code class="function">gtk_tree_store_set()</code></a> or <a class="link" href="GtkTreeStore.html#gtk-tree-store-set-value" title="gtk_tree_store_set_value ()"><code class="function">gtk_tree_store_set_value()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-insert-before.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 unset <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> to set to the new row. </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>A valid <a class="link" href="GtkTreeModel.html#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>
|
||
<tr>
|
||
<td class="parameter_name"><p>sibling</p></td>
|
||
<td class="parameter_description"><p>A valid <a class="link" href="GtkTreeModel.html#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>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-insert-after"></a><h3>gtk_tree_store_insert_after ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_insert_after (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *sibling</code></em>);</pre>
|
||
<p>Inserts a new row after <em class="parameter"><code>sibling</code></em>
|
||
. If <em class="parameter"><code>sibling</code></em>
|
||
is <code class="literal">NULL</code>, then the row will be
|
||
prepended to <em class="parameter"><code>parent</code></em>
|
||
’s children. If <em class="parameter"><code>parent</code></em>
|
||
and <em class="parameter"><code>sibling</code></em>
|
||
are <code class="literal">NULL</code>, then
|
||
the row will be prepended to the toplevel. If both <em class="parameter"><code>sibling</code></em>
|
||
and <em class="parameter"><code>parent</code></em>
|
||
are
|
||
set, then <em class="parameter"><code>parent</code></em>
|
||
must be the parent of <em class="parameter"><code>sibling</code></em>
|
||
. When <em class="parameter"><code>sibling</code></em>
|
||
is set,
|
||
<em class="parameter"><code>parent</code></em>
|
||
is optional.</p>
|
||
<p><em class="parameter"><code>iter</code></em>
|
||
will be changed to point to this new row. The row will be empty after
|
||
this function is called. To fill in values, you need to call
|
||
<a class="link" href="GtkTreeStore.html#gtk-tree-store-set" title="gtk_tree_store_set ()"><code class="function">gtk_tree_store_set()</code></a> or <a class="link" href="GtkTreeStore.html#gtk-tree-store-set-value" title="gtk_tree_store_set_value ()"><code class="function">gtk_tree_store_set_value()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-insert-after.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 unset <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> to set to the new row. </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>A valid <a class="link" href="GtkTreeModel.html#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>
|
||
<tr>
|
||
<td class="parameter_name"><p>sibling</p></td>
|
||
<td class="parameter_description"><p>A valid <a class="link" href="GtkTreeModel.html#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>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-insert-with-values"></a><h3>gtk_tree_store_insert_with_values ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_insert_with_values (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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> position</code></em>,
|
||
<em class="parameter"><code>...</code></em>);</pre>
|
||
<p>Creates a new row at <em class="parameter"><code>position</code></em>
|
||
. <em class="parameter"><code>iter</code></em>
|
||
will be changed to point to this
|
||
new row. If <em class="parameter"><code>position</code></em>
|
||
is -1, or larger than the number of rows on the list, then
|
||
the new row will be appended to the list. The row will be filled with
|
||
the values given to this function.</p>
|
||
<p>Calling
|
||
<code class="literal">gtk_tree_store_insert_with_values (tree_store, iter, position, ...)</code>
|
||
has the same effect as calling</p>
|
||
<div class="informalexample">
|
||
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
|
||
<tbody>
|
||
<tr>
|
||
<td class="listing_lines" align="right"><pre>1
|
||
2</pre></td>
|
||
<td class="listing_code"><pre class="programlisting"><span class="n">gtk_tree_store_insert</span> <span class="p">(</span><span class="n">tree_store</span><span class="p">,</span> <span class="n">iter</span><span class="p">,</span> <span class="n">position</span><span class="p">);</span>
|
||
<span class="n">gtk_tree_store_set</span> <span class="p">(</span><span class="n">tree_store</span><span class="p">,</span> <span class="n">iter</span><span class="p">,</span> <span class="p">...);</span></pre></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<p>
|
||
with the different that the former will only emit a row_inserted signal,
|
||
while the latter will emit row_inserted, row_changed and if the tree store
|
||
is sorted, rows_reordered. Since emitting the rows_reordered signal
|
||
repeatedly can affect the performance of the program,
|
||
<a class="link" href="GtkTreeStore.html#gtk-tree-store-insert-with-values" title="gtk_tree_store_insert_with_values ()"><code class="function">gtk_tree_store_insert_with_values()</code></a> should generally be preferred when
|
||
inserting rows in a sorted tree store.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-insert-with-values.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 unset <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> to set the new row, 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>
|
||
<tr>
|
||
<td class="parameter_name"><p>parent</p></td>
|
||
<td class="parameter_description"><p>A valid <a class="link" href="GtkTreeModel.html#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>
|
||
<tr>
|
||
<td class="parameter_name"><p>position</p></td>
|
||
<td class="parameter_description"><p>position to insert the new row, or -1 to append after existing rows</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, terminated with -1</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-insert-with-valuesv"></a><h3>gtk_tree_store_insert_with_valuesv ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_insert_with_valuesv (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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> position</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> *columns</code></em>,
|
||
<em class="parameter"><code><span class="type">GValue</span> *values</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> n_values</code></em>);</pre>
|
||
<p>A variant of <a class="link" href="GtkTreeStore.html#gtk-tree-store-insert-with-values" title="gtk_tree_store_insert_with_values ()"><code class="function">gtk_tree_store_insert_with_values()</code></a> which takes
|
||
the columns and values as two arrays, instead of varargs. This
|
||
function is mainly intended for language bindings.</p>
|
||
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> gtk_tree_store_insert_with_values]</span></p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-insert-with-valuesv.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 unset <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> to set the new row, 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>
|
||
<tr>
|
||
<td class="parameter_name"><p>parent</p></td>
|
||
<td class="parameter_description"><p>A valid <a class="link" href="GtkTreeModel.html#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>
|
||
<tr>
|
||
<td class="parameter_name"><p>position</p></td>
|
||
<td class="parameter_description"><p>position to insert the new row, or -1 for last</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>columns</p></td>
|
||
<td class="parameter_description"><p>an array of column numbers. </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=n_values]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>values</p></td>
|
||
<td class="parameter_description"><p>an array of GValues. </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=n_values]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>n_values</p></td>
|
||
<td class="parameter_description"><p>the length of the <em class="parameter"><code>columns</code></em>
|
||
and <em class="parameter"><code>values</code></em>
|
||
arrays</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-prepend"></a><h3>gtk_tree_store_prepend ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_prepend (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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>Prepends a new row to <em class="parameter"><code>tree_store</code></em>
|
||
. If <em class="parameter"><code>parent</code></em>
|
||
is non-<code class="literal">NULL</code>, then it will prepend
|
||
the new row before the first child of <em class="parameter"><code>parent</code></em>
|
||
, otherwise it will prepend a row
|
||
to the top level. <em class="parameter"><code>iter</code></em>
|
||
will be changed to point to this new row. The row
|
||
will be empty after this function is called. To fill in values, you need to
|
||
call <a class="link" href="GtkTreeStore.html#gtk-tree-store-set" title="gtk_tree_store_set ()"><code class="function">gtk_tree_store_set()</code></a> or <a class="link" href="GtkTreeStore.html#gtk-tree-store-set-value" title="gtk_tree_store_set_value ()"><code class="function">gtk_tree_store_set_value()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-prepend.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 unset <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> to set to the prepended row. </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>A valid <a class="link" href="GtkTreeModel.html#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>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-append"></a><h3>gtk_tree_store_append ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_append (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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>Appends a new row to <em class="parameter"><code>tree_store</code></em>
|
||
. If <em class="parameter"><code>parent</code></em>
|
||
is non-<code class="literal">NULL</code>, then it will append the
|
||
new row after the last child of <em class="parameter"><code>parent</code></em>
|
||
, otherwise it will append a row to
|
||
the top level. <em class="parameter"><code>iter</code></em>
|
||
will be changed to point to this new row. The row will
|
||
be empty after this function is called. To fill in values, you need to call
|
||
<a class="link" href="GtkTreeStore.html#gtk-tree-store-set" title="gtk_tree_store_set ()"><code class="function">gtk_tree_store_set()</code></a> or <a class="link" href="GtkTreeStore.html#gtk-tree-store-set-value" title="gtk_tree_store_set_value ()"><code class="function">gtk_tree_store_set_value()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-append.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 unset <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> to set to the appended row. </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>A valid <a class="link" href="GtkTreeModel.html#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>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-is-ancestor"></a><h3>gtk_tree_store_is_ancestor ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_store_is_ancestor (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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> *descendant</code></em>);</pre>
|
||
<p>Returns <code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em>
|
||
is an ancestor of <em class="parameter"><code>descendant</code></em>
|
||
. That is, <em class="parameter"><code>iter</code></em>
|
||
is the
|
||
parent (or grandparent or great-grandparent) of <em class="parameter"><code>descendant</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-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>tree_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 valid <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>descendant</p></td>
|
||
<td class="parameter_description"><p>A valid <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-is-ancestor.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em>
|
||
is an ancestor of <em class="parameter"><code>descendant</code></em>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-iter-depth"></a><h3>gtk_tree_store_iter_depth ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gint</span>
|
||
gtk_tree_store_iter_depth (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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 depth of <em class="parameter"><code>iter</code></em>
|
||
. This will be 0 for anything on the root level, 1
|
||
for anything down a level, etc.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-iter-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>tree_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</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 valid <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-iter-depth.returns"></a><h4>Returns</h4>
|
||
<p> The depth of <em class="parameter"><code>iter</code></em>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-clear"></a><h3>gtk_tree_store_clear ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_clear (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</code></em>);</pre>
|
||
<p>Removes all rows from <em class="parameter"><code>tree_store</code></em>
|
||
</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-clear.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_store</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-iter-is-valid"></a><h3>gtk_tree_store_iter_is_valid ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_tree_store_iter_is_valid (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
|
||
<p>WARNING: This function is slow. Only use it for debugging and/or testing
|
||
purposes.</p>
|
||
<p>Checks if the given iter is a valid iter for this <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-iter-is-valid.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>tree_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-iter-is-valid.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if the iter is valid, <code class="literal">FALSE</code> if the iter is invalid.</p>
|
||
</div>
|
||
<p class="since">Since: 2.2</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-reorder"></a><h3>gtk_tree_store_reorder ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_reorder (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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> *new_order</code></em>);</pre>
|
||
<p>Reorders the children of <em class="parameter"><code>parent</code></em>
|
||
in <em class="parameter"><code>tree_store</code></em>
|
||
to follow the order
|
||
indicated by <em class="parameter"><code>new_order</code></em>
|
||
. Note that this function only works with
|
||
unsorted stores.</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-store-reorder.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>parent</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeModel.html#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 may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</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 new 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>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.2</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-swap"></a><h3>gtk_tree_store_swap ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_swap (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *a</code></em>,
|
||
<em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *b</code></em>);</pre>
|
||
<p>Swaps <em class="parameter"><code>a</code></em>
|
||
and <em class="parameter"><code>b</code></em>
|
||
in the same level of <em class="parameter"><code>tree_store</code></em>
|
||
. Note that this function
|
||
only works with unsorted stores.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-swap.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>a</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>b</p></td>
|
||
<td class="parameter_description"><p>Another <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.2</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-move-before"></a><h3>gtk_tree_store_move_before ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_move_before (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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> *position</code></em>);</pre>
|
||
<p>Moves <em class="parameter"><code>iter</code></em>
|
||
in <em class="parameter"><code>tree_store</code></em>
|
||
to the position before <em class="parameter"><code>position</code></em>
|
||
. <em class="parameter"><code>iter</code></em>
|
||
and
|
||
<em class="parameter"><code>position</code></em>
|
||
should be in the same level. Note that this function only
|
||
works with unsorted stores. If <em class="parameter"><code>position</code></em>
|
||
is <code class="literal">NULL</code>, <em class="parameter"><code>iter</code></em>
|
||
will be
|
||
moved to the end of the level.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-move-before.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>position</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeModel.html#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>
|
||
<p class="since">Since: 2.2</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-tree-store-move-after"></a><h3>gtk_tree_store_move_after ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_tree_store_move_after (<em class="parameter"><code><a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a> *tree_store</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> *position</code></em>);</pre>
|
||
<p>Moves <em class="parameter"><code>iter</code></em>
|
||
in <em class="parameter"><code>tree_store</code></em>
|
||
to the position after <em class="parameter"><code>position</code></em>
|
||
. <em class="parameter"><code>iter</code></em>
|
||
and
|
||
<em class="parameter"><code>position</code></em>
|
||
should be in the same level. Note that this function only
|
||
works with unsorted stores. If <em class="parameter"><code>position</code></em>
|
||
is <code class="literal">NULL</code>, <em class="parameter"><code>iter</code></em>
|
||
will be moved
|
||
to the start of the level.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-tree-store-move-after.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_store</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>iter</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>position</p></td>
|
||
<td class="parameter_description"><p>A <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a>. </p></td>
|
||
<td class="parameter_annotations"><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>
|
||
<p class="since">Since: 2.2</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeStore.other_details"></a><h2>Types and Values</h2>
|
||
<div class="refsect2">
|
||
<a name="GtkTreeStore-struct"></a><h3>struct GtkTreeStore</h3>
|
||
<pre class="programlisting">struct GtkTreeStore;</pre>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkTreeStore.see-also"></a><h2>See Also</h2>
|
||
<p><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a></p>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>Generated by GTK-Doc V1.33.1</div>
|
||
</body>
|
||
</html> |