GtkSharp/doc/en/Gtk/TextAttributes.xml
Mike Kestner 91d63cee7a updates to latest monodocer -pretty
svn path=/trunk/gtk-sharp/; revision=71149
2007-01-16 16:18:05 +00:00

410 lines
14 KiB
XML

<Type Name="TextAttributes" FullName="Gtk.TextAttributes">
<TypeSignature Language="C#" Maintainer="auto" Value="public class TextAttributes : GLib.Opaque" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.10.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>An object to represent the possible attributes of text in a <see cref="T:Gtk.TextView" /></summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
</Base>
<Interfaces />
<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>Obsolete: use <see langword="null" />.</summary>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Gtk.TextAttributes is a reference type now, use null")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TextAttributes ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>Public constructor.</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>Obsolete, replaced by normal constructor</summary>
<returns>A new <see cref="T:Gtk.TextAttributes" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TextAttributes (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<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>
<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>Obsolete 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="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="Language">
<MemberSignature Language="C#" Value="public Pango.Language Language { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Language</ReturnType>
</ReturnValue>
<Docs>
<summary>The language of this text.</summary>
<remarks />
<value>To be added.</value>
</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>
<value>a <see cref="Pango.Language" /></value>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Replaced by Language property.")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Tabs">
<MemberSignature Language="C#" Value="public Pango.TabArray Tabs { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.TabArray</ReturnType>
</ReturnValue>
<Docs>
<summary>The tab stops for this text.</summary>
<remarks />
<value>To be added.</value>
</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>
<value>a <see cref="T:Pango.TabArray" /></value>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Replaced by Tabs property.")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Font">
<MemberSignature Language="C#" Value="public Pango.FontDescription Font { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.FontDescription</ReturnType>
</ReturnValue>
<Docs>
<summary>The font for this text.</summary>
<remarks />
<value>To be added.</value>
</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>
<value>a <see cref="T:Pango.FontDescription" /></value>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Replaced by Font property.")</AttributeName>
</Attribute>
</Attributes>
</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>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.TextAttributes" />.</remarks>
</Docs>
</Member>
<Member MemberName="Appearance">
<MemberSignature Language="C#" Value="public Gtk.TextAppearance Appearance { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextAppearance</ReturnType>
</ReturnValue>
<Docs>
<summary>The appearance of this text: colors, underlining, etc.</summary>
<remarks>See <see cref="T:Gtk.TextAppearance" /> for more details.</remarks>
<value>To be added.</value>
</Docs>
</Member>
<Member MemberName="Justification">
<MemberSignature Language="C#" Value="public Gtk.Justification Justification { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Justification</ReturnType>
</ReturnValue>
<Docs>
<summary>The justification of this text.</summary>
<remarks />
<value>To be added.</value>
</Docs>
</Member>
<Member MemberName="Direction">
<MemberSignature Language="C#" Value="public Gtk.TextDirection Direction { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextDirection</ReturnType>
</ReturnValue>
<Docs>
<summary>Whether this text runs right-to-left or left-to-right.</summary>
<remarks />
<value>To be added.</value>
</Docs>
</Member>
<Member MemberName="FontScale">
<MemberSignature Language="C#" Value="public double FontScale { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>The scale of this text.</summary>
<remarks>For more information about font scaling, see <see cref="T:Pango.Scale" /></remarks>
<value>To be added.</value>
</Docs>
</Member>
<Member MemberName="LeftMargin">
<MemberSignature Language="C#" Value="public int LeftMargin { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>The size of the left margin.</summary>
<remarks />
<value>To be added.</value>
</Docs>
</Member>
<Member MemberName="Indent">
<MemberSignature Language="C#" Value="public int Indent { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>The size of the indent.</summary>
<remarks />
<value>To be added.</value>
</Docs>
</Member>
<Member MemberName="RightMargin">
<MemberSignature Language="C#" Value="public int RightMargin { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>The size of the right margin.</summary>
<remarks />
<value>To be added.</value>
</Docs>
</Member>
<Member MemberName="PixelsAboveLines">
<MemberSignature Language="C#" Value="public int PixelsAboveLines { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>The number of blank pixels above a line of text.</summary>
<remarks />
<value>To be added.</value>
</Docs>
</Member>
<Member MemberName="PixelsBelowLines">
<MemberSignature Language="C#" Value="public int PixelsBelowLines { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>The number of blank pixels below a line of text.</summary>
<remarks />
<value>To be added.</value>
</Docs>
</Member>
<Member MemberName="PixelsInsideWrap">
<MemberSignature Language="C#" Value="public int PixelsInsideWrap { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>The number of pixels between wrapped lines.</summary>
<remarks />
<value>To be added.</value>
</Docs>
</Member>
<Member MemberName="WrapMode">
<MemberSignature Language="C#" Value="public Gtk.WrapMode WrapMode { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.WrapMode</ReturnType>
</ReturnValue>
<Docs>
<summary>The line-wrapping style for this text.</summary>
<remarks />
<value>To be added.</value>
</Docs>
</Member>
<Member MemberName="Invisible">
<MemberSignature Language="C#" Value="public bool Invisible { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Whether or not the text should be hidden.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="BgFullHeight">
<MemberSignature Language="C#" Value="public bool BgFullHeight { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Whether background is fit to full line height</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Editable">
<MemberSignature Language="C#" Value="public bool Editable { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Whether or not the text is editable.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Realized">
<MemberSignature Language="C#" Value="public bool Realized { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Whether or not the attribute is fully-realized.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
</Member>
</Members>
</Type>