[Mono-docs-list] RadioButton Docs

[Wade Mealing]

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

I've just been testing monodoc editor, and have buitl this
changeset.xml.

I am unable to upload using the GUI (again, its probably something on my
end, im not having much luck with this).

The part of the tree that I have worked on is the Gtk.RadioButton,
comments ? ideas ?

Wade Mealing

--=-xjCSwihcMiOIbZYu81d4
Content-Description: 
Content-Disposition: inline; filename=changeset.xml
Content-Type: text/xml; charset=
Content-Transfer-Encoding: 7bit

<?xml version="1.0" encoding="us-ascii"?>
<GlobalChangeset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <DocSetChangeset DocSet="gtk-sharp-docs">
    <FileChangeset RealFile="en/Gtk/RadioButton.xml">
      <Change XPath="/Type[1]/Docs[1]/summary[1]">
        <NewNode>
          <summary>Creates a single <see cref="T:CheckBox" /> like widget, which when grouped allows for a single selection from a </summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type[1]/Docs[1]/remarks[1]">
        <NewNode>
          <remarks>
            <para>A <see cref="T:RadioButton" /> by itself provides the same basic functionality as a <see cref="T:Gtk.CheckButton" />, 
it provides a checkbox next to another widget, usually a <see cref="T:Gtk.Label" />.  
When multiple <see cref="T:RadioButtons" /> are used together in a group, they become a new users interface component.  
</para>
            <para>
When grouped together, <see cref="T:RadioButtons" /> only allow a single selection to be made, selecting one radio button from the
group, all other radio buttons become deselected.  This is a method of ensuring that the user can only select a single choice
 from a group of options.
</para>
            <para>
The first call to create a RadioButton in a group  passes null  in place where Glib.Slist should be.  From this <see cref="RadioButton" /> 
, other RadioButtons can be added to this logical group by passing a Glib.Slist group parameter as the first argument in their constructer.
</para>
            <para> The value of the group can be obtained from the <see cref="P:Gtk.RadioButton.Group" /> Property 
<example>
                <code lang="C#">
 static GLib.SList group = radiobutton.Group;
	</code>
              </example></para>
            <example>
              <code lang="C#">
using Gtk;
using GtkSharp;
using System;
using System.Drawing;


    public class radiobuttons {

        static GLib.SList group = null;

        static void delete_event (object obj, DeleteEventArgs args)
        {
            Application.Quit();
        }

        static void exitbutton_event (object obj, EventArgs args)
        {
            Application.Quit();
        }

        public static void Main(string[] args)
        {

            Application.Init();

            Window window = new Window("radio buttons");
            window.DeleteEvent += new DeleteEventHandler (delete_event);
            window.BorderWidth = 0;

            HBox box1 = new HBox (false, 0);
            window.Add(box1);
            box1.Show();

            RadioButton radiobutton = new RadioButton  (null, "button1");
            box1.PackStart(radiobutton, true, true, 5);
            radiobutton.Show();

            group = radiobutton.Group;

            RadioButton radiobutton2 = new RadioButton(group, "button2");
            radiobutton2.Active = true;
            box1.PackStart(radiobutton2, true, true, 5);
            radiobutton2.Show();

            RadioButton  radiobutton3 = RadioButton.NewWithLabelFromWidget(radiobutton, "button3");
            box1.PackStart(radiobutton3, true, true, 5);
            radiobutton3.Show();

            window.ShowAll();

            Application.Run();

        }
    }

</code>
            </example>
          </remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type[1]/Members[1]/Member[9]/Docs[1]/remarks[1]">
        <NewNode>
          <remarks>This is an internal constructor, and should not be used by user code.</remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type[1]/Members[1]/Member[9]/Docs[1]/returns[1]">
        <NewNode>
          <returns>An object of type 'Gtk.RadioButton'</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type[1]/Members[1]/Member[7]/Docs[1]/remarks[1]">
        <NewNode>
          <remarks>This creates a <see cref="T:Gtk.RadioButton" /> with no label, useful when choosing a single image from a group.</remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type[1]/Members[1]/Member[7]/Docs[1]/returns[1]">
        <NewNode>
          <returns>An object of type 'Gtk.RadioButton'</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type[1]/Members[1]/Member[6]/Docs[1]/param[1]">
        <NewNode>
          <param name="group">an object of type 'GLib.SList', used to group <see cref="T:Gtk.RadioButton" /> into a single group.  Obtain this value from 
an existing radiobutton to add it to that  <see cref="T:Gtk.RadioButton" /> group, see the <see cref="P:Gtk.RadioButton.Group" /> property of  <see cref="T:Gtk.RadioButton" /></param>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type[1]/Members[1]/Member[8]/Docs[1]/returns[1]">
        <NewNode>
          <returns>An object of type 'Gtk.RadioButton' with the label set to string</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type[1]/Members[1]/Member[9]/Docs[1]/summary[1]">
        <NewNode>
          <summary>Internal constructor</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type[1]/Members[1]/Member[7]/Docs[1]/summary[1]">
        <NewNode>
          <summary>This creates a RadioButton with no label, in the same group as <see cref="T:Gtk.RadioButton" />, useful when choosing a single image from a group</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type[1]/Members[1]/Member[8]/Docs[1]/summary[1]">
        <NewNode>
          <summary>This creates a RadioButton with label from string.  This is the usual method of creating a RadioButton</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type[1]/Members[1]/Member[8]/Docs[1]/remarks[1]">
        <NewNode>
          <remarks>This creates a RadioButton with no label, useful when choosing a single image from a group</remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type[1]/Members[1]/Member[6]/Docs[1]/summary[1]">
        <NewNode>
          <summary>This creates a RadioButton with no label, useful when choosing a single image from a group</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
    </FileChangeset>
  </DocSetChangeset>
</GlobalChangeset>
--=-xjCSwihcMiOIbZYu81d4--