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

106 lines
4.2 KiB
XML

<Type Name="LayoutRun" FullName="Pango.LayoutRun">
<TypeSignature Language="C#" Maintainer="auto" Value="public struct LayoutRun" />
<AssemblyInfo>
<AssemblyName>pango-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>The <see cref="T:Pango.LayoutRun" /> structure represents a single run within a <see cref="T:Pango.LayoutLine" />.</summary>
<remarks>It is simply an alternate name for <see cref="T:Pango.GlyphItem" />, present for backwards compatibility. See the <see cref="T:Pango.GlyphItem" /> docs for details on the fields.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Pango.LayoutRun Zero;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Pango.LayoutRun</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a new <see cref="T:Pango.LayoutRun" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Pango.LayoutRun New (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.LayoutRun</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal method</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Pango.LayoutRun" /></returns>
<remarks>This is an internal method, and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="Glyphs">
<MemberSignature Language="C#" Value="public Pango.GlyphString Glyphs { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.GlyphString</ReturnType>
</ReturnValue>
<Docs>
<summary>the glyphs obtained by shaping the text corresponding to item.</summary>
<value>an object of type <see cref="T:Pango.GlyphString" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="glyphs">
<MemberSignature Language="C#" Value="public Pango.GlyphString glyphs { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.GlyphString</ReturnType>
</ReturnValue>
<Docs>
<summary>Obsolete alias for <see cref="M:Pango.LayoutRun.Glyphs" /></summary>
<value>an object of type <see cref="T:Pango.GlyphString" /></value>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message="Replaced by Glyphs property", IsError=False)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public Pango.Item Item { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Item</ReturnType>
</ReturnValue>
<Docs>
<summary>A <see cref="T:Pango.Item" /> that provides information about a segment of text.</summary>
<value>a <see cref="T:Pango.Item" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="item">
<MemberSignature Language="C#" Value="public Pango.Item item { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Item</ReturnType>
</ReturnValue>
<Docs>
<summary>Obsolete alias for <see cref="M:Pango.LayoutRun.Item" /></summary>
<value>a <see cref="T:Pango.Item" /></value>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message="Replaced by Item property", IsError=False)</AttributeName>
</Attribute>
</Attributes>
</Member>
</Members>
</Type>