GtkSharp/doc/en/Gtk/TextAttributes.xml
Shane Landrum 65ce35728c 2004-08-13 Shane Landrum <epicene@pobox.com>
* en/Gtk/TextAppearance.xml
	* en/Gtk/TextAttributes.xml: Classes to control text presentation.

svn path=/trunk/gtk-sharp/; revision=32314
2004-08-13 16:38:43 +00:00

331 lines
11 KiB
XML

<Type Name="TextAttributes" FullName="Gtk.TextAttributes">
<TypeSignature Language="C#" Value="public sealed struct TextAttributes;" 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>An object to represent the possible attributes of text in a <see cref="T:Gtk.TextView" /></summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes />
<Members>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Gtk.TextAttributes Zero;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextAttributes</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>No attributes at all.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Gtk.TextAttributes New ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextAttributes</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Public constructor.</summary>
<returns>A new <see cref="T:Gtk.TextAttributes" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Gtk.TextAttributes New (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextAttributes</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Constructor for internal use only.</summary>
<param name="raw">An <see cref="IntPtr" />, a pointer to the C object.</param>
<returns>a new <see cref="T:Gtk.TextAttributes" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Ref">
<MemberSignature Language="C#" Value="public void Ref ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Increments the reference count.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="CopyValues">
<MemberSignature Language="C#" Value="public void CopyValues (Gtk.TextAttributes dest);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dest" Type="Gtk.TextAttributes" />
</Parameters>
<Docs>
<summary>Copy the values in this object to <paramref name="dest" /> and free the values in this object..</summary>
<param name="dest">A new <see cref="T:Gtk.TextAttributes" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Gtk.TextAttributes Copy ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextAttributes</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Makes a new copy of this object.</summary>
<returns>A new <see cref="T:Gtk.TextAttributes" /></returns>
<remarks>FIXME: elaborate the difference between this and Copy, and see if the differences in the underlying C library carry over to the C# library</remarks>
</Docs>
</Member>
<Member MemberName="Unref">
<MemberSignature Language="C#" Value="public void Unref ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Decrements the reference count for this object, freeing the underlying C data structure if the refcount reaches 0.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="language">
<MemberSignature Language="C#" Value="public Pango.Language language { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Language</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The language of this text.</summary>
<param name="value">a <see cref="T:Pango.Language" /></param>
<returns>a <see cref="Pango.Language" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="tabs">
<MemberSignature Language="C#" Value="public Pango.TabArray tabs { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.TabArray</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The tab stops for this text.</summary>
<param name="value">a <see cref="T:Pango.TabArray" /></param>
<returns>a <see cref="T:Pango.TabArray" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="font">
<MemberSignature Language="C#" Value="public Pango.FontDescription font { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.FontDescription</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The font for this text.</summary>
<param name="value">a <see cref="T:Pango.FontDescription" /></param>
<returns>a <see cref="T:Pango.FontDescription" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.TextAttributes" />.</remarks>
</Docs>
</Member>
<Member MemberName="Refcount">
<MemberSignature Language="C#" Value="public uint Refcount;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The reference count for this object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Appearance">
<MemberSignature Language="C#" Value="public Gtk.TextAppearance Appearance;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextAppearance</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The appearance of this text: colors, underlining, etc.</summary>
<remarks>See <see cref="T:Gtk.TextAppearance" /> for more details.</remarks>
</Docs>
</Member>
<Member MemberName="Justification">
<MemberSignature Language="C#" Value="public Gtk.Justification Justification;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.Justification</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The justification of this text.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Direction">
<MemberSignature Language="C#" Value="public Gtk.TextDirection Direction;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextDirection</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether this text runs right-to-left or left-to-right.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="FontScale">
<MemberSignature Language="C#" Value="public double FontScale;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The scale of this text.</summary>
<remarks>For more information about font scaling, see <see cref="T:Pango.Scale" /></remarks>
</Docs>
</Member>
<Member MemberName="LeftMargin">
<MemberSignature Language="C#" Value="public int LeftMargin;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The size of the left margin.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Indent">
<MemberSignature Language="C#" Value="public int Indent;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The size of the indent.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="RightMargin">
<MemberSignature Language="C#" Value="public int RightMargin;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The size of the right margin.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="PixelsAboveLines">
<MemberSignature Language="C#" Value="public int PixelsAboveLines;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The number of blank pixels above a line of text.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="PixelsBelowLines">
<MemberSignature Language="C#" Value="public int PixelsBelowLines;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The number of blank pixels below a line of text.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="PixelsInsideWrap">
<MemberSignature Language="C#" Value="public int PixelsInsideWrap;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The number of pixels between wrapped lines.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="WrapMode">
<MemberSignature Language="C#" Value="public Gtk.WrapMode WrapMode;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WrapMode</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The line-wrapping style for this text.</summary>
<remarks />
</Docs>
</Member>
</Members>
</Type>