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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtktreeiter">
<refnamediv>
<refname>gtk.TreeIter</refname>
<refpurpose>An object that points at a path in a <link linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.TreeIter</classname></ooclass>
<ooclass><classname>gobject.GBoxed</classname></ooclass>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtktreeiter--copy">copy</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtktreeiter--free">free</link></methodname>
<methodparam></methodparam> </methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>A <link
linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> is an
object that points at a path in a <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>. A
<link linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
is created using one of the <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> or
<link
linkend="class-gtktreemodelsort"><classname>gtk.TreeModelSort</classname></link>
methods:</para>
<itemizedlist>
<listitem>
<simpara><link
linkend="method-gtktreemodel--get-iter"><methodname>gtk.TreeModel.get_iter</methodname>()</link></simpara>
</listitem>
<listitem>
<simpara><link
linkend="method-gtktreemodel--get-iter-from-string"><methodname>gtk.TreeModel.get_iter_from_string</methodname>()</link></simpara>
</listitem>
<listitem>
<simpara><link
linkend="method-gtktreemodel--get-iter-first"><methodname>gtk.TreeModel.get_iter_first</methodname>()</link></simpara>
</listitem>
<listitem>
<simpara><link
linkend="method-gtktreemodel--get-iter-root"><methodname>gtk.TreeModel.get_iter_root</methodname>()</link></simpara>
</listitem>
<listitem>
<simpara><link
linkend="method-gtktreemodel--iter-children"><methodname>gtk.TreeModel.iter_children</methodname>()</link></simpara>
</listitem>
<listitem>
<simpara><link
linkend="method-gtktreemodel--iter-parent"><methodname>gtk.TreeModel.iter_parent</methodname>()</link></simpara>
</listitem>
<listitem>
<simpara><link
linkend="method-gtktreemodelsort--convert-child-iter-to-iter"><methodname>gtk.TreeModelSort.convert_child_iter_to_iter</methodname>()</link></simpara>
</listitem>
<listitem>
<simpara><link
linkend="method-gtktreemodelsort--convert-iter-to-child-iter"><methodname>gtk.TreeModelSort.convert_child_iter_to_child_iter</methodname>()</link></simpara>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtktreeiter--copy">
<title>gtk.TreeIter.copy</title>
<programlisting><methodsynopsis language="python">
<methodname>copy</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a copy of the treeiter.</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>copy</methodname>() method returns a copy of the
treeiter. This iter must be freed with the <link
linkend="method-gtktreeiter--free"><methodname>free</methodname>()</link>
method.</para>
</refsect2>
<refsect2 id="method-gtktreeiter--free">
<title>gtk.TreeIter.free</title>
<programlisting><methodsynopsis language="python">
<methodname>free</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<warning>
<para>This method is deprecated and should not be used since it can
crash your application.</para>
</warning>
<para>The <methodname>free</methodname>() method frees a <link
linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</para>
</refsect2>
</refsect1>
</refentry>
|