ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Update docs for Gtk.

Browse source 
svn path=/trunk/gtk-sharp/; revision=12567
This commit is contained in:
Duncan Mak 2003-03-15 22:50:24 +00:00
parent 519ca82a97
commit 6a0ba3d687
15 changed files with 869 additions and 472 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
doc/en/Gtk/Alignment.xml
View file

@ -8,10 +8,12 @@
<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 container that controls the alignment and size of its child.</summary>
<remarks><para>An Alignment widget controls the alignment and size of its child widget. It has four settings: <see cref="P:Gtk.Alignment.Xscale"/>, <see cref="P:Gtk.Alignment.Yscale"/>, <see cref="P:Gtk.Alignment.Xalign"/>, and <see cref="P:Gtk.Alignment.Yalign"/>.</para>
<para>The scale settings are used to specify how much the child widget should expand to fill the space allocated to the Alignment. The values can range from 0 (meaning the child doesn't expand at all) to 1 (meaning the child expands to fill all of the available space).</para>
<para>The alignment settings are used to position the child widget within the available area. The values range from 0 (top or left) to 1 (bottom or right). If the scale settings are both set to 1, (making the child expand), the alignment settings have no effect.</para>
<para>To add a child to an Alignment, use the <see cref="M:Gtk.Container.Add"/> method from the <see cref="T:Gtk.Container"/> class.</para></remarks>
<remarks>
<para>An Alignment widget controls the alignment and size of its child widget. It has four settings: <see cref="P:Gtk.Alignment.Xscale" />, <see cref="P:Gtk.Alignment.Yscale" />, <see cref="P:Gtk.Alignment.Xalign" />, and <see cref="P:Gtk.Alignment.Yalign" />.</para>
<para>The scale settings are used to specify how much the child widget should expand to fill the space allocated to the Alignment. The values can range from 0 (meaning the child doesn't expand at all) to 1 (meaning the child expands to fill all of the available space).</para>
<para>The alignment settings are used to position the child widget within the available area. The values range from 0 (top or left) to 1 (bottom or right). If the scale settings are both set to 1, (making the child expand), the alignment settings have no effect.</para>
<para>To add a child to an Alignment, use the <see cref="M:Gtk.Container.Add" /> method from the <see cref="T:Gtk.Container" /> class.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Bin</BaseTypeName>
@ -50,7 +52,9 @@
<param name="yalign">The vertical alignment of the child widget, from 0 (top) to 1 (bottom).</param>
<param name="xscale">The amount that the child widget expands horizontally to fill up unused space, from 0 to 1.</param>
<param name="yscale">The amount that the child widget expands vertically to fill up unused space, from 0 to 1.</param>
<remarks><para>For the scale parameters, a value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the space allocated for the Alignment.</para></remarks>
<remarks>
<para>For the scale parameters, a value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the space allocated for the Alignment.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -98,7 +102,7 @@
<param name="xscale">The amount that the child widget expands horizontally to fill up unused space, from 0 to 1.</param>
<param name="yscale">The amount that the child widget expands vertically to fill up unused space, from 0 to 1.</param>
<returns>A new Alignment.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -108,8 +112,8 @@
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -137,7 +141,9 @@
<summary>Manage the vertical alignment of the child widget.</summary>
<param name="value">A new vertical alignment for the child widget.</param>
<returns>The child widget's current vertical alignment.</returns>
<remarks><para>This property is a value between 0 and 1 where 0 indicates alignment at the top of the container, and 1 indicates alignment at the bottom of the container.</para></remarks>
<remarks>
<para>This property is a value between 0 and 1 where 0 indicates alignment at the top of the container, and 1 indicates alignment at the bottom of the container.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Xalign">
@ -153,7 +159,9 @@
<summary>Manage the horizontal alignment of the child widget.</summary>
<param name="value">A new horizontal alignment for the child widget.</param>
<returns>The child widget's current horizontal alignment.</returns>
<remarks><para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size.</para></remarks>
<remarks>
<para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Xscale">
@ -169,7 +177,9 @@
<summary>Manage the horizontal expansion of the child widget.</summary>
<param name="value">The proportion that the child widget should expand horizontally.</param>
<returns>The current horizontal expansion of the child widget.</returns>
<remarks><para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size.</para></remarks>
<remarks>
<para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Yscale">
@ -185,7 +195,9 @@
<summary>Manage the vertical expansion of the child widget.</summary>
<param name="value">The proportion that the child widget should expand vertically.</param>
<returns>The current vertical expansion of the child widget.</returns>
<remarks><para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated vertical size.</para></remarks>
<remarks>
<para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated vertical size.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">

12
doc/en/Gtk/Bin.xml
View file

@ -8,9 +8,11 @@
<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 container with just one child.</summary>
<remarks><para>A Bin widget is a <see cref="T:Gtk.Container"/> with just one child. It is used to create subclasses, since it provides common code needed for handling a single child <see cref="T:Gtk.Widget"/>.</para>
<para>Many GTK+ widgets are subclasses of Bin, including <see cref="T:Gtk.Window"/>, <see cref="T:Gtk.Button"/>, <see cref="T:Gtk.Frame"/>, <see cref="T:Gtk.HandleBox"/>, and <see cref="T:Gtk.ScrolledWindow"/>.</para>
<para>To place a child widget inside this container, use the standard <see cref="M:Gtk.Container.Add"/> method.</para></remarks>
<remarks>
<para>A Bin widget is a <see cref="T:Gtk.Container" /> with just one child. It is used to create subclasses, since it provides common code needed for handling a single child <see cref="T:Gtk.Widget" />.</para>
<para>Many GTK+ widgets are subclasses of Bin, including <see cref="T:Gtk.Window" />, <see cref="T:Gtk.Button" />, <see cref="T:Gtk.Frame" />, <see cref="T:Gtk.HandleBox" />, and <see cref="T:Gtk.ScrolledWindow" />.</para>
<para>To place a child widget inside this container, use the standard <see cref="M:Gtk.Container.Add" /> method.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Container</BaseTypeName>
@ -66,8 +68,8 @@
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">

294
doc/en/Gtk/Button.xml
View file

@ -36,31 +36,309 @@
</Interfaces>
<Attributes />
<Members>
<Member MemberName="ColorSelectionDialog">
<MemberSignature Language="C#" Value="public Gtk.ColorSelectionDialog ColorSelectionDialog { get; };" />
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ColorSelectionDialog</ReturnType>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.ColorSelectionDialog'</returns>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UseStock">
<MemberSignature Language="C#" Value="public bool UseStock { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UseUnderline">
<MemberSignature Language="C#" Value="public bool UseUnderline { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Relief">
<MemberSignature Language="C#" Value="public Gtk.ReliefStyle Relief { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ReliefStyle</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gtk.ReliefStyle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.ReliefStyle'</param>
<returns>To be added: an object of type 'Gtk.ReliefStyle'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Label">
<MemberSignature Language="C#" Value="public string Label { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Activated">
<MemberSignature Language="C#" Value="public event EventHandler Activated;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Clicked">
<MemberSignature Language="C#" Value="public event EventHandler Clicked;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Left">
<MemberSignature Language="C#" Value="public event EventHandler Left;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Pressed">
<MemberSignature Language="C#" Value="public event EventHandler Pressed;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Released">
<MemberSignature Language="C#" Value="public event EventHandler Released;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Entered">
<MemberSignature Language="C#" Value="public event EventHandler Entered;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ActionGetType">
<MemberSignature Language="C#" Value="public static uint ActionGetType ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NewWithLabel">
<MemberSignature Language="C#" Value="public static Gtk.Button NewWithLabel (string label);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.Button</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="label">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NewFromStock">
<MemberSignature Language="C#" Value="public static Gtk.Button NewFromStock (string stock_id);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.Button</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stock_id" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="stock_id">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Leave">
<MemberSignature Language="C#" Value="public void Leave ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Press">
<MemberSignature Language="C#" Value="public void Press ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Release">
<MemberSignature Language="C#" Value="public void Release ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Click">
<MemberSignature Language="C#" Value="public void Click ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Enter">
<MemberSignature Language="C#" Value="public void Enter ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button (Gtk.ColorSelectionDialog cs, IntPtr raw);" />
<MemberSignature Language="C#" Value="protected Button (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="gtype">To be added: an object of type 'GLib.Type'</param>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="cs" Type="Gtk.ColorSelectionDialog" />
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cs">To be added: an object of type 'Gtk.ColorSelectionDialog'</param>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.ColorSelectionDialog+Button'</returns>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button (string label);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="label">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gtk.Button'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>

63
doc/en/Gtk/ColorSelectionButton.xml Normal file
View file

@ -0,0 +1,63 @@
<Type Name="ColorSelectionButton" FullName="Gtk.ColorSelectionDialog+ColorSelectionButton">
<TypeSignature Language="C#" Value="public class ColorSelectionButton : Gtk.Button, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey />
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Button</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=".ctor">
<MemberSignature Language="C#" Value="public ColorSelectionButton (Gtk.ColorSelectionDialog cs, IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="cs" Type="Gtk.ColorSelectionDialog" />
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cs">To be added: an object of type 'Gtk.ColorSelectionDialog'</param>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.ColorSelectionDialog+ColorSelectionButton'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ColorSelectionDialog">
<MemberSignature Language="C#" Value="public Gtk.ColorSelectionDialog ColorSelectionDialog { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ColorSelectionDialog</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.ColorSelectionDialog'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>

15
doc/en/Gtk/Combo.xml
View file

@ -276,21 +276,6 @@
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AppendString">
<MemberSignature Language="C#" Value="public void AppendString (string text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Combo (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>

21
doc/en/Gtk/HScale.xml
View file

@ -8,7 +8,10 @@
<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 horizontal slider widget for selecting a value from a range.</summary>
<remarks><para>The HScale widget allows the user to select a value with a horizontal slider.</para><para>This widget and its model is manipulated using methods and properties in its super classes, <see cref="T:Gtk.Scale"/> and <see cref="T:Gtk.Range"/>.</para></remarks>
<remarks>
<para>The HScale widget allows the user to select a value with a horizontal slider.</para>
<para>This widget and its model is manipulated using methods and properties in its super classes, <see cref="T:Gtk.Scale" /> and <see cref="T:Gtk.Range" />.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Scale</BaseTypeName>
@ -65,10 +68,12 @@
<Parameter Name="adjustment" Type="Gtk.Adjustment" />
</Parameters>
<Docs>
<summary>Creates a new horizontal slider based on the data in <paramref name="adjustment"/>.</summary>
<summary>Creates a new horizontal slider based on the data in <paramref name="adjustment" />.</summary>
<param name="adjustment">The model to use for this HScale</param>
<returns>A new HScale</returns>
<remarks><para>To create a horizontal slider without explicit use of a <see cref="T:Gtk.Adjustment"/>, use the alternative constructor.</para></remarks>
<remarks>
<para>To create a horizontal slider without explicit use of a <see cref="T:Gtk.Adjustment" />, use the alternative constructor.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -81,12 +86,14 @@
<Parameter Name="step" Type="System.Double" />
</Parameters>
<Docs>
<summary>Creates a new horizontal slider without the need for an <see cref="T:Gtk.Adjustment"/> object.</summary>
<summary>Creates a new horizontal slider without the need for an <see cref="T:Gtk.Adjustment" /> object.</summary>
<param name="min">The minimum value that is accepted by this HScale.</param>
<param name="max">The maximum value that is accepted by this HScale.</param>
<param name="step">The value to adjust the HScale by when 'sliding'.</param>
<returns>A new HScale.</returns>
<remarks><para>Creates a new horizontal slider that lets the user input a number between (and including) <paramref name="min"/> and <paramref name="max"/>. Each adjustment of the slider changes the value by <paramref name="step"/>, which must be non-zero.</para></remarks>
<remarks>
<para>Creates a new horizontal slider that lets the user input a number between (and including) <paramref name="min" /> and <paramref name="max" />. Each adjustment of the slider changes the value by <paramref name="step" />, which must be non-zero.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -96,8 +103,8 @@
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">

35
doc/en/Gtk/HandleBox.xml
View file

@ -8,10 +8,12 @@
<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 container with a handle and a detachable child widget.</summary>
<remarks><para>The HandleBox widget allows a portion of a window to be &quot;torn off&quot;. It is a <see cref="T:Gtk.Bin"/> widget that displays its child with a handle that the user can drag to create a separate floating window containing the child widget and the 'handle'.</para>
<para>A thin ghost is drawn in the original location of the HandleBox. By dragging the separate window back to its original location, it can be reattached. When reattaching, the ghost and float window, must be aligned along one of the edges, the <see cref="P:Gtk.HandlBox.SnapEdge"/>. This can either be specified by the application programmer explicitly, otherwise a reasonable default will be used, based on the <see cref="P:Gtk.HandleBox.HandlePosition"/>.</para>
<para>To make detaching and reattaching the HandleBox as minimally confusing as possible to the user, it is important to set the snap edge so that it does not move when the HandleBox is deattached. For instance, if the HandleBox is packed at the bottom of a <see cref="T:Gtk.VBox"/>, then when the HandleBox is detached, the bottom edge of the HandleBox's allocation will remain fixed as the height of the HandleBox shrinks, so the snap edge should be set to <see cref="P:Gtk.PositionType.Bottom"/>.</para>
<para>The child of this widget is set using the <see cref="M:Gtk.Container.Add"/> method in <see cref="T:Gtk.Container"/>.</para></remarks>
<remarks>
<para>The HandleBox widget allows a portion of a window to be "torn off". It is a <see cref="T:Gtk.Bin" /> widget that displays its child with a handle that the user can drag to create a separate floating window containing the child widget and the 'handle'.</para>
<para>A thin ghost is drawn in the original location of the HandleBox. By dragging the separate window back to its original location, it can be reattached. When reattaching, the ghost and float window, must be aligned along one of the edges, the <see cref="P:Gtk.HandlBox.SnapEdge" />. This can either be specified by the application programmer explicitly, otherwise a reasonable default will be used, based on the <see cref="P:Gtk.HandleBox.HandlePosition" />.</para>
<para>To make detaching and reattaching the HandleBox as minimally confusing as possible to the user, it is important to set the snap edge so that it does not move when the HandleBox is deattached. For instance, if the HandleBox is packed at the bottom of a <see cref="T:Gtk.VBox" />, then when the HandleBox is detached, the bottom edge of the HandleBox's allocation will remain fixed as the height of the HandleBox shrinks, so the snap edge should be set to <see cref="P:Gtk.PositionType.Bottom" />.</para>
<para>The child of this widget is set using the <see cref="M:Gtk.Container.Add" /> method in <see cref="T:Gtk.Container" />.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Bin</BaseTypeName>
@ -68,7 +70,9 @@
<Docs>
<summary>The main way to create a HandleBox.</summary>
<returns>A new HandleBox.</returns>
<remarks><para>Creates a new HandleBox, with the <see cref="P:Gtk.HandleBox.HandlePosition"/> set to the <see cref="P:Gtk.PositionType.Left"/>.</para></remarks>
<remarks>
<para>Creates a new HandleBox, with the <see cref="P:Gtk.HandleBox.HandlePosition" /> set to the <see cref="P:Gtk.PositionType.Left" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -96,7 +100,9 @@
<summary>Manage which edge a detached HandleBox must reattach to.</summary>
<param name="value">The new edge</param>
<returns>The current edge that snapping works with.</returns>
<remarks><para>To ensure good usability, this edge should be set to a side of the HandleBox whose position or size will not be altered when the child is detached.</para></remarks>
<remarks>
<para>To ensure good usability, this edge should be set to a side of the HandleBox whose position or size will not be altered when the child is detached.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ShadowType">
@ -109,10 +115,10 @@
<Parameter Name="value" Type="Gtk.ShadowType" />
</Parameters>
<Docs>
<summary>Manage the appearance of the <see cref="T:Gtk.Container"/> surrounding the child widget.</summary>
<summary>Manage the appearance of the <see cref="T:Gtk.Container" /> surrounding the child widget.</summary>
<param name="value">The new style of shadow to use for this HandleBox.</param>
<returns>The current style of shadow in use.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="HandlePosition">
@ -128,7 +134,10 @@
<summary>Manage where the handle of this container is placed.</summary>
<param name="value">A new position for the handle.</param>
<returns>The current position of the handle.</returns>
<remarks><para>Note: In western cultures, anything other than a <see cref="P:Gtk.PositionType.Left"/> handle for horizontal HandleBoxes, or a <see cref="P:Gtk.PositionType.Top"/> handle for vertical HandleBoxes, may seem strange to users.</para><para>The reverse is likely to be true for cultures with languages that are written from right to left.</para></remarks>
<remarks>
<para>Note: In western cultures, anything other than a <see cref="P:Gtk.PositionType.Left" /> handle for horizontal HandleBoxes, or a <see cref="P:Gtk.PositionType.Top" /> handle for vertical HandleBoxes, may seem strange to users.</para>
<para>The reverse is likely to be true for cultures with languages that are written from right to left.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Shadow">
@ -141,10 +150,10 @@
<Parameter Name="value" Type="Gtk.ShadowType" />
</Parameters>
<Docs>
<summary>Manage the appearance of the <see cref="T:Gtk.Container"/> surrounding the child widget.</summary>
<summary>Manage the appearance of the <see cref="T:Gtk.Container" /> surrounding the child widget.</summary>
<param name="value">The new style of shadow to use for this HandleBox.</param>
<returns>The current style of shadow in use.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="ChildAttached">
@ -154,7 +163,7 @@
<Parameters />
<Docs>
<summary>This event is fired when the contents of the HandleBox are reattached to the main window. </summary>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="ChildDetached">
@ -164,7 +173,7 @@
<Parameters />
<Docs>
<summary>This event is fired when the contents of the handlebox are detached from the main window.</summary>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">

9
doc/en/Gtk/NotebookPage.xml
View file

@ -47,12 +47,12 @@
widget. -1 if the widget is not found in the Notebook.
</returns>
<remarks>
<para>
<para>
Returns the number of the NotebookPage containing a
given widget in a given Notebook or -1 if the widget is not
found.
</para>
</remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -78,10 +78,9 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>Creates a new instance of <see
cref="T:Gtk.NotebookPage" /></returns>
<returns>Creates a new instance of <see cref="T:Gtk.NotebookPage" /></returns>
<remarks>
<para>
<para>
This is a constructor used by derivative types of <see cref="T:Gtk.NotebookPage" />.
This is not typically used by C# code.
</para>

12
doc/en/Gtk/PositionType.xml
View file

@ -8,7 +8,9 @@
<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>Indicates a position for placement or layout.</summary>
<remarks><para>A PositionType is used to place widgets, usually relative to other widgets or other parts of the same widget. For example, the position of a handle in a <see cref="T:Gtk.HandleBox"/>, or the position of tabs in a <see cref="T:Gtk.Notebook"/>.</para></remarks>
<remarks>
<para>A PositionType is used to place widgets, usually relative to other widgets or other parts of the same widget. For example, the position of a handle in a <see cref="T:Gtk.HandleBox" />, or the position of tabs in a <see cref="T:Gtk.Notebook" />.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -35,7 +37,7 @@
<Parameters />
<Docs>
<summary>The relevant item should be placed on the left.</summary>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Right">
@ -47,7 +49,7 @@
<Parameters />
<Docs>
<summary>The relevant item should be placed on the right.</summary>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Top">
@ -59,7 +61,7 @@
<Parameters />
<Docs>
<summary>The relevant item should be placed at the top.</summary>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Bottom">
@ -71,7 +73,7 @@
<Parameters />
<Docs>
<summary>The relevant item should be placed at the bottom.</summary>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="value__">

36
doc/en/Gtk/Range.xml
View file

@ -7,8 +7,10 @@
</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>Base class for widgets that visualize an <see cref="T:Gtk.Adjustment"/>.</summary>
<remarks><para>This class provides helper methods and properties for manipulating concrete widgets like <see cref="T:Gtk.HScale"/> and <see cref="T:Gtk.VScale"/>.</para></remarks>
<summary>Base class for widgets that visualize an <see cref="T:Gtk.Adjustment" />.</summary>
<remarks>
<para>This class provides helper methods and properties for manipulating concrete widgets like <see cref="T:Gtk.HScale" /> and <see cref="T:Gtk.VScale" />.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Widget</BaseTypeName>
@ -43,7 +45,9 @@
<summary>Sets the step and page sizes for this range.</summary>
<param name="step">Value difference for step movements, (see below).</param>
<param name="page">Value difference for page movements, (see below).</param>
<remarks><para>The <paramref name="step"/> size is used when the user clicks the <see cref="T:Gtk.Scrollbar"/> arrows or moves <see cref="T:Gtk.Scale"/> with arrow keys. The <paramref name="page"/> size is used for example when moving via Page Up or Page Down keys.</para></remarks>
<remarks>
<para>The <paramref name="step" /> size is used when the user clicks the <see cref="T:Gtk.Scrollbar" /> arrows or moves <see cref="T:Gtk.Scale" /> with arrow keys. The <paramref name="page" /> size is used for example when moving via Page Up or Page Down keys.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetRange">
@ -60,7 +64,7 @@
<summary>Sets the limits of this range.</summary>
<param name="min">The minimum acceptable value for this range.</param>
<param name="max">The maximum acceptable value for this range.</param>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Finalize">
@ -98,8 +102,8 @@
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -127,7 +131,7 @@
<summary>Manage the value of this range.</summary>
<param name="value">The new value for this range.</param>
<returns>The current value of this range.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Inverted">
@ -141,9 +145,11 @@
</Parameters>
<Docs>
<summary>Manage whether the control of this range is manipulated in the opposite direction.</summary>
<param name="value">Set to <see langword="true"/> to invert the controls.</param>
<param name="value">Set to <see langword="true" /> to invert the controls.</param>
<returns>Whether visual control of the range is currently inverted.</returns>
<remarks><para>Setting this to <see langword="true"/> causes a <see cref="T:Gtk.VScale"/> widget to move from right to left, instead of left to right.</para></remarks>
<remarks>
<para>Setting this to <see langword="true" /> causes a <see cref="T:Gtk.VScale" /> widget to move from right to left, instead of left to right.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="UpdatePolicy">
@ -159,7 +165,7 @@
<summary>Manage how often the value label is updated.</summary>
<param name="value">A new update policy.</param>
<returns>The current update policy.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Adjustment">
@ -173,9 +179,9 @@
</Parameters>
<Docs>
<summary>Manipulate the underlying model of this range.</summary>
<param name="value">Sets a new <see cref="T:Gtk.Adjustment"/> object to model this range.</param>
<returns>The current <see cref="T:Gtk.Adjustment"/> underlying this range.</returns>
<remarks></remarks>
<param name="value">Sets a new <see cref="T:Gtk.Adjustment" /> object to model this range.</param>
<returns>The current <see cref="T:Gtk.Adjustment" /> underlying this range.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="MoveSlider">
@ -195,7 +201,9 @@
<Parameters />
<Docs>
<summary>Fired when the value in this range changes.</summary>
<remarks><para>Connect to this event with a standard <see cref="T:System.EventHandler"/> to find out when the value changes.</para></remarks>
<remarks>
<para>Connect to this event with a standard <see cref="T:System.EventHandler" /> to find out when the value changes.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AdjustBounds">

27
doc/en/Gtk/Scale.xml
View file

@ -7,8 +7,10 @@
</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 base class for the concrete slider widgets; <see cref="T:Gtk.HScale"/> and <see cref="T:Gtk.VScale"/>.</summary>
<remarks><para>A Scale is a slider control used to select a numeric value. Specific manipulation can be done with methods and properties on its base class, <see cref="T:Gtk.Range"/>. To set the value of a scale, you would normally use the <see cref="P:Gtk.Range.Value"/> property. To detect changes to the value, connect an event handler to the <see cref="F:Gtk.Range.ValueChanged"/> event.</para></remarks>
<summary>A base class for the concrete slider widgets; <see cref="T:Gtk.HScale" /> and <see cref="T:Gtk.VScale" />.</summary>
<remarks>
<para>A Scale is a slider control used to select a numeric value. Specific manipulation can be done with methods and properties on its base class, <see cref="T:Gtk.Range" />. To set the value of a scale, you would normally use the <see cref="P:Gtk.Range.Value" /> property. To detect changes to the value, connect an event handler to the <see cref="F:Gtk.Range.ValueChanged" /> event.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Range</BaseTypeName>
@ -64,8 +66,8 @@
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -93,7 +95,9 @@
<summary>Manage the position of the value, relative to the slider.</summary>
<param name="value">The position to place the value</param>
<returns>Where the value is currently being drawn.</returns>
<remarks><para>Note: This property is only meaningful is a value is being drawn. To ensure a value is drawn, use the <see cref="P:Gtk.Scale.DrawValue"/> property.</para></remarks>
<remarks>
<para>Note: This property is only meaningful is a value is being drawn. To ensure a value is drawn, use the <see cref="P:Gtk.Scale.DrawValue" /> property.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="DrawValue">
@ -107,9 +111,12 @@
</Parameters>
<Docs>
<summary>Manage whether a label is displayed to show the current value.</summary>
<param name="value"><see langword="true"/> to display the value, <see langword="false"/> otherwise.</param>
<param name="value">
<see langword="true" /> to display the value, <see langword="false" /> otherwise.</param>
<returns>Whether the value is currently being displayed.</returns>
<remarks><para>Use the <see cref="P:Gtk.Scale.ValuePos"/> property to alter the position of displayed value.</para></remarks>
<remarks>
<para>Use the <see cref="P:Gtk.Scale.ValuePos" /> property to alter the position of displayed value.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Digits">
@ -125,7 +132,7 @@
<summary>Manage the number of decimal places for this slider.</summary>
<param name="value">The number of decimal places to display.</param>
<returns>The number of decimal places currently being displayed.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="FormatValue">
@ -135,7 +142,9 @@
<Parameters />
<Docs>
<summary>Allows the format of the displayed value to be altered.</summary>
<remarks><para>Note: The signature of this event handler is currently incorrect.</para></remarks>
<remarks>
<para>Note: The signature of this event handler is currently incorrect.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">

95
doc/en/Gtk/Table.xml
View file

@ -8,11 +8,13 @@
<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>Pack widgets in grid/table patterns.</summary>
<remarks><para>The Table widget allows a programmer to arrange widgets in rows and columns, making it easy to align many widgets adjacent to each other, horizontally and vertically.</para>
<para>Tables are created with a specific size - the number of rows and columns. This can be changed dynamically with the <see cref="M:Gtk.Table.Resize"/> method. Widgets are packed into the table with <see cref="M:Gtk.Table.Attach"/> methods.</para>
<para>The layout of a table can be altered by setting the spacing between rows and columns. This is done with the <see cref="P:Gtk.Table.ColumnSpacing"/> and <see cref="P:Gtk.Table.RowSpacing"/> properties, respectively. The spacing of individual cells can be adjusted with <see cref="M:Gtk.Table.SetColSpacing"/>.</para>
<para>The following shows how to create a table with three widgets:
<example><code lang="C#">
<remarks>
<para>The Table widget allows a programmer to arrange widgets in rows and columns, making it easy to align many widgets adjacent to each other, horizontally and vertically.</para>
<para>Tables are created with a specific size - the number of rows and columns. This can be changed dynamically with the <see cref="M:Gtk.Table.Resize" /> method. Widgets are packed into the table with <see cref="M:Gtk.Table.Attach" /> methods.</para>
<para>The layout of a table can be altered by setting the spacing between rows and columns. This is done with the <see cref="P:Gtk.Table.ColumnSpacing" /> and <see cref="P:Gtk.Table.RowSpacing" /> properties, respectively. The spacing of individual cells can be adjusted with <see cref="M:Gtk.Table.SetColSpacing" />.</para>
<para>The following shows how to create a table with three widgets:
<example>
<code lang="C#">
public Widget MakeTableTester()
{
// Create a table with 2 rows and 1 column
@ -28,8 +30,8 @@ public Widget MakeTableTester()
tableLayout.ShowAll();
return tableLayout;
}
</code></example>
</para>
</code>
</example></para>
</remarks>
</Docs>
<Base>
@ -64,8 +66,10 @@ public Widget MakeTableTester()
<Docs>
<summary>Sets the spacing around a specified column.</summary>
<param name="column">A zero-indexed column number to adjust the spacing of.</param>
<param name="spacing">The number of pixels on each side of the <paramref name="column"/>.</param>
<remarks><para>To adjust the spacing between all columns, use the <see cref="P:Gtk.Table.ColumnSpacing"/> property.</para></remarks>
<param name="spacing">The number of pixels on each side of the <paramref name="column" />.</param>
<remarks>
<para>To adjust the spacing between all columns, use the <see cref="P:Gtk.Table.ColumnSpacing" /> property.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GetColSpacing">
@ -80,8 +84,8 @@ public Widget MakeTableTester()
<Docs>
<summary>The spacing currently set for a given column.</summary>
<param name="column">A zero-indexed column number to retrieve spacing information from.</param>
<returns>The number of pixels of spacing assigned to the specified <paramref name="column"/>.</returns>
<remarks></remarks>
<returns>The number of pixels of spacing assigned to the specified <paramref name="column" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Resize">
@ -95,10 +99,10 @@ public Widget MakeTableTester()
<Parameter Name="columns" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Resizes the table so that the specified number of <paramref name="rows"/> and <paramref name="columns"/> are available for widget packing.</summary>
<summary>Resizes the table so that the specified number of <paramref name="rows" /> and <paramref name="columns" /> are available for widget packing.</summary>
<param name="rows">The new number of rows this table should allow.</param>
<param name="columns">The new number of columns this table should allow.</param>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Attach">
@ -120,17 +124,18 @@ public Widget MakeTableTester()
</Parameters>
<Docs>
<summary>Packs a widget into the table.</summary>
<param name="child">The <see cref="T:Gtk.Widget"/> to add.</param>
<param name="left_attach">The column number to attach the left side of <paramref name="child"/> to.</param>
<param name="right_attach">The column number to attach the right side of <paramref name="child"/> to.</param>
<param name="top_attach">The row number to attach the top of <paramref name="child"/> to.</param>
<param name="bottom_attach">The row number to attach the bottom of <paramref name="child"/> to.</param>
<param name="xoptions">The horizontal packing options for this <paramref name="child"/>.</param>
<param name="yoptions">The vertical packing options for this <paramref name="child"/>.</param>
<param name="xpadding">The number of pixels of padding to add to the left and right of <paramref name="child"/>.</param>
<param name="ypadding">The number of pixels of padding to add to the top and bottom of <paramref name="child"/>.</param>
<remarks><para>You can pack widgets into the Table using default packing and padding with the <see cref="M:Gtk.Table.Attach(Gtk.Widget,uint,uint,uint,uint)"/> convenience method.</para>
<para>Child widgets can span as many table cells as they wish, allowing the programmer to create complex grids of Widgets.</para>
<param name="child">The <see cref="T:Gtk.Widget" /> to add.</param>
<param name="left_attach">The column number to attach the left side of <paramref name="child" /> to.</param>
<param name="right_attach">The column number to attach the right side of <paramref name="child" /> to.</param>
<param name="top_attach">The row number to attach the top of <paramref name="child" /> to.</param>
<param name="bottom_attach">The row number to attach the bottom of <paramref name="child" /> to.</param>
<param name="xoptions">The horizontal packing options for this <paramref name="child" />.</param>
<param name="yoptions">The vertical packing options for this <paramref name="child" />.</param>
<param name="xpadding">The number of pixels of padding to add to the left and right of <paramref name="child" />.</param>
<param name="ypadding">The number of pixels of padding to add to the top and bottom of <paramref name="child" />.</param>
<remarks>
<para>You can pack widgets into the Table using default packing and padding with the <see cref="M:Gtk.Table.Attach(Gtk.Widget,uint,uint,uint,uint)" /> convenience method.</para>
<para>Child widgets can span as many table cells as they wish, allowing the programmer to create complex grids of Widgets.</para>
</remarks>
</Docs>
</Member>
@ -149,12 +154,14 @@ public Widget MakeTableTester()
</Parameters>
<Docs>
<summary>Packs a widget into the table with default packing options.</summary>
<param name="child">The <see cref="T:Gtk.Widget"/> to add.</param>
<param name="left_attach">The column number to attach the left side of <paramref name="child"/> to.</param>
<param name="right_attach">The column number to attach the right side of <paramref name="child"/> to.</param>
<param name="top_attach">The row number to attach the top of <paramref name="child"/> to.</param>
<param name="bottom_attach">The row number to attach the bottom of <paramref name="child"/> to.</param>
<remarks><para>To pack widgets into the table with more control over size and padding, use the alternative <see cref="M:Gtk.Table.Attach(Gtk.Widget,uint,uint,uint,uint,Gtk.AttachOptions,Gtk.AttachOptions,uint,uint)"/> method.</para></remarks>
<param name="child">The <see cref="T:Gtk.Widget" /> to add.</param>
<param name="left_attach">The column number to attach the left side of <paramref name="child" /> to.</param>
<param name="right_attach">The column number to attach the right side of <paramref name="child" /> to.</param>
<param name="top_attach">The row number to attach the top of <paramref name="child" /> to.</param>
<param name="bottom_attach">The row number to attach the bottom of <paramref name="child" /> to.</param>
<remarks>
<para>To pack widgets into the table with more control over size and padding, use the alternative <see cref="M:Gtk.Table.Attach(Gtk.Widget,uint,uint,uint,uint,Gtk.AttachOptions,Gtk.AttachOptions,uint,uint)" /> method.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -200,7 +207,9 @@ public Widget MakeTableTester()
<param name="columns">The number of columns in this table.</param>
<param name="homogeneous">Whether all table cells are forced to be the same size.</param>
<returns>A new Table.</returns>
<remarks><para>The size of the table can be altered after its creation using the <see cref="M:Gtk.able.Resize"/> method.</para></remarks>
<remarks>
<para>The size of the table can be altered after its creation using the <see cref="M:Gtk.able.Resize" /> method.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -210,8 +219,8 @@ public Widget MakeTableTester()
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -236,10 +245,10 @@ public Widget MakeTableTester()
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Sets the space between every column equal to <paramref name="value"/>.</summary>
<summary>Sets the space between every column equal to <paramref name="value" />.</summary>
<param name="value">The number of pixels to place between every column.</param>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="DefaultRowSpacing">
@ -251,7 +260,7 @@ public Widget MakeTableTester()
<Docs>
<summary>Retrieve the spacing that gets placed between newly added rows by default.</summary>
<returns>Spacing between rows that will be added, in pixels.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="DefaultColSpacing">
@ -311,7 +320,7 @@ public Widget MakeTableTester()
<summary>Manage the number of columns in this Table.</summary>
<param name="value">The number of columns that this table should have.</param>
<returns>The number of columns this table currently has.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Homogeneous">
@ -325,9 +334,11 @@ public Widget MakeTableTester()
</Parameters>
<Docs>
<summary>Manage whether all cells must be of equal size.</summary>
<param name="value"><see langword="true"/> to set all cells to an equal size, <see langword="false"/> otherwise.</param>
<returns><see langword="true"/> if all cells are currently equally sized, <see langword="false"/> otherwise.</returns>
<remarks></remarks>
<param name="value">
<see langword="true" /> to set all cells to an equal size, <see langword="false" /> otherwise.</param>
<returns>
<see langword="true" /> if all cells are currently equally sized, <see langword="false" /> otherwise.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="RowSpacing">
@ -359,7 +370,7 @@ public Widget MakeTableTester()
<summary>Manage the number of rows in this Table.</summary>
<param name="value">The number of rows that this table should have.</param>
<returns>The number of rows this table currently has.</returns>
<remarks></remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">

23
doc/en/Gtk/VScale.xml
View file

@ -8,8 +8,11 @@
<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 vertical slider widget for selecting a value from a range.</summary>
<remarks><para>The VScale widget allows the user to select a value with a vertical slider.</para><para>This widget and its model is manipulated using methods and properties in its super classes, <see cref="T:Gtk.Scale"/> and <see cref="T:Gtk.Range"/>.</para></remarks>
</Docs>
<remarks>
<para>The VScale widget allows the user to select a value with a vertical slider.</para>
<para>This widget and its model is manipulated using methods and properties in its super classes, <see cref="T:Gtk.Scale" /> and <see cref="T:Gtk.Range" />.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Scale</BaseTypeName>
</Base>
@ -65,10 +68,12 @@
<Parameter Name="adjustment" Type="Gtk.Adjustment" />
</Parameters>
<Docs>
<summary>Creates a new vertical slider based on the data in <paramref name="adjustment"/>.</summary>
<summary>Creates a new vertical slider based on the data in <paramref name="adjustment" />.</summary>
<param name="adjustment">The model to use for this VScale</param>
<returns>A new VScale</returns>
<remarks><para>To create a vertical slider without explicit use of a <see cref="T:Gtk.Adjustment"/>, use the alternative constructor.</para></remarks>
<remarks>
<para>To create a vertical slider without explicit use of a <see cref="T:Gtk.Adjustment" />, use the alternative constructor.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -81,12 +86,14 @@
<Parameter Name="step" Type="System.Double" />
</Parameters>
<Docs>
<summary>Creates a new vertical slider without the need for an <see cref="T:Gtk.Adjustment"/> object.</summary>
<summary>Creates a new vertical slider without the need for an <see cref="T:Gtk.Adjustment" /> object.</summary>
<param name="min">The minimum value that is accepted by this VScale.</param>
<param name="max">The maximum value that is accepted by this VScale.</param>
<param name="step">The value to adjust the VScale by when 'sliding'.</param>
<returns>A new VScale.</returns>
<remarks><para>Creates a new vertical slider that lets the user input a number between (and including) <paramref name="min"/> and <paramref name="max"/>. Each adjustment of the slider changes the value by <paramref name="step"/>, which must be non-zero.</para></remarks>
<remarks>
<para>Creates a new vertical slider that lets the user input a number between (and including) <paramref name="min" /> and <paramref name="max" />. Each adjustment of the slider changes the value by <paramref name="step" />, which must be non-zero.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -96,8 +103,8 @@
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns></returns>
<remarks></remarks>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="GType">

567
doc/en/Gtk/Widget.xml
View file

File diff suppressed because it is too large Load diff

96
doc/en/Gtk/WidgetFlags.xml
View file

@ -7,7 +7,7 @@
</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>Tells about certain properties of the <paramref name="widget"/>.</summary>
<summary>Tells about certain properties of the <paramref name="widget" />.</summary>
<remarks />
</Docs>
<Base>
@ -34,10 +34,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Widgets without a real parent, as there are <see cref="T:Gtk.Window"/>s and <see cref="T:Gtk.Menu"/>s have this flag set throughout their lifetime.</summary>
<summary>Widgets without a real parent, as there are <see cref="T:Gtk.Window" />s and <see cref="T:Gtk.Menu" />s have this flag set throughout their lifetime.</summary>
<remarks>
<para>
Toplevel widgets always contain their own <see cref="T:Gdk.Window"/>.
<para>
Toplevel widgets always contain their own <see cref="T:Gdk.Window" />.
</para>
</remarks>
</Docs>
@ -50,10 +50,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicative for a <paramref name="widget"/> that does not provide its own <see cref="T:Gdk.Window"/>.</summary>
<summary>Indicative for a <paramref name="widget" /> that does not provide its own <see cref="T:Gdk.Window" />.</summary>
<remarks>
<para>
Visible action (e.g. drawing) is performed on the parent's <see cref="T:Gdk.Window"/>.
<para>
Visible action (e.g. drawing) is performed on the parent's <see cref="T:Gdk.Window" />.
</para>
</remarks>
</Docs>
@ -66,10 +66,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary> Set by <see cref="M:Gtk.Widget.Realize"/>, unset by <see cref="M:Gtk.Widget.Unrealize"/>.</summary>
<summary> Set by <see cref="M:Gtk.Widget.Realize" />, unset by <see cref="M:Gtk.Widget.Unrealize" />.</summary>
<remarks>
<para>
A realized <paramref name="widget"/> has an associated <see cref="T:Gdk.Window"/>.
<para>
A realized <paramref name="widget" /> has an associated <see cref="T:Gdk.Window" />.
</para>
</remarks>
</Docs>
@ -82,10 +82,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Set by <see cref="M:Gtk.Widget.Map"/>, unset by <see cref="M:Gtk.Widget.Map"/>.</summary>
<summary>Set by <see cref="M:Gtk.Widget.Map" />, unset by <see cref="M:Gtk.Widget.Map" />.</summary>
<remarks>
<para>
Only realized widgets can be mapped. It means that <see cref="M:Gdk.Window.Show"/> has been called on the widgets window(s).
<para>
Only realized widgets can be mapped. It means that <see cref="M:Gdk.Window.Show" /> has been called on the widgets window(s).
</para>
</remarks>
</Docs>
@ -98,10 +98,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary> Set by <see cref="M:Gtk.Widget.Show"/>, unset by <see cref="M:Gtk.Widget.Hide"/>. Implies that a <paramref name="widget"/> will be mapped as soon as its parent is mapped.</summary>
<summary> Set by <see cref="M:Gtk.Widget.Show" />, unset by <see cref="M:Gtk.Widget.Hide" />. Implies that a <paramref name="widget" /> will be mapped as soon as its parent is mapped.</summary>
<remarks>
<para>
Implies that a <paramref name="widget"/> will be mapped as soon as its parent is mapped.
<para>
Implies that a <paramref name="widget" /> will be mapped as soon as its parent is mapped.
</para>
</remarks>
</Docs>
@ -114,9 +114,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Set and unset by <see cref="P:Gtk.Widget.Sensitive"/>. The sensitivity of a <paramref name="widget"/> determines whether it will receive certain events (e.g. button or key presses).</summary>
<summary>Set and unset by <see cref="P:Gtk.Widget.Sensitive" />. The sensitivity of a <paramref name="widget" /> determines whether it will receive certain events (e.g. button or key presses).</summary>
<remarks>
<para>
<para>
One premise for the widgets sensitivity is to have this flag set.
</para>
</remarks>
@ -130,10 +130,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Set and unset by <see cref="P:Gtk.Widget.Sensitive"/> operations on the parents of the <paramref name="widget"/>.</summary>
<summary>Set and unset by <see cref="P:Gtk.Widget.Sensitive" /> operations on the parents of the <paramref name="widget" />.</summary>
<remarks>
<para>
This is the second premise for the widgets sensitivity. Once it has <see cref="F:Gtk.WidgetFlags.Sensitive"/> and <see cref="F:Gtk.Widget.ParentSensitive"/> set, its state is effectively sensitive.
<para>
This is the second premise for the widgets sensitivity. Once it has <see cref="F:Gtk.WidgetFlags.Sensitive" /> and <see cref="F:Gtk.Widget.ParentSensitive" /> set, its state is effectively sensitive.
</para>
</remarks>
</Docs>
@ -146,10 +146,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Determines whether a <paramref name="widget"/> is able to handle focus grabs.</summary>
<summary>Determines whether a <paramref name="widget" /> is able to handle focus grabs.</summary>
<remarks>
<para>
Determines whether a <paramref name="widget"/> is able to handle focus grabs.
<para>
Determines whether a <paramref name="widget" /> is able to handle focus grabs.
</para>
</remarks>
</Docs>
@ -162,9 +162,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary> Set by <see cref="M:Gtk.Widget.GrabFocus"/> for widgets that also have <see cref="F:Gtk.WidgetFlags.CanFocus"/> set.</summary>
<summary> Set by <see cref="M:Gtk.Widget.GrabFocus" /> for widgets that also have <see cref="F:Gtk.WidgetFlags.CanFocus" /> set.</summary>
<remarks>
<para>
<para>
The flag will be unset once another widget grabs the focus.
</para>
</remarks>
@ -178,10 +178,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>The <paramref name="widget"/> is allowed to receive the default action via <see cref="M:Gtk.Widget.GrabDefault"/>.</summary>
<summary>The <paramref name="widget" /> is allowed to receive the default action via <see cref="M:Gtk.Widget.GrabDefault" />.</summary>
<remarks>
<para>
The <paramref name="widget"/> is allowed to receive the default action via <see cref="M:Gtk.Widget.GrabDefault"/>.
<para>
The <paramref name="widget" /> is allowed to receive the default action via <see cref="M:Gtk.Widget.GrabDefault" />.
</para>
</remarks>
</Docs>
@ -194,10 +194,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary> The <paramref name="widget"/> currently is receiving the default action.</summary>
<summary> The <paramref name="widget" /> currently is receiving the default action.</summary>
<remarks>
<para>
The <paramref name="widget"/> currently is receiving the default action.
<para>
The <paramref name="widget" /> currently is receiving the default action.
</para>
</remarks>
</Docs>
@ -210,9 +210,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary> Set by <see cref="M:Gtk.Widget.GrabDefault"/>gtk_grab_add(), unset by gtk_grab_remove().</summary>
<summary> Set by <see cref="M:Gtk.Widget.GrabDefault" />gtk_grab_add(), unset by gtk_grab_remove().</summary>
<remarks>
<para>
<para>
It means that the widget is in the grab_widgets stack, and will be the preferred one for receiving events other than ones of cosmetic value.
</para>
</remarks>
@ -228,8 +228,8 @@
<Docs>
<summary>Indicates that the widgets style has been looked up through the rc mechanism.</summary>
<remarks>
<para>
It does not imply that the <paramref name="widget"/> actually had a style defined through the rc mechanism.
<para>
It does not imply that the <paramref name="widget" /> actually had a style defined through the rc mechanism.
</para>
</remarks>
</Docs>
@ -242,10 +242,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicates that the <paramref name="widget"/> is a composite child of its parent.</summary>
<summary>Indicates that the <paramref name="widget" /> is a composite child of its parent.</summary>
<remarks>
<para>
See <see cref="M:Gtk.Widget.PushCompositeChild"/>, <see cref="M:Gtk.Widget.PopCompositeChild"/>.
<para>
See <see cref="M:Gtk.Widget.PushCompositeChild" />, <see cref="M:Gtk.Widget.PopCompositeChild" />.
</para>
</remarks>
</Docs>
@ -270,9 +270,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Set and unset by <see cref="P:Gtk.Widget.AppPaintable"/>.</summary>
<summary>Set and unset by <see cref="P:Gtk.Widget.AppPaintable" />.</summary>
<remarks>
<para>
<para>
Must be set on widgets whose window the application directly draws on, in order to keep GTK+ from overwriting the drawn stuff.
</para>
</remarks>
@ -286,10 +286,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>The <paramref name="widget"/> when focused will receive the default action and have <see cref="F:Gtk.WidgetFlags.HasDefault"/> set even if there is a different widget set as default.</summary>
<summary>The <paramref name="widget" /> when focused will receive the default action and have <see cref="F:Gtk.WidgetFlags.HasDefault" /> set even if there is a different widget set as default.</summary>
<remarks>
<para>
The <paramref name="widget"/> when focused will receive the default action and have <see cref="F:Gtk.WidgetFlags.HasDefault"/> set even if there is a different widget set as default.
<para>
The <paramref name="widget" /> when focused will receive the default action and have <see cref="F:Gtk.WidgetFlags.HasDefault" /> set even if there is a different widget set as default.
</para>
</remarks>
</Docs>
@ -302,10 +302,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Set and unset by <see cref="P:Gtk.Widget.DoubleBuffered"/>. Indicates that exposes done on the <paramref name="widget"/> should be double-buffered. </summary>
<summary>Set and unset by <see cref="P:Gtk.Widget.DoubleBuffered" />. Indicates that exposes done on the <paramref name="widget" /> should be double-buffered. </summary>
<remarks>
<para>
Indicates that exposes done on the <paramref name="widget"/> should be double-buffered.
<para>
Indicates that exposes done on the <paramref name="widget" /> should be double-buffered.
</para>
</remarks>
</Docs>
@ -323,4 +323,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>