GtkSharp/doc/en/Gtk/TreeModel.xml
John Luke cc1f6e10f2 run the updater, add docs for Art, Gda, and GnomeDb
(includes Gnome.Print)

svn path=/trunk/gtk-sharp/; revision=18154
2003-09-17 21:56:59 +00:00

523 lines
21 KiB
XML

<Type Name="TreeModel" FullName="Gtk.TreeModel">
<TypeSignature Language="C#" Value="public abstract interface TreeModel;" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base />
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</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">
<MemberSignature Language="C#" Value="public virtual bool IterChildren (out Gtk.TreeIter iter);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<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>
</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>
<Parameter Name="path" Type="Gtk.TreePath" />
<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>
</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>
<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>
</Docs>
</Member>
<Member MemberName="GetValue">
<MemberSignature Language="C#" Value="public virtual void GetValue (Gtk.TreeIter iter, int column, out 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" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="column">To be added: an object of type 'int'</param>
<param name="value">To be added: an object of type 'GLib.Value'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetIterFirst">
<MemberSignature Language="C#" Value="public virtual bool GetIterFirst (out Gtk.TreeIter iter);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<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>
</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>
<Parameter Name="path" Type="Gtk.TreePath" />
<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>
</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>
<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>
</Docs>
</Member>
<Member MemberName="EmitRowsReordered">
<MemberSignature Language="C#" Value="public virtual void EmitRowsReordered (Gtk.TreePath path, Gtk.TreeIter iter, 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" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="new_order">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</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>
<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>
</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>
<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>
</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>
<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>
</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>
<Parameter Name="path" Type="Gtk.TreePath" />
<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>
</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>
<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>
</Docs>
</Member>
<Member MemberName="IterNext">
<MemberSignature Language="C#" Value="public virtual bool IterNext (out Gtk.TreeIter iter);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<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>
</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>
<Parameter Name="iter" Type="Gtk.TreeIter" />
<Parameter Name="var_args" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="var_args">To be added: an object of type 'IntPtr'</param>
<remarks>To be added</remarks>
</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>
<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>
</Docs>
</Member>
<Member MemberName="NColumns">
<MemberSignature Language="C#" Value="public virtual int NColumns { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<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>
</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>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.TreeModelFlags'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowHasChildToggled">
<MemberSignature Language="C#" Value="public virtual event GtkSharp.RowHasChildToggledHandler RowHasChildToggled;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>GtkSharp.RowHasChildToggledHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowInserted">
<MemberSignature Language="C#" Value="public virtual event GtkSharp.RowInsertedHandler RowInserted;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>GtkSharp.RowInsertedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowDeleted">
<MemberSignature Language="C#" Value="public virtual event GtkSharp.RowDeletedHandler RowDeleted;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>GtkSharp.RowDeletedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowChanged">
<MemberSignature Language="C#" Value="public virtual event GtkSharp.RowChangedHandler RowChanged;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>GtkSharp.RowChangedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowsReordered">
<MemberSignature Language="C#" Value="public virtual event GtkSharp.RowsReorderedHandler RowsReordered;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>GtkSharp.RowsReorderedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<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>
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
<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>
</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>
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
<Parameter Name="parent" Type="Gtk.TreeIter" />
<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>
</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>
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
<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>
</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>
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
<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>
</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>
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
<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>
</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>
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
<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>
</Docs>
</Member>
<Member MemberName="GetStringFromIter">
<MemberSignature Language="C#" Value="public virtual string GetStringFromIter (Gtk.TreeIter iter);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetColumnType">
<MemberSignature Language="C#" Value="public virtual uint GetColumnType (int index_);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index_" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="index_">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>