diff options
| author | John Finlay <finlay@moeraki.com> | 2009-07-20 00:27:12 -0700 |
|---|---|---|
| committer | John Finlay <finlay@moeraki.com> | 2009-07-20 00:27:12 -0700 |
| commit | ca098328aaf0e3f48ddb08a24b58391e42484837 (patch) | |
| tree | 7ddead7dfe6f35632706a4fb59739c680887fc17 /docs/reference/pygtk-gtktreestore.xml | |
| parent | 5e4d735e8db6053cc8aa84e0cbaaf239754395a6 (diff) | |
| download | pygtk-ca098328aaf0e3f48ddb08a24b58391e42484837.tar.gz | |
Reword the description of the use of the new_order list in the
gtk.TreeModel.rows_reordered, gtk.TreeStore.reorder and gtk.ListStore.reorder
methods.
Diffstat (limited to 'docs/reference/pygtk-gtktreestore.xml')
| -rw-r--r-- | docs/reference/pygtk-gtktreestore.xml | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/docs/reference/pygtk-gtktreestore.xml b/docs/reference/pygtk-gtktreestore.xml index 6c7eef9c..d19f1282 100644 --- a/docs/reference/pygtk-gtktreestore.xml +++ b/docs/reference/pygtk-gtktreestore.xml @@ -763,10 +763,13 @@ testing purposes.</para> <varlistentry> <term><parameter role="keyword">new_order</parameter> :</term> - <listitem><simpara>a list of integers mapping the new position of - each child to its old position before the re-ordering, - i.e. <parameter>new_order</parameter><literal>[newpos] = - oldpos</literal>.</simpara></listitem> + <listitem><simpara>a list of integers. The child nodes will be + rearranged so that the <link + linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link> + node that is at position index + <parameter>new_order</parameter><literal>[i]</literal> will be + located at position index + <literal>i</literal>.</simpara></listitem> </varlistentry> </variablelist> @@ -775,10 +778,15 @@ testing purposes.</para> </note> <para>The <methodname>reorder</methodname>() method reorders the -children of the tree store node pointed to by <parameter>parent</parameter> -to match the order of the list of row numbers contained in -<parameter>new_order</parameter>. Note that this method only works with -unsorted stores.</para> + children of the tree store node pointed to by + <parameter>parent</parameter> to match the order of the list of row + numbers contained in <parameter>new_order</parameter>. The child nodes + will be rearranged so that the <link + linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link> + node that is at position index + <parameter>new_order</parameter><literal>[i]</literal> will be located + at position index <literal>i</literal>. Note that this method only + works with unsorted stores.</para> </refsect2> |