2003-02-12 02:00:12 +00:00
<Type Name= "TreePath" FullName= "Gtk.TreePath" >
2005-05-23 20:41:51 +00:00
<TypeSignature Language= "C#" Maintainer= "auto" Value= "public class TreePath : GLib.Opaque" />
2011-11-09 16:01:51 +00:00
<TypeSignature Language= "ILAsm" Value= ".class public auto ansi beforefieldinit TreePath extends GLib.Opaque" />
2003-02-12 02:00:12 +00:00
<AssemblyInfo >
<AssemblyName > gtk-sharp</AssemblyName>
2003-12-24 01:35:30 +00:00
<AssemblyPublicKey >
</AssemblyPublicKey>
2003-02-12 02:00:12 +00:00
</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
<Base >
<BaseTypeName > GLib.Opaque</BaseTypeName>
</Base>
2007-01-16 16:18:05 +00:00
<Interfaces >
</Interfaces>
2011-11-09 16:01:51 +00:00
<Docs >
<summary > Represents a particular node of a <see cref= "T:Gtk.TreeView" /> .</summary>
<remarks > A TreePath can be converted into either an array of unsigned integers or a string. The string form is a list of numbers separated by a colon. Each number refers to the offset at that level. Thus, the path "0" refers to the root node and the path "2:4" refers to the fifth child of the third node.</remarks>
</Docs>
2003-02-12 02:00:12 +00:00
<Members >
2011-11-09 16:01:51 +00:00
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public TreePath ();" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType > Constructor</MemberType>
<ReturnValue />
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Constructor; builds an empty TreePath.</summary>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public TreePath (int[] indices);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor(int32[] indices) cil managed" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "indices" Type= "System.Int32[]" />
</Parameters>
<Docs >
<param name= "indices" > a <see cref= "T:System.Int32" /> </param>
<summary > Creates a path for a set of indices.</summary>
<remarks />
<since version= "Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public TreePath (IntPtr raw);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "raw" Type= "System.IntPtr" />
</Parameters>
<Docs >
<param name= "raw" > Pointer to the C object.</param>
<summary > Internal constructor</summary>
<remarks >
<para > This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public TreePath (string path);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor(string path) cil managed" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "path" Type= "System.String" />
</Parameters>
<Docs >
<param name= "path" > an object of type <see cref= "T:System.String" /> </param>
<summary > Creates a new <see cref= "T:Gtk.TreePath" /> object.</summary>
<remarks > The <paramref name= "path" /> is expressed in the form "3:2:5". The toplevel or root path would thus be "0".</remarks>
</Docs>
</Member>
<Member MemberName= "AppendIndex" >
<MemberSignature Language= "C#" Value= "public void AppendIndex (int index_);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void AppendIndex(int32 index_) cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Void</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters >
<Parameter Name= "index_" Type= "System.Int32" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "index_" > a <see cref= "T:System.Int32" /> , the index to append</param>
<summary > Appends a new index to a path. As a result, the depth of the path is increased.</summary>
2004-08-04 17:10:22 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Compare" >
<MemberSignature Language= "C#" Value= "public int Compare (Gtk.TreePath b);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance int32 Compare(class Gtk.TreePath b) cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Int32</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "b" Type= "Gtk.TreePath" />
2003-09-14 20:14:06 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "b" > an object of type <see cref= "T:Gtk.TreePath" /> , the path to compare</param>
<summary > Compares two paths. If this path appears before <see cref= "T:Gtk.TreePath" /> b in a tree, then -1 is returned. If the parameter path appears before this path, then 1 is returned. If the two nodes are equal, then 0 is returned.</summary>
<returns > an object of type <see cref= "T:System.Int32" /> </returns>
2004-08-04 17:10:22 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Copy" >
<MemberSignature Language= "C#" Value= "public Gtk.TreePath Copy ();" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance class Gtk.TreePath Copy() cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > Gtk.TreePath</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters />
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Copies a TreePath into a new TreePath object.</summary>
<returns > an object of type <see cref= "T:Gtk.TreePath" /> , the new copy</returns>
<remarks />
</Docs>
</Member>
<Member MemberName= "Depth" >
<MemberSignature Language= "C#" Value= "public int Depth { get; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance int32 Depth" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Docs >
<summary > Returns the current depth of the TreePath.</summary>
<value > an object of type <see cref= "T:System.Int32" /> </value>
2004-08-04 17:10:22 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "Down" >
<MemberSignature Language= "C#" Value= "public void Down ();" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void Down() cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-08-04 17:10:22 +00:00
<summary > Changes this TreePath object to refer to its own first child.</summary>
<remarks > FIXME: make sure this is right.</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Equals" >
<MemberSignature Language= "C#" Value= "public override bool Equals (object o);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig virtual instance bool Equals(object o) cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Boolean</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "o" Type= "System.Object" />
2003-09-14 20:14:06 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "o" > To be added.</param>
<summary > To be added.</summary>
<returns > To be added.</returns>
<remarks > To be added.</remarks>
<since version= "Gtk# 3.0" />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Finalize" >
<MemberSignature Language= "C#" Value= "~TreePath ();" />
<MemberSignature Language= "ILAsm" Value= ".method familyhidebysig virtual instance void Finalize() cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2011-11-09 16:01:51 +00:00
<summary > To be added.</summary>
<remarks > To be added.</remarks>
<since version= "Gtk# 3.0" />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Free" >
<MemberSignature Language= "C#" Value= "public void Free ();" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void Free() cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
2011-11-09 16:01:51 +00:00
<Attributes >
<Attribute >
<AttributeName > System.Obsolete("Gtk.TreePath is now freed automatically")</AttributeName>
</Attribute>
</Attributes>
2003-02-12 02:00:12 +00:00
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Disposes of the TreePath object and any resources it was using.</summary>
2004-08-04 17:10:22 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Free" >
<MemberSignature Language= "C#" Value= "protected override void Free (IntPtr raw);" />
<MemberSignature Language= "ILAsm" Value= ".method familyhidebysig virtual instance void Free(native int raw) cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Void</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters >
<Parameter Name= "raw" Type= "System.IntPtr" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "raw" > To be added.</param>
<summary > To be added.</summary>
<remarks > To be added.</remarks>
<since version= "Gtk# 3.0" />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "GetHashCode" >
<MemberSignature Language= "C#" Value= "public override int GetHashCode ();" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Int32</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
<Parameters />
<Docs >
2011-11-09 16:01:51 +00:00
<summary > To be added.</summary>
<returns > To be added.</returns>
<remarks > To be added.</remarks>
<since version= "Gtk# 3.0" />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "GetIndicesWithDepth" >
<MemberSignature Language= "C#" Value= "public int GetIndicesWithDepth (out int depth);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance int32 GetIndicesWithDepth(int32 depth) cil managed" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "depth" Type= "System.Int32&" RefType= "out" />
2003-09-14 20:14:06 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "depth" > To be added.</param>
<summary > To be added.</summary>
<returns > To be added.</returns>
<remarks > To be added.</remarks>
<since version= "Gtk# 3.0" />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "GType" >
<MemberSignature Language= "C#" Value= "public static GLib.GType GType { get; }" />
<MemberSignature Language= "ILAsm" Value= ".property valuetype GLib.GType GType" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2011-11-09 16:01:51 +00:00
<summary > GType Property.</summary>
<value > a <see cref= "T:GLib.GType" /> </value>
<remarks > Returns the native <see cref= "T:GLib.GType" /> value for <see cref= "T:Gtk.TreePath" /> .</remarks>
</Docs>
</Member>
<Member MemberName= "Indices" >
<MemberSignature Language= "C#" Value= "public int[] Indices { get; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance int32[] Indices" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > Returns the current indices of the TreePath. This is an array of integers, each representing a node in a tree. This value should not be freed.</summary>
<value > a <see cref= "T:System.Int32[]" /> </value>
2004-08-04 17:10:22 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "IsAncestor" >
<MemberSignature Language= "C#" Value= "public bool IsAncestor (Gtk.TreePath descendant);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance bool IsAncestor(class Gtk.TreePath descendant) cil managed" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "descendant" Type= "Gtk.TreePath" />
2003-09-14 20:14:06 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "descendant" > an object of type <see cref= "T:Gtk.TreePath" /> , the potential descendant</param>
<summary > Tests whether this TreePath is an ancestor of a given TreePath</summary>
<returns > an object of type <see cref= "T:System.Boolean" /> , returns true if this TreePath is an ancestor of the given TreePath.</returns>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "IsDescendant" >
<MemberSignature Language= "C#" Value= "public bool IsDescendant (Gtk.TreePath ancestor);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance bool IsDescendant(class Gtk.TreePath ancestor) cil managed" />
<MemberType > Method</MemberType>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Boolean</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters >
<Parameter Name= "ancestor" Type= "Gtk.TreePath" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "ancestor" > an object of type <see cref= "T:Gtk.TreePath" /> , the potential ancestor to test</param>
<summary > Tests whether this TreePath is a descendant of a particular TreePath.</summary>
<returns > an object of type <see cref= "T:System.Boolean" /> , true if this TreePath is the other TreePath's descendant.</returns>
2004-08-04 17:10:22 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "NewFirst" >
<MemberSignature Language= "C#" Value= "public static Gtk.TreePath NewFirst ();" />
<MemberSignature Language= "ILAsm" Value= ".method public static hidebysig class Gtk.TreePath NewFirst() cil managed" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreePath</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > Creates a new GtkTreePath.</summary>
<returns > an object of type <see cref= "T:Gtk.TreePath" /> </returns>
<remarks > The string representation of this path is "0".</remarks>
</Docs>
</Member>
<Member MemberName= "Next" >
<MemberSignature Language= "C#" Value= "public void Next ();" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void Next() cil managed" />
2003-07-17 06:38:40 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters />
2003-07-17 06:38:40 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Moves the TreePath to point to the next node at the current depth.</summary>
2004-08-04 17:10:22 +00:00
<remarks />
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "PrependIndex" >
<MemberSignature Language= "C#" Value= "public void PrependIndex (int index_);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void PrependIndex(int32 index_) cil managed" />
2003-07-17 06:38:40 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-14 20:14:06 +00:00
<Parameter Name= "index_" Type= "System.Int32" />
</Parameters>
2003-07-17 06:38:40 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "index_" > a <see cref= "T:System.Int32" /> , the index to prepend</param>
<summary > Prepends a new index to a path. As a result, the depth of the path is increased.</summary>
2004-08-04 17:10:22 +00:00
<remarks />
2003-07-17 06:38:40 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Prev" >
<MemberSignature Language= "C#" Value= "public bool Prev ();" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance bool Prev() cil managed" />
<MemberType > Method</MemberType>
2003-10-12 09:06:39 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Boolean</ReturnType>
2003-10-12 09:06:39 +00:00
</ReturnValue>
<Parameters />
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Moves the TreePath to point to the previous node at the current depth, if it exists.</summary>
<returns > an object of type <see cref= "T:System.Boolean" /> , true if the path has a previous node and the move was made successfully.</returns>
2004-08-04 17:10:22 +00:00
<remarks />
2003-10-12 09:06:39 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "ToString" >
<MemberSignature Language= "C#" Value= "public override string ToString ();" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig virtual instance string ToString() cil managed" />
<MemberType > Method</MemberType>
2003-12-24 01:35:30 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.String</ReturnType>
2003-12-24 01:35:30 +00:00
</ReturnValue>
<Parameters />
<Docs >
2011-11-09 16:01:51 +00:00
<summary > To be added.</summary>
<returns > To be added.</returns>
<remarks > To be added.</remarks>
<since version= "Gtk# 3.0" />
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Up" >
<MemberSignature Language= "C#" Value= "public bool Up ();" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance bool Up() cil managed" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
2005-04-12 03:39:23 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Moves the TreePath to point to its parent node, if it has a parent.</summary>
<returns > an object of type <see cref= "T:System.Boolean" /> , true if the path has a previous node and the move was made successfully.</returns>
2005-04-12 03:39:23 +00:00
<remarks />
</Docs>
</Member>
2003-02-12 02:00:12 +00:00
</Members>
2005-06-17 18:43:30 +00:00
</Type>
