<Type Name="Rectangle" FullName="Gdk.Rectangle"> <TypeSignature Language="C#" Maintainer="auto" Value="public struct Rectangle" /> <AssemblyInfo> <AssemblyName>gdk-sharp</AssemblyName> <AssemblyPublicKey> </AssemblyPublicKey> <AssemblyVersion>2.12.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 a rectangle with x, y, width and height.</summary> <remarks /> </Docs> <Base> <BaseTypeName>System.ValueType</BaseTypeName> </Base> <Interfaces /> <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> <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> <value>a <see cref="T:GLib.GType" /></value> <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&" 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> <Member MemberName="Top"> <MemberSignature Language="C#" Value="public int Top { get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>The Y coordinate of the top of the rectangle.</summary> <value>a <see cref="T:System.Int32" /></value> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Bottom"> <MemberSignature Language="C#" Value="public int Bottom { get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>The Y coordinate of the bottom of the rectangle.</summary> <value>a <see cref="T:System.Int32" /></value> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Right"> <MemberSignature Language="C#" Value="public int Right { get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>The X coordinate of the right of the rectangle.</summary> <value>a <see cref="T:System.Int32" /></value> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Left"> <MemberSignature Language="C#" Value="public int Left { get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>The X coordinate of the left of the rectangle.</summary> <value>a <see cref="T:System.Int32" /></value> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </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>Gets if the area of the rectangle is zero</summary> <value>a <see cref="T:System.Boolean" /></value> <remarks>This will return true if either the height or the width is zero.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Size"> <MemberSignature Language="C#" Value="public Gdk.Size Size { set; get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>Gdk.Size</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Gets the size represented by (Width, Height)</summary> <value>a <see cref="T:Gdk.Size" /></value> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Location"> <MemberSignature Language="C#" Value="public Gdk.Point Location { set; get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>Gdk.Point</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Gets the point represented by (X, Y)</summary> <value>a <see cref="T:Gdk.Point" /></value> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="FromLTRB"> <MemberSignature Language="C#" Value="public static Gdk.Rectangle FromLTRB (int left, int top, int right, int bottom);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Gdk.Rectangle</ReturnType> </ReturnValue> <Parameters> <Parameter Name="left" Type="System.Int32" /> <Parameter Name="top" Type="System.Int32" /> <Parameter Name="right" Type="System.Int32" /> <Parameter Name="bottom" Type="System.Int32" /> </Parameters> <Docs> <summary>Creates a rectangle given the left, right, top, and bottom.</summary> <param name="left">a <see cref="T:System.Int32" /></param> <param name="top">a <see cref="T:System.Int32" /></param> <param name="right">a <see cref="T:System.Int32" /></param> <param name="bottom">a <see cref="T:System.Int32" /></param> <returns>a <see cref="T:Gdk.Rectangle" /></returns> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Union"> <MemberSignature Language="C#" Value="public static Gdk.Rectangle Union (Gdk.Rectangle r1, Gdk.Rectangle r2);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Gdk.Rectangle</ReturnType> </ReturnValue> <Parameters> <Parameter Name="r1" Type="Gdk.Rectangle" /> <Parameter Name="r2" Type="Gdk.Rectangle" /> </Parameters> <Docs> <summary>Gets the smallest rectangle that contains both parameters</summary> <param name="r1">a <see cref="T:Gdk.Rectangle" /></param> <param name="r2">a <see cref="T:Gdk.Rectangle" /></param> <returns>a <see cref="T:Gdk.Rectangle" /></returns> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Intersect"> <MemberSignature Language="C#" Value="public static Gdk.Rectangle Intersect (Gdk.Rectangle r1, Gdk.Rectangle r2);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Gdk.Rectangle</ReturnType> </ReturnValue> <Parameters> <Parameter Name="r1" Type="Gdk.Rectangle" /> <Parameter Name="r2" Type="Gdk.Rectangle" /> </Parameters> <Docs> <summary>Gets the largest rectangle (if any) which is contained by both parameters.</summary> <param name="r1">a <see cref="T:Gdk.Rectangle" /></param> <param name="r2">a <see cref="T:Gdk.Rectangle" /></param> <returns>a <see cref="T:Gdk.Rectangle" /></returns> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Inflate"> <MemberSignature Language="C#" Value="public static Gdk.Rectangle Inflate (Gdk.Rectangle rect, int x, int y);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Gdk.Rectangle</ReturnType> </ReturnValue> <Parameters> <Parameter Name="rect" Type="Gdk.Rectangle" /> <Parameter Name="x" Type="System.Int32" /> <Parameter Name="y" Type="System.Int32" /> </Parameters> <Docs> <summary>Changes the size of each side of the rectangle by the specified amount.</summary> <param name="rect">a <see cref="T:Gdk.Rectangle" /></param> <param name="x">Change in the X size</param> <param name="y">Change in the Y size</param> <returns>a <see cref="T:Gdk.Rectangle" /></returns> <remarks>The rectangle's center is the same as the center of <paramref name="rect" />.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Inflate"> <MemberSignature Language="C#" Value="public static Gdk.Rectangle Inflate (Gdk.Rectangle rect, Gdk.Size sz);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Gdk.Rectangle</ReturnType> </ReturnValue> <Parameters> <Parameter Name="rect" Type="Gdk.Rectangle" /> <Parameter Name="sz" Type="Gdk.Size" /> </Parameters> <Docs> <summary>Changes the size of each side of the rectangle by the specified amount.</summary> <param name="rect">a <see cref="T:Gdk.Rectangle" /></param> <param name="sz">A change in size.</param> <returns>a <see cref="T:Gdk.Rectangle" /></returns> <remarks>The rectangle's center is the same as the center of <paramref name="rect" />.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Offset"> <MemberSignature Language="C#" Value="public static Gdk.Rectangle Offset (Gdk.Rectangle rect, int dx, int dy);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Gdk.Rectangle</ReturnType> </ReturnValue> <Parameters> <Parameter Name="rect" Type="Gdk.Rectangle" /> <Parameter Name="dx" Type="System.Int32" /> <Parameter Name="dy" Type="System.Int32" /> </Parameters> <Docs> <summary>Returns the rectangle shifted by (dx,dy)</summary> <param name="rect">a <see cref="T:Gdk.Rectangle" /></param> <param name="dx">a <see cref="T:System.Int32" /></param> <param name="dy">a <see cref="T:System.Int32" /></param> <returns>a <see cref="T:Gdk.Rectangle" /></returns> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Offset"> <MemberSignature Language="C#" Value="public static Gdk.Rectangle Offset (Gdk.Rectangle rect, Gdk.Point dr);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Gdk.Rectangle</ReturnType> </ReturnValue> <Parameters> <Parameter Name="rect" Type="Gdk.Rectangle" /> <Parameter Name="dr" Type="Gdk.Point" /> </Parameters> <Docs> <summary>Returns a rectangle shifted by the vector dr</summary> <param name="rect">a <see cref="T:Gdk.Rectangle" /></param> <param name="dr">a <see cref="T:Gdk.Point" /></param> <returns>a <see cref="T:Gdk.Rectangle" /></returns> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Contains"> <MemberSignature Language="C#" Value="public bool Contains (Gdk.Rectangle rect);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="rect" Type="Gdk.Rectangle" /> </Parameters> <Docs> <summary>Tests if a rectangle is contained in this rectangle.</summary> <param name="rect">a <see cref="T:Gdk.Rectangle" /></param> <returns>a <see cref="T:System.Boolean" /></returns> <remarks>The rectangle must be fully enclosed for this test to return true. That is, the intersection of this and <paramref name="rect" /> must equal <paramref name="rect" />.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Contains"> <MemberSignature Language="C#" Value="public bool Contains (Gdk.Point pt);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="pt" Type="Gdk.Point" /> </Parameters> <Docs> <summary>Does hit testing for a point</summary> <param name="pt">a <see cref="T:Gdk.Point" /></param> <returns>a <see cref="T:System.Boolean" /></returns> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Contains"> <MemberSignature Language="C#" Value="public bool Contains (int x, int y);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="x" Type="System.Int32" /> <Parameter Name="y" Type="System.Int32" /> </Parameters> <Docs> <summary>Does hit testing for a point</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.Boolean" /></returns> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="IntersectsWith"> <MemberSignature Language="C#" Value="public bool IntersectsWith (Gdk.Rectangle r);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="r" Type="Gdk.Rectangle" /> </Parameters> <Docs> <summary>Tests if there is any overlap of this rectangle and another</summary> <param name="r">a <see cref="T:Gdk.Rectangle" /></param> <returns>a <see cref="T:System.Boolean" /></returns> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Intersect"> <MemberSignature Language="C#" Value="public void Intersect (Gdk.Rectangle r);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="r" Type="Gdk.Rectangle" /> </Parameters> <Docs> <summary>Modifies this rectangle to be the intersection with another rectangle</summary> <param name="r">a <see cref="T:Gdk.Rectangle" /></param> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Inflate"> <MemberSignature Language="C#" Value="public void Inflate (Gdk.Size sz);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="sz" Type="Gdk.Size" /> </Parameters> <Docs> <summary>Inflates this rectangle by a given size.</summary> <param name="sz">a <see cref="T:Gdk.Size" /></param> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Inflate"> <MemberSignature Language="C#" Value="public void Inflate (int width, int height);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="width" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" /> </Parameters> <Docs> <summary>Inflates this rectangle by a given size.</summary> <param name="width">a <see cref="T:System.Int32" /></param> <param name="height">a <see cref="T:System.Int32" /></param> <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>Offsets this rectangle by (dx,dy)</summary> <param name="dx">a <see cref="T:System.Int32" /></param> <param name="dy">a <see cref="T:System.Int32" /></param> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="Offset"> <MemberSignature Language="C#" Value="public void Offset (Gdk.Point dr);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="dr" Type="Gdk.Point" /> </Parameters> <Docs> <summary>Offsets this rectangle by the vector dr</summary> <param name="dr">a <see cref="T:Gdk.Point" /></param> <remarks>To be added</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public Rectangle (Gdk.Point loc, Gdk.Size sz);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="loc" Type="Gdk.Point" /> <Parameter Name="sz" Type="Gdk.Size" /> </Parameters> <Docs> <summary>Creates a rectangle from a point and a size.</summary> <param name="loc">a <see cref="T:Gdk.Point" /></param> <param name="sz">a <see cref="T:Gdk.Size" /></param> <remarks>To be added.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="op_Explicit"> <MemberSignature Language="C#" Value="public static GLib.Value op_Explicit (Gdk.Rectangle boxed);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>GLib.Value</ReturnType> </ReturnValue> <Parameters> <Parameter Name="boxed" Type="Gdk.Rectangle" /> </Parameters> <Docs> <param name="boxed">To be added.</param> <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="op_Explicit"> <MemberSignature Language="C#" Value="public static Gdk.Rectangle op_Explicit (GLib.Value val);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Gdk.Rectangle</ReturnType> </ReturnValue> <Parameters> <Parameter Name="val" Type="GLib.Value" /> </Parameters> <Docs> <param name="val">To be added.</param> <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="op_Equality"> <MemberSignature Language="C#" Value="public static bool op_Equality (Gdk.Rectangle r1, Gdk.Rectangle r2);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="r1" Type="Gdk.Rectangle" /> <Parameter Name="r2" Type="Gdk.Rectangle" /> </Parameters> <Docs> <param name="r1">To be added.</param> <param name="r2">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.Rectangle r1, Gdk.Rectangle r2);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="r1" Type="Gdk.Rectangle" /> <Parameter Name="r2" Type="Gdk.Rectangle" /> </Parameters> <Docs> <param name="r1">To be added.</param> <param name="r2">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>