2003-02-12 02:00:12 +00:00
<Type Name= "ListStore" FullName= "Gtk.ListStore" >
2003-02-15 03:08:25 +00:00
<TypeSignature Language= "C#" Value= "public class ListStore : GLib.Object, TreeModel, IWrapper, TreeDragSource, TreeDragDest, TreeSortable, IWrapper, IDisposable" Maintainer= "auto" />
2003-02-12 02:00:12 +00:00
<AssemblyInfo >
<AssemblyName > gtk-sharp</AssemblyName>
2003-12-04 21:09:30 +00:00
<AssemblyPublicKey >
</AssemblyPublicKey>
2003-02-12 02:00:12 +00:00
<AssemblyVersion > 0.0.0.0</AssemblyVersion>
2003-10-28 00:48:23 +00:00
<AssemblyCulture > neutral</AssemblyCulture>
2003-02-12 02:00:12 +00:00
<Attributes />
</AssemblyInfo>
2003-02-23 07:26:30 +00:00
<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>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-24 17:01:00 +00:00
<summary > The ListStore is a columned list data structure to be used with <see cref= "T:Gtk.TreeView" /> widget. It is the model part in Model/View/Controller design paradigm. The contents of the ListStore can be sorted and are drag-and-drop ready.
2004-04-10 22:07:38 +00:00
</summary>
2004-08-19 03:09:20 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
<Base >
<BaseTypeName > GLib.Object</BaseTypeName>
</Base>
<Interfaces >
<Interface >
<InterfaceName > Gtk.TreeModel</InterfaceName>
</Interface>
<Interface >
<InterfaceName > GLib.IWrapper</InterfaceName>
</Interface>
<Interface >
<InterfaceName > Gtk.TreeDragSource</InterfaceName>
</Interface>
<Interface >
<InterfaceName > Gtk.TreeDragDest</InterfaceName>
</Interface>
<Interface >
<InterfaceName > Gtk.TreeSortable</InterfaceName>
</Interface>
<Interface >
<InterfaceName > GLib.IWrapper</InterfaceName>
</Interface>
<Interface >
<InterfaceName > System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members >
<Member MemberName= "IterNChildren" >
<MemberSignature Language= "C#" Value= "public virtual int IterNChildren ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
<returns > To be added: an object of type 'int'</returns>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "IterChildren" >
2003-02-15 03:08:25 +00:00
<MemberSignature Language= "C#" Value= "public virtual bool IterChildren (out Gtk.TreeIter iter);" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
</Parameters>
2003-02-12 02:00:12 +00:00
<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>
</Docs>
</Member>
2004-08-19 03:09:20 +00:00
2003-02-12 02:00:12 +00:00
<Member MemberName= "ChangeSortColumn" >
<MemberSignature Language= "C#" Value= "public virtual void ChangeSortColumn ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Emits a <see cref= "M:Gtk.ListStore.SortColumnChanged" /> event.</summary>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "SetSortColumnId" >
<MemberSignature Language= "C#" Value= "public virtual void SetSortColumnId (int sort_column_id, Gtk.SortType order);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "sort_column_id" Type= "System.Int32" />
<Parameter Name= "order" Type= "Gtk.SortType" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "SetSortFunc" >
<MemberSignature Language= "C#" Value= "public virtual void SetSortFunc (int sort_column_id, Gtk.TreeIterCompareFunc sort_func, IntPtr user_data, Gtk.DestroyNotify destroy);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "sort_column_id" Type= "System.Int32" />
<Parameter Name= "sort_func" Type= "Gtk.TreeIterCompareFunc" />
<Parameter Name= "user_data" Type= "System.IntPtr" />
<Parameter Name= "destroy" Type= "Gtk.DestroyNotify" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "SetDefaultSortFunc" >
<MemberSignature Language= "C#" Value= "public virtual void SetDefaultSortFunc (Gtk.TreeIterCompareFunc sort_func, IntPtr user_data, Gtk.DestroyNotify destroy);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "sort_func" Type= "Gtk.TreeIterCompareFunc" />
<Parameter Name= "user_data" Type= "System.IntPtr" />
<Parameter Name= "destroy" Type= "Gtk.DestroyNotify" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "RowDropPossible" >
<MemberSignature Language= "C#" Value= "public virtual bool RowDropPossible (Gtk.TreePath dest_path, Gtk.SelectionData selection_data);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "dest_path" Type= "Gtk.TreePath" />
<Parameter Name= "selection_data" Type= "Gtk.SelectionData" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "DragDataReceived" >
<MemberSignature Language= "C#" Value= "public virtual bool DragDataReceived (Gtk.TreePath dest, Gtk.SelectionData selection_data);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "dest" Type= "Gtk.TreePath" />
<Parameter Name= "selection_data" Type= "Gtk.SelectionData" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-24 23:04:07 +00:00
<summary > Drags data received into this <see cref= "T:Gtk.ListStore" /> object.</summary>
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "DragDataGet" >
<MemberSignature Language= "C#" Value= "public virtual bool DragDataGet (Gtk.TreePath path, Gtk.SelectionData selection_data);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "selection_data" Type= "Gtk.SelectionData" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "RowDraggable" >
<MemberSignature Language= "C#" Value= "public virtual bool RowDraggable (Gtk.TreePath path);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "path" Type= "Gtk.TreePath" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "DragDataDelete" >
<MemberSignature Language= "C#" Value= "public virtual bool DragDataDelete (Gtk.TreePath path);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "path" Type= "Gtk.TreePath" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "EmitRowChanged" >
<MemberSignature Language= "C#" Value= "public virtual void EmitRowChanged (Gtk.TreePath path, Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "Foreach" >
<MemberSignature Language= "C#" Value= "public virtual void Foreach (Gtk.TreeModelForeachFunc func);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "func" Type= "Gtk.TreeModelForeachFunc" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "GetIterFirst" >
2003-02-15 03:08:25 +00:00
<MemberSignature Language= "C#" Value= "public virtual bool GetIterFirst (out Gtk.TreeIter iter);" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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&" /> to reset</param>
<returns > A <see cref= "T:System.Boolean" /> , true if the operation is successful, false if the ListStore is empty.</returns>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "EmitRowHasChildToggled" >
<MemberSignature Language= "C#" Value= "public virtual void EmitRowHasChildToggled (Gtk.TreePath path, Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "GetPath" >
<MemberSignature Language= "C#" Value= "public virtual Gtk.TreePath GetPath (Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreePath</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "IterHasChild" >
<MemberSignature Language= "C#" Value= "public virtual bool IterHasChild (Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "RefNode" >
<MemberSignature Language= "C#" Value= "public virtual void RefNode (Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "IterNChildren" >
<MemberSignature Language= "C#" Value= "public virtual int IterNChildren (Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "EmitRowInserted" >
<MemberSignature Language= "C#" Value= "public virtual void EmitRowInserted (Gtk.TreePath path, Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "EmitRowDeleted" >
<MemberSignature Language= "C#" Value= "public virtual void EmitRowDeleted (Gtk.TreePath path);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "path" Type= "Gtk.TreePath" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "GetValist" >
<MemberSignature Language= "C#" Value= "public virtual void GetValist (Gtk.TreeIter iter, IntPtr var_args);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "var_args" Type= "System.IntPtr" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-24 23:04:07 +00:00
<summary > Gets the values of child properties for the row pointed to by <paramref name= "iter" /> .</summary>
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
<param name= "var_args" > a <see cref= "T:System.IntPtr" /> , pointer to the va_list data structure of arguments (FIXME: clarify what va_lists look like)</param>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "UnrefNode" >
<MemberSignature Language= "C#" Value= "public virtual void UnrefNode (Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "Clear" >
<MemberSignature Language= "C#" Value= "public void Clear ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-04-10 22:07:38 +00:00
<summary > Removes all data from the store.</summary>
2004-08-19 03:09:20 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "SetValist" >
<MemberSignature Language= "C#" Value= "public void SetValist (Gtk.TreeIter iter, IntPtr var_args);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "var_args" Type= "System.IntPtr" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-24 23:04:07 +00:00
<summary > Sets the values of child properties for the row pointed to by <paramref name= "iter" /> .</summary>
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
<param name= "var_args" > a <see cref= "T:System.IntPtr" /> , pointer to the va_list data structure of arguments (FIXME: clarify what va_lists look like)</param>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "SetValue" >
<MemberSignature Language= "C#" Value= "public void SetValue (Gtk.TreeIter iter, int column, GLib.Value value);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "GLib.Value" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2004-04-10 22:07:38 +00:00
<remarks > The type of specified column must be a <see cref= "T:GLib.Value" /> .</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "Finalize" >
2003-10-13 22:55:58 +00:00
<MemberSignature Language= "C#" Value= "protected override void Finalize ();" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2003-02-23 07:26:30 +00:00
<summary > Disposes the resources associated with the object.</summary>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public ListStore (IntPtr raw);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "raw" Type= "System.IntPtr" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-23 07:26:30 +00:00
<summary > Internal constructor</summary>
<param name= "raw" > Pointer to the C object.</param>
<returns > An instance of ListStore, wrapping the C object.</returns>
<remarks >
<para > This is an internal constructor, and should not be used by user code.</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "NColumns" >
<MemberSignature Language= "C#" Value= "public virtual int NColumns { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Docs >
2004-08-19 03:09:20 +00:00
<summary > The number of columns in this ListStore.</summary>
<returns > A <see cref= "System.Int32" /> </returns>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "Flags" >
<MemberSignature Language= "C#" Value= "public virtual Gtk.TreeModelFlags Flags { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreeModelFlags</ReturnType>
</ReturnValue>
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "SortColumnChanged" >
<MemberSignature Language= "C#" Value= "public virtual event EventHandler SortColumnChanged;" />
<MemberType > Event</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
<ReturnType > System.EventHandler</ReturnType>
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2004-08-19 03:25:17 +00:00
<summary > Fired when the sorting column has changed.</summary>
2004-08-19 03:09:20 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "RowHasChildToggled" >
2004-02-25 23:39:06 +00:00
<MemberSignature Language= "C#" Value= "public virtual event Gtk.RowHasChildToggledHandler RowHasChildToggled;" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
2004-02-25 23:39:06 +00:00
<ReturnType > Gtk.RowHasChildToggledHandler</ReturnType>
2003-09-17 21:56:59 +00:00
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Fired when the display of a given row's children is toggled.</summary>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "RowInserted" >
2004-02-25 23:39:06 +00:00
<MemberSignature Language= "C#" Value= "public virtual event Gtk.RowInsertedHandler RowInserted;" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
2004-02-25 23:39:06 +00:00
<ReturnType > Gtk.RowInsertedHandler</ReturnType>
2003-09-17 21:56:59 +00:00
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Fired when a row of data is inserted.</summary>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "RowDeleted" >
2004-02-25 23:39:06 +00:00
<MemberSignature Language= "C#" Value= "public virtual event Gtk.RowDeletedHandler RowDeleted;" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
2004-02-25 23:39:06 +00:00
<ReturnType > Gtk.RowDeletedHandler</ReturnType>
2003-09-17 21:56:59 +00:00
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Fired when a row is deleted.</summary>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "RowChanged" >
2004-02-25 23:39:06 +00:00
<MemberSignature Language= "C#" Value= "public virtual event Gtk.RowChangedHandler RowChanged;" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
2004-02-25 23:39:06 +00:00
<ReturnType > Gtk.RowChangedHandler</ReturnType>
2003-09-17 21:56:59 +00:00
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Fired when a row has changed.</summary>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "RowsReordered" >
2004-02-25 23:39:06 +00:00
<MemberSignature Language= "C#" Value= "public virtual event Gtk.RowsReorderedHandler RowsReordered;" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
2004-02-25 23:39:06 +00:00
<ReturnType > Gtk.RowsReorderedHandler</ReturnType>
2003-09-17 21:56:59 +00:00
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Fired when the order of rows has changed.</summary>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2003-05-08 20:26:02 +00:00
<Member MemberName= "IterNthChild" >
<MemberSignature Language= "C#" Value= "public virtual bool IterNthChild (out Gtk.TreeIter iter, int n);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
<Parameter Name= "n" Type= "System.Int32" />
</Parameters>
2003-05-08 20:26:02 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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&" /> </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>
2003-05-08 20:26:02 +00:00
</Docs>
</Member>
<Member MemberName= "IterNthChild" >
<MemberSignature Language= "C#" Value= "public virtual bool IterNthChild (out Gtk.TreeIter iter, Gtk.TreeIter parent, int n);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
<Parameter Name= "parent" Type= "Gtk.TreeIter" />
<Parameter Name= "n" Type= "System.Int32" />
</Parameters>
2003-05-08 20:26:02 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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&" /> </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>
2003-05-08 20:26:02 +00:00
</Docs>
</Member>
<Member MemberName= "GetIterFromString" >
<MemberSignature Language= "C#" Value= "public virtual bool GetIterFromString (out Gtk.TreeIter iter, string path_string);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
<Parameter Name= "path_string" Type= "System.String" />
</Parameters>
2003-05-08 20:26:02 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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&" /> 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 />
2003-05-08 20:26:02 +00:00
</Docs>
</Member>
<Member MemberName= "IterChildren" >
<MemberSignature Language= "C#" Value= "public virtual bool IterChildren (out Gtk.TreeIter iter, Gtk.TreeIter parent);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
<Parameter Name= "parent" Type= "Gtk.TreeIter" />
</Parameters>
2003-05-08 20:26:02 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2003-05-08 20:26:02 +00:00
</Docs>
</Member>
<Member MemberName= "GetIter" >
<MemberSignature Language= "C#" Value= "public virtual bool GetIter (out Gtk.TreeIter iter, Gtk.TreePath path);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
<Parameter Name= "path" Type= "Gtk.TreePath" />
</Parameters>
2003-05-08 20:26:02 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Gets an iterator object for the given <paramref name= "path" /> .</summary>
<param name= "iter" > a <see cref= "T:Gtk.TreeIter&" /> 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 />
2003-05-08 20:26:02 +00:00
</Docs>
</Member>
<Member MemberName= "IterParent" >
<MemberSignature Language= "C#" Value= "public virtual bool IterParent (out Gtk.TreeIter iter, Gtk.TreeIter child);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
<Parameter Name= "child" Type= "Gtk.TreeIter" />
</Parameters>
2003-05-08 20:26:02 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Gets the parent row of <paramref name= "child" /> .</summary>
<param name= "iter" > a <see cref= "T:Gtk.TreeIter&" /> 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 />
2003-05-08 20:26:02 +00:00
</Docs>
</Member>
2003-07-17 06:38:40 +00:00
<Member MemberName= "AppendValues" >
<MemberSignature Language= "C#" Value= "public Gtk.TreeIter AppendValues (object [] values);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreeIter</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "values" Type= "System.Object[]" />
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
<Member MemberName= "AppendValues" >
<MemberSignature Language= "C#" Value= "public Gtk.TreeIter AppendValues (Array values);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreeIter</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "values" Type= "System.Array" />
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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 />
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "GetStringFromIter" >
<MemberSignature Language= "C#" Value= "public virtual string GetStringFromIter (Gtk.TreeIter iter);" />
2003-07-17 06:38:40 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2003-11-05 04:30:47 +00:00
<ReturnType > System.String</ReturnType>
2003-07-17 06:38:40 +00:00
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2004-08-24 23:04:07 +00:00
<summary > Marshals the given <paramref name= "iter" /> into a path string.</summary>
2003-07-17 06:38:40 +00:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2003-11-05 04:30:47 +00:00
<returns > a <see cref= "T:System.String" /> </returns>
2004-08-24 23:04:07 +00:00
<remarks />
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "MoveAfter" >
<MemberSignature Language= "C#" Value= "public void MoveAfter (Gtk.TreeIter iter, Gtk.TreeIter position);" />
2003-07-17 06:38:40 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
2003-11-05 04:30:47 +00:00
<Parameter Name= "position" Type= "Gtk.TreeIter" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2003-07-17 06:38:40 +00:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2003-11-05 04:30:47 +00:00
<param name= "position" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-08-19 03:09:20 +00:00
<remarks > This only works in unsorted stores.</remarks>
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "Swap" >
<MemberSignature Language= "C#" Value= "public void Swap (Gtk.TreeIter a, Gtk.TreeIter b);" />
2003-07-17 06:38:40 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-11-05 04:30:47 +00:00
<Parameter Name= "a" Type= "Gtk.TreeIter" />
<Parameter Name= "b" Type= "Gtk.TreeIter" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2004-04-10 22:07:38 +00:00
<summary > Swaps rows a and b in the store.</summary>
2003-11-05 04:30:47 +00:00
<param name= "a" > a <see cref= "T:Gtk.TreeIter" /> </param>
<param name= "b" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-04-10 22:07:38 +00:00
<remarks > This is only works in unsorted stores.</remarks>
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "MoveBefore" >
<MemberSignature Language= "C#" Value= "public void MoveBefore (Gtk.TreeIter iter, Gtk.TreeIter position);" />
2003-07-17 06:38:40 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
2003-11-05 04:30:47 +00:00
<Parameter Name= "position" Type= "Gtk.TreeIter" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2003-07-17 06:38:40 +00:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2003-11-05 04:30:47 +00:00
<param name= "position" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-08-19 03:09:20 +00:00
<remarks > This only works in unsorted stores.</remarks>
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "IterIsValid" >
<MemberSignature Language= "C#" Value= "public bool IterIsValid (Gtk.TreeIter iter);" />
2003-07-17 06:38:40 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2003-11-05 04:30:47 +00:00
<ReturnType > System.Boolean</ReturnType>
2003-07-17 06:38:40 +00:00
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Test whether <paramref name= "iter" /> is valid for this ListStore.</summary>
2003-07-17 06:38:40 +00:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-08-19 03:09:20 +00:00
<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>
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public ListStore (Type [] types);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "types" Type= "System.Type[]" />
</Parameters>
<Docs >
2004-04-10 22:07:38 +00:00
<summary > Creates a new store. The columns' type specified by the argument.</summary>
2003-11-05 04:30:47 +00:00
<param name= "types" > a <see cref= "T:System.Type[]" /> </param>
<returns > a <see cref= "T:Gtk.ListStore" /> </returns>
2004-04-10 22:07:38 +00:00
<remarks >
<example >
<code lang= "C#" >
ListStore ls = new ListStore (typeof (string), typeof (int), typeof (double));
...
</code>
</example>
The above example creates a new three columns list store. The types of the columns are <see cref= "T:System.String" /> , <see cref= "T:System.Int32" /> , and <see cref= "T:System.Double" /> .</remarks>
2003-11-05 04:30:47 +00:00
</Docs>
</Member>
<Member MemberName= "GetSortColumnId" >
<MemberSignature Language= "C#" Value= "public virtual bool GetSortColumnId (out int sort_column_id, out Gtk.SortType order);" />
2003-07-17 06:38:40 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
2003-11-05 04:30:47 +00:00
<Parameter Name= "sort_column_id" Type= "System.Int32&" RefType= "out" />
<Parameter Name= "order" Type= "Gtk.SortType&" RefType= "out" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2004-08-19 03:09:20 +00:00
<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&" /> , gets filled with the column number that's currently used for sorting</param>
<param name= "order" > a <see cref= "T:Gtk.SortType&" /> , 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 />
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "SetValue" >
<MemberSignature Language= "C#" Value= "public virtual void SetValue (Gtk.TreeIter iter, int column, bool value);" />
2003-07-17 06:38:40 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-11-05 04:30:47 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.Boolean" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2004-04-10 22:07:38 +00:00
<summary > Sets the value of the specified column in the row pointed by iter.</summary>
2003-11-05 04:30:47 +00:00
<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:System.Boolean" /> </param>
2004-04-10 22:07:38 +00:00
<remarks > The type of specified column must be a <see cref= "T:System.Boolean" /> .</remarks>
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "SetValue" >
<MemberSignature Language= "C#" Value= "public virtual void SetValue (Gtk.TreeIter iter, int column, double value);" />
2003-07-17 06:38:40 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
2003-11-05 04:30:47 +00:00
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.Double" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2004-04-10 22:07:38 +00:00
<summary > Sets the value of the specified column in the row pointed by iter.</summary>
2003-07-17 06:38:40 +00:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2003-11-05 04:30:47 +00:00
<param name= "column" > a <see cref= "T:System.Int32" /> </param>
<param name= "value" > a <see cref= "T:System.Double" /> </param>
2004-04-10 22:07:38 +00:00
<remarks > The type of specified column must be a <see cref= "T:System.Double" /> .</remarks>
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "SetValue" >
<MemberSignature Language= "C#" Value= "public virtual void SetValue (Gtk.TreeIter iter, int column, int value);" />
2003-07-17 06:38:40 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2003-11-05 04:30:47 +00:00
<ReturnType > System.Void</ReturnType>
2003-07-17 06:38:40 +00:00
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
2003-11-05 04:30:47 +00:00
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.Int32" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2004-04-10 22:07:38 +00:00
<summary > Sets the value of the specified column in the row pointed by iter.</summary>
2003-07-17 06:38:40 +00:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2003-11-05 04:30:47 +00:00
<param name= "column" > a <see cref= "T:System.Int32" /> </param>
<param name= "value" > a <see cref= "T:System.Int32" /> </param>
2004-04-10 22:07:38 +00:00
<remarks > The type of specified column must be an <see cref= "T:System.Int32" /> .</remarks>
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "SetValue" >
<MemberSignature Language= "C#" Value= "public virtual void SetValue (Gtk.TreeIter iter, int column, string value);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
2003-07-17 06:38:40 +00:00
<Parameters >
2003-11-05 04:30:47 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.String" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2004-04-10 22:07:38 +00:00
<summary > Sets the value of the specified column in the row pointed by iter.</summary>
2003-11-05 04:30:47 +00:00
<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:System.String" /> </param>
2004-04-10 22:07:38 +00:00
<remarks > The type of specified column must be a <see cref= "T:System.String" /> .</remarks>
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "SetValue" >
<MemberSignature Language= "C#" Value= "public virtual void SetValue (Gtk.TreeIter iter, int column, float value);" />
2003-10-12 09:06:39 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
2003-11-05 04:30:47 +00:00
<Parameter Name= "value" Type= "System.Single" />
2003-10-12 09:06:39 +00:00
</Parameters>
<Docs >
2004-04-10 22:07:38 +00:00
<summary > Sets the value of the specified column in the row pointed by iter.</summary>
2003-10-12 09:06:39 +00:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
<param name= "column" > a <see cref= "T:System.Int32" /> </param>
2003-11-05 04:30:47 +00:00
<param name= "value" > a <see cref= "T:System.Single" /> </param>
2004-04-10 22:07:38 +00:00
<remarks > The type of specified column must be an <see cref= "T:System.Single" /> </remarks>
2003-10-12 09:06:39 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "SetValue" >
<MemberSignature Language= "C#" Value= "public virtual void SetValue (Gtk.TreeIter iter, int column, uint value);" />
2003-10-28 00:48:23 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-11-05 04:30:47 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.UInt32" />
2003-10-28 00:48:23 +00:00
</Parameters>
<Docs >
2004-04-10 22:07:38 +00:00
<summary > Sets the value of the specified column in the row pointed by iter.</summary>
2003-11-05 04:30:47 +00:00
<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:System.UInt32" /> </param>
2004-04-10 22:07:38 +00:00
<remarks > The type of specified column must be an <see cref= "T:System.UInt32" /> .</remarks>
2003-10-28 00:48:23 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "SetValue" >
<MemberSignature Language= "C#" Value= "public virtual void SetValue (Gtk.TreeIter iter, int column, object value);" />
2003-10-28 00:48:23 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
2003-11-05 04:30:47 +00:00
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.Object" />
2003-10-28 00:48:23 +00:00
</Parameters>
<Docs >
2004-04-10 22:07:38 +00:00
<summary > Sets the value of the specified column in the row pointed by iter.</summary>
2003-10-28 00:48:23 +00:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2003-11-05 04:30:47 +00:00
<param name= "column" > a <see cref= "T:System.Int32" /> </param>
<param name= "value" > a <see cref= "T:System.Object" /> </param>
2004-04-10 22:07:38 +00:00
<remarks > The type of specified column must be an <see cref= "T:System.Object" /> .</remarks>
2003-10-28 00:48:23 +00:00
</Docs>
</Member>
2003-11-05 04:30:47 +00:00
<Member MemberName= "GetValue" >
<MemberSignature Language= "C#" Value= "public virtual object GetValue (Gtk.TreeIter iter, int column);" />
2003-10-28 00:48:23 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2003-11-05 04:30:47 +00:00
<ReturnType > System.Object</ReturnType>
2003-10-28 00:48:23 +00:00
</ReturnValue>
<Parameters >
2003-11-05 04:30:47 +00:00
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
2003-10-28 00:48:23 +00:00
</Parameters>
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2003-11-05 04:30:47 +00:00
<returns > a <see cref= "T:System.Object" /> </returns>
2004-08-19 03:09:20 +00:00
<remarks />
2003-11-05 04:30:47 +00:00
</Docs>
</Member>
<Member MemberName= "HasDefaultSortFunc" >
<MemberSignature Language= "C#" Value= "public virtual bool HasDefaultSortFunc { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2003-10-28 00:48:23 +00:00
</Docs>
</Member>
2003-12-24 01:35:30 +00:00
<Member MemberName= "GType" >
<MemberSignature Language= "C#" Value= "public static GLib.GType GType { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-21 20:14:42 +00:00
<summary > GType Property.</summary>
2003-12-24 01:35:30 +00:00
<returns > a <see cref= "T:GLib.GType" /> </returns>
2004-06-21 20:14:42 +00:00
<remarks > Returns the native <see cref= "T:GLib.GType" /> value for <see cref= "T:Gtk.ListStore" /> .</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "SetColumnTypes" >
<MemberSignature Language= "C#" Value= "public void SetColumnTypes (GLib.GType[] types);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "types" Type= "GLib.GType[]" />
</Parameters>
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Sets what types go in each column of a ListStore.</summary>
2003-12-24 01:35:30 +00:00
<param name= "types" > a <see cref= "T:GLib.GType[]" /> </param>
2004-08-19 03:09:20 +00:00
<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>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "GetColumnType" >
<MemberSignature Language= "C#" Value= "public virtual GLib.GType GetColumnType (int index_);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "index_" Type= "System.Int32" />
</Parameters>
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2003-12-24 01:35:30 +00:00
<returns > a <see cref= "T:GLib.GType" /> </returns>
2004-08-19 03:09:20 +00:00
<remarks />
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnRowsReordered" >
<MemberSignature Language= "C#" Value= "protected virtual void OnRowsReordered (Gtk.TreePath path, Gtk.TreeIter iter, out int new_order);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "new_order" Type= "System.Int32&" RefType= "out" />
</Parameters>
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.ListStore.RowsReordered" /> event.</summary>
2003-12-24 01:35:30 +00:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> </param>
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
<param name= "new_order" > a <see cref= "T:System.Int32&" /> </param>
2004-06-15 15:41:25 +00:00
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.ListStore.RowsReordered" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnRowChanged" >
<MemberSignature Language= "C#" Value= "protected virtual void OnRowChanged (Gtk.TreePath path, Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.ListStore.RowChanged" /> event.</summary>
2003-12-24 01:35:30 +00:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> </param>
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-06-15 15:41:25 +00:00
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.ListStore.RowChanged" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnRowDeleted" >
<MemberSignature Language= "C#" Value= "protected virtual void OnRowDeleted (Gtk.TreePath path);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
</Parameters>
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.ListStore.RowDeleted" /> event.</summary>
2003-12-24 01:35:30 +00:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> </param>
2004-06-15 15:41:25 +00:00
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.ListStore.RowDeleted" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnRowInserted" >
<MemberSignature Language= "C#" Value= "protected virtual void OnRowInserted (Gtk.TreePath path, Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.ListStore.RowInserted" /> event.</summary>
2003-12-24 01:35:30 +00:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> </param>
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-06-15 15:41:25 +00:00
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.ListStore.RowInserted" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnRowHasChildToggled" >
<MemberSignature Language= "C#" Value= "protected virtual void OnRowHasChildToggled (Gtk.TreePath path, Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.ListStore.RowHasChildToggled" /> event.</summary>
2003-12-24 01:35:30 +00:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> </param>
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-06-15 15:41:25 +00:00
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.ListStore.RowHasChildToggled" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnSortColumnChanged" >
<MemberSignature Language= "C#" Value= "protected virtual void OnSortColumnChanged ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.ListStore.SortColumnChanged" /> event.</summary>
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.ListStore.SortColumnChanged" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "protected ListStore (GLib.GType gtype);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "gtype" Type= "GLib.GType" />
</Parameters>
<Docs >
2004-06-21 20:33:11 +00:00
<summary > Protected Constructor.</summary>
2003-12-24 01:35:30 +00:00
<param name= "gtype" > a <see cref= "T:GLib.GType" /> </param>
<returns > a <see cref= "T:Gtk.ListStore" /> </returns>
2004-06-21 20:33:11 +00:00
<remarks > Chain to this constructor if you have manually registered a native <see cref= "T:GLib.GType" /> value for your subclass.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public ListStore (GLib.GType[] types);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "types" Type= "GLib.GType[]" />
</Parameters>
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Default constructor.</summary>
2003-12-24 01:35:30 +00:00
<param name= "types" > a <see cref= "T:GLib.GType[]" /> </param>
<returns > a <see cref= "T:Gtk.ListStore" /> </returns>
2004-08-19 03:09:20 +00:00
<remarks />
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
2004-02-26 18:46:28 +00:00
<Member MemberName= "Reorder" >
<MemberSignature Language= "C#" Value= "public int Reorder ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Reorders the ListStore.</summary>
2004-08-24 23:04:07 +00:00
<returns > a <see cref= "T:System.Int32" /> .</returns>
2004-08-19 03:09:20 +00:00
<remarks > (FIXME: Does this binding work?)</remarks>
2004-02-26 18:46:28 +00:00
</Docs>
</Member>
<Member MemberName= "Insert" >
<MemberSignature Language= "C#" Value= "public Gtk.TreeIter Insert (int position);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreeIter</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "position" Type= "System.Int32" />
</Parameters>
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Inserts a new row at position <paramref name= "position" /> .</summary>
2004-02-26 18:46:28 +00:00
<param name= "position" > a <see cref= "T:System.Int32" /> </param>
2004-08-19 03:09:20 +00:00
<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>
2004-02-26 18:46:28 +00:00
</Docs>
</Member>
<Member MemberName= "Prepend" >
<MemberSignature Language= "C#" Value= "public Gtk.TreeIter Prepend ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreeIter</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2004-02-26 18:46:28 +00:00
</Docs>
</Member>
<Member MemberName= "InsertBefore" >
<MemberSignature Language= "C#" Value= "public Gtk.TreeIter InsertBefore (Gtk.TreeIter sibling);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreeIter</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "sibling" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2004-02-26 18:46:28 +00:00
</Docs>
</Member>
<Member MemberName= "InsertAfter" >
<MemberSignature Language= "C#" Value= "public Gtk.TreeIter InsertAfter (Gtk.TreeIter sibling);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreeIter</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "sibling" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2004-02-26 18:46:28 +00:00
</Docs>
</Member>
<Member MemberName= "Append" >
<MemberSignature Language= "C#" Value= "public Gtk.TreeIter Append ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreeIter</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2004-02-26 18:46:28 +00:00
</Docs>
</Member>
<Member MemberName= "EmitRowsReordered" >
<MemberSignature Language= "C#" Value= "public virtual int EmitRowsReordered (Gtk.TreePath path, Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-08-19 03:09:20 +00:00
<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>
2004-02-26 18:46:28 +00:00
<returns > a <see cref= "T:System.Int32" /> </returns>
2004-08-19 03:09:20 +00:00
<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>
2004-02-26 18:46:28 +00:00
</Docs>
</Member>
2004-05-27 19:02:19 +00:00
<Member MemberName= "Remove" >
<MemberSignature Language= "C#" Value= "public bool Remove (ref Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "ref" />
</Parameters>
<Docs >
2004-05-28 17:31:16 +00:00
<summary > Removes a row from the store.</summary>
2004-05-27 19:02:19 +00:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
<returns > a <see cref= "T:System.Boolean" /> </returns>
2004-08-19 03:09:20 +00:00
<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>
2004-05-27 19:02:19 +00:00
</Docs>
</Member>
<Member MemberName= "GetValue" >
<MemberSignature Language= "C#" Value= "public virtual void GetValue (Gtk.TreeIter iter, int column, ref GLib.Value value);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "GLib.Value&" RefType= "ref" />
</Parameters>
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Gets the value of row <paramref name= "iter" /> of column
<paramref name= "column" /> and puts it in <paramref name= "value" /> .
</summary>
2004-05-27 19:02:19 +00:00
<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>
2004-08-19 03:09:20 +00:00
<remarks />
2004-05-27 19:02:19 +00:00
</Docs>
</Member>
2004-05-28 18:09:36 +00:00
<Member MemberName= "IterNext" >
<MemberSignature Language= "C#" Value= "public virtual bool IterNext (ref Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "ref" />
</Parameters>
<Docs >
2004-08-19 03:09:20 +00:00
<summary > Advances <paramref name= "iter" /> to the next row.</summary>
2004-05-28 18:09:36 +00:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-08-19 03:09:20 +00:00
<returns > a <see cref= "T:System.Boolean" /> for whether the operation succeeded.</returns>
<remarks />
2004-05-28 18:09:36 +00:00
</Docs>
</Member>
2003-02-12 02:00:12 +00:00
</Members>
2004-08-19 03:09:20 +00:00
</Type>
