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

2004-08-27 Shane Landrum <epicene@pobox.com>

Browse Source 
* en/Gtk/WindowKeysForeachFunc.xml
	* en/Gtk/Accessibility.xml
	* en/Gtk/CallbackMarshal.xml
	* en/Gtk/ColorSelectionChangePaletteFunc.xml
	* en/Gtk/ColorSelectionDialog.xml
	* en/Gtk/Container.xml
	* en/Gtk/DestroyNotify.xml
	* en/Gtk/IconSet.xml
	* en/Gtk/ScrollAdjustmentsSetArgs.xml
	* en/Gtk/ScrollType.xml
	* en/Gtk/MoveFocusArgs.xml : Miscellaneous docs.
	* en/Gtk/RB*.xml : Internal classes. Do not use.
	* en/Gtk/Style*.xml : Began documenting style-related classes.

svn path=/trunk/gtk-sharp/; revision=32959
This commit is contained in:
Shane Landrum 2004-08-28 01:45:27 +00:00
parent 4f843c4a62
commit fa3e9a5e70
19 changed files with 130 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/ChangeLog
View File

@ -1,3 +1,19 @@
2004-08-27 Shane Landrum <epicene@pobox.com>
* en/Gtk/WindowKeysForeachFunc.xml
* en/Gtk/Accessibility.xml
* en/Gtk/CallbackMarshal.xml
* en/Gtk/ColorSelectionChangePaletteFunc.xml
* en/Gtk/ColorSelectionDialog.xml
* en/Gtk/Container.xml
* en/Gtk/DestroyNotify.xml
* en/Gtk/IconSet.xml
* en/Gtk/ScrollAdjustmentsSetArgs.xml
* en/Gtk/ScrollType.xml
* en/Gtk/MoveFocusArgs.xml : Miscellaneous docs.
* en/Gtk/RB*.xml : Internal classes. Do not use.
* en/Gtk/Style*.xml : Began documenting style-related classes.
2004-08-27 Shane Landrum <epicene@pobox.com>
* en/Gtk/TagAddedArgs.xml

6
doc/en/Gtk/Accessible.xml
View File

@ -99,10 +99,10 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.Accessible" /></returns>
<remarks>To be added</remarks>
<remarks>Chain to this constructor if you have not registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

6
doc/en/Gtk/CallbackMarshal.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>Delegate for specifying a function signature for marshalling callbacks.</summary>
<remarks>FIXME: provide an example here</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -32,4 +32,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

6
doc/en/Gtk/ColorSelectionChangePaletteFunc.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>Delegate to specify function signature for methods that change the color palette in a <see cref="T:Gtk.ColorSelectionDialog" />.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -30,4 +30,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

4
doc/en/Gtk/ColorSelectionDialog.xml
View File

@ -85,7 +85,7 @@
<Docs>
<summary>A button for providing help with this dialog</summary>
<returns>A standard <see cref="T:Gtk.Button" />.</returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="CancelButton">
@ -154,4 +154,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

6
doc/en/Gtk/Container.xml
View File

@ -561,9 +561,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Protected constructor for chaining by descendant classes.</summary>
<returns>a <see cref="T:Gtk.Container" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ForAll">
@ -597,4 +597,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

7
doc/en/Gtk/DestroyNotify.xml
View File

@ -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 delegate specifying a function signature.</summary>
<remarks>See <see cref="M:Gtk.ListStore.SetSortFunc" /> for where this
gets used.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -28,4 +29,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

4
doc/en/Gtk/IconSet.xml
View File

@ -16,7 +16,7 @@
<remarks>
A <see cref="T:Gtk.IconSet" /> represents a single icon in
various sizes and widget states. It can provide a <see cref="T:Gdk.Pixbuf" /> for a given size and state on request,
and automatically caches some of the rendered GdkPixbuf objects.
and automatically caches some of the rendered <see cref="T:Gdk.Pixbuf"/> objects.
</remarks>
</Docs>
<Base>
@ -236,4 +236,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

2
doc/en/Gtk/Menu.xml
View File

@ -336,7 +336,7 @@ class PopupSample
<Docs>
<summary>Sets an accelerator path for this menu from which accelerator paths for its immediate children, its menu items, can be constructed.</summary>
<param name="value">A valid accelerator path.</param>
<returns>To be added: an object of type 'string'</returns>
<returns>void</returns>
<remarks>
<para>
The main purpose of this function is to spare the programmer the inconvenience of having to call <see cref="P:Gtk.MenuItem.AccelPath" /> on each menu item that should support runtime user changable accelerators. Instead, by just calling <see cref="P:Gtk.MenuItem.AccelPath" /> on their parent, each menu item of this menu, that contains a label describing its purpose, automatically gets an accel path assigned.

6
doc/en/Gtk/MoveFocusArgs.xml
View File

@ -53,10 +53,10 @@
<ReturnType>Gtk.DirectionType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.DirectionType'</returns>
<summary>The direction to move the focus.</summary>
<returns>a <see cref="Gtk.DirectionType" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

4
doc/en/Gtk/RBNode.xml
View File

@ -10,7 +10,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>To be added</summary>
<summary>A node of a red-black data tree. Do not use.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -135,4 +135,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

6
doc/en/Gtk/RBTree.xml
View File

@ -10,8 +10,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 red-black data tree. Do not use.</summary>
<remarks>For internal use only?</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -96,4 +96,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

4
doc/en/Gtk/RBTreeTraverseFunc.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>To be added</summary>
<summary>A delegate class for traversing a red-black tree.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -30,4 +30,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

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

@ -63,9 +63,9 @@
<ReturnType>Gtk.Adjustment</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Adjustment'</returns>
<remarks>To be added</remarks>
<summary>The vertical adjustment for the scrolling event.</summary>
<returns>a <see cref="T:Gtk.Adjustment"/></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Hadjustment">
@ -75,10 +75,10 @@
<ReturnType>Gtk.Adjustment</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Adjustment'</returns>
<remarks>To be added</remarks>
<summary>The horizontal adjustment for the scrolling event.</summary>
<returns>a <see cref="T:Gtk.Adjustment"/></returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

10
doc/en/Gtk/ScrollType.xml
View File

@ -137,7 +137,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Move the scroller a step up.</summary>
<remarks>
</remarks>
</Docs>
@ -150,7 +150,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Move the scroller a step down.</summary>
<remarks>
</remarks>
</Docs>
@ -163,7 +163,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Move the slider a page up.</summary>
<remarks>
</remarks>
</Docs>
@ -176,7 +176,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Move the slider a page down.</summary>
<remarks>
</remarks>
</Docs>
@ -291,4 +291,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

6
doc/en/Gtk/Selection.xml
View File

@ -10,8 +10,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>Object to represent a selection.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -187,4 +187,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

123
doc/en/Gtk/Style.xml
View File

@ -1,6 +1,6 @@
<Type Name="Style" FullName="Gtk.Style">
<TypeSignature Language="C#" Value="public class Style : GLib.Object, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo>
<AssemblyInfo>:
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
@ -38,9 +38,9 @@
</Parameters>
<Docs>
<summary>Gets the foreground color for a particular state</summary>
<param name="state">To be added: an object of type 'Gtk.StateType'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<param name="state">A <see cref="T:Gtk.StateType"/>, the state being considered</param>
<returns>A <see cref="T:Gdk.Color"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="Background">
@ -54,7 +54,7 @@
</Parameters>
<Docs>
<summary>Sets the background of <paramref name="window" /> to the background color or pixmap specified by style for the state.</summary>
<param name="state">A state.</param>
<param name="state">A <see cref="T:Gtk.StateType"/>, the state being considered</param>
<returns>A color to be used for the background.</returns>
<remarks>
</remarks>
@ -70,10 +70,10 @@
<Parameter Name="state" Type="Gtk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="state">To be added: an object of type 'Gtk.StateType'</param>
<returns>To be added: an object of type 'Gdk.GC'</returns>
<remarks>To be added</remarks>
<summary>Gets the graphics context for the background of <paramref name="state"/>.</summary>
<param name="state">a <see cref="T:Gtk.StateType"/></param>
<returns>a <see cref="T:Gdk.GC"/>, the graphics context</returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="ForegroundGC">
@ -86,10 +86,10 @@
<Parameter Name="state" Type="Gtk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="state">To be added: an object of type 'Gtk.StateType'</param>
<returns>To be added: an object of type 'Gdk.GC'</returns>
<remarks>To be added</remarks>
<summary>Gets the graphics context for the foreground of <paramref name="state"/>.</summary>
<param name="state">a <see cref="T:Gtk.StateType"/></param>
<returns>a <see cref="T:Gdk.GC"/>, the graphics context</returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="ApplyDefaultBackground">
@ -109,16 +109,16 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<param name="set_bg">To be added: an object of type 'bool'</param>
<param name="state_type">To be added: an object of type 'Gtk.StateType'</param>
<param name="area">To be added: an object of type 'Gdk.Rectangle'</param>
<param name="x">To be added: an object of type 'int'</param>
<param name="y">To be added: an object of type 'int'</param>
<param name="width">To be added: an object of type 'int'</param>
<param name="height">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Sets the default background.</summary>
<param name="window">A <see cref="T:Gdk.Window"/></param>
<param name="set_bg">A <see cref="T:System.Boolean"/> (TODO: explain)</param>
<param name="state_type">A <see cref="T:Gtk.StateType"/></param>
<param name="area">A <see cref="T:Gdk.Rectangle"/></param>
<param name="x">A <see cref="T:System.Int32"/>, X coordinate of the upper left corner</param>
<param name="y">A <see cref="T:System.Int32"/>, Y coordinate of the upper left corner</param>
<param name="width">A <see cref="T:System.Int32"/>, width of the area</param>
<param name="height">A <see cref="T:System.Int32"/>, height of the area</param>
<remarks>TODO: explain this, as the underlying GTK+ isn't very well-commented either</remarks>
</Docs>
</Member>
<Member MemberName="SetBackground">
@ -132,10 +132,11 @@
<Parameter Name="state_type" Type="Gtk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<param name="state_type">To be added: an object of type 'Gtk.StateType'</param>
<remarks>To be added</remarks>
<summary>Set the background of <paramref name="window"/> to the
color or pixmap specified by this style for <paramref name="state"/>.</summary>
<param name="window">A <see cref="T:Gdk.Window"/></param>
<param name="state_type">A <see cref="T:Gtk.StateType"/></param>
<remarks/>
</Docs>
</Member>
<Member MemberName="Detach">
@ -146,8 +147,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Detaches this style from the window it's attached to.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="RenderIcon">
@ -165,15 +166,15 @@
<Parameter Name="detail" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="source">To be added: an object of type 'Gtk.IconSource'</param>
<param name="direction">To be added: an object of type 'Gtk.TextDirection'</param>
<param name="state">To be added: an object of type 'Gtk.StateType'</param>
<param name="size">To be added: an object of type 'Gtk.IconSize'</param>
<param name="widget">To be added: an object of type 'Gtk.Widget'</param>
<param name="detail">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
<summary>Renders the icon specified by <paramref name="source"/> at the given <paramref name="size"/> according to the given parameters and returns the result in a pixbuf.</summary>
<param name="source">A <see cref="T:Gtk.IconSource"/></param>
<param name="direction">A <see cref="T:Gtk.TextDirection"/></param>
<param name="state">A <see cref="T:Gtk.StateType"/></param>
<param name="size">A <see cref="T:Gtk.IconSize"/></param>
<param name="widget">A <see cref="T:Gtk.Widget"/></param>
<param name="detail">A <see cref="T:System.String"/></param>
<returns>A <see cref="T:Gdk.Pixbuf"/></returns>
<remarks>TODO: needs an example.</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
@ -199,10 +200,10 @@
<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.IconSet'</returns>
<remarks>To be added</remarks>
<summary>Gets the icon set for the given <paramref name="stock_id">.</summary>
<param name="stock_id">A <see cref="T:System.String"/></param>
<returns>A <see cref="T:Gtk.IconSet"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="Attach">
@ -282,10 +283,10 @@
<Parameters>
</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 Y thickness, which is used for vertical padding.</summary>
<param name="value">A <see cref="T:System.Int32"/></param>
<returns>A <see cref="T:System.Int32"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="XThickness">
@ -311,8 +312,8 @@
</ReturnValue>
<Docs>
<summary>The foreground colors</summary>
<returns>To be added: an object of type 'Gdk.Color []'</returns>
<remarks>To be added</remarks>
<returns>A <see cref="T:Gdk.Color []"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="Backgrounds">
@ -322,9 +323,9 @@
<ReturnType>Gdk.Color []</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Color []'</returns>
<remarks>To be added</remarks>
<summary>The background colors.</summary>
<returns>A <see cref="T:Gdk.Color []"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="Black">
@ -334,9 +335,9 @@
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>Black.</summary>
<returns>A <see cref="T:Gdk.Color"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="White">
@ -346,9 +347,9 @@
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>White.</summary>
<returns>A <see cref="T:Gdk.Color"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="BackgroundGCs">
@ -359,7 +360,7 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.GC []'</returns>
<returns>A <see cref="T:Gdk.GC []"/></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -371,7 +372,7 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.GC []'</returns>
<returns>A <see cref="T:Gdk.GC []"/></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -383,7 +384,7 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.GC'</returns>
<returns>A <see cref="T:Gdk.GC"/></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -395,7 +396,7 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.GC'</returns>
<returns>A <see cref="T:Gdk.GC"/></returns>
<remarks>To be added</remarks>
</Docs>
</Member>

8
doc/en/Gtk/StyleChangedArgs.xml
View File

@ -39,10 +39,10 @@
<ReturnType>Gtk.ToolbarStyle</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.ToolbarStyle'</returns>
<remarks>To be added</remarks>
<summary>The style that the toolbar was changed to use.</summary>
<returns>A <see cref="T:Gtk.ToolbarStyle"/></returns>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>

4
doc/en/Gtk/WindowKeysForeachFunc.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>To be added</summary>
<summary>Delegate for use by <see cref="" /></summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -32,4 +32,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>