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
This commit is contained in:
Mike Kestner 2003-11-05 23:56:57 +00:00
parent b57221cf44
commit 3e18029f5f
4 changed files with 57 additions and 29 deletions

View File

@ -1,3 +1,9 @@
2003-11-05 Mike Kestner <mkestner@ximian.com>
* en/Gtk/ITreeNode.xml : documented
* en/Gtk/TreeNodeAddedHandler.xml : documented
* en/Gtk/TreeNodeRemovedHandler.xml : documented
2003-11-05 Mike Kestner <mkestner@ximian.com> 2003-11-05 Mike Kestner <mkestner@ximian.com>
* en/Gtk/TreeNodeAttribute.xml : documented * en/Gtk/TreeNodeAttribute.xml : documented

View File

@ -1,5 +1,5 @@
<Type Name="ITreeNode" FullName="Gtk.ITreeNode"> <Type Name="ITreeNode" FullName="Gtk.ITreeNode">
<TypeSignature Language="C#" Value="public abstract interface ITreeNode" Maintainer="auto" /> <TypeSignature Language="C#" Value="public abstract interface ITreeNode" Maintainer="Mike Kestner" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey> <AssemblyPublicKey></AssemblyPublicKey>
@ -7,10 +7,14 @@
<AssemblyCulture>neutral</AssemblyCulture> <AssemblyCulture>neutral</AssemblyCulture>
<Attributes /> <Attributes />
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement /> <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> <Docs>
<summary>To be added</summary> <summary>Tree Node navigation and update notification interface</summary>
<remarks>To be added</remarks> <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> </Docs>
<Base /> <Base />
<Interfaces /> <Interfaces />
@ -30,10 +34,14 @@
<Parameter Name="o" Type="System.Object" /> <Parameter Name="o" Type="System.Object" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>IndexOf method</summary>
<param name="o">a <see cref="T:System.Object" /></param> <param name="o">a <see cref="T:System.Object" /></param>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <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> </Docs>
</Member> </Member>
<Member MemberName="ID"> <Member MemberName="ID">
@ -44,22 +52,29 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>ID property</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <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> </Docs>
</Member> </Member>
<Member MemberName="Parent"> <Member MemberName="Parent">
<MemberSignature Language="C#" Value="public virtual Gtk.ITreeNode Parent { set; get; };" /> <MemberSignature Language="C#" Value="public virtual Gtk.ITreeNode Parent { get; };" />
<MemberType>Property</MemberType> <MemberType>Property</MemberType>
<ReturnValue> <ReturnValue>
<ReturnType>Gtk.ITreeNode</ReturnType> <ReturnType>Gtk.ITreeNode</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Parent property</summary>
<returns>a <see cref="T:Gtk.ITreeNode" /></returns> <returns>a <see cref="T:Gtk.ITreeNode" /></returns>
<remarks>To be added</remarks> <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> </Docs>
</Member> </Member>
<Member MemberName="ChildCount"> <Member MemberName="ChildCount">
@ -70,9 +85,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>ChildCount property</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks>Read-only. Indicates the number of children of this <see cref="T:Gtk.ITreeNode" /></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Item"> <Member MemberName="Item">
@ -85,10 +100,13 @@
<Parameter Name="index" Type="System.Int32" /> <Parameter Name="index" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Child indexer</summary>
<param name="index">a <see cref="T:System.Int32" /></param> <param name="index">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.ITreeNode" /></returns> <returns>a <see cref="T:Gtk.ITreeNode" /></returns>
<remarks>To be added</remarks> <remarks>
Returns the child at position <paramref name="index" /> in the list of children
of this <see cref="T:Gtk.ITreeNode" />
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Changed"> <Member MemberName="Changed">
@ -99,8 +117,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Changed event</summary>
<remarks>To be added</remarks> <remarks>Emited when the tree-related contents of the node have changed.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ChildAdded"> <Member MemberName="ChildAdded">
@ -111,8 +129,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>ChildAdded event</summary>
<remarks>To be added</remarks> <remarks>Emited when a child <see cref="T:Gtk.ITreeNode" /> is added to the <see cref="T:Gtk.ITreeNode" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ChildRemoved"> <Member MemberName="ChildRemoved">
@ -123,9 +141,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>ChildRemoved event</summary>
<remarks>To be added</remarks> <remarks>Emited when a child <see cref="T:Gtk.ITreeNode" /> is removed from the <see cref="T:Gtk.ITreeNode" />.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

View File

@ -1,5 +1,5 @@
<Type Name="TreeNodeAddedHandler" FullName="Gtk.TreeNodeAddedHandler"> <Type Name="TreeNodeAddedHandler" FullName="Gtk.TreeNodeAddedHandler">
<TypeSignature Language="C#" Value="public sealed delegate void TreeNodeAddedHandler (object o, Gtk.ITreeNode child);" Maintainer="auto" /> <TypeSignature Language="C#" Value="public sealed delegate void TreeNodeAddedHandler (object o, Gtk.ITreeNode child);" Maintainer="Mike Kestner" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey> <AssemblyPublicKey></AssemblyPublicKey>
@ -9,8 +9,8 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement /> <ThreadSafetyStatement />
<Docs> <Docs>
<summary>To be added</summary> <summary>TreeNodeAddedHandler delegate</summary>
<remarks>To be added</remarks> <remarks>Event handler for notification of the addition of a <paramref name="child" /> to node <paramref name="o" />.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>
@ -32,4 +32,4 @@
<Parameter Name="o" Type="System.Object" /> <Parameter Name="o" Type="System.Object" />
<Parameter Name="child" Type="Gtk.ITreeNode" /> <Parameter Name="child" Type="Gtk.ITreeNode" />
</Parameters> </Parameters>
</Type> </Type>

View File

@ -1,5 +1,5 @@
<Type Name="TreeNodeRemovedHandler" FullName="Gtk.TreeNodeRemovedHandler"> <Type Name="TreeNodeRemovedHandler" FullName="Gtk.TreeNodeRemovedHandler">
<TypeSignature Language="C#" Value="public sealed delegate void TreeNodeRemovedHandler (object o, int old_position);" Maintainer="auto" /> <TypeSignature Language="C#" Value="public sealed delegate void TreeNodeRemovedHandler (object o, int old_position);" Maintainer="Mike Kestner" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey> <AssemblyPublicKey></AssemblyPublicKey>
@ -9,8 +9,12 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement /> <ThreadSafetyStatement />
<Docs> <Docs>
<summary>To be added</summary> <summary>TreeNodeRemovedHandler delegate</summary>
<remarks>To be added</remarks> <remarks>
Event handler for notification of the removal of a child node. The node is already
removed when the event is raised, so <paramref name="old_position" /> points to the
former position of the removed node in the child list of <paramref name="o" />.
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>