GtkSharp/doc/en/Gdk/Rectangle.xml

<Type Name="Rectangle" FullName="Gdk.Rectangle">
  <TypeSignature Language="C#" Value="public sealed struct Rectangle;" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>gdk-sharp</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
    <AssemblyCulture>neutral</AssemblyCulture>
    <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 a rectangle with x, y, width and height.</summary>
    <remarks />
  </Docs>
  <Base>
    <BaseTypeName>System.ValueType</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes />
  <Members>
    <Member MemberName="Zero">
      <MemberSignature Language="C#" Value="public static Gdk.Rectangle Zero;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Rectangle</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>A zero initialized rectangle.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="New">
      <MemberSignature Language="C#" Value="public static Gdk.Rectangle New (IntPtr raw);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Rectangle</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="raw" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <summary>Makes a new rectangle.</summary>
        <param name="raw">An <see cref="T:IntPtr"/>, the underlying unmanaged C object.</param>
        <returns>A <see cref="T:Gdk.Rectangle"/></returns>
        <remarks>Not for general developer use.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Rectangle (int x, int y, int width, int height);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="x" Type="System.Int32" />
        <Parameter Name="y" Type="System.Int32" />
        <Parameter Name="width" Type="System.Int32" />
        <Parameter Name="height" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>Initializes a rectangle from the given values.</summary>
        <param name="x">X value.</param>
        <param name="y">Y value</param>
        <param name="width">Width of the rectangle.</param>
        <param name="height">Height of the rectangle</param>
        <returns>The initialized rectangle.</returns>
        <remarks/>
      </Docs>
    </Member>
    <Member MemberName="ToString">
      <MemberSignature Language="C#" Value="public override string ToString ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns a string representation of the rectangle.</summary>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>This is only intended to be used for debugging purposes.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GType">
      <MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>GLib.GType</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>GType Property.</summary>
        <returns>a <see cref="T:GLib.GType" /></returns>
        <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gdk.Rectangle" />.</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 element of the rectangle.</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 element of the rectangle.</summary>
        <remarks/>
      </Docs>
    </Member>
    <Member MemberName="Width">
      <MemberSignature Language="C#" Value="public int Width;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>The rectangle width</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Height">
      <MemberSignature Language="C#" Value="public int Height;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>The rectangle height.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Union">
      <MemberSignature Language="C#" Value="public Gdk.Rectangle Union (Gdk.Rectangle src2);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Rectangle</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="src2" Type="Gdk.Rectangle" />
      </Parameters>
      <Docs>
        <summary>Obtains the union of a this <see cref="T:Gdk.Rectangle" /> and another.</summary>
        <param name="src2">a <see cref="T:Gdk.Rectangle" /></param>
        <returns>a <see cref="T:Gdk.Rectangle" /> representing the union of the two <see cref="T:Gdk.Rectangle" /> objects.</returns>
        <remarks>The result is the smallest <see cref="T:Gdk.Rectangle" /> that contains both <see cref="T:Gdk.Rectangle" /> objects within its boundaries.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Intersect">
      <MemberSignature Language="C#" Value="public bool Intersect (Gdk.Rectangle src2, out Gdk.Rectangle dest);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="src2" Type="Gdk.Rectangle" />
        <Parameter Name="dest" Type="Gdk.Rectangle&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <summary>Obtains the intersection of a this <see cref="T:Gdk.Rectangle" /> and another.</summary>
        <param name="src2">a <see cref="T:Gdk.Rectangle" /></param>
        <param name="dest">a <see cref="T:Gdk.Rectangle" /> representing the intersection of this <see cref="T:Gdk.Rectangle" /> and the src2 <see cref="T:Gdk.Rectangle" /></param>
        <returns>Returns true if the two <see cref="T:Gdk.Rectangle" /> objects intersect.</returns>
        <remarks>The result is the rectangular region occupied by both source rectanlges.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>