GtkSharp/doc/en/Pango/CairoHelper.xml
Mike Kestner cbee149fd3 stubs and some simple documentation for 2.12 pango API
svn path=/trunk/gtk-sharp/; revision=96993
2008-02-29 17:20:28 +00:00

302 lines
12 KiB
XML

<Type Name="CairoHelper" FullName="Pango.CairoHelper">
<TypeSignature Language="C#" Value="public class CairoHelper" />
<AssemblyInfo>
<AssemblyName>pango-sharp</AssemblyName>
<AssemblyVersion>2.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CairoHelper ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>Do not use.</summary>
<remarks>No instance methods exist for this class.</remarks>
</Docs>
</Member>
<Member MemberName="ShowLayout">
<MemberSignature Language="C#" Value="public static void ShowLayout (Cairo.Context cr, Pango.Layout layout);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cr" Type="Cairo.Context" />
<Parameter Name="layout" Type="Pango.Layout" />
</Parameters>
<Docs>
<param name="cr">a Cairo context.</param>
<param name="layout">The layout to render.</param>
<summary>Renders the contents of a Layout on a context.</summary>
<remarks>The top left corner of the Layout is located at the current point of the context.</remarks>
</Docs>
</Member>
<Member MemberName="ShowLayoutLine">
<MemberSignature Language="C#" Value="public static void ShowLayoutLine (Cairo.Context cr, Pango.LayoutLine line);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cr" Type="Cairo.Context" />
<Parameter Name="line" Type="Pango.LayoutLine" />
</Parameters>
<Docs>
<param name="cr">a cairo context.</param>
<param name="line">a line in a layout.</param>
<summary>Renders a layout line on a context.</summary>
<remarks>The origin of the glyphs is located at the current point of the context.</remarks>
</Docs>
</Member>
<Member MemberName="LayoutLinePath">
<MemberSignature Language="C#" Value="public static void LayoutLinePath (Cairo.Context cr, Pango.LayoutLine line);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cr" Type="Cairo.Context" />
<Parameter Name="line" Type="Pango.LayoutLine" />
</Parameters>
<Docs>
<param name="cr">a cairo context.</param>
<param name="line"> a layout line.</param>
<summary>Adds the glyphs in a line to the current path of a context.</summary>
<remarks>The origin of the glyphs is located at the current point of the context.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateContext">
<MemberSignature Language="C#" Value="public static void UpdateContext (Cairo.Context cr, Pango.Context context);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cr" Type="Cairo.Context" />
<Parameter Name="context" Type="Pango.Context" />
</Parameters>
<Docs>
<param name="cr">a cairo context.</param>
<param name="context">a Pango context.</param>
<summary>Updates a Pango context to match the transformation and target surface of a cairo context.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="ContextGetResolution">
<MemberSignature Language="C#" Value="public static double ContextGetResolution (Pango.Context context);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Pango.Context" />
</Parameters>
<Docs>
<param name="context">a Pango context.</param>
<summary>Gets the resolution for a context.</summary>
<returns>the dots per inch, or a negative value if none has been set.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GlyphStringPath">
<MemberSignature Language="C#" Value="public static void GlyphStringPath (Cairo.Context cr, Pango.Font font, Pango.GlyphString glyphs);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cr" Type="Cairo.Context" />
<Parameter Name="font" Type="Pango.Font" />
<Parameter Name="glyphs" Type="Pango.GlyphString" />
</Parameters>
<Docs>
<param name="cr">a cairo context.</param>
<param name="font">a font.</param>
<param name="glyphs">a glyph string.</param>
<summary>Adds a glyph string to the current path of a cairo context.</summary>
<remarks>The origin of the glyph string is the current point of the context.</remarks>
</Docs>
</Member>
<Member MemberName="ContextSetResolution">
<MemberSignature Language="C#" Value="public static void ContextSetResolution (Pango.Context context, double dpi);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Pango.Context" />
<Parameter Name="dpi" Type="System.Double" />
</Parameters>
<Docs>
<param name="context">a pango context.</param>
<param name="dpi">dots per inch.</param>
<summary>Sets the resolution for a context.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="CreateLayout">
<MemberSignature Language="C#" Value="public static Pango.Layout CreateLayout (Cairo.Context cr);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Layout</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cr" Type="Cairo.Context" />
</Parameters>
<Docs>
<param name="cr">a cairo context.</param>
<summary>Creates a pango layout for a cairo context.</summary>
<returns>a pango layout.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="ShowGlyphString">
<MemberSignature Language="C#" Value="public static void ShowGlyphString (Cairo.Context cr, Pango.Font font, Pango.GlyphString glyphs);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cr" Type="Cairo.Context" />
<Parameter Name="font" Type="Pango.Font" />
<Parameter Name="glyphs" Type="Pango.GlyphString" />
</Parameters>
<Docs>
<param name="cr">a cairo context.</param>
<param name="font"> a font.</param>
<param name="glyphs">a glyph string.</param>
<summary>Renders a glyph string to a cairo context.</summary>
<remarks>The origin of the glyph string is located at the current point of the context.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateLayout">
<MemberSignature Language="C#" Value="public static void UpdateLayout (Cairo.Context cr, Pango.Layout layout);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cr" Type="Cairo.Context" />
<Parameter Name="layout" Type="Pango.Layout" />
</Parameters>
<Docs>
<param name="cr">a cairo context.</param>
<param name="layout">a pango layout.</param>
<summary>Updates the internal context of a pango layout to the transformation and target surface of a cairo context.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="LayoutPath">
<MemberSignature Language="C#" Value="public static void LayoutPath (Cairo.Context cr, Pango.Layout layout);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cr" Type="Cairo.Context" />
<Parameter Name="layout" Type="Pango.Layout" />
</Parameters>
<Docs>
<param name="cr">To be added.</param>
<param name="layout">To be added.</param>
<summary>Adds the contents of a layout to the path of a cairo context.</summary>
<remarks>The layout origin is located at the current point of the cairo context.</remarks>
</Docs>
</Member>
<Member MemberName="ContextGetShapeRenderer">
<MemberSignature Language="C#" Value="public static Pango.CairoShapeRendererFunc ContextGetShapeRenderer (Pango.Context context, IntPtr data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.CairoShapeRendererFunc</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Pango.Context" />
<Parameter Name="data" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="context">To be added.</param>
<param name="data">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.12" />
</Docs>
</Member>
<Member MemberName="ContextSetShapeRenderer">
<MemberSignature Language="C#" Value="public static void ContextSetShapeRenderer (Pango.Context context, Pango.CairoShapeRendererFunc func);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Pango.Context" />
<Parameter Name="func" Type="Pango.CairoShapeRendererFunc" />
</Parameters>
<Docs>
<param name="context">To be added.</param>
<param name="func">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.12" />
</Docs>
</Member>
<Member MemberName="ErrorUnderlinePath">
<MemberSignature Language="C#" Value="public static void ErrorUnderlinePath (Cairo.Context cr, double x, double y, double width, double height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cr" Type="Cairo.Context" />
<Parameter Name="x" Type="System.Double" />
<Parameter Name="y" Type="System.Double" />
<Parameter Name="width" Type="System.Double" />
<Parameter Name="height" Type="System.Double" />
</Parameters>
<Docs>
<param name="cr">To be added.</param>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="width">To be added.</param>
<param name="height">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.12" />
</Docs>
</Member>
<Member MemberName="ShowErrorUnderline">
<MemberSignature Language="C#" Value="public static void ShowErrorUnderline (Cairo.Context cr, double x, double y, double width, double height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cr" Type="Cairo.Context" />
<Parameter Name="x" Type="System.Double" />
<Parameter Name="y" Type="System.Double" />
<Parameter Name="width" Type="System.Double" />
<Parameter Name="height" Type="System.Double" />
</Parameters>
<Docs>
<param name="cr">To be added.</param>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="width">To be added.</param>
<param name="height">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.12" />
</Docs>
</Member>
</Members>
<Docs>
<summary>Cairo-related method provider.</summary>
<remarks />
<since version="Gtk# 2.10" />
</Docs>
</Type>