GtkSharp/doc/en/Gnome/CanvasText.xml
Duncan Mak f3966a2a4c 2003-02-23 Duncan Mak <duncan@ximian.com>
* en/*/*.xml: a Big patch. This adds code-generated documentation
	for internal constructors, the GType property and the Finalized method.

svn path=/trunk/gtk-sharp/; revision=11858
2003-02-23 07:26:30 +00:00

604 lines
22 KiB
XML

<Type Name="CanvasText" FullName="Gnome.CanvasText">
<TypeSignature Language="C#" Value="public class CanvasText : Gnome.CanvasItem, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasItem</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 virtual 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="protected CanvasText (uint gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of CanvasText, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gnome.CanvasText" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CanvasText (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 CanvasText, 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="protected CanvasText ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.CanvasText'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CanvasText (Gnome.CanvasGroup group);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<returns>To be added: an object of type 'Gnome.CanvasText'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gnome.CanvasText</summary>
<returns>The GLib TYpe for the Gnome.CanvasText class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Markup">
<MemberSignature Language="C#" Value="public string Markup { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Strikethrough">
<MemberSignature Language="C#" Value="public bool Strikethrough { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Rise">
<MemberSignature Language="C#" Value="public int Rise { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Text">
<MemberSignature Language="C#" Value="public string Text { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Family">
<MemberSignature Language="C#" Value="public string Family { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Y">
<MemberSignature Language="C#" Value="public double Y { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="X">
<MemberSignature Language="C#" Value="public double X { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ClipHeight">
<MemberSignature Language="C#" Value="public double ClipHeight { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Stretch">
<MemberSignature Language="C#" Value="public Pango.Stretch Stretch { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Stretch</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Pango.Stretch" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Stretch'</param>
<returns>To be added: an object of type 'Pango.Stretch'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Justification">
<MemberSignature Language="C#" Value="public Gtk.Justification Justification { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Justification</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gtk.Justification" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.Justification'</param>
<returns>To be added: an object of type 'Gtk.Justification'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="TextHeight">
<MemberSignature Language="C#" Value="public double TextHeight { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="YOffset">
<MemberSignature Language="C#" Value="public double YOffset { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</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>
<Parameter Name="value" Type="Gdk.Drawable" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Drawable'</param>
<returns>To be added: an object of type 'Gdk.Drawable'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Anchor">
<MemberSignature Language="C#" Value="public Gtk.AnchorType Anchor { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.AnchorType</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gtk.AnchorType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.AnchorType'</param>
<returns>To be added: an object of type 'Gtk.AnchorType'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SizePoints">
<MemberSignature Language="C#" Value="public double SizePoints { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Weight">
<MemberSignature Language="C#" Value="public int Weight { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Clip">
<MemberSignature Language="C#" Value="public bool Clip { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Attributes">
<MemberSignature Language="C#" Value="public Pango.AttrList Attributes { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.AttrList</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Pango.AttrList" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.AttrList'</param>
<returns>To be added: an object of type 'Pango.AttrList'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Underline">
<MemberSignature Language="C#" Value="public Pango.Underline Underline { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Underline</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Pango.Underline" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Underline'</param>
<returns>To be added: an object of type 'Pango.Underline'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Scale">
<MemberSignature Language="C#" Value="public double Scale { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FillColorRgba">
<MemberSignature Language="C#" Value="public uint FillColorRgba { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Size">
<MemberSignature Language="C#" Value="public int Size { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ClipWidth">
<MemberSignature Language="C#" Value="public double ClipWidth { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Style">
<MemberSignature Language="C#" Value="public Pango.Style Style { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Style</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Pango.Style" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Style'</param>
<returns>To be added: an object of type 'Pango.Style'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Variant">
<MemberSignature Language="C#" Value="public Pango.Variant Variant { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Variant</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Pango.Variant" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Variant'</param>
<returns>To be added: an object of type 'Pango.Variant'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FillColorGdk">
<MemberSignature Language="C#" Value="public Gdk.Color FillColorGdk { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FontDesc">
<MemberSignature Language="C#" Value="public Pango.FontDescription FontDesc { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.FontDescription</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Pango.FontDescription" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.FontDescription'</param>
<returns>To be added: an object of type 'Pango.FontDescription'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Font">
<MemberSignature Language="C#" Value="public string Font { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="TextWidth">
<MemberSignature Language="C#" Value="public double TextWidth { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="XOffset">
<MemberSignature Language="C#" Value="public double XOffset { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FillColor">
<MemberSignature Language="C#" Value="public string FillColor { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>