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

211 lines
7.7 KiB
XML

<Type Name="Scale" FullName="Pango.Scale">
<TypeSignature Language="C#" Value="public sealed class Scale" Maintainer="auto" />
<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>Scale factors.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="PangoScale">
<MemberSignature Language="C#" Value="public static readonly double PangoScale = 1024;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Represents the scale between dimensions used for Pango distances and device units.</summary>
<remarks>The definition of device units is dependent on the output device; it will typically be pixels for a screen, and points for a printer. This is currently 1024, but this may be changed in the future. When setting font sizes, device units are always considered to be points (as in "12 point font"), rather than pixels.</remarks>
</Docs>
<MemberValue>1024</MemberValue>
</Member>
<Member MemberName="XXSmall">
<MemberSignature Language="C#" Value="public static readonly double XXSmall = 0.5787037037037;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The scale factor for three shrinking steps (1 / (1.2 * 1.2 * 1.2)).</summary>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
<MemberValue>0.5787037037037</MemberValue>
</Member>
<Member MemberName="XSmall">
<MemberSignature Language="C#" Value="public static readonly double XSmall = 0.6444444444444;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The scale factor for two shrinking steps (1 / (1.2 * 1.2)).</summary>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
<MemberValue>0.6444444444444</MemberValue>
</Member>
<Member MemberName="Small">
<MemberSignature Language="C#" Value="public static readonly double Small = 0.8333333333333;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The scale factor for one shrinking step (1 / 1.2).</summary>
<remarks />
</Docs>
<MemberValue>0.8333333333333</MemberValue>
</Member>
<Member MemberName="Medium">
<MemberSignature Language="C#" Value="public static readonly double Medium = 1;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The scale factor for normal size (1.0).</summary>
<remarks />
</Docs>
<MemberValue>1</MemberValue>
</Member>
<Member MemberName="Large">
<MemberSignature Language="C#" Value="public static readonly double Large = 1.2;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The scale factor for one magnification step (1.2).</summary>
<remarks />
</Docs>
<MemberValue>1.2</MemberValue>
</Member>
<Member MemberName="XLarge">
<MemberSignature Language="C#" Value="public static readonly double XLarge = 1.4399999999999;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The scale factor for two magnification steps (1.2 * 1.2).</summary>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
<MemberValue>1.4399999999999</MemberValue>
</Member>
<Member MemberName="XXLarge">
<MemberSignature Language="C#" Value="public static readonly double XXLarge = 1.728;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The scale factor for three magnification steps (1.2 * 1.2 * 1.2).</summary>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
<MemberValue>1.728</MemberValue>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Scale ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Default constructor</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="XX_Small" Deprecated="true">
<MemberSignature Language="C#" Value="public static readonly double XX_Small = 0.5787037037037;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Obsolete alias for <see cref="F:Pango.Scale.XXSmall" />.</summary>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message="Replaced by XXSmall", IsError=False)</AttributeName>
</Attribute>
</Attributes>
<MemberValue>0.5787037037037</MemberValue>
</Member>
<Member MemberName="X_Small" Deprecated="true">
<MemberSignature Language="C#" Value="public static readonly double X_Small = 0.6444444444444;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Obsolete alias for <see cref="F:Pango.Scale.XSmall" />.</summary>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message="Replaced by XSmall", IsError=False)</AttributeName>
</Attribute>
</Attributes>
<MemberValue>0.6444444444444</MemberValue>
</Member>
<Member MemberName="X_Large" Deprecated="true">
<MemberSignature Language="C#" Value="public static readonly double X_Large = 1.4399999999999;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Obsolete alias for <see cref="F:Pango.Scale.XLarge" />.</summary>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message="Replaced by XLarge", IsError=False)</AttributeName>
</Attribute>
</Attributes>
<MemberValue>1.4399999999999</MemberValue>
</Member>
<Member MemberName="XX_Large" Deprecated="true">
<MemberSignature Language="C#" Value="public static readonly double XX_Large = 1.728;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Obsolete alias for <see cref="F:Pango.Scale.XXLarge" />.</summary>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message="Replaced by XXLarge", IsError=False)</AttributeName>
</Attribute>
</Attributes>
<MemberValue>1.728</MemberValue>
</Member>
</Members>
</Type>