GtkSharp/doc/en/Pango/Layout.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

634 lines
No EOL
25 KiB
XML

<Type Name="Layout" FullName="Pango.Layout">
<TypeSignature Language="C#" Value="public class Layout : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>pango-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>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="SetMarkup">
<MemberSignature Language="C#" Value="public void SetMarkup (string markup);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="markup" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="markup">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetText">
<MemberSignature Language="C#" Value="public void SetText (string text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetMarkupWithAccel">
<MemberSignature Language="C#" Value="public void SetMarkupWithAccel (string markup, int length, string accel_marker, string accel_char);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="markup" Type="System.String" />
<Parameter Name="length" Type="System.Int32" />
<Parameter Name="accel_marker" Type="System.String" />
<Parameter Name="accel_char" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="markup">To be added: an object of type 'string'</param>
<param name="length">To be added: an object of type 'int'</param>
<param name="accel_marker">To be added: an object of type 'string'</param>
<param name="accel_char">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetLine">
<MemberSignature Language="C#" Value="public Pango.LayoutLine GetLine (int line);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.LayoutLine</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="line" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="line">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'Pango.LayoutLine'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetPixelExtents">
<MemberSignature Language="C#" Value="public void GetPixelExtents (Pango.Rectangle ink_rect, Pango.Rectangle logical_rect);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ink_rect" Type="Pango.Rectangle" />
<Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="ink_rect">To be added: an object of type 'Pango.Rectangle'</param>
<param name="logical_rect">To be added: an object of type 'Pango.Rectangle'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="XyToIndex">
<MemberSignature Language="C#" Value="public bool XyToIndex (int x, int y, int index, int trailing);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="trailing" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">To be added: an object of type 'int'</param>
<param name="y">To be added: an object of type 'int'</param>
<param name="index">To be added: an object of type 'int'</param>
<param name="trailing">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetCursorPos">
<MemberSignature Language="C#" Value="public void GetCursorPos (int index, Pango.Rectangle strong_pos, Pango.Rectangle weak_pos);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="strong_pos" Type="Pango.Rectangle" />
<Parameter Name="weak_pos" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="index">To be added: an object of type 'int'</param>
<param name="strong_pos">To be added: an object of type 'Pango.Rectangle'</param>
<param name="weak_pos">To be added: an object of type 'Pango.Rectangle'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetSize">
<MemberSignature Language="C#" Value="public void GetSize (out int width, out int height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="width" Type="System.Int32&amp;" />
<Parameter Name="height" Type="System.Int32&amp;" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="width">To be added: an object of type 'int&amp;'</param>
<param name="height">To be added: an object of type 'int&amp;'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Pango.Layout Copy ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Layout</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.Layout'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetLogAttrs">
<MemberSignature Language="C#" Value="public void GetLogAttrs (Pango.LogAttr attrs, int n_attrs);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="attrs" Type="Pango.LogAttr" />
<Parameter Name="n_attrs" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="attrs">To be added: an object of type 'Pango.LogAttr'</param>
<param name="n_attrs">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetMarkup">
<MemberSignature Language="C#" Value="public void SetMarkup (string markup, int length);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="markup" Type="System.String" />
<Parameter Name="length" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="markup">To be added: an object of type 'string'</param>
<param name="length">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IndexToPos">
<MemberSignature Language="C#" Value="public void IndexToPos (int index, Pango.Rectangle pos);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="pos" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="index">To be added: an object of type 'int'</param>
<param name="pos">To be added: an object of type 'Pango.Rectangle'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ContextChanged">
<MemberSignature Language="C#" Value="public void ContextChanged ();" />
<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="GetExtents">
<MemberSignature Language="C#" Value="public void GetExtents (Pango.Rectangle ink_rect, Pango.Rectangle logical_rect);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ink_rect" Type="Pango.Rectangle" />
<Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="ink_rect">To be added: an object of type 'Pango.Rectangle'</param>
<param name="logical_rect">To be added: an object of type 'Pango.Rectangle'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetPixelSize">
<MemberSignature Language="C#" Value="public void GetPixelSize (out int width, out int height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="width" Type="System.Int32&amp;" />
<Parameter Name="height" Type="System.Int32&amp;" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="width">To be added: an object of type 'int&amp;'</param>
<param name="height">To be added: an object of type 'int&amp;'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetText">
<MemberSignature Language="C#" Value="public void SetText (string text, int length);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
<Parameter Name="length" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">To be added: an object of type 'string'</param>
<param name="length">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="MoveCursorVisually">
<MemberSignature Language="C#" Value="public void MoveCursorVisually (bool strong, int old_index, int old_trailing, int direction, int new_index, int new_trailing);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="strong" Type="System.Boolean" />
<Parameter Name="old_index" Type="System.Int32" />
<Parameter Name="old_trailing" Type="System.Int32" />
<Parameter Name="direction" Type="System.Int32" />
<Parameter Name="new_index" Type="System.Int32" />
<Parameter Name="new_trailing" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="strong">To be added: an object of type 'bool'</param>
<param name="old_index">To be added: an object of type 'int'</param>
<param name="old_trailing">To be added: an object of type 'int'</param>
<param name="direction">To be added: an object of type 'int'</param>
<param name="new_index">To be added: an object of type 'int'</param>
<param name="new_trailing">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<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 Layout (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 Layout, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Pango.Layout" /> 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 Layout (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 Layout, 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 Layout (Pango.Context context);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="context" Type="Pango.Context" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="context">To be added: an object of type 'Pango.Context'</param>
<returns>To be added: an object of type 'Pango.Layout'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Layout ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.Layout'</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 Pango.Layout</summary>
<returns>The GLib TYpe for the Pango.Layout class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Size">
<MemberSignature Language="C#" Value="public Size { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Size</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type ''</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="LineCount">
<MemberSignature Language="C#" Value="public int LineCount { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Lines">
<MemberSignature Language="C#" Value="public GLib.SList Lines { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.SList</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'GLib.SList'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Indent">
<MemberSignature Language="C#" Value="public int Indent { 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="Alignment">
<MemberSignature Language="C#" Value="public Pango.Alignment Alignment { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Alignment</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Pango.Alignment" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Alignment'</param>
<returns>To be added: an object of type 'Pango.Alignment'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Tabs">
<MemberSignature Language="C#" Value="public Pango.TabArray Tabs { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.TabArray</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Pango.TabArray" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.TabArray'</param>
<returns>To be added: an object of type 'Pango.TabArray'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SingleParagraphMode">
<MemberSignature Language="C#" Value="public bool SingleParagraphMode { 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="Context">
<MemberSignature Language="C#" Value="public Pango.Context Context { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Context</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.Context'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Iter">
<MemberSignature Language="C#" Value="public Pango.LayoutIter Iter { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.LayoutIter</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.LayoutIter'</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="Spacing">
<MemberSignature Language="C#" Value="public int Spacing { 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="Justify">
<MemberSignature Language="C#" Value="public bool Justify { 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="Width">
<MemberSignature Language="C#" Value="public int Width { 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 { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Wrap">
<MemberSignature Language="C#" Value="public Pango.WrapMode Wrap { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.WrapMode</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Pango.WrapMode" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.WrapMode'</param>
<returns>To be added: an object of type 'Pango.WrapMode'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FontDescription">
<MemberSignature Language="C#" Value="public Pango.FontDescription FontDescription { set; };" />
<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>
</Members>
</Type>