GtkSharp/doc/en/Pango/Attribute.xml
Mike Kestner 352fc8e849 Run the doc updater
Didn't audit any of this.
2012-03-28 22:10:46 -05:00

180 lines
7.3 KiB
XML

<Type Name="Attribute" FullName="Pango.Attribute">
<TypeSignature Language="C#" Maintainer="auto" Value="public class Attribute : GLib.IWrapper, IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Attribute extends System.Object implements class GLib.IWrapper, class System.IDisposable" />
<AssemblyInfo>
<AssemblyName>pango-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>This is the base class for all Pango text attributes</summary>
<remarks />
</Docs>
<Members>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Pango.Attribute Copy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Pango.Attribute Copy() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Attribute</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Make a copy of an attribute.</summary>
<returns>a new <see cref="T:Pango.Attribute" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Dispose method</summary>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="EndIndex">
<MemberSignature Language="C#" Value="public uint EndIndex { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int32 EndIndex" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>end index of the range.</summary>
<value>a <see cref="T:System.UInt32" /></value>
<remarks>The character containing this byte index is not included in the range.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Equal">
<MemberSignature Language="C#" Value="public bool Equal (Pango.Attribute attr2);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Equal(class Pango.Attribute attr2) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="attr2" Type="Pango.Attribute" />
</Parameters>
<Docs>
<param name="attr2">a <see cref="T:Pango.Attribute" /> to be tested for equality.</param>
<summary>Compare two attributes for equality.</summary>
<returns>
<see langword="true" /> if the two attributes have the same value.</returns>
<remarks>This compares only the actual value of the two attributes and not the ranges that the attributes apply to.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="~Attribute ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="GetAttribute">
<MemberSignature Language="C#" Value="public static Pango.Attribute GetAttribute (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Pango.Attribute GetAttribute(native int raw) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Attribute</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<summary>Gets an Attribute or Attribute subclass for a native PangoAttribute pointer</summary>
<returns>a <see cref="T:Pango.Attribute" /></returns>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
<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 <see cref="T:GLib.GType" /> value for <see cref="T:Pango.Attribute" /></remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Handle">
<MemberSignature Language="C#" Value="public IntPtr Handle { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance native int Handle" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Pointer to the raw PangoAttribute structure associated with this object.</summary>
<value>a <see cref="T:System.IntPtr" /></value>
<remarks>To be added</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="StartIndex">
<MemberSignature Language="C#" Value="public uint StartIndex { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int32 StartIndex" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>the start index of the range (in bytes).</summary>
<value>a <see cref="T:System.UInt32" /></value>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Pango.AttrType Type { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Pango.AttrType Type" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.AttrType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The attribute type</summary>
<value>a <see cref="T:Pango.AttrType" /></value>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
</Member>
</Members>
</Type>