Sophie

Sophie

distrib > Mandriva > 9.2 > i586 > media > contrib > by-pkgid > df634f7f22d35db1c99644e5db0b11d9 > files > 515

gtk-sharp-doc-0.11-0.20030831.3mdk.i586.rpm

<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>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 <see cref="T:Gtk.CheckButton" /> places a discrete <see cref="T:Gtk.ToggleButton" /> next to a widget.</summary>
    <remarks>
      <para>
        A <see cref="T:Gtk.CheckButton" /> 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>
    <example>
      <code language="C#">
using System;
using Gtk;
using GtkSharp;

class CheckButtonSample
{
	CheckButton cb;
	
	static void Main ()
	{
		new CheckButtonSample ();	
	}
	
	CheckButtonSample ()
	{
		Application.Init ();
	
		Window win = new Window ("CheckButtonSample");
		win.DeleteEvent += new DeleteEventHandler (OnWinDelete);

		VBox vbox = new VBox (true, 1);
		win.Add (vbox);

		cb = new CheckButton ("Checked");
		cb.Toggled += new EventHandler (OnCheckToggled);
		vbox.Add (cb);	
		
		win.ShowAll ();
		Application.Run ();
	}
	
	void OnCheckToggled (object obj, EventArgs args)
	{
		if (cb.Label == "Checked")
		{
			cb.Label = "Unchecked";
		}
		else
		{
			cb.Label = "Checked";
		}
	}
	
	void OnWinDelete (object obj, DeleteEventArgs args)
	{
		Application.Quit ();
	}
}
      </code>
    </example>
  </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 <see cref="T:Gtk.CheckButton" /> object with a label to the right of it.</summary>
        <param name="label">The label displayed to the right of the <see cref="T:Gtk.CheckButton" />.</param>
        <returns>The newly created <see cref="T:Gtk.CheckButton" />.</returns>
        <remarks>Creates a new <see cref="T:Gtk.CheckButton" /> object with a <see cref="T:Gtk.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 the resources associated with the object.</summary>
        <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">Pointer to the C object.</param>
        <returns>An instance of <see cref="T:Gtk.CheckButton" />, wrapping the C object.</returns>
        <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 CheckButton ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Constructor</summary>
        <returns>A new <see cref="T:Gtk.CheckButton" /></returns>
        <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 <see cref="T:Gtk.Label" />.</param>
        <returns>A new <see cref="T:Gtk.CheckButton" /> with a <see cref="T:Gtk.Label" /></returns>
        <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>The <see cref="T:GLib.Type" /> for <see cref="T:Gtk.CheckButton" /></summary>
        <returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gtk.CheckButton" /> class.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected CheckButton (GLib.Type gtype);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="gtype" Type="GLib.Type" />
      </Parameters>
      <Docs>
        <summary>Internal constructor</summary>
        <param name="gtype">GLib type for the type</param>
        <returns>Creates a new instance of <see cref="T:Gtk.CheckButton" />, using the GLib-provided type</returns>
        <remarks>
          <para>This is a constructor used by derivative types of <see cref="T:Gtk.CheckButton" /> that would have their own GLib type assigned to it.  This is not typically used by C# code.</para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>