GtkSharp/doc/en/Gtk/CheckButton.xml
Duncan Mak 2a82ba7d27 CheckButton documentation from Kevin Breit <mrproper@ximian.com>
svn path=/trunk/gtk-sharp/; revision=11782
2003-02-20 19:25:37 +00:00

137 lines
5 KiB
XML

<Type Name="CheckButton" FullName="Gtk.CheckButton">
<TypeSignature Language="C#" Value="public class CheckButton : Gtk.ToggleButton, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Kevin Breit" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>CheckButton is not a thread safe object</ThreadSafetyStatement>
<Docs>
<summary>A GtkCheckButton places a discrete GtkToggleButton next to a widget.</summary>
<remarks>
<para>
A GtkCheckButton places a discrete <see cref="T:Gtk.ToggleButton"/> next to a widget, usually a <see cref="T:Gtk.Label"/>. See <see cref="T:Gtk.ToggleButton"/> for more information about toggle/check buttons.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.ToggleButton</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Atk.Implementor</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="NewWithLabel">
<MemberSignature Language="C#" Value="public static Gtk.CheckButton NewWithLabel (string label);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.CheckButton</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<summary>Creates a new CheckButton object with a label to the right of it.</summary>
<param name="label">The label displayed to the right of the CheckButton.</param>
<returns>The newely created CheckButton.</returns>
<remarks>Creates a new CheckButton object with a label to the
right of it</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes of this widget</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CheckButton (uint gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Internal contructor</summary>
<param name="gtype"></param>
<returns>A new CheckButton</returns>
<remarks>Internal contructor</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CheckButton (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">A pointer to a GtkCheckButton, as returned by the Gtk+ C API.</param>
<returns>A C# Gtk.CheckButton that wraps the <paramref name="raw"/> parameter</returns>
<remarks>
<para>
If you don't already know that you need this constructor, it should not be used.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CheckButton ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Constructor</summary>
<returns>A new CheckButton</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CheckButton (string label);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<summary>Constructor</summary>
<param name="label">A string for the label.</param>
<returns>A new CheckButton with a label</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>Get the type of this object, as registered with the
GLib object system.</summary>
<returns><para>A number that uniquely identifies this type in
the GLib object system.</para></returns>
<remarks><para>Mostly for internal use.</para></remarks>
</Docs>
</Member>
</Members>
</Type>