GtkSharp/doc/en/Gnome/CanvasPoints.xml
Mike Kestner 0e47e78f96 update docs to 2.8 API and document all new members
svn path=/trunk/gtk-sharp/; revision=54175
2005-12-09 23:12:49 +00:00

137 lines
4.8 KiB
XML

<Type Name="CanvasPoints" FullName="Gnome.CanvasPoints">
<TypeSignature Language="C#" Maintainer="auto" Value="public class CanvasPoints : GLib.Opaque" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.8.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 to manage an array of points (X and Y coordinates). </summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="Ref">
<MemberSignature Language="C#" Value="public Gnome.CanvasPoints Ref ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.CanvasPoints</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.CanvasPoints'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Free">
<MemberSignature Language="C#" Value="public void Free ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CanvasPoints (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<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>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CanvasPoints (int num_points);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="num_points" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="num_points">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CanvasPoints (double[] coords);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="coords" Type="System.Double[]" />
</Parameters>
<Docs>
<summary>Creates canvas points from x and y coordinates stored in array.</summary>
<param name="coords">
<see cref="T:System.Double[]" /> array of coordinates (num_points * 2 in size), X coordinates are stored in the even-numbered indices, and Y coordinates are stored in the odd-numbered indices.</param>
<remarks>
<example>
<code lang="C#">
// LineExample.cs - Displays triangle using gnome canvas
// Compile: mcs -r gtk-sharp.dll -r gnome-sharp.dll LineExample.cs
namespace GnomeSamples {
using System;
using Gtk;
using Gnome;
public class LineExample {
public static int Main (string[] args) {
Application.Init ();
Gtk.Window win = new Gtk.Window ("Canvas line example");
win.DeleteEvent += new DeleteEventHandler (Window_Delete);
Canvas canvas = new Canvas ();
win.Add (canvas);
CanvasLine line = new CanvasLine (canvas.Root ());
line.Points = new CanvasPoints (new double[]{40,0, 0,80, 80,80, 40,0});
win.ShowAll ();
Application.Run ();
return 0;
}
static void Window_Delete (object obj, DeleteEventArgs args) {
Application.Quit ();
args.RetVal = true;
}
}
}
</code>
</example>
</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:Gnome.CanvasPoints" />.</remarks>
</Docs>
</Member>
</Members>
</Type>