GtkSharp/doc/en/Gnome/CanvasPolygon.xml
Mike Kestner 070eb3cc64 2004-06-01 Mike Kestner <mkestner@ximian.com>
* en/*/*.xml : run updater to add new protected ctor () 's.

svn path=/trunk/gtk-sharp/; revision=28646
2004-06-01 18:05:26 +00:00

161 lines
5.9 KiB
XML

<Type Name="CanvasPolygon" FullName="Gnome.CanvasPolygon">
<TypeSignature Language="C#" Value="public class CanvasPolygon : Gnome.CanvasShape, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gnome-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>Polygon canvas item</summary>
<remarks>
<para>
A canvas item for drawing polygon (multi sided) shapes.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasShape</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with the object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CanvasPolygon (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
<returns>An instance of CanvasPolygon, wrapping the C object.</returns>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CanvasPolygon (Gnome.CanvasGroup group);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>Creates a new polygon</summary>
<param name="group">
The <see cref="T:Gnome.CanvasGroup" /> that this item
belongs to.
</param>
<returns>the newly-created <see cref="T:Gnome.CanvasPolygon" /> object</returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Points">
<MemberSignature Language="C#" Value="public Gnome.CanvasPoints Points { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.CanvasPoints</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>a <see cref="T:Gnome.CanvasPoints" /> pointer. This
can be created by a call to the <see cref="C:Gnome.CanvasPoints" /> constructor.
</summary>
<param name="value">a <see cref="T:Gnome.CanvasPoints" /> pointer.</param>
<returns>a <see cref="T:Gnome.CanvasPoints" /> pointer.</returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="ToPoint">
<MemberSignature Language="C#" Value="public static double ToPoint (out double poly, int num_points, double x, double y);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="poly" Type="System.Double&amp;" RefType="out" />
<Parameter Name="num_points" Type="System.Int32" />
<Parameter Name="x" Type="System.Double" />
<Parameter Name="y" Type="System.Double" />
</Parameters>
<Docs>
<summary>Computes the distance between a point and a polygon.</summary>
<param name="poly">FIXME
Vertices of the polygon. X coordinates are in the even
indices, and Y coordinates are in the odd indices.</param>
<param name="num_points">Number of points in the polygon.</param>
<param name="x">X coordinate of the point.</param>
<param name="y">Y coordinate of the point.</param>
<returns>The distance from the point to the polygon, or zero if the point is inside the polygon.</returns>
<remarks>
</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>To be added</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CanvasPolygon (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gnome.CanvasPolygon" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CanvasPolygon ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gnome.CanvasPolygon" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>