GtkSharp/doc/en/Gdk/Size.xml

236 lines
9 KiB
XML
Raw Normal View History

<Type Name="Size" FullName="Gdk.Size">
<TypeSignature Language="C#" Maintainer="auto" Value="public struct Size" />
<AssemblyInfo>
<AssemblyName>gdk-sharp</AssemblyName>
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 71 EB 6C 55 75 52 9C BF 72 44 F7 A6 EA 05 62 84 F9 EA E0 3B CF F2 CC 13 2C 9C 49 0A B3 09 EA B0 B5 6B CE 44 9D F5 03 D9 C0 A8 1E 52 05 85 CD BE 70 E2 FB 90 43 4B AC 04 FA 62 22 A8 00 98 B7 A1 A7 B3 AF 99 1A 41 23 24 BB 43 25 F6 B8 65 BB 64 EB F6 D1 C2 06 D5 73 2D DF BC 70 A7 38 9E E5 3E 0C 24 6E 32 79 74 1A D0 05 03 E4 98 42 E1 9B F3 7B 19 8B 40 21 26 CB 36 89 C2 EA 64 96 A4 7C B4]</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>A value type representing a height and width.</summary>
<remarks>The operators are also overridden so that plus (+) yields a new Size with widths and heights summed. minus (-) is imiplemented similarly. != and == are also implemented to check height and width values.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="Empty">
<MemberSignature Language="C#" Value="public static readonly Gdk.Size Empty;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gdk.Size</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>A static readonly Size </summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object o);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="o" Type="System.Object" />
</Parameters>
<Docs>
<summary>
<para>Determines whether the current instance and a specified
<see cref="T:System.Object" /> represent the same value.</para>
</summary>
<param name="o">a <see cref="T:System.Object" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Generates a hash code for the current instance.</para>
</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>width^height</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>Overrides ToString method.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>yields: String.Format ("{{Width={0}, Height={1}}}", width, height);
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Size (Gdk.Point pt);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="pt" Type="Gdk.Point" />
</Parameters>
<Docs>
<summary>Constructor based on <see cref="T:Gtk.Point" />. Initial height and width taken to be point.X and point.Y</summary>
<param name="pt">a <see cref="T:Gdk.Point" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Size (int width, int height);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="width" Type="System.Int32" />
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Constructor with initial values for height and width.</summary>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<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 height and width == 0</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public int Width { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets/sets the width value</summary>
<value>a <see cref="T:System.Int32" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public int Height { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Get/set the height value</summary>
<value>a <see cref="T:System.Int32" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="op_Addition">
<MemberSignature Language="C#" Value="public static Gdk.Size op_Addition (Gdk.Size sz1, Gdk.Size sz2);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Size</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sz1" Type="Gdk.Size" />
<Parameter Name="sz2" Type="Gdk.Size" />
</Parameters>
<Docs>
<param name="sz1">To be added.</param>
<param name="sz2">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.Size sz_a, Gdk.Size sz_b);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sz_a" Type="Gdk.Size" />
<Parameter Name="sz_b" Type="Gdk.Size" />
</Parameters>
<Docs>
<param name="sz_a">To be added.</param>
<param name="sz_b">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool op_Inequality (Gdk.Size sz_a, Gdk.Size sz_b);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sz_a" Type="Gdk.Size" />
<Parameter Name="sz_b" Type="Gdk.Size" />
</Parameters>
<Docs>
<param name="sz_a">To be added.</param>
<param name="sz_b">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Subtraction">
<MemberSignature Language="C#" Value="public static Gdk.Size op_Subtraction (Gdk.Size sz1, Gdk.Size sz2);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Size</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sz1" Type="Gdk.Size" />
<Parameter Name="sz2" Type="Gdk.Size" />
</Parameters>
<Docs>
<param name="sz1">To be added.</param>
<param name="sz2">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.Point op_Explicit (Gdk.Size sz);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Point</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sz" Type="Gdk.Size" />
</Parameters>
<Docs>
<param name="sz">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>