GtkSharp/doc/en/Pango/Coverage.xml

<Type Name="Coverage" FullName="Pango.Coverage">
  <TypeSignature Language="C#" Value="public class Coverage : GLib.Opaque, IWrapper" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>pango-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>Represents a map from ISO-10646 character point to <see cref="T:Pango.CoverageLevel" />.</summary>
    <remarks />
  </Docs>
  <Base>
    <BaseTypeName>GLib.Opaque</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>GLib.IWrapper</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes />
  <Members>
    <Member MemberName="Copy">
      <MemberSignature Language="C#" Value="public Pango.Coverage Copy ();" />
      <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="Unref">
      <MemberSignature Language="C#" Value="public void Unref ();" />
      <MemberType>Method</MemberType>
      <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="Max">
      <MemberSignature Language="C#" Value="public void Max (Pango.Coverage other);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="other" Type="Pango.Coverage" />
      </Parameters>
      <Docs>
        <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>
        <param name="other">an object of type <see cref="T:Pango.Coverage" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Ref">
      <MemberSignature Language="C#" Value="public Pango.Coverage Ref ();" />
      <MemberType>Method</MemberType>
      <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=".ctor">
      <MemberSignature Language="C#" Value="public Coverage (IntPtr raw);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="raw" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <summary>Internal constructor</summary>
        <param name="raw">Pointer to the C object.</param>
        <returns>An instance of Coverage, wrapping the C object.</returns>
        <remarks>
          <para>This is an internal constructor, and should not be used by user code.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Coverage ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Default constructor</summary>
        <returns>an object of type <see cref="T:Pango.Coverage" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Set">
      <MemberSignature Language="C#" Value="public void Set (int index_, Pango.CoverageLevel level);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="index_" Type="System.Int32" />
        <Parameter Name="level" Type="Pango.CoverageLevel" />
      </Parameters>
      <Docs>
        <summary>Modify a particular index</summary>
        <param name="index_"> the index to modify</param>
        <param name="level"> the new level for <paramref name="index_" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Get">
      <MemberSignature Language="C#" Value="public Pango.CoverageLevel Get (int index_);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Pango.CoverageLevel</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="index_" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>Determine whether a particular index is covered.</summary>
        <param name="index_"> the index to check</param>
        <returns>a <see cref="T:Pango.CoverageLevel" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="FromBytes">
      <MemberSignature Language="C#" Value="public static Pango.Coverage FromBytes (out byte bytes, int n_bytes);" />
      <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>
        <summary>Convert data generated from <see cref="M:Pango.ConverageToBytes()" /> back to a <see cref="T:Pango.Coverage" /></summary>
        <param name="bytes">a <see cref="T:System.Byte&amp;" /></param>
        <param name="n_bytes">a <see cref="T:System.Int32" /></param>
        <returns>a <see cref="T:Pango.Coverage" /> or <see langword="null" /> if the data was invalid</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="ToBytes">
      <MemberSignature Language="C#" Value="public void ToBytes (out byte bytes, out int n_bytes);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="bytes" Type="System.Byte&amp;" RefType="out" />
        <Parameter Name="n_bytes" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <summary>Convert a <see cref="T:Pango.Coverage" /> structure into a flat binary format.</summary>
        <param name="bytes"> location to store result</param>
        <param name="n_bytes">a <see cref="T:System.Int32&amp;" /></param>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
  </Members>
</Type>