ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

2004-08-18 Shane Landrum <epicene@pobox.com>

Browse source 
* en/Gtk/ListStore.xml: Added docs.

svn path=/trunk/gtk-sharp/; revision=32505
This commit is contained in:
Shane Landrum 2004-08-19 03:09:20 +00:00
parent 8566d2376a
commit 762035688c
2 changed files with 271 additions and 201 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/ChangeLog
View file

@ -1,3 +1,7 @@
2004-08-18 Shane Landrum <epicene@pobox.com>
* en/Gtk/ListStore.xml: Added docs.
2004-08-13 Shane Landrum <epicene@pobox.com>
* DragBeginArgs.xml

468
doc/en/Gtk/ListStore.xml
View file

@ -12,7 +12,7 @@
<Docs>
<summary>The ListStore is a columned list data structure to be used with <see cref="T:Gtk.TreeView" /> widget. It is the <i>model</i> part in <b>Model/View/Controller</b> design paradigm. The contents of the ListStore can be sorted and are drag-and-drop ready.
</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -71,6 +71,8 @@
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ChangeSortColumn">
<MemberSignature Language="C#" Value="public virtual void ChangeSortColumn ();" />
<MemberType>Method</MemberType>
@ -79,8 +81,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emits a <see cref="M:Gtk.ListStore.SortColumnChanged" /> event.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="SetSortColumnId">
@ -94,10 +96,10 @@
<Parameter Name="order" Type="Gtk.SortType" />
</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>
<remarks>To be added</remarks>
<summary>Sets the column number to sort by.</summary>
<param name="sort_column_id">A <see cref="T:System.Int32" />, the column number to sort by.</param>
<param name="order">A <see cref="T:Gtk.SortType" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName="SetSortFunc">
@ -113,12 +115,13 @@
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
</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>
<remarks>To be added</remarks>
<summary>Sets a sort function to be used for the column
<paramref name="sort_column_id" />.</summary>
<param name="sort_column_id">A <see cref="T:System.Int32" /> for the column number.</param>
<param name="sort_func">A <see cref="T:Gtk.TreeIterCompareFunc"/></param>
<param name="user_data">A <see cref="T:IntPtr"/></param>
<param name="destroy">A <see cref="T:Gtk.DestroyNotify" />, function that will be run on destruction of <paramref name="user_data" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName="SetDefaultSortFunc">
@ -133,11 +136,11 @@
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
</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>
<remarks>To be added</remarks>
<summary>Set the function that will be used by default to sort columns.</summary>
<param name="sort_func">A <see cref="T:Gtk.TreeIterCompareFunc"/></param>
<param name="user_data">A <see cref="T:IntPtr"/> (FIXME: explain this)</param>
<param name="destroy">A <see cref="T:Gtk.DestroyNotify" />, function that will be run on destruction of <paramref name="user_data" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName="RowDropPossible">
@ -151,11 +154,12 @@
<Parameter Name="selection_data" Type="Gtk.SelectionData" />
</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>
<remarks>To be added</remarks>
<summary>Returns true if the row at <paramref name='dest_path' /> can
have <paramref name="selection_data" /> dropped on it.</summary>
<param name="dest_path">A <see cref="T:Gtk.TreePath"/></param>
<param name="selection_data">A <see cref="T:Gtk.SelectionData" /></param>
<returns>A boolean.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="DragDataReceived">
@ -169,11 +173,11 @@
<Parameter Name="selection_data" Type="Gtk.SelectionData" />
</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>
<remarks>To be added</remarks>
<summary>Drags data received into this <see cref="T:ListStore" /> object.</summary>
<param name="dest">A <see cref="T:Gtk.TreePath" />, the destination path of the drag</param>
<param name="selection_data">A <see cref="T:Gtk.SelectionData"/>, the data that was dragged</param>
<returns>A boolean, true if the data was successfully received.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="DragDataGet">
@ -187,11 +191,13 @@
<Parameter Name="selection_data" Type="Gtk.SelectionData" />
</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>
<remarks>To be added</remarks>
<summary>Method used when this ListStore is part of a source widget
for a drag-and-drop operation; gets the data that was dragged from the
associated widget.</summary>
<param name="path">a <see cref="T:Gtk.TreePath"/></param>
<param name="selection_data">A <see cref="T:Gtk.SelectionData"/></param>
<returns>A <see cref="T:System.Boolean"/>, true if the operation succeeded.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="RowDraggable">
@ -204,10 +210,10 @@
<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>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Returns whether or not a given row can be dragged.</summary>
<param name="path">a <see cref="T:Gtk.TreePath" /></param>
<returns>A boolean, true if the row is draggable.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="DragDataDelete">
@ -220,10 +226,10 @@
<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>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>When this ListStore is the data source for a drag operation and the drag operation is a move, this method runs to delete the data after the data has been received by the target widget.</summary>
<param name="path">A <see cref="T:Gtk.TreePath"/>, the path of the data to delete.</param>
<returns>A <see cref="T:System.Boolean"/>, true if the operation succeeds.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="EmitRowChanged">
@ -237,10 +243,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>Fires a <see cref="E:Gtk.ListStore.RowChanged"/> event. Call this after changing a row so that the view widget for this ListStore will update.</summary>
<param name="path">a <see cref="T:Gtk.TreePath"/></param>
<param name="iter">a <see cref="Gtk.TreeIter"/></param>
<remarks />
</Docs>
</Member>
<Member MemberName="Foreach">
@ -253,9 +259,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>Runs a method on every row of a ListStore.</summary>
<param name="func">A <see cref="T:Gtk.TreeModelForeachFunc"/> to run over every row.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="GetIterFirst">
@ -268,10 +274,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>Initializes <paramref name="iter"/> with the first iterator in the ListStore (the top item).</summary>
<param name="iter">A <see cref="T:Gtk.TreeIter&amp;"/> to reset</param>
<returns>A <see cref="T:System.Boolean"/>, true if the operation is successful, false if the ListStore is empty.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="EmitRowHasChildToggled">
@ -285,10 +291,12 @@
<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 a <see cref="T:Gtk.ListStore.RowHasChildToggled"/> event. This is meant to be called whenever the child state of a node changes.</summary>
<param name="path">a <see cref="T:Gtk.TreePath"/> to pass to the event</param>
<param name="iter">a <see cref="T:Gtk.TreeIter"/> to pass to the event</param>
<remarks>This is mandated by the <see cref="T:Gtk.TreeModel"/>, but it
shouldn't get used much for ListStores because they don't generally
have child nodes.</remarks>
</Docs>
</Member>
<Member MemberName="GetPath">
@ -301,10 +309,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>Turns a <see cref="T:Gtk.TreeIter"/> specified by <paramref name="iter"/> into a <see cref="T:Gtk.TreePath"/>.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter"/></param>
<returns>a <see cref="T:Gtk.TreePath"/></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="IterHasChild">
@ -317,10 +325,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>Tests whether a given row has a child node.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter"/></param>
<returns>A <see cref="T:System:Boolean"/>, always false for ListStores.</returns>
<remarks>This is mandated by <see cref="T:Gtk.TreeModel"/></remarks>
</Docs>
</Member>
<Member MemberName="RefNode">
@ -333,9 +341,12 @@
<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 ListStore reference the row pointed to by <paramref name="iter"/>. </summary>
<param name="iter">a <see cref="T:Gtk.TreeIter"/></param>
<remarks>
<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 reffed state.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="IterNChildren">
@ -348,10 +359,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. If <paramref name="iter"/> is null, as in the case of all ListStore objects, this will return the number of top-level items.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<returns>a <see cref="System.Int32"/></returns>
<remarks>FIXME: Why does ListStore.custom call gtk_tree_model_iter_n_children?</remarks>
</Docs>
</Member>
<Member MemberName="EmitRowInserted">
@ -365,10 +376,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>Fires a <see cref="E:Gtk.TreeModel.RowInserted" /> event. </summary>
<param name="path">a <see cref="T:Gtk.TreePath" /> to pass to the event.</param>
<param name="iter">a see cref="T:Gtk.TreeIter" /> to pass to the event.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="EmitRowDeleted">
@ -381,9 +392,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>Fires a <see cref="E:Gtk.TreeModel.RowDeleted" /> event. </summary>
<param name="path">a <see cref="T:Gtk.TreePath" /> to pass to the event.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="GetValist">
@ -413,9 +424,16 @@
<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 ListStore unref the row at <paramref name="iter" />.</summary>
<param name="iter">a <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>For more information on what this means, see
<see cref="M:Gtk.ListStore.RefNode" />. Please note that
nodes that are deleted are not unreffed.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Clear">
@ -427,7 +445,7 @@
<Parameters />
<Docs>
<summary>Removes all data from the store.</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="SetValist">
@ -459,10 +477,10 @@
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>Sets the value of the specified column in the row pointed by iter.</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>
<summary>Sets the value of the specified column in the row pointed by <paramref name="iter" />.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter"/></param>
<param name="column">a <see cref="T:System.Int32"/>, the column number</param>
<param name="value">a <see cref="GLib.Value"/></param>
<remarks>The type of specified column must be a <see cref="T:GLib.Value" />.</remarks>
</Docs>
</Member>
@ -501,9 +519,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>The number of columns in this ListStore.</summary>
<returns>A <see cref="System.Int32" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Flags">
@ -513,9 +531,10 @@
<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>The flags for this ListStore. </summary>
<returns>A <see cref="T:Gtk.TreeModelFlags"/></returns>
<remarks>Flags are about the shape of this object's data; see the
class documentation for more details.</remarks>
</Docs>
</Member>
<Member MemberName="SortColumnChanged">
@ -526,8 +545,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when a column has changed.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="RowHasChildToggled">
@ -538,8 +557,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when the display of a given row's children is toggled.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="RowInserted">
@ -550,8 +569,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when a row of data is inserted.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="RowDeleted">
@ -562,8 +581,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when a row is deleted.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="RowChanged">
@ -574,8 +593,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when a row has changed.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="RowsReordered">
@ -586,8 +605,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when the order of rows has changed.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="IterNthChild">
@ -601,11 +620,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="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 this ListStore, using the given index. The first index is 0. If <paramref name="n"/> is too big, or this ListStore has no rows, <paramref name="iter"/> is set to an invalid iterator and false is returned. For ListStore objects, the <paramref name="n"/>th root node is set, since they don't have a tree-like structure.
</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter&amp;"/></param>
<param name="n">a <see cref="T:System.Int32"/></param>
<returns>a <see cref="T:System.Boolean"/>, true if <paramref name="iter"/> has an <paramref name="n"/>th child.</returns>
<remarks>This is a custom binding for Gtk# which assumes that the current object is the parent. An alternate invocation form that parallels the C API is available.</remarks>
</Docs>
</Member>
<Member MemberName="IterNthChild">
@ -620,12 +640,13 @@
<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. 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 false is returned. <paramref name="parent"/> will remain a valid node after this function has been called. As a special case, if <paramref name="parent"/> is <see langword="null"/>, then the <paramref name="n"/>th root node is set.
</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter&amp;"/></param>
<param name="n">a <see cref="T:System.Int32"/></param>
<returns>a <see cref="T:System.Boolean"/>, true if <paramref name="parent"/> has an <paramref name="n"/>th child.</returns>
<remarks>This invocation form is closer to the underlying C API, but it's probably less useful for most C# purposes.</remarks>
</Docs>
</Member>
<Member MemberName="GetIterFromString">
@ -639,11 +660,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>Marshals a path string into a <see cref="T:Gtk.TreeIter"/> object that points to a row in this tree.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter&amp;"/> to be set by this method</param>
<param name="path_string">A path string</param>
<returns>A <see cref="System.Boolean"/>, true if this string is a valid path for this ListStore.</returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="IterChildren">
@ -657,11 +678,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></summary>
<param name="iter"><see cref="T:Gtk.TreeIter"/>, an object that will be set to point to the first child.</param>
<param name="parent">a <see cref="T:Gtk.TreeIter"/>, the parent row.</param>
<returns>A <see cref="System.Boolean"/>, true if <paramref name="iter" /> has children.</returns>
<remarks>In general, this will return false, as ListStore isn't tree-shaped. However, if <paramref name="parent" /> is <see langword="null" />, <paramref name="iter" /> will return the list itself, since they're all children of the root.</remarks>
</Docs>
</Member>
<Member MemberName="GetIter">
@ -675,11 +696,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>Gets an iterator object for the given <paramref name="path"/>.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter&amp;" /> to set to point to the row.</param>
<param name="path">a <see cref="Gtk.TreePath" /></param>
<returns>A <see cref="T:System.Boolean" />, true if the row exists</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="IterParent">
@ -693,11 +714,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>Gets the parent row of <paramref name="child"/>.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter&amp;" /> to set to point to the row.</param>
<param name="child">a <see cref="T:Gtk.TreeIter" />, the child row whose parent we want to get</param>
<returns>A <see cref="T:System.Boolean" />, true if the parent exists. Since ListStore objects aren't tree-shaped, this will always return false.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="AppendValues">
@ -710,10 +731,10 @@
<Parameter Name="values" Type="System.Object[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="values">a <see cref="T:System.Object[]" /></param>
<returns>a <see cref="T:Gtk.TreeIter" /></returns>
<remarks>To be added</remarks>
<summary>Appends a new row to the ListStore and puts the objects in <paramref name="values" /> in it.</summary>
<param name="values">a list <see cref="T:System.Object[]" />, one item for each column of a row.</param>
<returns>a <see cref="T:Gtk.TreeIter" /> pointing to the new row</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="AppendValues">
@ -726,10 +747,10 @@
<Parameter Name="values" Type="System.Array" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="values">a <see cref="T:System.Array" /></param>
<returns>a <see cref="T:Gtk.TreeIter" /></returns>
<remarks>To be added</remarks>
<summary>Appends a new row to the ListStore and puts the contents of <paramref name="values" /> in it.</summary>
<param name="values">a <see cref="T:System.Array" /> with as many elements as the ListStore has columns.</param>
<returns>a <see cref="T:Gtk.TreeIter" /> pointing to the new row</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GetStringFromIter">
@ -742,10 +763,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Marshals the given <paramref name="iter" /> into a string.</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>(FIXME: explain the return results.)</remarks>
</Docs>
</Member>
<Member MemberName="MoveAfter">
@ -759,10 +780,15 @@
<Parameter Name="position" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Move the row pointed to by <paramref name="iter"/> to the
position after <paramref name="position"/>. If
<paramref name="position"/> is <see langword="null"/>,
<paramref name="iter"/> will be moved to point to the start
of the list.
</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="position">a <see cref="T:Gtk.TreeIter" /></param>
<remarks>To be added</remarks>
<remarks>This only works in unsorted stores.</remarks>
</Docs>
</Member>
<Member MemberName="Swap">
@ -793,10 +819,15 @@
<Parameter Name="position" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Move the row pointed to by <paramref name="iter"/> to the
position before <paramref name="position"/>. If
<paramref name="position"/> is <see langword="null"/>,
<paramref name="iter"/> will be moved to point to the end
of the list.
</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="position">a <see cref="T:Gtk.TreeIter" /></param>
<remarks>To be added</remarks>
<remarks>This only works in unsorted stores.</remarks>
</Docs>
</Member>
<Member MemberName="IterIsValid">
@ -809,10 +840,11 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Test whether <paramref name="iter"/> is valid for this ListStore.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.Boolean" />, true if <paramref name="iter"/> is valid.</returns>
<remarks>WARNING: this method is slow and is only intended for
debugging/testing purposes.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -847,11 +879,11 @@ The above example creates a new three columns list store. The types of the colum
<Parameter Name="order" Type="Gtk.SortType&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="sort_column_id">a <see cref="T:System.Int32&amp;" /></param>
<param name="order">a <see cref="T:Gtk.SortType&amp;" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Report on which column is currently being used to sort this ListStore.</summary>
<param name="sort_column_id">a <see cref="T:System.Int32&amp;" />, gets filled with the column number that's currently used for sorting</param>
<param name="order">a <see cref="T:Gtk.SortType&amp;" />, the current type of sort (ascending or descending)</param>
<returns>a <see cref="T:System.Boolean" />, false if the default sort column for this ListStore is being used, true if some other sort column is being used.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="SetValue">
@ -998,11 +1030,12 @@ The above example creates a new three columns list store. The types of the colum
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<summary>Gets the data from row <paramref name="iter"/> of column
<paramref name="column"/>.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" />, the row to look in</param>
<param name="column">a <see cref="T:System.Int32" />, the column number to look in</param>
<returns>a <see cref="T:System.Object" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="HasDefaultSortFunc">
@ -1013,9 +1046,10 @@ The above example creates a new three columns list store. The types of the colum
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Find out whether this ListStore has a default sort function.</summary>
<returns>a <see cref="T:System.Boolean" />, true if there is a default
sort function.</returns>
<remarks>To set a default sort function, use <see cref="M:Gtk.ListStore.SetDefaultSortFunc"/>.</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -1041,9 +1075,14 @@ The above example creates a new three columns list store. The types of the colum
<Parameter Name="types" Type="GLib.GType[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets what types go in each column of a ListStore.</summary>
<param name="types">a <see cref="T:GLib.GType[]" /></param>
<remarks>To be added</remarks>
<remarks> This function is meant primarily for #GObjects that inherit
from <see cref="T:Gtk.ListStore"/> and should only be used when
constructing a new <see cref="T:Gtk.ListStore"/>. It will not
function after a row has been added or after a method on the
<see cref="T:Gtk.TreeModel"/> interface has been called.
</remarks>
</Docs>
</Member>
<Member MemberName="GetColumnType">
@ -1056,10 +1095,10 @@ The above example creates a new three columns list store. The types of the colum
<Parameter Name="index_" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="index_">a <see cref="T:System.Int32" /></param>
<summary>Gets the type of data stored in column number <paramref name="index_" />.</summary>
<param name="index_">a <see cref="T:System.Int32" />, the column to check</param>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="OnRowsReordered">
@ -1181,10 +1220,10 @@ The above example creates a new three columns list store. The types of the colum
<Parameter Name="types" Type="GLib.GType[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Default constructor.</summary>
<param name="types">a <see cref="T:GLib.GType[]" /></param>
<returns>a <see cref="T:Gtk.ListStore" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Reorder">
@ -1195,9 +1234,9 @@ The above example creates a new three columns list store. The types of the colum
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Reorders the ListStore.</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks>(FIXME: Does this binding work?)</remarks>
</Docs>
</Member>
<Member MemberName="Insert">
@ -1210,10 +1249,14 @@ The above example creates a new three columns list store. The types of the colum
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Inserts a new row at position <paramref name="position" />.</summary>
<param name="position">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.TreeIter" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:Gtk.TreeIter" /> pointing to the new row.</returns>
<remarks> If <paramref name="position" /> is larger than the number
of rows on the list, then the new row will be appended to the list.
The row will be empty before this function is called. To set the
value of the new row, use <see cref="M:Gtk.ListStore.SetValue" />.
</remarks>
</Docs>
</Member>
<Member MemberName="Prepend">
@ -1224,9 +1267,13 @@ The above example creates a new three columns list store. The types of the colum
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.TreeIter" /></returns>
<remarks>To be added</remarks>
<summary>Adds a new row to the beginning of the list.</summary>
<returns>a <see cref="T:Gtk.TreeIter" /> pointing to the new row.
</returns>
<remarks>
The row will be empty before this function is called. To set the
value of the new row, use <see cref="M:Gtk.ListStore.SetValue" />.
</remarks>
</Docs>
</Member>
<Member MemberName="InsertBefore">
@ -1239,10 +1286,17 @@ The above example creates a new three columns list store. The types of the colum
<Parameter Name="sibling" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="sibling">a <see cref="T:Gtk.TreeIter" /></param>
<returns>a <see cref="T:Gtk.TreeIter" /></returns>
<remarks>To be added</remarks>
<summary>
Inserts a new row before <paramref name="sibling" />. If
<paramref name="sibling" /> is null, then the row will be appended
to the end of the list.
</summary>
<param name="sibling">a <see cref="T:Gtk.TreeIter" />, the row to insert before</param>
<returns>a <see cref="T:Gtk.TreeIter" /> that points to the new row</returns>
<remarks>
The row will be empty before this function is called. To set the
value of the new row, use <see cref="M:Gtk.ListStore.SetValue" />.
</remarks>
</Docs>
</Member>
<Member MemberName="InsertAfter">
@ -1255,10 +1309,17 @@ The above example creates a new three columns list store. The types of the colum
<Parameter Name="sibling" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="sibling">a <see cref="T:Gtk.TreeIter" /></param>
<returns>a <see cref="T:Gtk.TreeIter" /></returns>
<remarks>To be added</remarks>
<summary>
Inserts a new row after <paramref name="sibling" />. If
<paramref name="sibling" /> is null, then the row will be appended
to the end of the list.
</summary>
<param name="sibling">a <see cref="T:Gtk.TreeIter" />, the row to insert before</param>
<returns>a <see cref="T:Gtk.TreeIter" /> that points to the new row</returns>
<remarks>
The row will be empty before this function is called. To set the
value of the new row, use <see cref="M:Gtk.ListStore.SetValue" />.
</remarks>
</Docs>
</Member>
<Member MemberName="Append">
@ -1269,9 +1330,12 @@ The above example creates a new three columns list store. The types of the colum
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.TreeIter" /></returns>
<remarks>To be added</remarks>
<summary>Appends a new row to the ListStore.</summary>
<returns>a <see cref="T:Gtk.TreeIter" /> that points to the new row.</returns>
<remarks>
The row will be empty before this function is called. To set the
value of the new row, use <see cref="M:Gtk.ListStore.SetValue" />.
</remarks>
</Docs>
</Member>
<Member MemberName="EmitRowsReordered">
@ -1285,11 +1349,11 @@ The above example creates a new three columns list store. The types of the colum
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.TreePath" /></param>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<summary>Fires a <see cref="E:Gtk.ListStore.RowsReordered"/> event.</summary>
<param name="path">a <see cref="T:Gtk.TreePath" />, pointer to the row whose children have been reordered</param>
<param name="iter">a <see cref="T:Gtk.TreeIter" />, pointer to the row whose children have been reordered</param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks>This is part of the implementation of <see cref="T:Gtk.TreeModel"/>. It should be called by other class methods that reorder rows so that the proper events are fired. (FIXME: since lists don't have parents/children, how does this get used in practice? There should be an example here.)</remarks>
</Docs>
</Member>
<Member MemberName="Remove">
@ -1305,7 +1369,7 @@ The above example creates a new three columns list store. The types of the colum
<summary>Removes a row from the store.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>After being removed, iter is set to be the next valid row, or invalidated if it pointed to the last row in the store.</remarks>
<remarks>After being removed, <paramref name="iter" /> is set to be the next valid row, or invalidated if it pointed to the last row in the store.</remarks>
</Docs>
</Member>
<Member MemberName="GetValue">
@ -1320,11 +1384,13 @@ The above example creates a new three columns list store. The types of the colum
<Parameter Name="value" Type="GLib.Value&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Gets the value of row <paramref name="iter" /> of column
<paramref name="column" /> and puts it in <paramref name="value"/>.
</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<param name="value">a <see cref="T:GLib.Value" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="IterNext">
@ -1337,11 +1403,11 @@ The above example creates a new three columns list store. The types of the colum
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Advances <paramref name="iter" /> to the next row.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.Boolean" /> for whether the operation succeeded.</returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>