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

100 lines
3.1 KiB
XML

<Type Name="Underline" FullName="Pango.Underline">
<TypeSignature Language="C#" Maintainer="duncan" Value="public enum Underline" />
<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>
This enumeration is used to specify whether text should be
underlined, and if so, the type of underlining.
</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Attributes>
<Attribute>
<AttributeName>GLib.GType(WrapperType=typeof(Pango.UnderlineGType))</AttributeName>
</Attribute>
</Attributes>
<Members>
<Member MemberName="None">
<MemberSignature Language="C#" Value="None" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Pango.Underline</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>No underline should be drawn</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Single">
<MemberSignature Language="C#" Value="Single" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Pango.Underline</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>A single underline should be drawn</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Double">
<MemberSignature Language="C#" Value="Double" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Pango.Underline</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>A double underline should be drawn</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Low">
<MemberSignature Language="C#" Value="Low" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Pango.Underline</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
A single underline should be drawn at a position beneath the
ink extedn of the text being underlined
</summary>
<remarks>
<para>
This should be used only for underlining single
characters, such as for keyboard accelerators.
<see cref="T:Pango.Underline.Single" /> should be used for
extended portions of text
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Error">
<MemberSignature Language="C#" Value="Error" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Pango.Underline</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
</Members>
</Type>