GtkSharp/doc/en/Pango/GlyphString.xml
John Luke 8de889da0e more pango docs
svn path=/trunk/gtk-sharp/; revision=31265
2004-07-17 18:05:37 +00:00

260 lines
No EOL
10 KiB
XML

<Type Name="GlyphString" FullName="Pango.GlyphString">
<TypeSignature Language="C#" Value="public sealed struct GlyphString;" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>pango-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<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>Used to store strings of glyphs with geometry and visual attribute information.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes />
<Members>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Pango.GlyphString Zero;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Pango.GlyphString</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns an empty <see cref="T:Pango.GlyphString" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Pango.GlyphString New ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.GlyphString</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.GlyphString'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Pango.GlyphString New (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.GlyphString</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.GlyphString" /></returns>
<remarks>This is an internal method, and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Pango.GlyphString Copy ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.GlyphString</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.GlyphString'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Extents">
<MemberSignature Language="C#" Value="public void Extents (Pango.Font font, Pango.Rectangle ink_rect, Pango.Rectangle logical_rect);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="font" Type="Pango.Font" />
<Parameter Name="ink_rect" Type="Pango.Rectangle" />
<Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="font">To be added: an object of type 'Pango.Font'</param>
<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="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="ExtentsRange">
<MemberSignature Language="C#" Value="public void ExtentsRange (int start, int end, Pango.Font font, Pango.Rectangle ink_rect, Pango.Rectangle logical_rect);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="start" Type="System.Int32" />
<Parameter Name="end" Type="System.Int32" />
<Parameter Name="font" Type="Pango.Font" />
<Parameter Name="ink_rect" Type="Pango.Rectangle" />
<Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start">To be added: an object of type 'int'</param>
<param name="end">To be added: an object of type 'int'</param>
<param name="font">To be added: an object of type 'Pango.Font'</param>
<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="Size">
<MemberSignature Language="C#" Value="public int Size { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</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="glyphs">
<MemberSignature Language="C#" Value="public Pango.GlyphInfo glyphs { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.GlyphInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>an array of <see cref="T:Pango.GlyphInfo" /></summary>
<returns>an object of type <see cref="T:Pango.GlyphInfo" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="XToIndex">
<MemberSignature Language="C#" Value="public void XToIndex (string text, Pango.Analysis analysis, int x_pos, out int index_, out int trailing);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
<Parameter Name="analysis" Type="Pango.Analysis" />
<Parameter Name="x_pos" Type="System.Int32" />
<Parameter Name="index_" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="trailing" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">a <see cref="T:System.String" /></param>
<param name="analysis">a <see cref="T:Pango.Analysis" /></param>
<param name="x_pos">a <see cref="T:System.Int32" /></param>
<param name="index_">a <see cref="T:System.Int32&amp;" /></param>
<param name="trailing">a <see cref="T:System.Int32&amp;" /></param>
<remarks>To be added</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>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Pango.GlyphString" />.</remarks>
</Docs>
</Member>
<Member MemberName="NumGlyphs">
<MemberSignature Language="C#" Value="public int NumGlyphs;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>the number of glyphs in the string.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Space">
<MemberSignature Language="C#" Value="public int Space;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IndexToX">
<MemberSignature Language="C#" Value="public int IndexToX (string text, Pango.Analysis analysis, int index_, bool trailing);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
<Parameter Name="analysis" Type="Pango.Analysis" />
<Parameter Name="index_" Type="System.Int32" />
<Parameter Name="trailing" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">a <see cref="T:System.String" /></param>
<param name="analysis">a <see cref="T:Pango.Analysis" /></param>
<param name="index_">a <see cref="T:System.Int32" /></param>
<param name="trailing">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetLogicalWidths">
<MemberSignature Language="C#" Value="public int GetLogicalWidths (string text, int embedding_level);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
<Parameter Name="embedding_level" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">a <see cref="T:System.String" /></param>
<param name="embedding_level">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>