[Mono-docs-list] CheckButton documentation

Kevin Breit mrproper@ximian.com
20 Feb 2003 10:23:28 -0500


--=-LjnoDhfwDaM8nd3dX8vW
Content-Type: text/plain
Content-Transfer-Encoding: 7bit

Hey,
	Attached is the CheckButton.xml file for Gtk#.  In general, it should
be okay.  I just want to make sure before I commit.
Thanks
-- 
Kevin Breit <mrproper@ximian.com>

--=-LjnoDhfwDaM8nd3dX8vW
Content-Disposition: attachment; filename=CheckButton.xml
Content-Type: text/xml; name=CheckButton.xml; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit

<Type Name="CheckButton" FullName="Gtk.CheckButton">
  <TypeSignature Language="C#" Value="public class CheckButton : Gtk.ToggleButton, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
  <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 CheckButton is a special type of togglebutton that
    normally is positioned next to a label.  The
    CheckButton differs from the <see cred="T:Gtk.ToggleButton"/> in
    that the CheckButton has a check inside of the box which gets toggled, while the
    ToggleButton depresses the entire button.</summary>
    <remarks><para>An alternativeto the CheckButton is the <see
    cred="T:Gtk.ToggleButton"/>.</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: an object of type 'string'</param>
        <returns>A Gtk# object of the type 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.HBox 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>Internal 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>Internal constructor</summary>
        <param name="label">An object of System.String that will be
        the label placed to the right of the CheckButton.</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>
--=-LjnoDhfwDaM8nd3dX8vW--