File: class-gtktreeiter.html

package info (click to toggle)
python-gtk2-doc 2.5.2-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 8,304 kB
  • ctags: 3,741
  • sloc: makefile: 38
file content (9 lines) | stat: -rw-r--r-- 6,297 bytes parent folder | download
1
2
3
4
5
6
7
8
9
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.TreeIter</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="previous" href="class-gtktreedragsource.html" title="gtk.TreeDragSource"><link rel="next" href="class-gtktreemodel.html" title="gtk.TreeModel"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.TreeIter</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtktreedragsource.html">Prev</a></td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-gtktreemodel.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtktreeiter"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.TreeIter</h2><p>gtk.TreeIter &#8212; An object that points at a path in a <a href="class-gtktreemodel.html" title="gtk.TreeModel"><tt class="classname">gtk.TreeModel</tt></a>.</p></div><div class="refsect1" lang="en"><a name="id3578648"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.TreeIter</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
<code class="methodsynopsis">    def <span class="methodname"><a href="class-gtktreeiter.html#method-gtktreeiter--copy" title="gtk.TreeIter.copy">copy</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtktreeiter.html#method-gtktreeiter--free" title="gtk.TreeIter.free">free</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3578703"></a><h2>Description</h2><p>A <a href="class-gtktreeiter.html" title="gtk.TreeIter"><tt class="classname">gtk.TreeIter</tt></a> is an
object that points at a path in a <a href="class-gtktreemodel.html" title="gtk.TreeModel"><tt class="classname">gtk.TreeModel</tt></a>. A
<a href="class-gtktreeiter.html" title="gtk.TreeIter"><tt class="classname">gtk.TreeIter</tt></a>
is created using one of the <a href="class-gtktreemodel.html" title="gtk.TreeModel"><tt class="classname">gtk.TreeModel</tt></a> or
<a href="class-gtktreemodelsort.html" title="gtk.TreeModelSort"><tt class="classname">gtk.TreeModelSort</tt></a> 
methods:</p><div class="itemizedlist"><ul type="disc"><li><a href="class-gtktreemodel.html#method-gtktreemodel--get-iter" title="gtk.TreeModel.get_iter"><tt class="methodname">gtk.TreeModel.get_iter</tt>()</a></li><li><a href="class-gtktreemodel.html#method-gtktreemodel--get-iter-from-string" title="gtk.TreeModel.get_iter_from_string"><tt class="methodname">gtk.TreeModel.get_iter_from_string</tt>()</a></li><li><a href="class-gtktreemodel.html#method-gtktreemodel--get-iter-first" title="gtk.TreeModel.get_iter_first"><tt class="methodname">gtk.TreeModel.get_iter_first</tt>()</a></li><li><a href="class-gtktreemodel.html#method-gtktreemodel--get-iter-root" title="gtk.TreeModel.get_iter_root"><tt class="methodname">gtk.TreeModel.get_iter_root</tt>()</a></li><li><a href="class-gtktreemodel.html#method-gtktreemodel--iter-children" title="gtk.TreeModel.iter_children"><tt class="methodname">gtk.TreeModel.iter_children</tt>()</a></li><li><a href="class-gtktreemodel.html#method-gtktreemodel--iter-parent" title="gtk.TreeModel.iter_parent"><tt class="methodname">gtk.TreeModel.iter_parent</tt>()</a></li><li><a href="class-gtktreemodelsort.html#method-gtktreemodelsort--convert-child-iter-to-iter" title="gtk.TreeModelSort.convert_child_iter_to_iter"><tt class="methodname">gtk.TreeModelSort.convert_child_iter_to_iter</tt>()</a></li><li><a href="class-gtktreemodelsort.html#method-gtktreemodelsort--convert-iter-to-child-iter" title="gtk.TreeModelSort.convert_iter_to_child_iter"><tt class="methodname">gtk.TreeModelSort.convert_child_iter_to_child_iter</tt>()</a></li></ul></div></div><div class="refsect1" lang="en"><a name="id3578868"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtktreeiter--copy"></a><h3>gtk.TreeIter.copy</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">copy</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a copy of the treeiter.</td></tr></tbody></table><p>The <tt class="methodname">copy</tt>() method returns a copy of the
treeiter. This iter must be freed  with the <a href="class-gtktreeiter.html#method-gtktreeiter--free" title="gtk.TreeIter.free"><tt class="methodname">free</tt>()</a>
method.</p></div><div class="refsect2" lang="en"><a name="method-gtktreeiter--free"></a><h3>gtk.TreeIter.free</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">free</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">free</tt>() method frees a <a href="class-gtktreeiter.html" title="gtk.TreeIter"><tt class="classname">gtk.TreeIter</tt></a>.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtktreedragsource.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="class-gtktreemodel.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.TreeDragSource</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.TreeModel</td></tr></table></div></body></html>