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

2004-07-02 Peter Johanson <latexer@gentoo.org>

Browse source 
* en/Art/*.xml : docs for some Art API.

svn path=/trunk/gtk-sharp/; revision=30661
This commit is contained in:
Mike Kestner 2004-07-02 12:47:27 +00:00
parent 5a1a334410
commit 98243f7ef9
4 changed files with 65 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/ChangeLog
View file

@ -1,3 +1,7 @@
2004-07-02 Peter Johanson <latexer@gentoo.org>
* en/Art/*.xml : docs for some Art API.
2004-06-29 Mike Kestner <mkestner@ximian.com> 2004-06-29 Mike Kestner <mkestner@ximian.com>
* en/Gdk/Key.xml : script fill summary tags. There isn't a lot of * en/Gdk/Key.xml : script fill summary tags. There isn't a lot of

100
doc/en/Art/Affine.xml
View file

@ -30,9 +30,9 @@
<Parameter Name="theta" Type="System.Double" /> <Parameter Name="theta" Type="System.Double" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets up a rotation matrix.</summary>
<param name="dst">a <see cref="T:System.Double[]" /></param> <param name="dst">Where to store the resulting affine transformation.</param>
<param name="theta">a <see cref="T:System.Double" /></param> <param name="theta">Rotation angle in degrees.</param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
@ -46,10 +46,10 @@
<Parameter Name="src" Type="System.Double[]" /> <Parameter Name="src" Type="System.Double[]" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Finds the expansion factor, i.e. the square root of the factor by which the affine transform affects area.</summary>
<param name="src">a <see cref="T:System.Double[]" /></param> <param name="src">The affine transformation.</param>
<returns>a <see cref="T:System.Double" /></returns> <returns>The expansion factor.</returns>
<remarks>To be added</remarks> <remarks>In an affine transform composed of scaling, rotation, shearing, and translation, returns the amount of scaling.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Identity"> <Member MemberName="Identity">
@ -62,8 +62,8 @@
<Parameter Name="dst" Type="System.Double[]" /> <Parameter Name="dst" Type="System.Double[]" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Set up the identity matrix.</summary>
<param name="dst">a <see cref="T:System.Double[]" /></param> <param name="dst">Where to store the resulting affine transform.</param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
@ -80,12 +80,12 @@
<Parameter Name="vert" Type="System.Int32" /> <Parameter Name="vert" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Flips the affine transform.</summary>
<param name="dst_affine">a <see cref="T:System.Double[]" /></param> <param name="dst_affine">Where to store the resulting affine transform.</param>
<param name="src_affine">a <see cref="T:System.Double[]" /></param> <param name="src_affine">The original affine transformation.</param>
<param name="horz">a <see cref="T:System.Int32" /></param> <param name="horz">Whether or not to flip horizontally.</param>
<param name="vert">a <see cref="T:System.Int32" /></param> <param name="vert">Whether or not to flip vertically.</param>
<remarks>To be added</remarks> <remarks>Both horz and vert false results in a simple copy operation. True for both results in an 180 degree rotation.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ToStringArray"> <Member MemberName="ToStringArray">
@ -99,10 +99,10 @@
<Parameter Name="src" Type="System.Double[]" /> <Parameter Name="src" Type="System.Double[]" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Converts an affine transform into a bit of PostScript code that implements the transform.</summary>
<param name="str">a <see cref="T:System.String[]" /></param> <param name="str">The resulting string.</param>
<param name="src">a <see cref="T:System.Double[]" /></param> <param name="src">The affine transform.</param>
<remarks>To be added</remarks> <remarks>Special cases of scaling, rotation, and translation are detected, and the corresponding PostScript operators used (this greatly aids understanding the output generated). The identity transform is mapped to the null string.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Invert"> <Member MemberName="Invert">
@ -116,10 +116,10 @@
<Parameter Name="src_affine" Type="System.Double[]" /> <Parameter Name="src_affine" Type="System.Double[]" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets up the inverse of the given transformation.</summary>
<param name="dst_affine">a <see cref="T:System.Double[]" /></param> <param name="dst_affine">Where the resulting affine is stored.</param>
<param name="src_affine">a <see cref="T:System.Double[]" /></param> <param name="src_affine">The original affine transformation.</param>
<remarks>To be added</remarks> <remarks>The inverse is in the classical sense; src_affine multiplied with dst_affine, or dst_affine multiplied with src_affine will be (to within roundoff error) the identify affine. See <see cref="M:Art.Affine.Identity(double[])" /></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Multiply"> <Member MemberName="Multiply">
@ -134,10 +134,10 @@
<Parameter Name="src2" Type="System.Double[]" /> <Parameter Name="src2" Type="System.Double[]" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Multiplies two affine transforms together, i.e. the resulting dst is equivalent to doing first src1 then src2.</summary>
<param name="dst">a <see cref="T:System.Double[]" /></param> <param name="dst">Where to store the resulting affine transform.</param>
<param name="src1">a <see cref="T:System.Double[]" /></param> <param name="src1">The first affine transform to multiply.</param>
<param name="src2">a <see cref="T:System.Double[]" /></param> <param name="src2">The second affine transform to multiply.</param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
@ -152,9 +152,9 @@
<Parameter Name="theta" Type="System.Double" /> <Parameter Name="theta" Type="System.Double" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Setup a shearing matrix</summary>
<param name="dst">a <see cref="T:System.Double[]" /></param> <param name="dst">Where to store the resulting affine transformation.</param>
<param name="theta">a <see cref="T:System.Double" /></param> <param name="theta">Shear angle in degrees.</param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
@ -168,10 +168,10 @@
<Parameter Name="src" Type="System.Double[]" /> <Parameter Name="src" Type="System.Double[]" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Determines wether a matrix is rectilinear, i.e. grid-aligned rectangles are transformed to other grid-aligned rectangles.</summary>
<param name="src">a <see cref="T:System.Double[]" /></param> <param name="src">The affine transformation to test.</param>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks>The implementation has epsilon-tolerance for roundoff errors.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Equal"> <Member MemberName="Equal">
@ -185,11 +185,11 @@
<Parameter Name="matrix2" Type="System.Double[]" /> <Parameter Name="matrix2" Type="System.Double[]" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Determine if two matrices are equal.</summary>
<param name="matrix1">a <see cref="T:System.Double[]" /></param> <param name="matrix1">An affine transformation.</param>
<param name="matrix2">a <see cref="T:System.Double[]" /></param> <param name="matrix2">Another affine transformation.</param>
<returns>a <see cref="T:System.Int32" /></returns> <returns>True if the matrices are equal, otherwise false.</returns>
<remarks>To be added</remarks> <remarks>Equality is verified with epsilon-tolerance for roundoff errors.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Translate"> <Member MemberName="Translate">
@ -204,10 +204,10 @@
<Parameter Name="ty" Type="System.Double" /> <Parameter Name="ty" Type="System.Double" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets up a translation matrix.</summary>
<param name="dst">a <see cref="T:System.Double[]" /></param> <param name="dst">Where to store the resulting affine transform.</param>
<param name="tx">a <see cref="T:System.Double" /></param> <param name="tx">X translation amount.</param>
<param name="ty">a <see cref="T:System.Double" /></param> <param name="ty">Y translation amount.</param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
@ -223,10 +223,10 @@
<Parameter Name="sy" Type="System.Double" /> <Parameter Name="sy" Type="System.Double" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets up a scaling matrix.</summary>
<param name="dst">a <see cref="T:System.Double[]" /></param> <param name="dst">Where to store the resulting affine transform.</param>
<param name="sx">a <see cref="T:System.Double" /></param> <param name="sx">X scale factor.</param>
<param name="sy">a <see cref="T:System.Double" /></param> <param name="sy">Y scale factor.</param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
@ -252,10 +252,10 @@
<Parameter Name="affine" Type="System.Double[]" /> <Parameter Name="affine" Type="System.Double[]" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Apply an affine transform to an <see cref="T:Art.Point" />.</summary>
<param name="src">a <see cref="T:Art.Point" /></param> <param name="src">The original point.</param>
<param name="affine">a <see cref="T:System.Double" /></param> <param name="affine">The affine transform.</param>
<returns>a <see cref="T:Art.Point" /></returns> <returns>The resulting point after performing the transform.</returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>

10
doc/en/Art/Point.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>Structure representing a point in the Art 2D space.</summary>
<remarks>To be added</remarks> <remarks>The Art 2D space is not a direct cartesian 2D space: it is an indirect cartesian space (that is, its direction is the invert of the standard trigonometric direction). The 2D space used by Art is inspired by the X coordinate space.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -28,7 +28,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get a point at the origin.</summary>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
@ -57,7 +57,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The X coordinate.</summary>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
@ -70,7 +70,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The Y coordinate.</summary>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>

10
doc/en/Gnome/CanvasEventArgs.xml
View file

@ -10,10 +10,12 @@
</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>Event data.</summary> <summary>Details of events coming from CanvasItems. See <see cref="T:Gnome.CanvasItem" />.</summary>
<remarks> <remarks>Contains mouse button clicks, motion, enter/leave, and key press events from CanvasItems. Use these to create user interactive items. The x and y coordinates of the event structure have been converted to canvas world coordinates.
<para>The <see cref="M:Gnome.CanvasItem.CanvasEvent" /> event invokes <see cref="T:Gnome.CanvasEventHandler" /> delegates which pass event data via this class.</para> <block subset="none" type="note">
</remarks> <para>To signify that an event has been handled, and stop it from being further emitted, set <see cref="P:GLib.SignalArgs.Retval" /> to true.
</para>
</block></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.SignalArgs</BaseTypeName> <BaseTypeName>GLib.SignalArgs</BaseTypeName>