GtkSharp/doc/en/Gdk/Point.xml
Ben Maurer 89a5fdaf12 Documented Point.xml
svn path=/trunk/gtk-sharp/; revision=14776
2003-05-21 21:02:52 +00:00

102 lines
3.5 KiB
XML

<Type Name="Point" FullName="Gdk.Point">
<TypeSignature Language="C#" Value="public sealed struct Point;" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gdk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</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>Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional, Cartesian plane.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes />
<Members>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Gdk.Point Zero;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gdk.Point</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The point (0, 0).</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="x">
<MemberSignature Language="C#" Value="public int x;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The x-coordinate of the Point.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="y">
<MemberSignature Language="C#" Value="public int y;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The x-coordinate of the Point.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Gdk.Point New (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Point</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns></returns>
<remarks>This is an internal constructor, and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public virtual string ToString ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The point as a string.</summary>
<returns>The point as a string.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Point (int x, int y);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Creates a Point object from integer x- and y-coordinates.</summary>
<param name="x">The x-coordinate.</param>
<param name="y">The y-coordinate.</param>
<returns></returns>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>