2003-07-27 John Luke <jluke@cfl.rr.com>

* en/Gtk/CheckButton.xml: add small example, update

	* en/Gtk/TreeModelFlags.xml:
	* en/Gtk/RcFlags.xml: more documentation from
	Jonathan Kessler <Jwkpiano1@comcast.net>.

svn path=/trunk/gtk-sharp/; revision=16750
This commit is contained in:
John Luke 2003-07-27 18:21:23 +00:00
parent fec0df9def
commit 4fe4e95204
4 changed files with 98 additions and 38 deletions

View File

@ -1,3 +1,11 @@
2003-07-27 John Luke <jluke@cfl.rr.com>
* en/Gtk/CheckButton.xml: add small example, update
* en/Gtk/TreeModelFlags.xml:
* en/Gtk/RcFlags.xml: more documentation from
Jonathan Kessler <Jwkpiano1@comcast.net>.
2003-07-26 Duncan Mak <duncan@ximian.com>
* en/Gtk/Orientation.xml:

View File

@ -7,12 +7,64 @@
</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 GtkCheckButton places a discrete GtkToggleButton next to a widget.</summary>
<summary>A <see cref="T:Gtk.CheckButton" /> places a discrete <see cref="T:Gtk.ToggleButton" /> 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.
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>
@ -40,13 +92,13 @@
<ReturnType>Gtk.CheckButton</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="label" Type="System.String" />
</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
<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>
@ -67,12 +119,12 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</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 CheckButton, wrapping the C object.</returns>
<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>
@ -85,7 +137,7 @@
<Parameters />
<Docs>
<summary>Constructor</summary>
<returns>A new CheckButton</returns>
<returns>A new <see cref="T:Gtk.CheckButton" /></returns>
<remarks />
</Docs>
</Member>
@ -94,12 +146,12 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="label" Type="System.String" />
</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>
<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>
@ -110,8 +162,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gtk.CheckButton</summary>
<returns>The GLib Type for the Gtk.CheckButton class.</returns>
<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>
@ -120,16 +172,16 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</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 CheckButton, using the GLib-provided type</returns>
<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>
</Type>

View File

@ -9,8 +9,8 @@
</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>To be added</summary>
<remarks>To be added</remarks>
<summary>An enumeration that is used as a bitmask to specify which fields of <see cref="T:Gtk.RcStyle"/> have been set for each state.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -40,8 +40,8 @@
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>If set, the foreground color has been set for this state.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Bg">
@ -52,8 +52,8 @@
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>If set, the background color has been set for this state.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Text">
@ -64,8 +64,8 @@
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>If set, the text color has been set for this state.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Base">
@ -76,8 +76,8 @@
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>If set, the base color has been set for this state. </summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="value__">

View File

@ -7,8 +7,8 @@
</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>To be added</summary>
<remarks>To be added</remarks>
<summary>These flags indicate various properties of a <see cref="T:Gtk.TreeModel"/>.</summary>
<remarks>These flags are returned through the property <see cref="P:Gtk.TreeModel.Flags"/> and must be static for the lifetime of the object.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -34,8 +34,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>If set, iterators survive all signals emitted by the tree.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ListOnly">
@ -46,8 +46,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>If set, the model is a list only and never has children.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="value__">