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

* en/Gtk/TreeNodeAttribute.xml : documented
	* en/Gtk/TreeNodeValueAttribute.xml : documented

svn path=/trunk/gtk-sharp/; revision=19649
This commit is contained in:
Mike Kestner 2003-11-05 21:28:19 +00:00
parent 58b580c26f
commit 7513a7625b
3 changed files with 71 additions and 18 deletions

View File

@ -1,3 +1,8 @@
2003-11-05 Mike Kestner <mkestner@ximian.com>
* en/Gtk/TreeNodeAttribute.xml : documented
* en/Gtk/TreeNodeValueAttribute.xml : documented
2003-11-04 John Luke <jluke@cfl.rr.com>
* en/*/*.xml: run updater

View File

@ -1,5 +1,5 @@
<Type Name="TreeNodeAttribute" FullName="Gtk.TreeNodeAttribute">
<TypeSignature Language="C#" Value="public class TreeNodeAttribute : System.Attribute" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class TreeNodeAttribute : System.Attribute" Maintainer="Mike Kestner" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey>
@ -7,10 +7,31 @@
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</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>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>An attribute to specify tree node information of a class.</summary>
<remarks>
<para>
This attribute can be applied to a class which implements the
<see cref="T:Gtk.ITreeNode" /> interface to provide additional information
about the node type to the <see cref="T:Gtk.NodeStore"/> which will contain
the nodes.
</para>
<para>
In the following example, the class MyTreeNode is tagged as
a tree node with 3 columns:
<example>
<code lang="C#">
[TreeNode(ColumnCount=3)]
public class MyTreeNode : ITreeNode {
...
}
</code>
</example>
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
@ -28,9 +49,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>TreeNodeAttribute constructor</summary>
<returns>a <see cref="T:Gtk.TreeNodeAttribute" /></returns>
<remarks>To be added</remarks>
<remarks>Instantiates a <see cref="T:Gtk.TreeNodeAttribute"/></remarks>
</Docs>
</Member>
<Member MemberName="ColumnCount">
@ -41,10 +62,15 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>ColumnCount named value.</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks>
Specifies the number of columns the node exposes. A
<see cref="T:Gtk.TreeNodeValueAttribute"/>
should be added to each of the properties of the class which represent
the individual column values.
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -1,5 +1,5 @@
<Type Name="TreeNodeValueAttribute" FullName="Gtk.TreeNodeValueAttribute">
<TypeSignature Language="C#" Value="public class TreeNodeValueAttribute : System.Attribute" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class TreeNodeValueAttribute : System.Attribute" Maintainer="Mike Kestner" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey>
@ -7,10 +7,29 @@
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</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>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>An attribute to identify a property as a tree node column value.</summary>
<remarks>
<para>
This attribute is applied to a property of a tree node class to
indicate that the property holds a column value of the node.
</para>
<para>
In the following example, the Frombulator property is tagged as Column 2
of the node which implements it:
</para>
<example>
<code lang="C#">
[TreeNodeValue(Column=2)]
public string Frombulator {
get {
return frombulator;
}
}
</code>
</example>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
@ -28,9 +47,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>TreeNodeValueAttribute constructor</summary>
<returns>a <see cref="T:Gtk.TreeNodeValueAttribute" /></returns>
<remarks>To be added</remarks>
<remarks>Instantiates a <see cref="T:Gtk.TreeNodeValueAttribute" /></remarks>
</Docs>
</Member>
<Member MemberName="Column">
@ -41,10 +60,13 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Column named value</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks>
The column number of the value which is exposed by the property
this <see cref="T:Gtk.TreeNodeValueAttribute" /> marks.
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>