ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-12-24 13:55:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Contributions from spigaz@gmail.com

Browse source 
svn path=/trunk/gtk-sharp/; revision=41109
This commit is contained in:
Miguel de Icaza 2005-02-23 19:01:51 +00:00
parent eb4269562f
commit 909200cf13
8 changed files with 121 additions and 116 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
doc/en/Art/DRect.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 Structure that suports rectangle with double coordinates.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -59,10 +59,10 @@
<Parameter Name="src" Type="Art.DRect" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="dst">a <see cref="T:Art.IRect" /></param>
<param name="src">a <see cref="T:Art.DRect" /></param>
<remarks>To be added</remarks>
<summary>Converts the src rectangle into a interger one.</summary>
<param name="dst">The newly created integer rectangle (<see cref="T:Art.IRect" />).</param>
<param name="src">The source rectangle (<see cref="T:Art.DRect" />).</param>
<remarks>The rouding is done using floor for x0 and y0 and ceil for x1 and y1.</remarks>
</Docs>
</Member>
<Member MemberName="Svp">
@ -75,9 +75,9 @@
<Parameter Name="svp" Type="Art.SVP" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="svp">a <see cref="T:Art.SVP" /></param>
<remarks>To be added</remarks>
<summary>Finds the bounding box os a sorted vector path.</summary>
<param name="svp">The Sorted Vector Path.</param>
<remarks>The result is used to initialize the current instance.</remarks>
</Docs>
</Member>
<Member MemberName="SvpUnion">
@ -90,9 +90,9 @@
<Parameter Name="svp" Type="Art.SVP" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Finds the bounding box to the Sorted Vector Path and then unifies the resulting rectangle with the current instance.</summary>
<param name="svp">a <see cref="T:Art.SVP" /></param>
<remarks>To be added</remarks>
<remarks>The result is used to initialize the current instance.</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
@ -105,9 +105,9 @@
<Parameter Name="src" Type="Art.DRect" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="src">a <see cref="T:Art.DRect" /></param>
<remarks>To be added</remarks>
<summary>Copies the values of the given rectangle, into this one.</summary>
<param name="src">The <see cref="T:Art.DRect" /> that is going to init the current one.</param>
<remarks>The current rectangle will be a clone of the given one.</remarks>
</Docs>
</Member>
<Member MemberName="Empty">
@ -118,9 +118,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<summary>Checks if the rectangle is empty.</summary>
<returns>True if the rectangle is empty, false otherwise.</returns>
<remarks>For the rectangle to be empty, x1 has to be smaller or equal to x0, or y0 smaller or equal to y1.</remarks>
</Docs>
</Member>
<Member MemberName="Union">
@ -134,9 +134,9 @@
<Parameter Name="src2" Type="Art.DRect" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="src1">a <see cref="T:Art.DRect" /></param>
<param name="src2">a <see cref="T:Art.DRect" /></param>
<summary>Finds the union of two rectangles and initializes the current one with the result.</summary>
<param name="src1">The first source rectangle used.</param>
<param name="src2">The second source rectangle used.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -151,10 +151,10 @@
<Parameter Name="matrix" Type="System.Double[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="src">a <see cref="T:Art.DRect" /></param>
<param name="matrix">a <see cref="T:System.Double[]" /></param>
<remarks>To be added</remarks>
<summary>Applies an affine transformation to the src rectangle and initializes this one with the result.</summary>
<param name="src">The source rectangle used to apply the transformation.</param>
<param name="matrix">A <see cref="T:System.Double[]" /> with 6 elements containing the transformation's matrix.</param>
<remarks>It finds the smallest rectangle enclosing the transformed src. The result is exactly the affine transformation of src when the matrix specifies an rectilinear affine transformation. otherwise its a conservative approximation.</remarks>
</Docs>
</Member>
<Member MemberName="Intersect">
@ -168,10 +168,10 @@
<Parameter Name="src2" Type="Art.DRect" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="src1">a <see cref="T:Art.DRect" /></param>
<param name="src2">a <see cref="T:Art.DRect" /></param>
<remarks>To be added</remarks>
<summary>Finds the intersection of two rectangles and initializes the current one with the result.</summary>
<param name="src1">The first source rectangle used.</param>
<param name="src2">The second source rectangle used.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="X0">
@ -183,8 +183,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The first coordinate of the rectangle on the X axis.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Y0">
@ -196,8 +196,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The first coordinate of the rectangle on the Y axis.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="X1">
@ -209,8 +209,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The second coordinate of the rectangle on the X axis.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Y1">
@ -222,8 +222,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The second coordinate of the rectangle on the Y axis.</summary>
<remarks />
</Docs>
</Member>
</Members>

32
doc/en/Art/Global.xml
View file

@ -95,13 +95,13 @@
<Parameter Name="p_nrects" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uta">a <see cref="T:Art.Uta" /></param>
<param name="max_width">a <see cref="T:System.Int32" /></param>
<param name="max_height">a <see cref="T:System.Int32" /></param>
<param name="p_nrects">a <see cref="T:System.Int32&amp;" /></param>
<returns>a <see cref="T:Art.IRect" /></returns>
<remarks>To be added</remarks>
<summary>Decomposes a UTA into a list of rectangles.</summary>
<param name="uta">The given UTA.</param>
<param name="max_width">The maximum width of the resulting rectangles.</param>
<param name="max_height">The maximum height of the resulting rectangles.</param>
<param name="p_nrects">The number of rectangles generated. Should be an out. Its unnecessary.</param>
<returns>It should return a IRect[]. Yup, a bug. </returns>
<remarks>This routine provides a precise implementation, meaning that the rectangles cover exactly the same are as the uta.</remarks>
</Docs>
</Member>
<Member MemberName="GraySvpAa">
@ -119,15 +119,15 @@
<Parameter Name="rowstride" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="svp">a <see cref="T:Art.SVP" /></param>
<param name="x0">a <see cref="T:System.Int32" /></param>
<param name="y0">a <see cref="T:System.Int32" /></param>
<param name="x1">a <see cref="T:System.Int32" /></param>
<param name="y1">a <see cref="T:System.Int32" /></param>
<param name="rowstride">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Byte" /></returns>
<remarks>To be added</remarks>
<summary>Renders the Sorted Vector Path into the given byte[].</summary>
<param name="svp">The given Sorted Vector Path.</param>
<param name="x0">The left coordinate of the viewport.</param>
<param name="y0">The top coordinate of the viewport.</param>
<param name="x1">The right coordinate of the viewport.</param>
<param name="y1">The bottom coordinate of the viewport.</param>
<param name="rowstride">The row stride of the pixel buffer.</param>
<returns>The function is void, it should get the byte[] were to render... Its a bug.</returns>
<remarks>Is only renders inside the area of the viewport.</remarks>
</Docs>
</Member>
</Members>

50
doc/en/Art/IRect.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 Structure that suports rectangle with int coordinates.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -29,7 +29,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -58,9 +58,9 @@
<Parameter Name="src" Type="Art.IRect" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="src">a <see cref="T:Art.IRect" /></param>
<remarks>To be added</remarks>
<summary>Copies the values of the given rectangle, into this one.</summary>
<param name="src">The <see cref="T:Art.IRect" /> that is going to init the current one.</param>
<remarks>The current rectangle will be a clone of the given one.</remarks>
</Docs>
</Member>
<Member MemberName="Union">
@ -74,10 +74,10 @@
<Parameter Name="src2" Type="Art.IRect" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="src1">a <see cref="T:Art.IRect" /></param>
<param name="src2">a <see cref="T:Art.IRect" /></param>
<remarks>To be added</remarks>
<summary>Finds the union of two rectangles and initializes the current one with the result.</summary>
<param name="src1">The first source rectangle used.</param>
<param name="src2">The first source rectangle used.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="Empty">
@ -88,9 +88,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<summary>Checks if the rectangle is empty.</summary>
<returns>True if the rectangle is empty, false otherwise.</returns>
<remarks>For the rectangle to be empty, x1 has to be smaller or equal to x0, or y0 smaller or equal to y1.</remarks>
</Docs>
</Member>
<Member MemberName="Intersect">
@ -104,10 +104,10 @@
<Parameter Name="src2" Type="Art.IRect" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="src1">a <see cref="T:Art.IRect" /></param>
<param name="src2">a <see cref="T:Art.IRect" /></param>
<remarks>To be added</remarks>
<summary>Finds the intersection of two rectangles and initializes the current one with the result.</summary>
<param name="src1">The first source rectangle used.</param>
<param name="src2">The second source rectangle used.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="X0">
@ -119,8 +119,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The first coordinate of the rectangle on the X axis.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Y0">
@ -132,8 +132,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The first coordinate of the rectangle on the Y axis.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="X1">
@ -145,8 +145,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The second coordinate of the rectangle on the X axis.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Y1">
@ -158,8 +158,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The second coordinate of the rectangle on the Y axis.</summary>
<remarks />
</Docs>
</Member>
</Members>

2
doc/en/Art/SVP.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>Sorted Vector Path</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

11
doc/en/Gdk/Display.xml
View file

@ -49,9 +49,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Display" /></returns>
<remarks>To be added</remarks>
<summary>Opens the default display specified by the command line arguments or the environment variables, setting it as the default display, it it was already set, then its just returned.</summary>
<returns>A <see cref="T:Gdk.Display" /> that is the default display just opened.</returns>
<remarks>Global.ParseArgs should be called first.
<block subset="none" type="note">
<para>
This method is internal and shouldn't be used in any application.
</para>
</block></remarks>
</Docs>
</Member>
<Member MemberName="Open">

20
doc/en/Gdk/Global.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>
<Docs>
<summary>Global API elements for <see cref="N:Gdk" /></summary>
<remarks />
<remarks>Shouldn't be called explicitly if Gtk.Application.Init() is used.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -199,9 +199,9 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<summary>Gets the display name specified in the command line arguments passed to Global.ParseArgs.</summary>
<returns>A <see cref="T:System.String" /> containing the name specified.</returns>
<remarks>If the name was not specified then null is returned.</remarks>
</Docs>
</Member>
<Member MemberName="ProgramClass">
@ -358,9 +358,9 @@
<Parameter Name="argv" Type="System.String[]&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="argv">a <see cref="T:System.String[]" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<summary>Initializes the library for usage.</summary>
<param name="argv">A <see cref="T:System.String[]" /> containing the args used to initialize the library.</param>
<returns>A <see cref="T:System.Boolean" />, that is true if its able to open and set the default display, otherwise its false.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -374,9 +374,9 @@
<Parameter Name="argv" Type="System.String[]&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="argv">a <see cref="T:System.String[]" /></param>
<remarks>To be added</remarks>
<summary>Parses command line arguments and stores them for future usage.</summary>
<param name="argv">A <see cref="T:System.String[]" /> containing the args to parse.</param>
<remarks>Shouldn't be called explicitly if Global.InitCheck or Gtk.Application.Init or Gtk.Application.InitCheck are being used.</remarks>
</Docs>
</Member>
<Member MemberName="QueryDepths">

48
doc/en/Gdk/Screen.xml
View file

@ -46,9 +46,9 @@
<ReturnType>Gdk.Screen</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Screen" /></returns>
<remarks>To be added</remarks>
<summary>The default screen of the default display.</summary>
<returns>The default <see cref="T:Gdk.Screen" />.</returns>
<remarks>Returns null if there iss no default display.</remarks>
</Docs>
</Member>
<Member MemberName="NMonitors">
@ -92,9 +92,9 @@ Console.WriteLine("You have {0} monitors.",numMonitors);
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<summary>The height of the screen in pixels.</summary>
<returns>A <see cref="T:System.Int32" /> with the number of pixels of the screen.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Display">
@ -140,9 +140,9 @@ Console.WriteLine("You have {0} monitors.",numMonitors);
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<summary>The height of the screen in millimeters.</summary>
<returns>A <see cref="T:System.Int32" /> with the height of the screen in millimeters.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Width">
@ -152,9 +152,9 @@ Console.WriteLine("You have {0} monitors.",numMonitors);
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<summary>The width of the screen in pixels.</summary>
<returns>A <see cref="T:System.Int32" /> with the number of pixels of the screen.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="WidthMm">
@ -164,9 +164,9 @@ Console.WriteLine("You have {0} monitors.",numMonitors);
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<summary>The width of the screen in millimeters.</summary>
<returns>A <see cref="T:System.Int32" /> with the width of the screen in millimeters.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="DefaultColormap">
@ -242,10 +242,10 @@ Console.WriteLine("You have {0} monitors.",numMonitors);
<Parameter Name="window" Type="Gdk.Window" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<summary>Gets the monitor that contains most of the given window.</summary>
<param name="window">A <see cref="T:Gdk.Window" /> whose main monitor is claimed.</param>
<returns>A <see cref="T:System.Int32" /> indicating the required monitor.</returns>
<remarks>If the window does not intersect any of the monitors, then the a close one is returned.</remarks>
</Docs>
</Member>
<Member MemberName="GetMonitorAtPoint">
@ -259,11 +259,11 @@ Console.WriteLine("You have {0} monitors.",numMonitors);
<Parameter Name="y" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<summary>Gets the monitor number where the point is located.</summary>
<param name="x">A <see cref="T:System.Int32" /> representing the x coordinate on the virtual screen.</param>
<param name="y">A <see cref="T:System.Int32" /> representing the y coordinate on the virtual screen.</param>
<returns>A <see cref="T:System.Int32" /> indicating the monitor where the point is located.</returns>
<remarks>If the point isn't in any monitor, then the nearest monitor is returned.</remarks>
</Docs>
</Member>
<Member MemberName="BroadcastClientMessage">

2
doc/en/Gtk/Window.xml
View file

@ -407,7 +407,7 @@ Console.WriteLine("Width: {0}, Height: {1}" , width , height);</code>
</ReturnValue>
<Parameters />
<Docs>
<summary>Asks to deiconify (i.e. unminimizw) the specified <paramref name="window" />.</summary>
<summary>Asks to deiconify (i.e. unminimize) the specified <paramref name="window" />.</summary>
<remarks>
<para>
Note that you shouldn't assume the <paramref name="window" /> is definitely deiconified afterward, because other entities (e.g. the user or window manager) could iconify it again before your code which assumes deiconification gets to run.