GtkSharp/doc/en/Gtk/TreeIter.xml

200 lines
8.5 KiB
XML
Raw Normal View History

<Type Name="TreeIter" FullName="Gtk.TreeIter">
<TypeSignature Language="C#" Maintainer="auto" Value="public struct TreeIter : IEquatable&lt;Gtk.TreeIter&gt;" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit TreeIter extends System.ValueType implements class System.IEquatable`1&lt;valuetype Gtk.TreeIter&gt;" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</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>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IEquatable&lt;Gtk.TreeIter&gt;</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>The <see cref="T:Gtk.TreeIter" /> is the primary structure for accessing a tree row.</summary>
<remarks>Models are expected to put a unique integer in the <see cref="F:Gtk.TreeIter.Stamp" /> field, and put model-specific data in the three <see cref="F:Gtk.TreeIter.user_data" /> fields.</remarks>
</Docs>
<Members>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Gtk.TreeIter Copy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Gtk.TreeIter Copy() cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("This is a no-op")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gtk.TreeIter</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Copy the TreeIter by value.</summary>
<returns>the copy of the <see cref="T:Gtk.TreeIter" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (Gtk.TreeIter other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype Gtk.TreeIter other) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object other) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="System.Object" />
</Parameters>
<Docs>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<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>
<Parameters />
<Docs>
<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.TreeIter" />.</remarks>
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Gtk.TreeIter New (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Gtk.TreeIter New(native int raw) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.TreeIter</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">an object of type <see cref="T:System.IntPtr" />, a pointer to the underlying C object.</param>
<summary>Creates a new <see cref="T:Gtk.TreeIter" /> object.</summary>
<returns>an object of type <see cref="T:Gtk.TreeIter" /></returns>
<remarks>This is usually called indirectly by other methods. Not for use by application developers.</remarks>
</Docs>
</Member>
<Member MemberName="op_Explicit">
<MemberSignature Language="C#" Value="public static Gtk.TreeIter op_Explicit (GLib.Value val);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname valuetype Gtk.TreeIter op_Explicit(valuetype GLib.Value val) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.TreeIter</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="val" Type="GLib.Value" />
</Parameters>
<Docs>
<param name="val">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Explicit">
<MemberSignature Language="C#" Value="public static GLib.Value op_Explicit (Gtk.TreeIter boxed);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname valuetype GLib.Value op_Explicit(valuetype Gtk.TreeIter boxed) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.Value</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="boxed" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<param name="boxed">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Stamp">
<MemberSignature Language="C#" Value="public int Stamp;" />
<MemberSignature Language="ILAsm" Value=".field public int32 Stamp" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>A unique stamp to catch invalid iterators.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="UserData">
<MemberSignature Language="C#" Value="public IntPtr UserData { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance native int UserData" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>UserData property.</summary>
<value>Pointer value representing iter contents.</value>
<remarks>Useful to <see cref="T:Gtk.TreeModelImplementor" /> implementors to set and retrieve content values for the iterator. Not generally useful for <see cref="T:Gtk.TreeView" /> users.</remarks>
</Docs>
</Member>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Gtk.TreeIter Zero;" />
<MemberSignature Language="ILAsm" Value=".field public static valuetype Gtk.TreeIter Zero" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.TreeIter</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Makes a new TreeIter with empty/default values.</summary>
<remarks />
</Docs>
</Member>
</Members>
</Type>