Ryujinx-GtkSharp/doc/en/Gtk/TreeNodeAttribute.xml
Mike Kestner 2871d80ab2 2005-01-03 Mike Kestner <mkestner@novell.com>
* gtk/NodeStore.cs : expose TreeModelFlags.ListOnly if the TreeNode
	has ListOnly set.
	* gtk/TreeNodeAttribute.cs : add ListOnly named value.

svn path=/trunk/gtk-sharp/; revision=38282
2005-01-03 18:37:08 +00:00

109 lines
3.6 KiB
XML

<Type Name="TreeNodeAttribute" FullName="Gtk.TreeNodeAttribute">
<TypeSignature Language="C#" Value="public class TreeNodeAttribute : System.Attribute" 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>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.AttributeUsageAttribute</AttributeName>
</Attribute>
</Attributes>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TreeNodeAttribute ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>TreeNodeAttribute constructor</summary>
<returns>a <see cref="T:Gtk.TreeNodeAttribute" /></returns>
<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>
<returns>a <see cref="T:System.Int32" /></returns>
<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>
<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>
<returns>a <see cref="T:System.Boolean" /></returns>
<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>
</Docs>
</Member>
</Members>
</Type>