483 lines
16 KiB
XML
483 lines
16 KiB
XML
<Type Name="CanvasLine" FullName="Gnome.CanvasLine">
|
|
<TypeSignature Language="C#" Maintainer="auto" Value="public class CanvasLine : Gnome.CanvasItem" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gnome-sharp</AssemblyName>
|
|
<AssemblyPublicKey>
|
|
</AssemblyPublicKey>
|
|
<AssemblyVersion>2.16.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>Line canvas item</summary>
|
|
<remarks>
|
|
A canvas item for drawing lines. This canvas item uses a
|
|
<see cref="T:Gnome.CanvasPoints" /> structure so one or multiple joined lined
|
|
segments can be drawn with a single <see cref="T:Gnome.CanvasLine" /> item.
|
|
|
|
<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>
|
|
<Base>
|
|
<BaseTypeName>Gnome.CanvasItem</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
</Interfaces>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public CanvasLine (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>
|
|
<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 CanvasLine (Gnome.CanvasGroup group);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="group" Type="Gnome.CanvasGroup" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Creates a new line</summary>
|
|
<param name="group">
|
|
The <see cref="T:Gnome.CanvasGroup" /> that this item
|
|
belongs to.
|
|
</param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FillStipple">
|
|
<MemberSignature Language="C#" Value="public Gdk.Drawable FillStipple { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Drawable</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Stipple pattern for the line.</summary>
|
|
<value>Stipple pattern for the line.</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("fill_stipple")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="ArrowShapeB">
|
|
<MemberSignature Language="C#" Value="public double ArrowShapeB { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Double</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>
|
|
Distance from tip of arrowhead to trailing point, measured
|
|
along the shaft.
|
|
</summary>
|
|
<value>Distance from tip of arrowhead to trailing point, measured along shaft.</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("arrow_shape_b")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="ArrowShapeA">
|
|
<MemberSignature Language="C#" Value="public double ArrowShapeA { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Double</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Distance from tip of arrowhead to center.</summary>
|
|
<value>Distance from tip of arrowhead to center.</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("arrow_shape_a")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Smooth">
|
|
<MemberSignature Language="C#" Value="public bool Smooth { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Specifies whether to smooth the line using parabolic splines.</summary>
|
|
<value>Whether to smooth the line using parabolic splines</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("smooth")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="LineStyle">
|
|
<MemberSignature Language="C#" Value="public Gdk.LineStyle LineStyle { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.LineStyle</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Line dash style.</summary>
|
|
<value>Line dash style</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("line_style")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</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>
|
|
<value>a <see cref="T:Gnome.CanvasPoints" /> pointer.</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("points")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="FirstArrowhead">
|
|
<MemberSignature Language="C#" Value="public bool FirstArrowhead { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Specifies whether to draw an arrowhead on the first point of the line.</summary>
|
|
<value>whether to draw an arrowhead on the first point of the line.</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("first_arrowhead")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="SplineSteps">
|
|
<MemberSignature Language="C#" Value="public uint SplineSteps { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Specifies the number of steps to use when rendering curves.</summary>
|
|
<value>the number of steps to use when rendering curves.</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("spline_steps")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="LastArrowhead">
|
|
<MemberSignature Language="C#" Value="public bool LastArrowhead { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Specifies whether to draw an arrowhead on the last point of the line.</summary>
|
|
<value>whether to draw an arrowhead on the last point of the line.</value>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("last_arrowhead")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="CapStyle">
|
|
<MemberSignature Language="C#" Value="public Gdk.CapStyle CapStyle { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.CapStyle</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Determines how the ends of lines are drawn (the line cap style).</summary>
|
|
<value>the line cap style</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("cap_style")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="JoinStyle">
|
|
<MemberSignature Language="C#" Value="public Gdk.JoinStyle JoinStyle { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.JoinStyle</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Vertex join style for line segments</summary>
|
|
<value>Vertex join style</value>
|
|
<remarks>
|
|
<para>
|
|
(<see cref="F:Gdk.JoinStyle.Miter" /> to join by extending
|
|
each line to meet at an angle, <see cref="F:Gdk.JoinStyle.Round" /> to join by a circular arc,
|
|
and <see cref="F:Gdk.JoinStyle.Bevel" /> to join by a
|
|
straight line which makes an equal angle with each line)
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("join_style")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="FillColorRgba">
|
|
<MemberSignature Language="C#" Value="public uint FillColorRgba { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Line color with an alpha component (in the format 0xRRGGBBAA).</summary>
|
|
<value>the line color</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("fill_color_rgba")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="FillColorGdk">
|
|
<MemberSignature Language="C#" Value="public Gdk.Color FillColorGdk { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Color</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The <see cref="T:Gdk.Color" /> to draw the line with.</summary>
|
|
<value>the line color</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("fill_color_gdk")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="WidthUnits">
|
|
<MemberSignature Language="C#" Value="public double WidthUnits { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Double</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Width of the line in canvas units. The line width will be scaled when the canvas zoom factor changes.</summary>
|
|
<value>width of the line in canvas units</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("width_units")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="ArrowShapeC">
|
|
<MemberSignature Language="C#" Value="public double ArrowShapeC { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Double</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Distance of arrowhead trailing points from outside edge of shaft.</summary>
|
|
<value>Distance of arrowhead trailing points from outside edge of shaft.</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("arrow_shape_c")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="WidthPixels">
|
|
<MemberSignature Language="C#" Value="public uint WidthPixels { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Width of the line in pixels. The line width will not be scaled when the canvas zoom factor changes.</summary>
|
|
<value>width of the line in pixels.</value>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("width_pixels")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="FillColor">
|
|
<MemberSignature Language="C#" Value="public string FillColor { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>X color specification for line.</summary>
|
|
<value>X color specification for the line</value>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("fill_color")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</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.CanvasLine" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected CanvasLine (GLib.GType gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="GLib.GType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Protected Constructor.</summary>
|
|
<param name="gtype">a <see cref="T:GLib.GType" /></param>
|
|
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Obsolete</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected CanvasLine ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|