The-Homebrew-Cloud/Ryujinx-GtkSharp
2
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-09-08 07:53:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge in documents from bug #38940 by Hector, and doc Frame.xml myself.

Browse Source 
svn path=/trunk/gtk-sharp/; revision=12068
This commit is contained in:
Lee Mallabone 2003-02-28 19:26:53 +00:00
parent 4465050e40
commit b68831eb6c
7 changed files with 104 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/ChangeLog
View File

@ -1,3 +1,13 @@
2003-02-28 Lee Mallabone <mono-docs@fonicmonkey.net>
* en/Gtk/Invisible.xml:
* en/Gtk/Separator.xml:
* en/Gtk/VSeparator.xml:
* en/Gtk/GammaCurve: Hector's latest.
* en/Gtk/Frame.xml: complete docs exluding dubious API calls.
* en/Gtk/MenuItem: document a couple of skeleton methods
2003-02-27 Martin Willemoes Hansen <mwh@sysrq.dk>
* en/Gtk/TreeModel.xml: Fixed GetValue method signature

77
doc/en/Gtk/Frame.xml
View File

@ -1,5 +1,5 @@
<Type Name="Frame" FullName="Gtk.Frame">
<TypeSignature Language="C#" Value="public class Frame : Gtk.Bin, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class Frame : Gtk.Bin, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,9 @@
</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 <see cref="T:Gtk.Bin"/> with a decorative frame and optional <see cref="T:Gtk.Label"/>.</summary>
<remarks><para>This widget draws a frame around whatever it contains, so is often used to visually group a set of widgets together.</para>
<para>If present, a label is drawn in a gap in the top side of the frame. The position of the label can be controlled with <see cref="M:Gtk.Frame.SetLabelAlign"/>.</para></remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Bin</BaseTypeName>
@ -57,10 +58,10 @@
<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 <see cref="P:Gtk.Frame.LabelWidget"/>.</summary>
<param name="xalign">The horizontal alignment, between 0 and 1.0.</param>
<param name="yalign">The vertical alignment, between 0 and 1.0.</param>
<remarks><para>Horizontal and vertical alignments can be adjusted individually using the <see cref="P:Gtk.Frame.LabelXAlign"/> and <see cref="P:Gtk.Frame.LabelYAlign"/> properties, respectively.</para></remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -115,10 +116,10 @@
<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.Frame'</returns>
<remarks>To be added</remarks>
<summary>Create a new frame with a label in the top left corner.</summary>
<param name="label">The text to appear as this frame's label</param>
<returns>A new Frame.</returns>
<remarks><para>This creates a new frame with a <see cref="T:Gtk.Label"/> widget in the top left corner, displaying the text passed in as <paramref name="label"/>.</para></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -127,9 +128,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Frame'</returns>
<remarks>To be added</remarks>
<summary>Create a new frame with no label</summary>
<returns>A new Frame with a null <see cref="P:Gtk.Frame.LabelWidget"/>.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -154,10 +155,10 @@
<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>Manage the widget that acts as a frame's <see cref="T:Gtk.Label"/>.</summary>
<param name="value">A widget to replace the existing label.</param>
<returns>The current <see cref="T:Gtk.Widget"/> in use as this Frame's label.</returns>
<remarks><para>Despite its name, this property does not have to set a <see cref="T:Gtk.Label"/> widget as its label. Because of the way that Gtk containers work, you may add an arbitrary widget as the label for this frame. However, a genuine <see cref="T:Gtk.Label"/> is recommended for consistency with other applications.</para></remarks>
</Docs>
</Member>
<Member MemberName="LabelYalign">
@ -170,10 +171,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>Set the vertical alignment of the <see cref="P:Gtk.Frame.LabelWidget"/>.</summary>
<param name="value">A new vertical alignment between 0 and 1.0</param>
<returns>The existing vertical alignment of this Frame's label</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="LabelXalign">
@ -186,10 +187,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>Set the horizontal alignment of the <see cref="P:Gtk.Frame.LabelWidget"/>.</summary>
<param name="value">A new horizontal alignment between 0 and 1.0</param>
<returns>The existing horizontal alignment of this Frame's label</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ShadowType">
@ -202,10 +203,10 @@
<Parameter Name="value" Type="Gtk.ShadowType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.ShadowType'</param>
<returns>To be added: an object of type 'Gtk.ShadowType'</returns>
<remarks>To be added</remarks>
<summary>Manage the appearance of this frame's border.</summary>
<param name="value">A new shadow type.</param>
<returns>The current shadow style that this Frame is rendered with.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Label">
@ -218,10 +219,10 @@
<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>
<summary>The string that is visible as the Frame's label</summary>
<param name="value">Sets the text of the label, if this Frame has one.</param>
<returns>The text of a label if <see cref="P:Gtk.Frame.LabelWidget"/> is a <see cref="T:Gtk.Label"/>, null otherwise.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Shadow">
@ -234,10 +235,10 @@
<Parameter Name="value" Type="Gtk.ShadowType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.ShadowType'</param>
<returns>To be added: an object of type 'Gtk.ShadowType'</returns>
<remarks>To be added</remarks>
<summary>Manage the appearance of this frame's border.</summary>
<param name="value">A new shadow type.</param>
<returns>The current shadow style that this Frame is rendered with.</returns>
<remarks></remarks>
</Docs>
</Member>
</Members>

21
doc/en/Gtk/GammaCurve.xml
View File

@ -1,5 +1,5 @@
<Type Name="GammaCurve" FullName="Gtk.GammaCurve">
<TypeSignature Language="C#" Value="public class GammaCurve : Gtk.VBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class GammaCurve : Gtk.VBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gmoez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,15 @@
</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>The <see cref="T:Gtk.GammaCurve"/> widget is a variant of <see cref="T:Gtk.Curve"/> specifically for editing gamma curves, which are used in graphics applications such as the Gimp.</summary>
<remarks>
<para>
The <see cref="T:Gtk.GammaCurve"/> widget shows a curve which the user can edit with the mouse just like a <see cref="T:Gtk.Curve"/> widget. On the right of the curve it also displays 5 buttons, 3 of which change between the 3 curve modes (spline, linear and free), and the other 2 set the curve to a particular gamma value, or reset it to a straight line.
</para>
<para>
NOTE: this widget is considered too specialized/little-used for GTK+, and will in the future be moved to some other package. If your application needs this widget, feel free to use it, as the widget does work and is useful in some applications; it's just not of general interest. However, we are not accepting new features for the widget, and it will eventually move out of the GTK+ distribution.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.VBox</BaseTypeName>
@ -79,9 +86,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.GammaCurve'</returns>
<remarks>To be added</remarks>
<summary>Constructor.</summary>
<returns>An instance of <see cref="T:Gtk.GammaCurve"/>.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -97,4 +104,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

18
doc/en/Gtk/Invisible.xml
View File

@ -1,5 +1,5 @@
<Type Name="Invisible" FullName="Gtk.Invisible">
<TypeSignature Language="C#" Value="public class Invisible : Gtk.Widget, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class Invisible : Gtk.Widget, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,12 @@
</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>The <see cref="T:Gtk.Invisible"/> widget is used for reliable pointer grabs and selection handling in the code for drag-and-drop.</summary>
<remarks>
<para>
Used internally in GTK+, and is probably not useful for application developers.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Widget</BaseTypeName>
@ -79,9 +83,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Invisible'</returns>
<remarks>To be added</remarks>
<summary>Constructor.</summary>
<returns>An instance of <see cref="T:Gtk.Invisible"/>.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -97,4 +101,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

24
doc/en/Gtk/MenuItem.xml
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>A widget used for items in menus</summary>
<remarks><para>The MenuItem and derived widgets are the only valid children for menus. Their function is to correctly handle highlighting, alignment, events and submenus.</para></remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Item</BaseTypeName>
@ -39,10 +39,10 @@
<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.MenuItem'</returns>
<remarks>To be added</remarks>
<summary>Creates a new MenuItem with a <see cref="T:Gtk.Label"/>.</summary>
<param name="label">The text to appear on this menu item.</param>
<returns>A new MenuItem</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RemoveSubmenu">
@ -53,8 +53,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Removes the MenuItem's submenu, if it has one.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Deselect">
@ -65,8 +65,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fires the <see cref="F:Gtk.Item.Deselect"/> event.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Select">
@ -77,8 +77,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fires the <see cref="F:Gtk.Item.Select"/> event.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ToggleSizeAllocate">

14
doc/en/Gtk/Separator.xml
View File

@ -1,5 +1,5 @@
<Type Name="Separator" FullName="Gtk.Separator">
<TypeSignature Language="C#" Value="public class Separator : Gtk.Widget, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class Separator : Gtk.Widget, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -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>The <see cref="T:Gtk.Separator"/> widget is an abstract class, used only for deriving the subclasses <see cref="T:Gtk.HSeparator"/> and <see cref="T:Gtk.VSeparator"/>.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Widget</BaseTypeName>
@ -79,9 +79,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Separator'</returns>
<remarks>To be added</remarks>
<summary>Constructor.</summary>
<returns>A instance of <see cref="T:Gtk.Separator"/>.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -97,4 +97,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

18
doc/en/Gtk/VSeparator.xml
View File

@ -1,5 +1,5 @@
<Type Name="VSeparator" FullName="Gtk.VSeparator">
<TypeSignature Language="C#" Value="public class VSeparator : Gtk.Separator, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class VSeparator : Gtk.Separator, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,12 @@
</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>The <see cref="T:Gtk.VSeparator"/> is a vertical separator, used to group the widgets within a window.</summary>
<remarks>
<para>
The <see cref="T:Gtk.VSeparator"/> is a vertical separator, used to group the widgets within a window. It displays a vertical line with a shadow to make it appear sunken into the interface.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Separator</BaseTypeName>
@ -79,9 +83,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.VSeparator'</returns>
<remarks>To be added</remarks>
<summary>Constructor.</summary>
<returns>A vertical separator.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -97,4 +101,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>