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

235 lines
10 KiB
XML

<Type Name="Coverage" FullName="Pango.Coverage">
<TypeSignature Language="C#" Maintainer="auto" Value="public class Coverage : GLib.Opaque" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Coverage extends GLib.Opaque" />
<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>GLib.Opaque</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Docs>
<summary>Represents a map from ISO-10646 character point to <see cref="T:Pango.CoverageLevel" />.</summary>
<remarks />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Coverage ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Default constructor</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Coverage (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">Pointer to the C object.</param>
<summary>Internal constructor</summary>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Pango.Coverage Copy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Pango.Coverage Copy() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Coverage</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Copy an existing <see cref="T:Pango.Coverage" />.</summary>
<returns>an object of type <see cref="T:Pango.Coverage" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="~Coverage ();" />
<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="FromBytes">
<MemberSignature Language="C#" Value="public static Pango.Coverage FromBytes (out byte bytes, int n_bytes);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Pango.Coverage FromBytes(unsigned int8 bytes, int32 n_bytes) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Coverage</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="bytes" Type="System.Byte&amp;" RefType="out" />
<Parameter Name="n_bytes" Type="System.Int32" />
</Parameters>
<Docs>
<param name="bytes">a <see cref="T:System.Byte&amp;" /></param>
<param name="n_bytes">a <see cref="T:System.Int32" /></param>
<summary>Convert data generated from <see cref="M:Pango.ConverageToBytes()" /> back to a <see cref="T:Pango.Coverage" /></summary>
<returns>a <see cref="T:Pango.Coverage" /> or <see langword="null" /> if the data was invalid</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public Pango.CoverageLevel Get (int index_);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Pango.CoverageLevel Get(int32 index_) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.CoverageLevel</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index_" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index_"> the index to check</param>
<summary>Determine whether a particular index is covered.</summary>
<returns>a <see cref="T:Pango.CoverageLevel" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Max">
<MemberSignature Language="C#" Value="public void Max (Pango.Coverage other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Max(class Pango.Coverage other) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Pango.Coverage" />
</Parameters>
<Docs>
<param name="other">an object of type <see cref="T:Pango.Coverage" /></param>
<summary>Set the coverage for each index to be the max (better) value of the current coverage for the index and the coverage for the corresponding index in <paramref name="other" />.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Ref">
<MemberSignature Language="C#" Value="public Pango.Coverage Ref ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Pango.Coverage Ref() cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Pango.Coverage is now refcounted automatically")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Pango.Coverage</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Increase the reference count on the <see cref="T:Pango.Coverage" /> by one</summary>
<returns>an object of type <see cref="T:Pango.Coverage" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Ref">
<MemberSignature Language="C#" Value="protected override void Ref (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Ref(native int raw) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="Set">
<MemberSignature Language="C#" Value="public void Set (int index_, Pango.CoverageLevel level);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Set(int32 index_, valuetype Pango.CoverageLevel level) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index_" Type="System.Int32" />
<Parameter Name="level" Type="Pango.CoverageLevel" />
</Parameters>
<Docs>
<param name="index_"> the index to modify</param>
<param name="level"> the new level for <paramref name="index_" /></param>
<summary>Modify a particular index</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="ToBytes">
<MemberSignature Language="C#" Value="public void ToBytes (out byte[] bytes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ToBytes(unsigned int8[] bytes) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="bytes" Type="System.Byte[]&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="bytes">a <see cref="T:System.Byte[]" /></param>
<summary>Convert a <see cref="T:Pango.Coverage" /> structure into a flat binary format.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Unref">
<MemberSignature Language="C#" Value="public void Unref ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Unref() cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Pango.Coverage is now refcounted automatically")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Decrease the reference count on the <see cref="T:Pango.Coverage" /> by one.</summary>
<remarks>If the result is zero, free the coverage and all associated memory.</remarks>
</Docs>
</Member>
<Member MemberName="Unref">
<MemberSignature Language="C#" Value="protected override void Unref (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Unref(native int raw) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
</Members>
</Type>