GtkSharp/doc/en/Gtk/SelectionMode.xml
Duncan Mak efa9acf122 2003-03-06 Duncan Mak <duncan@ximian.com>
* en/*/*.xml: Updated all the docs to match the new API. All the nodes
	that no longer have a corresponding member in the type are now
	marked as deprecated. We'll have to wait for Miguel to implement
	this in the browser to stop displaying them.

	All gtype constructors have been regenerated, because of the
	'uint' to 'GLib.Type' change. However, this patch will preserve
	(well, it was regenerated) the customized text for those GType
	constructors.

	A lot of the 'Finalized' methods are also now marked as
	deprecated, because the classes implement 'Dispose' instead. This
	is a possible place for customized scripts to generate template
	documentation, similar to the GType property and GType constructors.

svn path=/trunk/gtk-sharp/; revision=12270
2003-03-07 01:30:00 +00:00

126 lines
4.5 KiB
XML

<Type Name="SelectionMode" FullName="Gtk.SelectionMode">
<TypeSignature Language="C#" Value="public sealed struct SelectionMode;" Maintainer="Hector Gomez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<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 enumeration used by TreeSelection.</summary>
<remarks>
<para>
This enumeration is used by <see cref="T:Gtk.TreeSelection" /> to decide how selection behaves.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IComparable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IConvertible</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IFormattable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="None">
<MemberSignature Language="C#" Value="public static Gtk.SelectionMode None;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.SelectionMode</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Nothing can be selected.</summary>
<remarks>
<para>
Nothing can be selected.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Single">
<MemberSignature Language="C#" Value="public static Gtk.SelectionMode Single;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.SelectionMode</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Only one item can be selected at any given moment. Other items can have focus, but will not be marked as selected.</summary>
<remarks>
<para>
Only one item can be selected at any given moment. Other items can have focus, but will not be marked as selected.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Browse">
<MemberSignature Language="C#" Value="public static Gtk.SelectionMode Browse;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.SelectionMode</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Only one item can be selected at any given moment. Any item currently having focus will be marked as selected.</summary>
<remarks>
<para>
Only one item can be selected at any given moment. Any item currently having focus will be marked as selected.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Multiple">
<MemberSignature Language="C#" Value="public static Gtk.SelectionMode Multiple;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.SelectionMode</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Several items may be selected or unselected with a click or using the spacebar. They cannot be selected or unselected in any other way.</summary>
<remarks>
<para>
Note that multiple selection should only be used where all items share the exact same callback routine.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Extended">
<MemberSignature Language="C#" Value="public static Gtk.SelectionMode Extended;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.SelectionMode</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Several items may be selected or unselected using drag, or the shift (selects all items from the leader to the current focus) or control (selects the item having current focus) keys.</summary>
<remarks>
<para>
Note that extended selection should only be used where all items share the exact same callback routine.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="value__">
<MemberSignature Language="C#" Value="public int value__;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>