mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-23 16:15:35 +00:00
First draft of Alignment and Bin docs.
svn path=/trunk/gtk-sharp/; revision=12522
This commit is contained in:
Lee Mallabone
parent
b2cdb3a585
commit
9083728e6d
|
|
@ -1,3 +1,8 @@
|
|||
2003-03-15 Lee Mallabone <mono-docs@fonicmonkey.net>
|
||||
|
||||
* en/Gtk/Bin.xml:
|
||||
* en/Gtk/Alignment.xml: First drafts.
|
||||
|
||||
2003-03-12 Lee Mallabone <mono-docs@fonicmonkey.net>
|
||||
|
||||
* en/Gtk/PositionType.xml:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<Type Name="Alignment" FullName="Gtk.Alignment">
|
||||
<TypeSignature Language="C#" Value="public class Alignment : Gtk.Bin, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class Alignment : Gtk.Bin, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
|
|
@ -7,8 +7,11 @@
|
|||
</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>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>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.Bin</BaseTypeName>
|
||||
|
|
@ -42,12 +45,12 @@
|
|||
<Parameter Name="yscale" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="xalign">To be added: an object of type 'float'</param>
|
||||
<param name="yalign">To be added: an object of type 'float'</param>
|
||||
<param name="xscale">To be added: an object of type 'float'</param>
|
||||
<param name="yscale">To be added: an object of type 'float'</param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Adjusts all the alignment and scale properties.</summary>
|
||||
<param name="xalign">The horizontal alignment of the child widget, from 0 (left) to 1 (right).</param>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Finalize">
|
||||
|
|
@ -89,13 +92,13 @@
|
|||
<Parameter Name="yscale" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="xalign">To be added: an object of type 'float'</param>
|
||||
<param name="yalign">To be added: an object of type 'float'</param>
|
||||
<param name="xscale">To be added: an object of type 'float'</param>
|
||||
<param name="yscale">To be added: an object of type 'float'</param>
|
||||
<returns>To be added: an object of type 'Gtk.Alignment'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Creates a new Alignment with the specified alignment and spacing.</summary>
|
||||
<param name="xalign">The horizontal alignment of the child widget, from 0 (left) to 1 (right).</param>
|
||||
<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>
|
||||
<returns>A new Alignment.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
|
|
@ -104,9 +107,9 @@
|
|||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Alignment'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Internal constructor</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
|
|
@ -131,10 +134,10 @@
|
|||
<Parameter Name="value" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'float'</param>
|
||||
<returns>To be added: an object of type 'float'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Xalign">
|
||||
|
|
@ -147,10 +150,10 @@
|
|||
<Parameter Name="value" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'float'</param>
|
||||
<returns>To be added: an object of type 'float'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Xscale">
|
||||
|
|
@ -163,10 +166,10 @@
|
|||
<Parameter Name="value" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'float'</param>
|
||||
<returns>To be added: an object of type 'float'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Yscale">
|
||||
|
|
@ -179,10 +182,10 @@
|
|||
<Parameter Name="value" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'float'</param>
|
||||
<returns>To be added: an object of type 'float'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<Type Name="Bin" FullName="Gtk.Bin">
|
||||
<TypeSignature Language="C#" Value="public class Bin : Gtk.Container, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class Bin : Gtk.Container, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
|
|
@ -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>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<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>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.Container</BaseTypeName>
|
||||
|
|
@ -63,9 +65,9 @@
|
|||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Bin'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Internal constructor</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
|
|
|
|||
Loading…
Reference in a new issue