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

2004-09-20 Shane Landrum <epicene@pobox.com>

Browse source 
* en/Gdk/FilterFunc.xml
	* en/Gdk/Point.xml
	* en/Gdk/Region.xml
	* en/Gdk/Rgb.xml
	* en/Gdk/RgbCmap.xml : Added docs for Gdk classes.

svn path=/trunk/gtk-sharp/; revision=34079
This commit is contained in:
Shane Landrum 2004-09-20 04:18:35 +00:00
parent 40379be9e4
commit 0dba717c3f
6 changed files with 102 additions and 78 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/ChangeLog
View file

@ -1,3 +1,11 @@
2004-09-20 Shane Landrum <epicene@pobox.com>
* en/Gdk/FilterFunc.xml
* en/Gdk/Point.xml
* en/Gdk/Region.xml
* en/Gdk/Rgb.xml
* en/Gdk/RgbCmap.xml : Added docs for Gdk classes.
2004-09-20 Shane Landrum <epicene@pobox.com> 2004-09-20 Shane Landrum <epicene@pobox.com>
* en/Gtk/FileSelection.xml * en/Gtk/FileSelection.xml

4
doc/en/Gdk/FilterFunc.xml
View file

@ -7,8 +7,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Delegate for callbacks invoked by <see cref="M:Gdk.Window.AddFilter"/>.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>

2
doc/en/Gdk/Point.xml
View file

@ -42,7 +42,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Internal constructor</summary> <summary>Internal constructor</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param> <param name="raw">a <see cref="M:IntPtr"/>, pointer to internal data</param>
<returns /> <returns />
<remarks>This is an internal constructor, and should not be used by user code.</remarks> <remarks>This is an internal constructor, and should not be used by user code.</remarks>
</Docs> </Docs>

92
doc/en/Gdk/Region.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Represents an area of the screen.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -30,9 +30,9 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="rectangle">To be added: an object of type 'Gdk.Rectangle'</param> <param name="rectangle">a <see cref="M:Gdk.Rectangle"/></param>
<returns>To be added: an object of type 'Gdk.Region'</returns> <returns>a <see cref="M:Gdk.Region"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Copy"> <Member MemberName="Copy">
@ -44,8 +44,8 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Region'</returns> <returns>a <see cref="M:Gdk.Region"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RectIn"> <Member MemberName="RectIn">
@ -59,9 +59,9 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="rect">To be added: an object of type 'Gdk.Rectangle'</param> <param name="rect">a <see cref="M:Gdk.Rectangle"/></param>
<returns>To be added: an object of type 'Gdk.OverlapType'</returns> <returns>a <see cref="M:Gdk.OverlapType"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SpansIntersectForeach"> <Member MemberName="SpansIntersectForeach">
@ -78,11 +78,11 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="spans">To be added: an object of type 'Gdk.Span'</param> <param name="spans">a <see cref="M:Gdk.Span"/></param>
<param name="n_spans">To be added: an object of type 'int'</param> <param name="n_spans">a <see cref="M:System.Int32"/></param>
<param name="sorted">To be added: an object of type 'bool'</param> <param name="sorted">a <see cref="M:System.Boolean"/></param>
<param name="function">To be added: an object of type 'Gdk.SpanFunc'</param> <param name="function">a <see cref="M:Gdk.SpanFunc"/></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Xor"> <Member MemberName="Xor">
@ -96,8 +96,8 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="source2">To be added: an object of type 'Gdk.Region'</param> <param name="source2">a <see cref="M:Gdk.Region"/></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Subtract"> <Member MemberName="Subtract">
@ -111,8 +111,8 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="source2">To be added: an object of type 'Gdk.Region'</param> <param name="source2">a <see cref="M:Gdk.Region"/></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="UnionWithRect"> <Member MemberName="UnionWithRect">
@ -126,8 +126,8 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="rect">To be added: an object of type 'Gdk.Rectangle'</param> <param name="rect">a <see cref="M:Gdk.Rectangle"/></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Destroy"> <Member MemberName="Destroy">
@ -139,7 +139,7 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Offset"> <Member MemberName="Offset">
@ -154,9 +154,9 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="dx">To be added: an object of type 'int'</param> <param name="dx">a <see cref="M:System.Int32"/></param>
<param name="dy">To be added: an object of type 'int'</param> <param name="dy">a <see cref="M:System.Int32"/></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Empty"> <Member MemberName="Empty">
@ -168,8 +168,8 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>a <see cref="M:System.Boolean"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Intersect"> <Member MemberName="Intersect">
@ -183,8 +183,8 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="source2">To be added: an object of type 'Gdk.Region'</param> <param name="source2">a <see cref="M:Gdk.Region"/></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PointIn"> <Member MemberName="PointIn">
@ -199,10 +199,10 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="x">To be added: an object of type 'int'</param> <param name="x">a <see cref="M:System.Int32"/></param>
<param name="y">To be added: an object of type 'int'</param> <param name="y">a <see cref="M:System.Int32"/></param>
<returns>To be added: an object of type 'bool'</returns> <returns>a <see cref="M:System.Boolean"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Union"> <Member MemberName="Union">
@ -216,8 +216,8 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="source2">To be added: an object of type 'Gdk.Region'</param> <param name="source2">a <see cref="M:Gdk.Region"/></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Equal"> <Member MemberName="Equal">
@ -231,9 +231,9 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="region2">To be added: an object of type 'Gdk.Region'</param> <param name="region2">a <see cref="M:Gdk.Region"/></param>
<returns>To be added: an object of type 'bool'</returns> <returns>a <see cref="M:System.Boolean"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Shrink"> <Member MemberName="Shrink">
@ -248,9 +248,9 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="dx">To be added: an object of type 'int'</param> <param name="dx">a <see cref="M:System.Int32"/></param>
<param name="dy">To be added: an object of type 'int'</param> <param name="dy">a <see cref="M:System.Int32"/></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -264,7 +264,7 @@
<summary>To be added</summary> <summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gdk.Region" /></returns> <returns>a <see cref="T:Gdk.Region" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -275,7 +275,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:Gdk.Region" /></returns> <returns>a <see cref="T:Gdk.Region" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetRectangles"> <Member MemberName="GetRectangles">
@ -288,7 +288,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:Gdk.Rectangle[]" /></returns> <returns>a <see cref="T:Gdk.Rectangle[]" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Clipbox"> <Member MemberName="Clipbox">
@ -301,7 +301,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:Gdk.Rectangle" /></returns> <returns>a <see cref="T:Gdk.Rectangle" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Polygon"> <Member MemberName="Polygon">
@ -319,7 +319,7 @@
<param name="points">a <see cref="T:Gdk.Point" /></param> <param name="points">a <see cref="T:Gdk.Point" /></param>
<param name="fill_rule">a <see cref="T:System.Int32" /></param> <param name="fill_rule">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.Region" /></returns> <returns>a <see cref="T:Gdk.Region" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

42
doc/en/Gdk/Rgb.xml
View file

@ -11,7 +11,7 @@
<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> <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> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Object</BaseTypeName> <BaseTypeName>System.Object</BaseTypeName>
@ -30,10 +30,26 @@
<Parameter Name="color" Type="Gdk.Color" /> <Parameter Name="color" Type="Gdk.Color" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<p><paramref name="colormap"/> should be the colormap for the graphics context and
drawable you're using to draw. If you're drawing to a <see cref="T:Gtk.Widget"/>,
call <see cref="M:Gtk.Widget.GetColormap"/>.
</p><p>
<paramref name="color"/> should have its red, green, and blue fields initialized;
this method will fill in <paramref name="color"/>'s pixel field with the best
matching pixel from a color cube. The color is then ready to be
used for drawing, e.g. you can call <see cref="M:Gdk.GC.SetForeground"/> which
expects "pixel" to be initialized.
</p><p>
In many cases, you can avoid this whole issue by setting
<see cref="P:Gdk.GC.RgbFgColor"/> or <see cref="P:Gdk.GC.RgbBgColor"/>, which
do not expect "pixel" to be initialized in advance. If you use those
mutators, there's no need for calling this method.
</p>
</summary>
<param name="colormap">a <see cref="T:Gdk.Colormap" /></param> <param name="colormap">a <see cref="T:Gdk.Colormap" /></param>
<param name="color">a <see cref="T:Gdk.Color" /></param> <param name="color">a <see cref="T:Gdk.Color" /></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Ditherable"> <Member MemberName="Ditherable">
@ -46,7 +62,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -55,9 +71,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Basic constructor.</summary>
<returns>a <see cref="T:Gdk.Rgb" /></returns> <returns>a <see cref="T:Gdk.Rgb" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="MinColors"> <Member MemberName="MinColors">
@ -69,10 +85,10 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The minimum number of colors for this colormap.</summary>
<param name="value">a <see cref="T:System.Int32" /></param> <param name="value">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Visual"> <Member MemberName="Visual">
@ -84,7 +100,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:Gdk.Visual" /></returns> <returns>a <see cref="T:Gdk.Visual" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Install"> <Member MemberName="Install">
@ -99,7 +115,7 @@
<summary>To be added</summary> <summary>To be added</summary>
<param name="value">a <see cref="T:System.Boolean" /></param> <param name="value">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Colormap"> <Member MemberName="Colormap">
@ -111,7 +127,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:Gdk.Colormap" /></returns> <returns>a <see cref="T:Gdk.Colormap" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Verbose"> <Member MemberName="Verbose">
@ -123,10 +139,10 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether or not to be verbose to the console about actions. Useful for debugging.</summary>
<param name="value">a <see cref="T:System.Boolean" /></param> <param name="value">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

24
doc/en/Gdk/RgbCmap.xml
View file

@ -11,7 +11,7 @@
<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> <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> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns an empty <see cref="T:Gdk.RgbCmap"/></summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor.</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param> <param name="raw">a <see cref="M:IntPtr"/></param>
<returns>To be added: an object of type 'Gdk.RgbCmap'</returns> <returns>a <see cref="M:Gdk.RgbCmap"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Free"> <Member MemberName="Free">
@ -55,8 +55,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use. For internal use only.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">
@ -74,7 +74,7 @@
<param name="colors">a <see cref="T:System.UInt32&amp;" /></param> <param name="colors">a <see cref="T:System.UInt32&amp;" /></param>
<param name="n_colors">a <see cref="T:System.Int32" /></param> <param name="n_colors">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.RgbCmap" /></returns> <returns>a <see cref="T:Gdk.RgbCmap" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Colors"> <Member MemberName="Colors">
@ -87,7 +87,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="NColors"> <Member MemberName="NColors">
@ -100,7 +100,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>