GtkSharp/doc/en/Art/IRect.xml

164 lines
5.7 KiB
XML
Raw Normal View History

<Type Name="IRect" FullName="Art.IRect">
<TypeSignature Language="C#" Maintainer="auto" Value="public struct IRect" />
<AssemblyInfo>
<AssemblyName>art-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.20.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>A Structure that suports rectangle with int coordinates.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Art.IRect Zero;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Art.IRect</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Art.IRect New (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.IRect</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Art.IRect" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public void Copy (Art.IRect src);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="src" Type="Art.IRect" />
</Parameters>
<Docs>
<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">
<MemberSignature Language="C#" Value="public void Union (Art.IRect src1, Art.IRect src2);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="src1" Type="Art.IRect" />
<Parameter Name="src2" Type="Art.IRect" />
</Parameters>
<Docs>
<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">
<MemberSignature Language="C#" Value="public int Empty ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<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">
<MemberSignature Language="C#" Value="public void Intersect (Art.IRect src1, Art.IRect src2);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="src1" Type="Art.IRect" />
<Parameter Name="src2" Type="Art.IRect" />
</Parameters>
<Docs>
<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">
<MemberSignature Language="C#" Value="public int X0;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The first coordinate of the rectangle on the X axis.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Y0">
<MemberSignature Language="C#" Value="public int Y0;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The first coordinate of the rectangle on the Y axis.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="X1">
<MemberSignature Language="C#" Value="public int X1;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The second coordinate of the rectangle on the X axis.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Y1">
<MemberSignature Language="C#" Value="public int Y1;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The second coordinate of the rectangle on the Y axis.</summary>
<remarks />
</Docs>
</Member>
</Members>
</Type>