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

145 lines
6 KiB
XML

<Type Name="FontMap" FullName="Pango.FontMap">
<TypeSignature Language="C#" Maintainer="auto" Value="public class FontMap : GLib.Object" />
<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>Represents the set of fonts available for a particular rendering system.</summary>
<remarks>This is a virtual object with implementations being specific to particular rendering systems.</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<Member MemberName="LoadFont">
<MemberSignature Language="C#" Value="public Pango.Font LoadFont (Pango.Context context, Pango.FontDescription desc);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Font</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Pango.Context" />
<Parameter Name="desc" Type="Pango.FontDescription" />
</Parameters>
<Docs>
<summary>Load the font in the fontmap that is the closest match for <paramref name="desc" />.</summary>
<param name="context">a <see cref="T:Pango.Context" /> the font will be used with</param>
<param name="desc">a <see cref="T:Pango.FontDescription" /> describing the font to load</param>
<returns>the font loaded, or <see langword="null" /> if no font matched.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="LoadFontset">
<MemberSignature Language="C#" Value="public Pango.Fontset LoadFontset (Pango.Context context, Pango.FontDescription desc, Pango.Language language);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Fontset</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Pango.Context" />
<Parameter Name="desc" Type="Pango.FontDescription" />
<Parameter Name="language" Type="Pango.Language" />
</Parameters>
<Docs>
<summary>Load a set of fonts in the fontmap that can be used to render a font matching <paramref name="desc" />.</summary>
<param name="context">a <see cref="T:Pango.Context" /> the font will be used with</param>
<param name="desc">a <see cref="T:Pango.FontDescription" /> describing the font to load </param>
<param name="language">a <see cref="T:Pango.Language" /> the fonts will be used for</param>
<returns>the fontset, or <see langword="null" /> if no font matched.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FontMap (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="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:Pango.FontMap" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected FontMap (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(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="ListFamilies">
<MemberSignature Language="C#" Value="public int ListFamilies (Pango.FontFamily families);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="families" Type="Pango.FontFamily" />
</Parameters>
<Docs>
<summary>List all families for a fontmap.</summary>
<param name="families">a <see cref="T:Pango.FontFamily" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected FontMap ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Protected constructor</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Families">
<MemberSignature Language="C#" Value="public Pango.FontFamily[] Families { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.FontFamily[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>List all families for a fontmap.</summary>
<value>a <see cref="T:Pango.FontFamily[]" /></value>
<remarks>
</remarks>
</Docs>
</Member>
</Members>
</Type>