GtkSharp/doc/en/Gdk/Point.xml
Mike Kestner b939f1f390 2005-06-16 Mike Kestner <mkestner@novell.com>
* en/*/*.xml : run the versionator to add since elements for 2.4.

svn path=/trunk/gtk-sharp/; revision=46100
2005-06-16 18:56:42 +00:00

228 lines
8.1 KiB
XML

<Type Name="Point" FullName="Gdk.Point">
<TypeSignature Language="C#" Maintainer="auto" Value="public struct Point" />
<AssemblyInfo>
<AssemblyName>gdk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</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 />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<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 />
</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">a <see cref="M:IntPtr" />, pointer to internal data</param>
<returns />
<remarks>This is an internal constructor, and should not be used by user code.</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>
<remarks />
</Docs>
</Member>
<Member MemberName="X">
<MemberSignature Language="C#" Value="public int X;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The x-coordinate of the Point.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Y">
<MemberSignature Language="C#" Value="public int Y;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The y-coordinate of the Point.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="IsEmpty">
<MemberSignature Language="C#" Value="public bool IsEmpty { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Checks if the point is (0,0)</summary>
<value>true if this == (0,0</value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Offset">
<MemberSignature Language="C#" Value="public void Offset (int dx, int dy);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dx" Type="System.Int32" />
<Parameter Name="dy" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Moves this point by quanities dx and dy</summary>
<param name="dx">Quanity by which to change X</param>
<param name="dy">Quanity by which to change Y</param>
<remarks>To be added.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Point (Gdk.Size sz);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="sz" Type="Gdk.Size" />
</Parameters>
<Docs>
<summary>Constructs a point from a <see cref="T:Gdk.Size" /></summary>
<param name="sz">a <see cref="T:Gdk.Size" /></param>
<remarks>The point will have an X of <paramref name="sz" />.Width and a Y of <paramref name="sz" />.Height</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="op_Explicit">
<MemberSignature Language="C#" Value="public static Gdk.Size op_Explicit (Gdk.Point pt);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Size</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pt" Type="Gdk.Point" />
</Parameters>
<Docs>
<param name="pt">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="op_Addition">
<MemberSignature Language="C#" Value="public static Gdk.Point op_Addition (Gdk.Point pt, Gdk.Size sz);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Point</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pt" Type="Gdk.Point" />
<Parameter Name="sz" Type="Gdk.Size" />
</Parameters>
<Docs>
<param name="pt">To be added.</param>
<param name="sz">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="op_Subtraction">
<MemberSignature Language="C#" Value="public static Gdk.Point op_Subtraction (Gdk.Point pt, Gdk.Size sz);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Point</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pt" Type="Gdk.Point" />
<Parameter Name="sz" Type="Gdk.Size" />
</Parameters>
<Docs>
<param name="pt">To be added.</param>
<param name="sz">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="op_Equality">
<MemberSignature Language="C#" Value="public static bool op_Equality (Gdk.Point pt_a, Gdk.Point pt_b);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pt_a" Type="Gdk.Point" />
<Parameter Name="pt_b" Type="Gdk.Point" />
</Parameters>
<Docs>
<param name="pt_a">To be added.</param>
<param name="pt_b">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool op_Inequality (Gdk.Point pt_a, Gdk.Point pt_b);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pt_a" Type="Gdk.Point" />
<Parameter Name="pt_b" Type="Gdk.Point" />
</Parameters>
<Docs>
<param name="pt_a">To be added.</param>
<param name="pt_b">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
</Members>
</Type>