GtkSharp/doc/en/Gtk/RulerMetric.xml
Mike Kestner 60b7406317 updater run for 2.4 api.
svn path=/trunk/gtk-sharp/; revision=35742
2004-11-05 21:25:40 +00:00

116 lines
4.1 KiB
XML

<Type Name="RulerMetric" FullName="Gtk.RulerMetric">
<TypeSignature Language="C#" Value="public sealed struct RulerMetric;" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-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>Information about measurement units on <see cref="T:Gtk.Ruler" /> objects.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes />
<Members>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Gtk.RulerMetric Zero;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.RulerMetric</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>An empty/default RulerMetric.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Gtk.RulerMetric New (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.RulerMetric</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Default constructor.</summary>
<param name="raw">A <see cref="T:IntPtr" />, pointer to the underlying C object.</param>
<returns>A <see cref="T:Gtk.RulerMetric" /></returns>
<remarks>For internal use only.</remarks>
</Docs>
</Member>
<Member MemberName="MetricName">
<MemberSignature Language="C#" Value="public string MetricName;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The name of the units this ruler measures: one of Pixels, Inches, or Centimeters.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Abbrev">
<MemberSignature Language="C#" Value="public string Abbrev;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The abbreviations for this metric's units: "Pi" for pixels, "In" for inches, "Cn" for centimeters.</summary>
<remarks>"Cn" isn't a typo; that's how it's defined in Gtk+. See bugzilla.gnome.org bug 151944.</remarks>
</Docs>
</Member>
<Member MemberName="PixelsPerUnit">
<MemberSignature Language="C#" Value="public double PixelsPerUnit;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The conversion factor between pixels and the given unit for the ruler.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="RulerScale">
<MemberSignature Language="C#" Value="public double [] RulerScale;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double[]</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>An array of possible scales for the ruler, dependent on the units chosen.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Subdivide">
<MemberSignature Language="C#" Value="public int [] Subdivide;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32[]</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>How many sub-units to break up each ruler unit into.</summary>
<remarks />
</Docs>
</Member>
</Members>
</Type>