* en/Gtk/Misc.xml: Raphael J. Schmid, <raphael@arrivingarrow.net>.

* en/Gtk/CornerType.xml: Kevin Breit, <mrproper@ximian.com>.

* en/Gtk/AccelLabel.xml: Hector E. Gomez Morales <hgomez_36@flashmail.com>.

* en/Gtk/AccelFlags.xml: Hector E. Gomez Morales <hgomez_36@flashmail.com>.

svn path=/trunk/gtk-sharp/; revision=11816
This commit is contained in:
Duncan Mak 2003-02-21 22:52:43 +00:00
parent 388ec2d564
commit 641a3191a1
5 changed files with 131 additions and 76 deletions

View File

@ -1,3 +1,13 @@
2003-02-21 Duncan Mak <duncan@ximian.com>
* en/Gtk/Misc.xml: Raphael J. Schmid, <raphael@arrivingarrow.net>.
* en/Gtk/CornerType.xml: Kevin Breit, <mrproper@ximian.com>.
* en/Gtk/AccelLabel.xml: Hector E. Gomez Morales <hgomez_36@flashmail.com>.
* en/Gtk/AccelFlags.xml: Hector E. Gomez Morales <hgomez_36@flashmail.com>.
2003-02-19 Jeffrey Stedfast <fejj@ximian.com>
* en/Gdk/GC.xml: Documented.

View File

@ -1,5 +1,5 @@
<Type Name="AccelFlags" FullName="Gtk.AccelFlags">
<TypeSignature Language="C#" Value="public sealed struct AccelFlags;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct AccelFlags;" Maintainer="Hector Gomez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,12 @@
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>An enumeration used by AccelLabel</summary>
<remarks>
<para>
This enumeration is used by <see cref="T:Gtk.AccelLabel"/> to see decide to display or not display an accelerator key and to know if an accelerator key is removable.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -34,8 +38,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Determines if <see cref="T:Gtk.AccelLabel"/> will display the accelerator key or not.</summary>
<remarks>
<para>Determines if <see cref="T:Gtk.AccelLabel"/> will display the accelerator key or not.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Locked">
@ -46,8 +52,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Determines if the accelerator key is removable by <see cref="T:Gtk.AccelLabel"/></summary>
<remarks>
<para>Determines if the accelerator key is removable by <see cref="T:Gtk.AccelLabel"/></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Mask">
@ -75,4 +83,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -1,5 +1,5 @@
<Type Name="AccelLabel" FullName="Gtk.AccelLabel">
<TypeSignature Language="C#" Value="public class AccelLabel : Gtk.Label, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class AccelLabel : Gtk.Label, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,15 @@
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A widget that displays an accelerator key</summary>
<remarks>
<para>
The <see cref="T:Gtk.AccelLabel"/> widget is a subclass of <see cref="T:Gtk.Label"/> that also displays an accelerator key on the right of the label text. The <see cref="T:Gtk.AccelLabel"/> widget is commonly used in menus to show the keyboard shortcuts for commands.
</para>
<para>
The accelerator key to display is not set explicitly instead, the <see cref="T:Gtk.AccelLabel"/> displays the accelerators which have been added to a particular widget. This widget is set by calling <see cref="P:Gtk.AccelLabel.AccelWidget"/>.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Label</BaseTypeName>
@ -35,11 +42,16 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Recreates the string representing the accelerator keys.</summary>
<returns><see cref="langword:false"/> Default, since the strings are updated this is not needed</returns>
<remarks>
<para>
Recreates the string representing the accelerator keys. This should not be needed since the string is automatically updated whenever accelerators are added or removed from the associated widget.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -50,8 +62,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>To be added.</summary>
<remarks>
<para>
To be added.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -125,10 +141,17 @@
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
<summary>Returns the width needed to display the accelerator key(s).</summary>
<returns>The width needed to display the accelerator key(s)</returns>
<remarks>
<para>
Returns the width needed to display the accelerator key(s). This is used by menus to align all of the <see cref="T:Gtk.MenuItem"/> widgets, and shouldn't be needed by applications.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AccelClosure">
@ -141,10 +164,14 @@
<Parameter Name="value" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the closure to be monitored by this accelerator label.</summary>
<param name="value">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'IntPtr'</returns>
<remarks>To be added</remarks>
<remarks>
<para>
Sets the closure to be monitored by this accelerator label. The closure must be connected to an accelerator group. See <see cref="P:Gtk.AccelLabel.AccelWidget"/>.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AccelWidget">
@ -157,11 +184,15 @@
<Parameter Name="value" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.Widget'</param>
<returns>To be added: an object of type 'Gtk.Widget'</returns>
<remarks>To be added</remarks>
<summary>Fetches the widget monitored by this acceleretaor label.</summary>
<param name="value">The widget to be monitored</param>
<returns>The object monitored by the accelerator label, or <see cref="langword:null"/></returns>
<remarks>
<para>
Fetches the widget monitored by this acceleretaor label.
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -1,14 +1,14 @@
<Type Name="CornerType" FullName="Gtk.CornerType">
<TypeSignature Language="C#" Value="public sealed struct CornerType;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct CornerType;" Maintainer="Kevin Breit" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<ThreadSafetyStatement>CornerType is a thread safe object.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Specifies which corner a child widget should be placed in when packed into a <see cref="T:Gtk.ScrolledWindow"/>. This is effectively the opposite of where the scroll bars are placed.</summary>
<remarks>This is effectively the opposite of where the scroll bars are placed.</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>Place the scrollbars on the right and bottom of the widget (default behaviour).</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BottomLeft">
@ -46,8 +46,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Place the scrollbars on the top and right of the widget.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="TopRight">
@ -58,8 +58,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Place the scrollbars on the left and bottom of the widget.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BottomRight">
@ -70,8 +70,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Place the scrollbars on the top and left of the widget.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="value__">

View File

@ -1,5 +1,5 @@
<Type Name="Misc" FullName="Gtk.Misc">
<TypeSignature Language="C#" Value="public class Misc : Gtk.Widget, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class Misc : Gtk.Widget, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="RJS" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,18 @@
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A base class for widgets with alignments and padding.</summary>
<remarks>
<para>
The GtkMisc widget is an abstract widget which is not useful itself, but is used to derive subclasses which have alignment and padding attributes.
</para>
<para>
The horizontal and vertical padding attributes allows extra space to be added around the widget.
</para>
<para>
The horizontal and vertical alignment attributes enable the widget to be positioned within its allocated area. Note that if the widget is added to a container in such a way that it expands automatically to fill its allocated area, the alignment settings will not alter the widgets position.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Widget</BaseTypeName>
@ -40,10 +50,9 @@
<Parameter Name="yalign" 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>
<remarks>To be added</remarks>
<summary>Sets the alignment of the widget.</summary>
<param name="xalign">The horizontal alignment, from 0 (left) to 1 (right).</param>
<param name="yalign">The vertical alignment, from 0 (top) to 1 (bottom).</param>
</Docs>
</Member>
<Member MemberName="SetPadding">
@ -57,10 +66,9 @@
<Parameter Name="ypad" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="xpad">To be added: an object of type 'int'</param>
<param name="ypad">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Sets the amount of space to add around the widget.</summary>
<param name="xpad">The amount of space to add on the left and right of the widget, in pixels.</param>
<param name="ypad">The amount of space to add on the top and bottom of the widget, in pixels.</param>
</Docs>
</Member>
<Member MemberName="GetAlignment">
@ -74,10 +82,9 @@
<Parameter Name="yalign" 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>
<remarks>To be added</remarks>
<summary>Gets the X and Y alignment of the widget within its allocation. See <see cref="M:Gtk.Misc.SetAlignment"/>.</summary>
<param name="xalign">Location to store X alignment of misc, or <see cref="langword:null"/>.</param>
<param name="yalign">Location to store Y alignment of misc, or <See cref="langword:null"/>.</param>
</Docs>
</Member>
<Member MemberName="GetPadding">
@ -91,10 +98,9 @@
<Parameter Name="ypad" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="xpad">To be added: an object of type 'int'</param>
<param name="ypad">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>iGets the padding in the X and Y directions of the widget. See <see cref="M:Gtk.Misc.SetPadding"/>).</summary>
<param name="xpad">Location to store padding in the X direction, or <see cref="langword:null"/>.</param>
<param name="ypad">Location to store padding in the Y direction, or <see cref="langword:null"/>.</param>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -139,7 +145,7 @@
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Misc ();" />
<MemberType>Constructor</MemberType>
<MemberType>Internal constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
@ -170,10 +176,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>The vertical alignment</summary>
<param name="value">The vertical alignment, from 0 (top) to 1 (bottom).</param>
<returns>The vertical alignment</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Xalign">
@ -186,10 +192,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>The horizontal alignment</summary>
<param name="value">The horizontal alignment, from 0 (left) to 1 (right).</param>
<returns>The horizontal alignment</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Ypad">
@ -202,10 +208,10 @@
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>The amount of space to add on the left and right of the widget, in pixels.</summary>
<param name="value">The amount of space to add on the left and right of the widget, in pixels.</param>
<returns>The amount of space to add on the left and right of the widget, in pixels.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Xpad">
@ -218,11 +224,11 @@
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>The amount of space to add on the top and bottom of the widget, in pixels.</summary>
<param name="value">The amount of space to add on the top and bottom of the widget, in pixels.</param>
<returns>The amount of space to add on the top and bottom of the widget, in pixels.</returns>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>