GtkSharp/doc/en/Gtk/ITreeNode.xml
Mike Kestner 3e18029f5f 2003-11-05 Mike Kestner <mkestner@ximian.com>
* en/Gtk/ITreeNode.xml : documented
	* en/Gtk/TreeNodeAddedHandler.xml : documented
	* en/Gtk/TreeNodeRemovedHandler.xml : documented

svn path=/trunk/gtk-sharp/; revision=19654
2003-11-05 23:56:57 +00:00

150 lines
5.8 KiB
XML

<Type Name="ITreeNode" FullName="Gtk.ITreeNode">
<TypeSignature Language="C#" Value="public abstract interface ITreeNode" Maintainer="Mike Kestner" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<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>Tree Node navigation and update notification interface</summary>
<remarks>
Implement this interface for types which expose tree node information.
Types which implement this interface can be used to instantiate a
<see cref="T:Gtk.NodeStore" /> for a <see cref="T:Gtk.TreeView" />
</remarks>
</Docs>
<Base />
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Reflection.DefaultMemberAttribute</AttributeName>
</Attribute>
</Attributes>
<Members>
<Member MemberName="IndexOf">
<MemberSignature Language="C#" Value="public virtual int IndexOf (object o);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="o" Type="System.Object" />
</Parameters>
<Docs>
<summary>IndexOf method</summary>
<param name="o">a <see cref="T:System.Object" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>
Returns the position of the specified child object in the
list of children. If the child is not found, the returned
value should be less than 0, typically -1.
</remarks>
</Docs>
</Member>
<Member MemberName="ID">
<MemberSignature Language="C#" Value="public virtual int ID { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>ID property</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>
Read-only. Represents a unique identifier for the object as a positive integer.
This value is used by the <see cref="T:Gtk.NodeStore" /> as a hash value and
must uniquely identify the object.
</remarks>
</Docs>
</Member>
<Member MemberName="Parent">
<MemberSignature Language="C#" Value="public virtual Gtk.ITreeNode Parent { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ITreeNode</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Parent property</summary>
<returns>a <see cref="T:Gtk.ITreeNode" /></returns>
<remarks>
Read-only, The parent <see cref="T:Gtk.ITreeNode" /> for this <see cref="T:Gtk.ITreeNode" />
or <see langword="null" /> if the node is a root <see cref="T:Gtk.ITreeNode" />.
</remarks>
</Docs>
</Member>
<Member MemberName="ChildCount">
<MemberSignature Language="C#" Value="public virtual int ChildCount { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>ChildCount property</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>Read-only. Indicates the number of children of this <see cref="T:Gtk.ITreeNode" /></remarks>
</Docs>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public virtual Gtk.ITreeNode Item { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ITreeNode</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Child indexer</summary>
<param name="index">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.ITreeNode" /></returns>
<remarks>
Returns the child at position <paramref name="index" /> in the list of children
of this <see cref="T:Gtk.ITreeNode" />
</remarks>
</Docs>
</Member>
<Member MemberName="Changed">
<MemberSignature Language="C#" Value="public virtual event EventHandler Changed;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Changed event</summary>
<remarks>Emited when the tree-related contents of the node have changed.</remarks>
</Docs>
</Member>
<Member MemberName="ChildAdded">
<MemberSignature Language="C#" Value="public virtual event Gtk.TreeNodeAddedHandler ChildAdded;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.TreeNodeAddedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>ChildAdded event</summary>
<remarks>Emited when a child <see cref="T:Gtk.ITreeNode" /> is added to the <see cref="T:Gtk.ITreeNode" />.</remarks>
</Docs>
</Member>
<Member MemberName="ChildRemoved">
<MemberSignature Language="C#" Value="public virtual event Gtk.TreeNodeRemovedHandler ChildRemoved;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.TreeNodeRemovedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>ChildRemoved event</summary>
<remarks>Emited when a child <see cref="T:Gtk.ITreeNode" /> is removed from the <see cref="T:Gtk.ITreeNode" />.</remarks>
</Docs>
</Member>
</Members>
</Type>