GtkSharp/doc/en/Pango/Font.xml
Duncan Mak efa9acf122 2003-03-06 Duncan Mak <duncan@ximian.com>
* en/*/*.xml: Updated all the docs to match the new API. All the nodes
	that no longer have a corresponding member in the type are now
	marked as deprecated. We'll have to wait for Miguel to implement
	this in the browser to stop displaying them.

	All gtype constructors have been regenerated, because of the
	'uint' to 'GLib.Type' change. However, this patch will preserve
	(well, it was regenerated) the customized text for those GType
	constructors.

	A lot of the 'Finalized' methods are also now marked as
	deprecated, because the classes implement 'Dispose' instead. This
	is a possible place for customized scripts to generate template
	documentation, similar to the GType property and GType constructors.

svn path=/trunk/gtk-sharp/; revision=12270
2003-03-07 01:30:00 +00:00

222 lines
8.7 KiB
XML

<Type Name="Font" FullName="Pango.Font">
<TypeSignature Language="C#" Value="public class Font : 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="DescriptionsFree">
<MemberSignature Language="C#" Value="public static void DescriptionsFree (Pango.FontDescription descs, int n_descs);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="descs" Type="Pango.FontDescription" />
<Parameter Name="n_descs" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="descs">To be added: an object of type 'Pango.FontDescription'</param>
<param name="n_descs">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="MaskGetType" Deprecated="true">
<MemberSignature Language="C#" Value="public static uint MaskGetType ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetMetrics">
<MemberSignature Language="C#" Value="public Pango.FontMetrics GetMetrics (Pango.Language language);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.FontMetrics</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="language" Type="Pango.Language" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="language">To be added: an object of type 'Pango.Language'</param>
<returns>To be added: an object of type 'Pango.FontMetrics'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetCoverage">
<MemberSignature Language="C#" Value="public Pango.Coverage GetCoverage (Pango.Language language);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Coverage</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="language" Type="Pango.Language" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="language">To be added: an object of type 'Pango.Language'</param>
<returns>To be added: an object of type 'Pango.Coverage'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FindShaper">
<MemberSignature Language="C#" Value="public Pango.EngineShape FindShaper (Pango.Language language, uint ch);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.EngineShape</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="language" Type="Pango.Language" />
<Parameter Name="ch" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="language">To be added: an object of type 'Pango.Language'</param>
<param name="ch">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'Pango.EngineShape'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Describe">
<MemberSignature Language="C#" Value="public Pango.FontDescription Describe ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.FontDescription</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.FontDescription'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetGlyphExtents">
<MemberSignature Language="C#" Value="public void GetGlyphExtents (uint glyph, Pango.Rectangle ink_rect, Pango.Rectangle logical_rect);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="glyph" Type="System.UInt32" />
<Parameter Name="ink_rect" Type="Pango.Rectangle" />
<Parameter Name="logical_rect" Type="Pango.Rectangle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="glyph">To be added: an object of type 'uint'</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="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" Deprecated="true">
<MemberSignature Language="C#" Value="protected Font (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 Font, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Pango.Font" /> 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 Font (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 Font, 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="protected Font ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.Font'</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.Font</summary>
<returns>The GLib Type for the Pango.Font class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Font (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of Font, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Pango.Font" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>