ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

2003-11-05 Mike Kestner <mkestner@ximian.com>

Browse source 
* en/Gtk/TreeNode.xml : documented
	* en/Gtk/TreeView.xml : documented NodeStore ctor.

svn path=/trunk/gtk-sharp/; revision=19658
This commit is contained in:
Mike Kestner 2003-11-06 01:28:34 +00:00
parent 3e18029f5f
commit 05e6e6c156
3 changed files with 96 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/ChangeLog
View file

@ -1,3 +1,8 @@
2003-11-05 Mike Kestner <mkestner@ximian.com>
* en/Gtk/TreeNode.xml : documented
* en/Gtk/TreeView.xml : documented NodeStore ctor.
2003-11-05 Mike Kestner <mkestner@ximian.com> 2003-11-05 Mike Kestner <mkestner@ximian.com>
* en/Gtk/ITreeNode.xml : documented * en/Gtk/ITreeNode.xml : documented

113
doc/en/Gtk/TreeNode.xml
View file

@ -1,5 +1,5 @@
<Type Name="TreeNode" FullName="Gtk.TreeNode"> <Type Name="TreeNode" FullName="Gtk.TreeNode">
<TypeSignature Language="C#" Value="public abstract class TreeNode : ITreeNode" Maintainer="auto" /> <TypeSignature Language="C#" Value="public abstract class TreeNode : ITreeNode" Maintainer="Mike Kestner" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey> <AssemblyPublicKey></AssemblyPublicKey>
@ -7,10 +7,49 @@
<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>TreeNode abstract class</summary>
<remarks>To be added</remarks> <remarks>
<para>
Convenience class for deriving ITreeNode implementing objects for
<see cref="T:Gtk.NodeStore"/> implementations. This class can be subclassed
to quickly implement a node type without having to implement the tree building
and navigational aspects of the <see cref="T:Gtk.ITreeNode"/> interface.
</para>
<para>
The following example shows a simple <see cref="T:Gtk.TreeNode"/> subclass:
</para>
<example>
<code lang="C#">
[TreeNode(ColumnCount=1)]
public class MyTreeNode : TreeNode {
string level;
public MyTreeNode (string level)
{
this.level = level;
}
[TreeNodeValue(Column=0)]
public string Level {
get {
return level;
}
set {
level = value;
OnChanged ();
}
}
}
</code>
</example>
<para>
The <see cref="T:Gtk.TreeNode"/> base class provides all the <see cref="T:Gtk.ITreeNode"/>
details and MyTreeNode uses <see cref="T:Gtk.TreeNode.OnChanged"/> to notify of tree related
node changes.
</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Object</BaseTypeName> <BaseTypeName>System.Object</BaseTypeName>
@ -36,10 +75,13 @@
<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 child index of <paramref name="o"/>
or -1 if <paramref name="o"/> is not a child of this <see cref="T:Gtk.TreeNode"/>.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnChanged"> <Member MemberName="OnChanged">
@ -50,8 +92,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>OnChanged method</summary>
<remarks>To be added</remarks> <remarks>Raises the Changed event. Call this method if any column values of the node change.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddChild"> <Member MemberName="AddChild">
@ -64,9 +106,14 @@
<Parameter Name="child" Type="Gtk.ITreeNode" /> <Parameter Name="child" Type="Gtk.ITreeNode" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>AddChild method</summary>
<param name="child">a <see cref="T:Gtk.ITreeNode" /></param> <param name="child">a <see cref="T:Gtk.ITreeNode" /></param>
<remarks>To be added</remarks> <remarks>
Adds the specified <paramref name="child"/> to this <see cref="T:Gtk.ITreeNode"/>.
The <paramref name="child"/> is added to the end of the children list, the
<see cref="P:Gtk.TreeNode.Parent"/> property of <paramref name="child"/> is set to
this node, and the <see cref="E:Gtk.TreeNode.ChildAdded"/> event is raised.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RemoveChild"> <Member MemberName="RemoveChild">
@ -79,9 +126,13 @@
<Parameter Name="child" Type="Gtk.ITreeNode" /> <Parameter Name="child" Type="Gtk.ITreeNode" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>RemoveChild method</summary>
<param name="child">a <see cref="T:Gtk.ITreeNode" /></param> <param name="child">a <see cref="T:Gtk.ITreeNode" /></param>
<remarks>To be added</remarks> <remarks>
Removes the specified <paramref name="child"/> from this <see cref="T:Gtk.ITreeNode"/>.
The <see cref="P:Gtk.TreeNode.Parent"/> property of <paramref name="child"/> is set to
<see langword="null"/> and the <see cref="E:Gtk.TreeNode.ChildRemoved"/> event is raised.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -90,9 +141,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>TreeNode constructor</summary>
<returns>a <see cref="T:Gtk.TreeNode" /></returns> <returns>a <see cref="T:Gtk.TreeNode" /></returns>
<remarks>To be added</remarks> <remarks>Default constructor..</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ID"> <Member MemberName="ID">
@ -103,9 +154,9 @@
</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. Provides a unique identifier for all <see cref="T:Gtk.TreeNode" /> instances.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Parent"> <Member MemberName="Parent">
@ -116,9 +167,9 @@
</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 node.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ChildCount"> <Member MemberName="ChildCount">
@ -129,9 +180,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>ChildCount</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. The number of <see cref="T:Gtk.ITreeNode" /> children of this node.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Item"> <Member MemberName="Item">
@ -144,10 +195,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
for this <see cref="T:Gtk.ITreeNode" />.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Changed"> <Member MemberName="Changed">
@ -158,8 +212,11 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Changed event</summary>
<remarks>To be added</remarks> <remarks>
Raised when the contents of the <see cref="T:Gtk.ITreeNode" /> change.
Use <see cref="M:Gtk.ITreeNode.OnChange"/> for a convenient way to raise the event.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ChildAdded"> <Member MemberName="ChildAdded">
@ -170,8 +227,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>ChildAdded event</summary>
<remarks>To be added</remarks> <remarks>Raised when a child <see cref="T:Gtk.ITreeNode" /> is added to the node.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ChildRemoved"> <Member MemberName="ChildRemoved">
@ -182,8 +239,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>ChildRemoved event</summary>
<remarks>To be added</remarks> <remarks>Raised when a child <see cref="T:Gtk.ITreeNode" /> is removed from the node.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

6
doc/en/Gtk/TreeView.xml
View file

@ -1432,10 +1432,12 @@ public class TreeViewDemo {
<Parameter Name="store" Type="Gtk.NodeStore" /> <Parameter Name="store" Type="Gtk.NodeStore" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>TreeView constructor</summary>
<param name="store">a <see cref="T:Gtk.NodeStore" /></param> <param name="store">a <see cref="T:Gtk.NodeStore" /></param>
<returns>a <see cref="T:Gtk.TreeView" /></returns> <returns>a <see cref="T:Gtk.TreeView" /></returns>
<remarks>To be added</remarks> <remarks>Creates a <see cref="T:Gtk.TreeView" /> with <paramref name="store"/> as
its <see cref="P:Gtk.TreeView.Model"/>.
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>