2003-10-05 John Luke <jluke@cfl.rr.com>

* en/Gtk/TreeStore.xml:
	* en/Gtk/TreeModel.xml: first pass through these two monsters

svn path=/trunk/gtk-sharp/; revision=18641
This commit is contained in:
John Luke 2003-10-05 20:12:17 +00:00
parent 17be196384
commit afda438e0f
3 changed files with 389 additions and 331 deletions

View File

@ -1,3 +1,8 @@
2003-10-05 John Luke <jluke@cfl.rr.com>
* en/Gtk/TreeStore.xml:
* en/Gtk/TreeModel.xml: first pass through these two monsters
2003-10-04 Hector E. Gomez Morales <hgomez_36@flashmail.com>
* en/Gtk/Icon.xml

View File

@ -1,5 +1,5 @@
<Type Name="TreeModel" FullName="Gtk.TreeModel">
<TypeSignature Language="C#" Value="public abstract interface TreeModel;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public abstract interface TreeModel;" Maintainer="John Luke" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,33 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The tree interface used by <see cref="T:Gtk.TreeView" /></summary>
<remarks>
<para>
The <see cref="T:Gtk.TreeModel" /> interface defines a generic tree interface for use by the <see cref="T:Gtk.TreeView" /> widget. It is an abstract interface, and is designed to be usable with any appropriate data structure. The programmer just has to implement this interface on their own data type for it to be viewable by a <see cref="T:Gtk.TreeView" /> widget.
</para>
<para>
The model is represented as a hierarchical tree of strongly-typed, columned data. In other words, the model can be seen as a tree where every node has different values depending on which column is being queried. The types are homogeneous per column across all nodes. It is important to note that this interface only provides a way of examining a model and observing changes. The implementation of each individual model decides how and if changes are made.
</para>
<para>
In order to make life simpler for programmers who do not need to write their own specialized model, two generic models are provided - the <see cref="T:Gtk.TreeStore" /> and the <see cref="T:Gtk.ListStore" />. To use these, the developer simply pushes data into these models as necessary. These models provide the data structure as well as all appropriate tree interfaces. As a result, implementing drag and drop, sorting, and storing data is trivial. For the vast majority of trees and lists, these two models are sufficient.
</para>
<para>
Models are accessed on a node/column level of granularity. One can query for the value of a model at a certain node and a certain column on that node. There are two structures used to reference a particular node in a model. They are the <see cref="T:Gtk.TreePath" /> and the <see cref="T:Gtk.TreeIter" />. Most of the interface consists of operations on a <see cref="T:Gtk.TreeIter" />.
</para>
<para>
A path is essentially a potential node. It is a location on a model that may or may not actually correspond to a node on a specific model. The <see cref="T:Gtk.TreePath" /> struct can be converted into either an array of unsigned integers or a string. The string form is a list of numbers separated by a colon. Each number refers to the offset at that level. Thus, the path "0" refers to the root node and the path "2:4" refers to the fifth child of the third node.
</para>
<para>
By contrast, a <see cref="T:Gtk.TreeIter" /> is a reference to a specific node on a specific model. It is a generic struct with an integer and three generic pointers. These are filled in by the model in a model-specific way. One can convert a path to an iterator by calling <see cref="M:Gtk.TreeModel.GetIter(Gtk.TreeIter,Gtk.TreePath)" />. These iterators are the primary way of accessing a model and are similar to the iterators used by <see cref="T:Gtk.TextBuffer" />. The model interface defines a set of operations using them for navigating the model.
</para>
<para>
It is expected that models fill in the iterator with private data. For example, the <see cref="T:Gtk.ListStore" /> model, which is internally a simple linked list, stores a list node in one of the pointers. The <see cref="T:Gtk.TreeModelSort" /> stores an array and an offset in two of the pointers. Additionally, there is an integer field. This field is generally filled with a unique stamp per model. This stamp is for catching errors resulting from using invalid iterators with a model.
</para>
<para>
The lifecycle of an iterator can be a little confusing at first. Iterators are expected to always be valid for as long as the model is unchanged (and does not emit a signal). Additionally, some models guarantee that an iterator is valid for as long as the node it refers to is valid (most notably the <see cref="T:Gtk.TreeStore" /> and <see cref="T:Gtk.ListStore" />). Although generally uninteresting, as one always has to allow for the case where iterators do not persist beyond a signal, some very important performance enhancements were made in the sort model. As a result, the <see cref="F:Gtk.TreeModelFlags.ItersPersist" /> flag was added to indicate this behavior.
</para>
</remarks>
</Docs>
<Base />
<Interfaces>
@ -26,9 +51,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Returns the number of children that the <see cref="T:Gtk.TreeIter" /> has.</summary>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>As a special case, if iter is <see langword="null" />, then the number of toplevel nodes is returned.</remarks>
</Docs>
</Member>
<Member MemberName="IterChildren">
@ -41,10 +66,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>To be added:</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added:</remarks>
</Docs>
</Member>
<Member MemberName="EmitRowChanged">
@ -58,10 +83,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Emits the <see cref="E:Gtk.TreeModel.RowChanged" /> signal.</summary>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Foreach">
@ -74,9 +99,9 @@
<Parameter Name="func" Type="Gtk.TreeModelForeachFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="func">To be added: an object of type 'Gtk.TreeModelForeachFunc'</param>
<remarks>To be added</remarks>
<summary>Calls <paramref name="func" /> on each node in model in a depth-first fashion.</summary>
<param name="func">an object of type <see cref="T:Gtk.TreeModelForeachFunc" /></param>
<remarks>If func returns <see langword="true" />, then the tree ceases to be walked, and this method returns.</remarks>
</Docs>
</Member>
<Member MemberName="GetValue">
@ -91,11 +116,11 @@
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="column">To be added: an object of type 'int'</param>
<param name="value">To be added: an object of type 'GLib.Value'</param>
<remarks>To be added</remarks>
<summary>Gets a value at <paramref name="iter" /> and <paramref name="column" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="column">an object of type <see cref="T:System.Int32" /></param>
<param name="value">an object of type <see cref="T:GLib.Value" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetIterFirst">
@ -108,10 +133,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Gets the first iterator in the tree (the one at the path "0") and returns <see langword="true" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>Returns <see langword="false" /> if the tree is empty.</remarks>
</Docs>
</Member>
<Member MemberName="EmitRowHasChildToggled">
@ -125,10 +150,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Emits the <see cref="E:Gtk.TreeModel.RowHasChildToggled" /> event.</summary>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>This should be called by models after the child state of a node changes.</remarks>
</Docs>
</Member>
<Member MemberName="GetPath">
@ -141,10 +166,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<returns>To be added: an object of type 'Gtk.TreePath'</returns>
<remarks>To be added</remarks>
<summary>Gets the <see cref="T:Gtk.TreePath" /> of <paramref name="iter" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:Gtk.TreePath" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="EmitRowsReordered">
@ -159,11 +184,11 @@
<Parameter Name="new_order" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="new_order">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Emits the <see cref="E:Gtk.TreeModel.RowsReordered" /> event.</summary>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="new_order">an object of type <see cref="T:System.Int32" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IterHasChild">
@ -176,10 +201,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Returns <see langword="true" /> if iter has children, <see langword="false" /> otherwise.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RefNode">
@ -192,9 +217,13 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Lets the tree ref the node.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>
<para>This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons.</para>
<para>This function is primarily meant as a way for views to let caching model know when nodes are being displayed (and hence, whether or not to cache that node.) For example, a file-system based model would not want to keep the entire file-hierarchy in memory, just the sections that are currently being displayed by every current view.</para>
<para>A model should be expected to be able to get an iter independent of its referenced state.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="IterNChildren">
@ -207,10 +236,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Returns the number of children that <paramref name="iter" /> has.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>As a special case, if <paramref name="iter" /> is <see langword="null" />, then the number of toplevel nodes is returned.</remarks>
</Docs>
</Member>
<Member MemberName="EmitRowInserted">
@ -224,10 +253,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Emits the <see cref="E:Gtk.TreeModel.RowInserted" /> event.</summary>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="EmitRowDeleted">
@ -240,9 +269,9 @@
<Parameter Name="path" Type="Gtk.TreePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<remarks>To be added</remarks>
<summary>Emits the <see cref="E:Gtk.TreeModel.RowDeleted" /> event.</summary>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<remarks>This should be called by models after a row has been removed. The location pointed to by <paramref name="path" /> should be the location that the row previously was at. It may not be a valid location anymore.</remarks>
</Docs>
</Member>
<Member MemberName="IterNext">
@ -255,10 +284,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets <paramref name="iter" /> to point to the node following it at the current level.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>If there is no next iter, <see langword="false" /> is returned and iter is set to be invalid.</remarks>
</Docs>
</Member>
<Member MemberName="GetValist">
@ -273,8 +302,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="var_args">To be added: an object of type 'IntPtr'</param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="var_args">an object of type <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -288,9 +317,9 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Lets the tree unref the node.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. For more information on what this means, see <see cref="M:Gtk.TreeModel.RefNode()" />. Please note that nodes that are deleted are not unreferenced.</remarks>
</Docs>
</Member>
<Member MemberName="NColumns">
@ -300,9 +329,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Returns the number of columns supported by the <see cref="T:Gtk.TreeModel" />.</summary>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Flags">
@ -312,9 +341,9 @@
<ReturnType>Gtk.TreeModelFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.TreeModelFlags'</returns>
<remarks>To be added</remarks>
<summary>Returns a set of flags supported by this interface.</summary>
<returns>an object of type <see cref="T:Gtk.TreeModelFlags" /></returns>
<remarks>The flags are a bitwise combination of <see cref="T:Gtk.TreeModelFlags" />. The flags supported should not change during the lifecycle of the <see cref="T:Gtk.TreeModel" />.</remarks>
</Docs>
</Member>
<Member MemberName="RowHasChildToggled">
@ -325,8 +354,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a child of a row is toggled.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RowInserted">
@ -337,8 +366,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a row has been inserted into the model.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RowDeleted">
@ -349,8 +378,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a row is deleted.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RowChanged">
@ -361,8 +390,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a row has changed.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RowsReordered">
@ -373,8 +402,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a row is re-ordered</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IterNthChild">
@ -388,11 +417,11 @@
<Parameter Name="n" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="n">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets <paramref name="iter" /> to be the child of the root node, using the given index.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="n">an object of type <see cref="T:System.Int32" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>In this case, the nth root node is set.</remarks>
</Docs>
</Member>
<Member MemberName="IterNthChild">
@ -407,12 +436,12 @@
<Parameter Name="n" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="parent">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="n">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets <paramref name="iter" /> to be the child of <paramref name="parent" />, using the given index.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="parent">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="n">an object of type <see cref="T:System.Int32" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>The first index is 0. If <paramref name="n" /> is too big, or <paramref name="parent" /> has no children, <paramref name="iter" /> is set to an invalid iterator and <see langword="false" /> is returned. <paramref name="parent" /> will remain a valid node after this function has been called.</remarks>
</Docs>
</Member>
<Member MemberName="GetIterFromString">
@ -426,11 +455,11 @@
<Parameter Name="path_string" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="path_string">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Gets the <see cref="T:Gtk.TreeIter" /> at <paramref name="path_string" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="path_string">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>Otherwise, <paramref name="iter" /> is left invalid and <see langword="false" /> is returned.</remarks>
</Docs>
</Member>
<Member MemberName="IterChildren">
@ -444,11 +473,11 @@
<Parameter Name="parent" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="parent">To be added: an object of type 'Gtk.TreeIter'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets <paramref name="iter" /> to point to the first child of <paramref name="parent" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="parent">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>If <paramref name="parent" /> has no children, <see langword="false" /> is returned and <paramref name="iter" /> is set to be invalid. <paramref name="parent" /> will remain a valid node after this function has been called.</remarks>
</Docs>
</Member>
<Member MemberName="GetIter">
@ -462,11 +491,11 @@
<Parameter Name="path" Type="Gtk.TreePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets <paramref name="iter" /> to a valid iterator pointing to <paramref name="path" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IterParent">
@ -480,11 +509,11 @@
<Parameter Name="child" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="child">To be added: an object of type 'Gtk.TreeIter'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets <paramref name="iter" /> to be the parent of <paramref name="child" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="child">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>If <paramref name="child" /> is at the toplevel, and does not have a parent, then <paramref name="iter" /> is set to an invalid iterator and <see langword="false" /> is returned. <paramref name="child" /> will remain a valid node after this function has been called.</remarks>
</Docs>
</Member>
<Member MemberName="GetStringFromIter">
@ -497,10 +526,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Generates a string representation of the path of <paramref name="iter" />.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks>This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.</remarks>
</Docs>
</Member>
<Member MemberName="GetColumnType">
@ -513,11 +542,11 @@
<Parameter Name="index_" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Returns the type of the column.</summary>
<param name="index_">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -1,5 +1,5 @@
<Type Name="TreeStore" FullName="Gtk.TreeStore">
<TypeSignature Language="C#" Value="public class TreeStore : GLib.Object, TreeModel, IWrapper, TreeDragSource, TreeDragDest, TreeSortable, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class TreeStore : GLib.Object, TreeModel, IWrapper, TreeDragSource, TreeDragDest, TreeSortable, IWrapper, IDisposable" Maintainer="John Luke" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A tree-like data structure that can be used with the <see cref="T:Gtk.TreeView" /></summary>
<remarks>The <see cref="T:Gtk.TreeStore" /> object is a list model for use with a <see cref="T:Gtk.TreeView" /> widget. It implements the <see cref="T:Gtk.TreeModel" /> interface, and consequentialy, can use all of the methods available there. It also implements the <see cref="T:Gtk.TreeSortable" /> interface so it can be sorted by the view. Finally, it also implements the tree drag and drop interfaces.</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -48,9 +48,9 @@
<Parameter Name="types" Type="System.UInt32 []" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="types">To be added: an object of type 'uint []'</param>
<remarks>To be added</remarks>
<summary>This method is meant primarily for GObjects that inherit from <see cref="T:Gtk.TreeStore" />, and should only be used when constructing a new <see cref="T:Gtk.TreeStore" />.</summary>
<param name="types">an object of type <see cref="T:System.UInt32" /> []</param>
<remarks>It will not function after a row has been added, or a method on the <see cref="T:Gtk.TreeModel" /> interface is called.</remarks>
</Docs>
</Member>
<Member MemberName="IterNChildren">
@ -61,9 +61,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Returns the number of children that the <see cref="T:Gtk.TreeIter" /> has.</summary>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>As a special case, if iter is <see langword="null" />, then the number of toplevel nodes is returned.</remarks>
</Docs>
</Member>
<Member MemberName="IterChildren">
@ -77,8 +77,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<returns>To be added: an object of type 'bool'</returns>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -92,9 +92,9 @@
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<remarks>To be added</remarks>
<summary>Prepends a new row to the <see cref="T:Gtk.TreeStore" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>It will prepend a row to the top level. <paramref name="iter" /> will be changed to point to this new row. The row will be empty after this method is called. To fill in values, you need to call <see cref="M:Gtk.TreeStore.SetValue()" />.</remarks>
</Docs>
</Member>
<Member MemberName="Append">
@ -107,9 +107,9 @@
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<remarks>To be added</remarks>
<summary>Appends a new row to the <see cref="T:Gtk.TreeStore" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>It will append a row to the top level. <paramref name="iter" /> will be changed to point to this new row. The row will be empty after this method is called. To fill in values, you need to call <see cref="M:Gtk.TreeStore.SetValue()" />.</remarks>
</Docs>
</Member>
<Member MemberName="GetSortColumnId">
@ -124,9 +124,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="sort_column_id">To be added: an object of type 'int'</param>
<param name="order">To be added: an object of type 'Gtk.SortType'</param>
<returns>To be added: an object of type 'bool'</returns>
<param name="sort_column_id">an object of type <see cref="T:System.Int32" /></param>
<param name="order">an object of type <see cref="T:Gtk.SortType" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -154,8 +154,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="sort_column_id">To be added: an object of type 'int'</param>
<param name="order">To be added: an object of type 'Gtk.SortType'</param>
<param name="sort_column_id">an object of type <see cref="T:System.Int32" /></param>
<param name="order">an object of type <see cref="T:Gtk.SortType" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -173,10 +173,10 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="sort_column_id">To be added: an object of type 'int'</param>
<param name="sort_func">To be added: an object of type 'Gtk.TreeIterCompareFunc'</param>
<param name="user_data">To be added: an object of type 'IntPtr'</param>
<param name="destroy">To be added: an object of type 'Gtk.DestroyNotify'</param>
<param name="sort_column_id">an object of type <see cref="T:System.Int32" /></param>
<param name="sort_func">an object of type <see cref="T:Gtk.TreeIterCompareFunc" /></param>
<param name="user_data">an object of type <see cref="T:System.IntPtr" /></param>
<param name="destroy">an object of type <see cref="T:Gtk.DestroyNotify" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -189,7 +189,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -206,9 +206,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="sort_func">To be added: an object of type 'Gtk.TreeIterCompareFunc'</param>
<param name="user_data">To be added: an object of type 'IntPtr'</param>
<param name="destroy">To be added: an object of type 'Gtk.DestroyNotify'</param>
<param name="sort_func">an object of type <see cref="T:Gtk.TreeIterCompareFunc" /></param>
<param name="user_data">an object of type <see cref="T:System.IntPtr" /></param>
<param name="destroy">an object of type <see cref="T:Gtk.DestroyNotify" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -224,9 +224,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="dest_path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="selection_data">To be added: an object of type 'Gtk.SelectionData'</param>
<returns>To be added: an object of type 'bool'</returns>
<param name="dest_path">an object of type <see cref="T:Gtk.TreePath" /></param>
<param name="selection_data">an object of type <see cref="T:Gtk.SelectionData" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -242,9 +242,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="dest">To be added: an object of type 'Gtk.TreePath'</param>
<param name="selection_data">To be added: an object of type 'Gtk.SelectionData'</param>
<returns>To be added: an object of type 'bool'</returns>
<param name="dest">an object of type <see cref="T:Gtk.TreePath" /></param>
<param name="selection_data">an object of type <see cref="T:Gtk.SelectionData" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -260,9 +260,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="selection_data">To be added: an object of type 'Gtk.SelectionData'</param>
<returns>To be added: an object of type 'bool'</returns>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<param name="selection_data">an object of type <see cref="T:Gtk.SelectionData" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -277,8 +277,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<returns>To be added: an object of type 'bool'</returns>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -293,8 +293,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<returns>To be added: an object of type 'bool'</returns>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -309,10 +309,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Emits the <see cref="E:Gtk.TreeStore.RowChanged" /> event.</summary>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Foreach">
@ -325,9 +325,9 @@
<Parameter Name="func" Type="Gtk.TreeModelForeachFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="func">To be added: an object of type 'Gtk.TreeModelForeachFunc'</param>
<remarks>To be added</remarks>
<summary>Calls <paramref name="func" /> on each node in model in a depth-first fashion.</summary>
<param name="func">an object of type <see cref="T:Gtk.TreeModelForeachFunc" /></param>
<remarks>If func returns <see langword="true" />, then the tree ceases to be walked, and this method returns.</remarks>
</Docs>
</Member>
<Member MemberName="GetIterFirst">
@ -340,10 +340,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Gets the first iterator in the tree (the one at the path "0") and returns <see langword="true" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>Returns <see langword="false" /> if the tree is empty.</remarks>
</Docs>
</Member>
<Member MemberName="EmitRowHasChildToggled">
@ -357,10 +357,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Emits the <see cref="E:Gtk.TreeStore.RowHasChildToggled" /> event.</summary>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetPath">
@ -373,10 +373,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<returns>To be added: an object of type 'Gtk.TreePath'</returns>
<remarks>To be added</remarks>
<summary>Gets the <see cref="T:Gtk.TreePath" /> of <paramref name="iter" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:Gtk.TreePath" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="EmitRowsReordered">
@ -391,11 +391,11 @@
<Parameter Name="new_order" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="new_order">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Emits the <see cref="E:Gtk.TreeStore.RowsReordered" /> event.</summary>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="new_order">an object of type <see cref="T:System.Int32" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IterHasChild">
@ -408,10 +408,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Returns <see langword="true" /> if iter has children, <see langword="false" /> otherwise.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RefNode">
@ -424,9 +424,13 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Lets the tree ref the node.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>
<para>This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons.</para>
<para>This function is primarily meant as a way for views to let caching model know when nodes are being displayed (and hence, whether or not to cache that node.) For example, a file-system based model would not want to keep the entire file-hierarchy in memory, just the sections that are currently being displayed by every current view.</para>
<para>A model should be expected to be able to get an iter independent of its referenced state.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="IterNChildren">
@ -439,10 +443,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Returns the number of children that <paramref name="iter" /> has.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>As a special case, if <paramref name="iter" /> is <see langword="null" />, then the number of toplevel nodes is returned.</remarks>
</Docs>
</Member>
<Member MemberName="EmitRowInserted">
@ -456,10 +460,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Emits the <see cref="E:Gtk.TreeModel.RowInserted" /> event.</summary>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="EmitRowDeleted">
@ -472,9 +476,9 @@
<Parameter Name="path" Type="Gtk.TreePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<remarks>To be added</remarks>
<summary>Emits the <see cref="E:Gtk.TreeModel.RowDeleted" /> event.</summary>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<remarks>This should be called by models after a row has been removed. The location pointed to by <paramref name="path" /> should be the location that the row previously was at. It may not be a valid location anymore.</remarks>
</Docs>
</Member>
<Member MemberName="IterNext">
@ -487,10 +491,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets <paramref name="iter" /> to point to the node following it at the current level.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>If there is no next iter, <see langword="false" /> is returned and iter is set to be invalid.</remarks>
</Docs>
</Member>
<Member MemberName="GetValist">
@ -505,8 +509,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="var_args">To be added: an object of type 'IntPtr'</param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="var_args">an object of type <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -520,9 +524,9 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Lets the tree unref the node.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. For more information on what this means, see <see cref="M:Gtk.TreeModel.RefNode()" />. Please note that nodes that are deleted are not unreferenced.</remarks>
</Docs>
</Member>
<Member MemberName="Clear">
@ -533,8 +537,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Removes all rows from the <see cref="T:Gtk.TreeStore" /></summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetValist">
@ -549,8 +553,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="var_args">To be added: an object of type 'IntPtr'</param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="var_args">an object of type <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -565,11 +569,11 @@
<Parameter Name="descendant" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="descendant">To be added: an object of type 'Gtk.TreeIter'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Returns <see langword="true" /> if <paramref name="iter" /> is an ancestor of <paramref name="descendant" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="descendant">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>That is, <paramref name="iter" /> is the parent (or grandparent or great-grandparent) of <paramref name="descendant" />.</remarks>
</Docs>
</Member>
<Member MemberName="SetColumnTypes">
@ -583,10 +587,10 @@
<Parameter Name="types" Type="System.UInt32 []" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="n_columns">To be added: an object of type 'int'</param>
<param name="types">To be added: an object of type 'uint []'</param>
<remarks>To be added</remarks>
<summary>This function is meant primarily for GObjects that inherit from <see cref="T:Gtk.TreeStore" />, and should only be used when constructing a new <see cref="T:Gtk.TreeStore" />.</summary>
<param name="n_columns">an object of type <see cref="T:System.Int32" /></param>
<param name="types">an object of type <see cref="T:System.UInt32" /> []</param>
<remarks>It will not function after a row has been added, or a method on the <see cref="T:Gtk.TreeModel" /> interface is called.</remarks>
</Docs>
</Member>
<Member MemberName="SetValue">
@ -601,11 +605,11 @@
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="column">To be added: an object of type 'int'</param>
<param name="value">To be added: an object of type 'GLib.Value'</param>
<remarks>To be added</remarks>
<summary>Sets the data in the cell specified by <paramref name="iter" /> and <paramref name="column" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="column">an object of type <see cref="T:System.Int32" /></param>
<param name="value">an object of type <see cref="T:GLib.Value" /></param>
<remarks>The type of value must be convertible to the type of the column.</remarks>
</Docs>
</Member>
<Member MemberName="IterDepth">
@ -618,10 +622,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Returns the depth of <paramref name="iter" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>This will be 0 for anything on the root level, 1 for anything down a level, etc.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -660,10 +664,16 @@
<Parameter Name="types" Type="System.UInt32 []" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="types">To be added: an object of type 'uint []'</param>
<returns>To be added: an object of type 'Gtk.TreeStore'</returns>
<remarks>To be added</remarks>
<summary>Creates a new <see cref="T:Gtk.TreeStore" /> instance.</summary>
<param name="types">an object of type <see cref="T:System.UInt32" /> []</param>
<returns>an object of type <see cref="T:Gtk.TreeStore" /></returns>
<remarks></remarks>
<example>
<code language="C#">
Treestore store;
store = new TreeStore ((int) GLib.TypeFundamentals.TypeInt, (int) GLib.TypeFundamentals.TypeString);
</code>
</example>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -672,9 +682,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.TreeStore'</returns>
<remarks>To be added</remarks>
<summary>Internal constructor</summary>
<returns>an object of type <see cref="T:Gtk.TreeStore" /></returns>
<remarks>This is an internal constructor, and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -684,8 +694,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gtk.TreeStore</summary>
<returns>The GLib Type for the Gtk.TreeStore class.</returns>
<summary>The <see cref="T:GLib.Type" /> for <see cref="T:Gtk.TreeStore" /></summary>
<returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gtk.TreeStore" /> class.</returns>
<remarks />
</Docs>
</Member>
@ -696,9 +706,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Returns the number of columns supported by the <see cref="T:Gtk.TreeStore" />.</summary>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Flags">
@ -708,9 +718,9 @@
<ReturnType>Gtk.TreeModelFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.TreeModelFlags'</returns>
<remarks>To be added</remarks>
<summary>Returns a set of flags supported by this <see cref="T:Gtk.TreeStore" />.</summary>
<returns>an object of type <see cref="T:Gtk.TreeModelFlags" /></returns>
<remarks>The flags are a bitwise combination of <see cref="T:Gtk.TreeModelFlags" />. The flags supported should not change during the lifecycle of the <see cref="T:Gtk.TreeStore" />.</remarks>
</Docs>
</Member>
<Member MemberName="SortColumnChanged">
@ -721,8 +731,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the sort column of the <see cref="T:Gtk.TreeStore" /> has changed.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RowHasChildToggled">
@ -733,8 +743,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a child of a row is toggled.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RowInserted">
@ -745,8 +755,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a row is inserted into the <see cref="T:Gtk.TreeStore" />.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RowDeleted">
@ -757,8 +767,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a row is deleted from the <see cref="T:Gtk.TreeStore" />.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RowChanged">
@ -769,8 +779,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a row is in the <see cref="T:Gtk.TreeStore" /> is changed.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RowsReordered">
@ -781,8 +791,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the rows of the <see cref="T:Gtk.TreeStore" /> are re-ordered.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetValue">
@ -797,11 +807,11 @@
<Parameter Name="value" Type="GLib.Value&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="column">To be added: an object of type 'int'</param>
<param name="value">To be added: an object of type 'GLib.Value&amp;'</param>
<remarks>To be added</remarks>
<summary>Gets a value at <paramref name="iter" /> and <paramref name="column" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="column">an object of type <see cref="T:System.Int32" /></param>
<param name="value">an object of type <see cref="T:GLib.Value" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -831,11 +841,11 @@
<Parameter Name="n" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="n">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets <paramref name="iter" /> to be the child of the root node, using the given index.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="n">an object of type <see cref="T:System.Int32" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>In this case, the nth root node is set.</remarks>
</Docs>
</Member>
<Member MemberName="InsertAfter">
@ -849,10 +859,14 @@
<Parameter Name="sibling" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="sibling">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Inserts a new row after <paramref name="sibling" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="sibling">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>
<para>
If <paramref name="sibling" /> is <see langword="null" />, then the row will be prepended to the children of its parent. If parent and sibling are <see langword="null" />, then the row will be prepended to the toplevel. If both <paramref name="sibling" /> and parent are set, then parent must be the parent of <paramref name="sibling" />. When <paramref name="sibling" /> is set, parent is optional.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="InsertBefore">
@ -866,10 +880,10 @@
<Parameter Name="sibling" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="sibling">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Inserts a new row before <paramref name="sibling" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="sibling">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>If <paramref name="sibling" /> is <see langword="null" />, then the row will be appended to the children of its parent. If parent and sibling are <see langword="null" />, then the row will be appended to the toplevel. If both <paramref name="sibling" /> and parent are set, then parent must be the parent of <paramref name="sibling" />. When <paramref name="sibling" /> is set, parent is optional.</remarks>
</Docs>
</Member>
<Member MemberName="Insert">
@ -883,10 +897,10 @@
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="position">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Creates a new row at <paramref name="position" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="position">an object of type <see cref="T:System.Int32" /></param>
<remarks>If parent is not <see langword="null" />, then the row will be made a child of parent. Otherwise, the row will be created at the toplevel. If <paramref name="position" /> is larger than the number of rows at that level, then the new row will be inserted to the end of the list. <paramref name="iter" /> 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 <see cref="M:Gtk.TreeStore.SetValue()" />.</remarks>
</Docs>
</Member>
<Member MemberName="IterNthChild">
@ -901,12 +915,12 @@
<Parameter Name="n" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="parent">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="n">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets <paramref name="iter" /> to be the child of <paramref name="parent" />, using the given index.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="parent">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="n">an object of type <see cref="T:System.Int32" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>The first index is 0. If <paramref name="n" /> is too big, or <paramref name="parent" /> has no children, <paramref name="iter" /> is set to an invalid iterator and <see langword="false" /> is returned. <paramref name="parent" /> will remain a valid node after this function has been called.</remarks>
</Docs>
</Member>
<Member MemberName="GetIterFromString">
@ -920,11 +934,11 @@
<Parameter Name="path_string" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="path_string">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Gets the <see cref="T:Gtk.TreeIter" /> at <paramref name="path_string" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="path_string">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>Otherwise, <paramref name="iter" /> is left invalid and <see langword="false" /> is returned.</remarks>
</Docs>
</Member>
<Member MemberName="IterChildren">
@ -938,11 +952,11 @@
<Parameter Name="parent" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="parent">To be added: an object of type 'Gtk.TreeIter'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets <paramref name="iter" /> to point to the first child of <paramref name="parent" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="parent">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>If <paramref name="parent" /> has no children, <see langword="false" /> is returned and <paramref name="iter" /> is set to be invalid. <paramref name="parent" /> will remain a valid node after this function has been called.</remarks>
</Docs>
</Member>
<Member MemberName="GetIter">
@ -956,11 +970,11 @@
<Parameter Name="path" Type="Gtk.TreePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets <paramref name="iter" /> to a valid iterator pointing to <paramref name="path" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IterParent">
@ -974,11 +988,11 @@
<Parameter Name="child" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="child">To be added: an object of type 'Gtk.TreeIter'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets <paramref name="iter" /> to be the parent of <paramref name="child" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="child">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>If <paramref name="child" /> is at the toplevel, and does not have a parent, then <paramref name="iter" /> is set to an invalid iterator and <see langword="false" /> is returned. <paramref name="child" /> will remain a valid node after this function has been called.</remarks>
</Docs>
</Member>
<Member MemberName="Append">
@ -992,10 +1006,10 @@
<Parameter Name="parent" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="parent">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Appends a new row to the <see cref="T:Gtk.TreeStore" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="parent">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>If parent and is <see langword="null" />, then the row will be prepended to the toplevel.</remarks>
</Docs>
</Member>
<Member MemberName="InsertAfter">
@ -1010,11 +1024,15 @@
<Parameter Name="sibling" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="parent">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="sibling">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Inserts a new row after <paramref name="sibling" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="parent">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="sibling">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>
<para>
If <paramref name="sibling" /> is <see langword="null" />, then the row will be prepended to the children of its parent. If parent and sibling are <see langword="null" />, then the row will be prepended to the toplevel. If both <paramref name="sibling" /> and parent are set, then parent must be the parent of <paramref name="sibling" />. When <paramref name="sibling" /> is set, parent is optional.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="InsertBefore">
@ -1029,11 +1047,11 @@
<Parameter Name="sibling" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="parent">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="sibling">To be added: an object of type 'Gtk.TreeIter'</param>
<remarks>To be added</remarks>
<summary>Inserts a new row before <paramref name="sibling" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="parent">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="sibling">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>If <paramref name="sibling" /> is <see langword="null" />, then the row will be appended to the children of its parent. If parent and sibling are <see langword="null" />, then the row will be appended to the toplevel. If both <paramref name="sibling" /> and parent are set, then parent must be the parent of <paramref name="sibling" />. When <paramref name="sibling" /> is set, parent is optional.</remarks>
</Docs>
</Member>
<Member MemberName="Prepend">
@ -1048,8 +1066,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="parent">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="parent">an object of type <see cref="T:Gtk.TreeIter" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -1066,9 +1084,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter&amp;'</param>
<param name="parent">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="position">To be added: an object of type 'int'</param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="parent">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="position">an object of type <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -1431,11 +1449,17 @@
<Parameter Name="types" Type="System.Type[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Creates a new <see cref="T:Gtk.TreeStore" /> instance.</summary>
<param name="types">a <see cref="T:System.Type[]" /></param>
<returns>a <see cref="T:Gtk.TreeStore" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
<example>
<code language="C#">
Treestore store;
store = new TreeStore (typeof (int), typeof (string));
</code>
</example>
</Docs>
</Member>
</Members>
</Type>
</Type>