GtkSharp/doc/en/Gnome/Font.xml
John Luke 70635096fa 2004-12-29 John Luke <john.luke@gmail.com>
* gen-intptr-ctor-docs.cs: docs for Type (IntPtr) ctor
        * gen-gtype-ctor-docs.cs: docs for Type (GType) ctor
        * gen-finalize-docs.cs: docs Finalize methods
        * gen-gtype-docs.cs: docs GType properties, based off
        of gen-vm-docs.cs
        * en/*.xml: run these 4 tools for all the assemblies


svn path=/trunk/gtk-sharp/; revision=38159
2004-12-29 18:36:31 +00:00

667 lines
No EOL
24 KiB
XML

<Type Name="Font" FullName="Gnome.Font">
<TypeSignature Language="C#" Value="public class Font : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gnome-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>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="Finalize">
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with this <see cref="T:Gnome.Font" /> object.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="GetPangoDescription">
<MemberSignature Language="C#" Value="public Pango.FontDescription GetPangoDescription (double dpi);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.FontDescription</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dpi" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="dpi">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:Pango.FontDescription" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphKerning">
<MemberSignature Language="C#" Value="public double GetGlyphKerning (int glyph1, int glyph2);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="glyph1" Type="System.Int32" />
<Parameter Name="glyph2" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="glyph1">a <see cref="T:System.Int32" /></param>
<param name="glyph2">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="LookupDefault">
<MemberSignature Language="C#" Value="public int LookupDefault (int unicode);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="unicode" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="unicode">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetClosestPangoFont">
<MemberSignature Language="C#" Value="public Pango.Font GetClosestPangoFont (Pango.FontMap map, double dpi);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Font</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="map" Type="Pango.FontMap" />
<Parameter Name="dpi" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="map">a <see cref="T:Pango.FontMap" /></param>
<param name="dpi">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:Pango.Font" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphStdoutline">
<MemberSignature Language="C#" Value="public Art.Bpath GetGlyphStdoutline (int glyph);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.Bpath</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="glyph" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="glyph">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Art.Bpath" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphWidth">
<MemberSignature Language="C#" Value="public double GetGlyphWidth (int glyph);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="glyph" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="glyph">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphStdbbox">
<MemberSignature Language="C#" Value="public Art.DRect GetGlyphStdbbox (int glyph, Art.DRect bbox);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.DRect</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="glyph" Type="System.Int32" />
<Parameter Name="bbox" Type="Art.DRect" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="glyph">a <see cref="T:System.Int32" /></param>
<param name="bbox">a <see cref="T:Art.DRect" /></param>
<returns>a <see cref="T:Art.DRect" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphStdkerning">
<MemberSignature Language="C#" Value="public Art.Point GetGlyphStdkerning (int glyph0, int glyph1, Art.Point kerning);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.Point</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="glyph0" Type="System.Int32" />
<Parameter Name="glyph1" Type="System.Int32" />
<Parameter Name="kerning" Type="Art.Point" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="glyph0">a <see cref="T:System.Int32" /></param>
<param name="glyph1">a <see cref="T:System.Int32" /></param>
<param name="kerning">a <see cref="T:Art.Point" /></param>
<returns>a <see cref="T:Art.Point" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetWidthUtf8Sized">
<MemberSignature Language="C#" Value="public double GetWidthUtf8Sized (string s, int n);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="s" Type="System.String" />
<Parameter Name="n" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="s">a <see cref="T:System.String" /></param>
<param name="n">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetWidthUtf8">
<MemberSignature Language="C#" Value="public double GetWidthUtf8 (string s);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="s" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="s">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphStdadvance">
<MemberSignature Language="C#" Value="public Art.Point GetGlyphStdadvance (int glyph, Art.Point advance);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Art.Point</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="glyph" Type="System.Int32" />
<Parameter Name="advance" Type="Art.Point" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="glyph">a <see cref="T:System.Int32" /></param>
<param name="advance">a <see cref="T:Art.Point" /></param>
<returns>a <see cref="T:Art.Point" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Font (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gnome.Font" /></returns>
<remarks>This is not typically used by C# code.</remarks>
</Docs>
</Member>
<Member MemberName="Ascender">
<MemberSignature Language="C#" Value="public double Ascender { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsFixedPitch">
<MemberSignature Language="C#" Value="public bool IsFixedPitch { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FamilyName">
<MemberSignature Language="C#" Value="public string FamilyName { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FullName">
<MemberSignature Language="C#" Value="public string FullName { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UnderlinePosition">
<MemberSignature Language="C#" Value="public double UnderlinePosition { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FontName">
<MemberSignature Language="C#" Value="public string FontName { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Descender">
<MemberSignature Language="C#" Value="public double Descender { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CapHeight">
<MemberSignature Language="C#" Value="public double CapHeight { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FontBBox">
<MemberSignature Language="C#" Value="public IntPtr FontBBox { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.IntPtr" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Weight">
<MemberSignature Language="C#" Value="public string Weight { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Size">
<MemberSignature Language="C#" Value="public double Size { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="XHeight">
<MemberSignature Language="C#" Value="public double XHeight { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ItalicAngle">
<MemberSignature Language="C#" Value="public double ItalicAngle { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Version">
<MemberSignature Language="C#" Value="public string Version { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UnderlineThickness">
<MemberSignature Language="C#" Value="public double UnderlineThickness { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Face">
<MemberSignature Language="C#" Value="public Gnome.FontFace Face { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.FontFace</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gnome.FontFace" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FindClosestFromWeightSlant">
<MemberSignature Language="C#" Value="public static Gnome.Font FindClosestFromWeightSlant (string family, Gnome.FontWeight weight, bool italic, double size);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Font</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="family" Type="System.String" />
<Parameter Name="weight" Type="Gnome.FontWeight" />
<Parameter Name="italic" Type="System.Boolean" />
<Parameter Name="size" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="family">a <see cref="T:System.String" /></param>
<param name="weight">a <see cref="T:Gnome.FontWeight" /></param>
<param name="italic">a <see cref="T:System.Boolean" /></param>
<param name="size">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:Gnome.Font" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FindClosestFromFullName">
<MemberSignature Language="C#" Value="public static Gnome.Font FindClosestFromFullName (string str1ng);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Font</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str1ng" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="str1ng">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gnome.Font" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FindClosest">
<MemberSignature Language="C#" Value="public static Gnome.Font FindClosest (string name, double size);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Font</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="size" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">a <see cref="T:System.String" /></param>
<param name="size">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:Gnome.Font" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FindFromFullName">
<MemberSignature Language="C#" Value="public static Gnome.Font FindFromFullName (string str1ng);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Font</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str1ng" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="str1ng">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gnome.Font" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Find">
<MemberSignature Language="C#" Value="public static Gnome.Font Find (string name, double size);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Font</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="size" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">a <see cref="T:System.String" /></param>
<param name="size">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:Gnome.Font" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetRfont">
<MemberSignature Language="C#" Value="public Gnome.RFont GetRfont (out double t);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.RFont</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="t" Type="System.Double&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="t">a <see cref="T:System.Double&amp;" /></param>
<returns>a <see cref="T:Gnome.RFont" /></returns>
<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:Gnome.Font" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Font (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>
<returns>a <see cref="T:Gnome.Font" /></returns>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
</Member>
<Member MemberName="List">
<MemberSignature Language="C#" Value="public static string [] List ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String[]" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="StyleList">
<MemberSignature Language="C#" Value="public static string [] StyleList (string family);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="family" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="family">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.String[]" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SpeciesName">
<MemberSignature Language="C#" Value="public byte SpeciesName { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Byte" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public byte Name { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Byte" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PsName">
<MemberSignature Language="C#" Value="public byte PsName { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Byte" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Font ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gnome.Font" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>