GtkSharp/doc/en/Gtk/TreeNodeAttribute.xml
Mike Kestner f2774d7879 obnoxiously large assembly version update
svn path=/trunk/gtk-sharp/; revision=63369
2006-08-04 19:43:19 +00:00

110 lines
3.7 KiB
XML

<Type Name="TreeNodeAttribute" FullName="Gtk.TreeNodeAttribute">
<TypeSignature Language="C#" Maintainer="Mike Kestner" Value="public sealed class TreeNodeAttribute : System.Attribute" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</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>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>
<para>
In the following example, the class MyListNode is tagged as
a node with 2 columns and no child nodes:
<example>
<code lang="C#">
[TreeNode(ColumnCount=2, ListOnly=true)]
public class MyListNode : ITreeNode {
...
}
</code>
</example></para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.AttributeUsage(AllowMultiple=False, Inherited=True, ValidOn=System.AttributeTargets.Class)</AttributeName>
</Attribute>
</Attributes>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TreeNodeAttribute ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>TreeNodeAttribute constructor</summary>
<remarks>Instantiates a <see cref="T:Gtk.TreeNodeAttribute" /></remarks>
</Docs>
</Member>
<Member MemberName="ColumnCount">
<MemberSignature Language="C#" Value="public int ColumnCount { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>ColumnCount named value.</summary>
<value>a <see cref="T:System.Int32" /></value>
<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>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message="This is no longer needed; it gets detected by Gtk#", IsError=False)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="ListOnly">
<MemberSignature Language="C#" Value="public bool ListOnly { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>ListOnly named value.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>
Specifies if the node can have children. For list views, this tells the
NodeStore that it is non-hierarchical and it can expose flags so that the
NodeView doesn't include space for expanders in the column layout.
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
</Members>
</Type>