GtkSharp/doc/en/Gtk/ColorSelectionDialog.xml
Mike Kestner 0e47e78f96 update docs to 2.8 API and document all new members
svn path=/trunk/gtk-sharp/; revision=54175
2005-12-09 23:12:49 +00:00

133 lines
5.3 KiB
XML

<Type Name="ColorSelectionDialog" FullName="Gtk.ColorSelectionDialog">
<TypeSignature Language="C#" Maintainer="Lee Mallabone" Value="public class ColorSelectionDialog : Gtk.Dialog" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.8.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>A standard dialog box for selecting a color.</summary>
<remarks>
<para>The ColorSelectionDialog provides a standard <see cref="T:Gtk.Dialog" /> which allows the user to select a color much like the <see cref="T:Gtk.FileSelection" /> provides a standard dialog for file selection.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Dialog</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ColorSelectionDialog (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ColorSelectionDialog (string title);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="title" Type="System.String" />
</Parameters>
<Docs>
<summary>The main way to construct a new color selector.</summary>
<param name="title">A title that will appear in the window's title bar.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="HelpButton">
<MemberSignature Language="C#" Value="public Gtk.Button HelpButton { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Button</ReturnType>
</ReturnValue>
<Docs>
<summary>A button for providing help with this dialog</summary>
<value>A standard <see cref="T:Gtk.Button" />.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="CancelButton">
<MemberSignature Language="C#" Value="public Gtk.Button CancelButton { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Button</ReturnType>
</ReturnValue>
<Docs>
<summary>A button for cancelling this dialog</summary>
<value>A standard <see cref="T:Gtk.Button" />.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="OkButton">
<MemberSignature Language="C#" Value="public Gtk.Button OkButton { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Button</ReturnType>
</ReturnValue>
<Docs>
<summary>A button to confirm use of the selected color.</summary>
<value>A standard <see cref="T:Gtk.Button" />.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="ColorSelection">
<MemberSignature Language="C#" Value="public Gtk.ColorSelection ColorSelection { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ColorSelection</ReturnType>
</ReturnValue>
<Docs>
<summary>An accessor to the actual ColorSelection widget.</summary>
<value>The ColorSelection component of this <see cref="T:Gtk.Dialog" />.</value>
<remarks>
<para>All color-related functions are available using the methods on this property, such as <see cref="P:Gtk.ColorSelection.CurrentColor" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.ColorSelectionDialog" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ColorSelectionDialog (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes>
</Member>
</Members>
</Type>